Object
ActiveResource::Base is the main class for mapping RESTful resources as models in a Rails application.
For an outline of what Active Resource is capable of, see its README.
Active Resource objects represent your RESTful resources as manipulatable Ruby objects. To map resources to Ruby objects, Active Resource only needs a class name that corresponds to the resource name (e.g., the class Person maps to the resources people, very similarly to Active Record) and a site value, which holds the URI of the resources.
class Person < ActiveResource::Base self.site = "http://api.people.com:3000/" end
Now the Person class is mapped to RESTful resources located at api.people.com:3000/people/, and you can now use Active Resource’s life cycle methods to manipulate resources. In the case where you already have an existing model with the same name as the desired RESTful resource you can set the element_name value.
class PersonResource < ActiveResource::Base self.site = "http://api.people.com:3000/" self.element_name = "person" end
If your Active Resource object is required to use an HTTP proxy you can set the proxy value which holds a URI.
class PersonResource < ActiveResource::Base self.site = "http://api.people.com:3000/" self.proxy = "http://user:password@proxy.people.com:8080" end
Active Resource exposes methods for creating, finding, updating, and deleting resources from REST web services.
ryan = Person.new(:first => 'Ryan', :last => 'Daigle') ryan.save # => true ryan.id # => 2 Person.exists?(ryan.id) # => true ryan.exists? # => true ryan = Person.find(1) # Resource holding our newly created Person object ryan.first = 'Rizzle' ryan.save # => true ryan.destroy # => true
As you can see, these are very similar to Active Record’s life cycle methods for database records. You can read more about each of these methods in their respective documentation.
Since simple CRUD/life cycle methods can’t accomplish every task, Active Resource also supports defining your own custom REST methods. To invoke them, Active Resource provides the get, post, put and delete methods where you can specify a custom REST method name to invoke.
# POST to the custom 'register' REST method, i.e. POST /people/new/register.json. Person.new(:name => 'Ryan').post(:register) # => { :id => 1, :name => 'Ryan', :position => 'Clerk' } # PUT an update by invoking the 'promote' REST method, i.e. PUT /people/1/promote.json?position=Manager. Person.find(1).put(:promote, :position => 'Manager') # => { :id => 1, :name => 'Ryan', :position => 'Manager' } # GET all the positions available, i.e. GET /people/positions.json. Person.get(:positions) # => [{:name => 'Manager'}, {:name => 'Clerk'}] # DELETE to 'fire' a person, i.e. DELETE /people/1/fire.json. Person.find(1).delete(:fire)
For more information on using custom REST methods, see the ActiveResource::CustomMethods documentation.
You can validate resources client side by overriding validation methods in the base class.
class Person < ActiveResource::Base self.site = "http://api.people.com:3000/" protected def validate errors.add("last", "has invalid characters") unless last =~ /[a-zA-Z]*/ end end
See the ActiveResource::Validations documentation for more information.
Many REST APIs will require authentication, usually in the form of basic HTTP authentication. Authentication can be specified by:
putting the credentials in the URL for the site variable.
class Person < ActiveResource::Base self.site = "http://ryan:password@api.people.com:3000/" end
defining user and/or password variables
class Person < ActiveResource::Base self.site = "http://api.people.com:3000/" self.user = "ryan" self.password = "password" end
For obvious security reasons, it is probably best if such services are available over HTTPS.
Note: Some values cannot be provided in the URL passed to site. e.g. email addresses as usernames. In those situations you should use the separate user and password option.
End point uses an X509 certificate for authentication. See ssl_options= for all options.
class Person < ActiveResource::Base self.site = "https://secure.api.people.com/" self.ssl_options = {:cert => OpenSSL::X509::Certificate.new(File.open(pem_file)) :key => OpenSSL::PKey::RSA.new(File.open(pem_file)), :ca_path => "/path/to/OpenSSL/formatted/CA_Certs", :verify_mode => OpenSSL::SSL::VERIFY_PEER} end
Error handling and validation is handled in much the same manner as you’re used to seeing in Active Record. Both the response code in the HTTP response and the body of the response are used to indicate that an error occurred.
When a GET is requested for a resource that does not exist, the HTTP 404 (Resource Not Found) response code will be returned from the server which will raise an ActiveResource::ResourceNotFound exception.
# GET http://api.people.com:3000/people/999.json ryan = Person.find(999) # 404, raises ActiveResource::ResourceNotFound
404 is just one of the HTTP error response codes that Active Resource will handle with its own exception. The following HTTP response codes will also result in these exceptions:
200..399 - Valid response. No exceptions, other than these redirects:
301, 302, 303, 307 - ActiveResource::Redirection
400 - ActiveResource::BadRequest
401 - ActiveResource::UnauthorizedAccess
403 - ActiveResource::ForbiddenAccess
404 - ActiveResource::ResourceNotFound
405 - ActiveResource::MethodNotAllowed
409 - ActiveResource::ResourceConflict
410 - ActiveResource::ResourceGone
422 - ActiveResource::ResourceInvalid (rescued by save as validation errors)
401..499 - ActiveResource::ClientError
500..599 - ActiveResource::ServerError
Other - ActiveResource::ConnectionError
These custom exceptions allow you to deal with resource errors more naturally and with more precision rather than returning a general HTTP error. For example:
begin ryan = Person.find(my_id) rescue ActiveResource::ResourceNotFound redirect_to :action => 'not_found' rescue ActiveResource::ResourceConflict, ActiveResource::ResourceInvalid redirect_to :action => 'new' end
When a GET is requested for a nested resource and you don’t provide the prefix_param an ActiveResource::MissingPrefixParam will be raised.
class Comment < ActiveResource::Base self.site = "http://someip.com/posts/:post_id/" end Comment.find(1) # => ActiveResource::MissingPrefixParam: post_id prefix_option is missing
Active Resource supports validations on resources and will return errors if any of these validations fail (e.g., “First name can not be blank” and so on). These types of errors are denoted in the response by a response code of 422 and an XML or JSON representation of the validation errors. The save operation will then fail (with a false return value) and the validation errors can be accessed on the resource in question.
ryan = Person.find(1) ryan.first # => '' ryan.save # => false # When # PUT http://api.people.com:3000/people/1.json # or # PUT http://api.people.com:3000/people/1.json # is requested with invalid values, the response is: # # Response (422): # <errors><error>First cannot be empty</error></errors> # or # {"errors":["First cannot be empty"]} # ryan.errors.invalid?(:first) # => true ryan.errors.full_messages # => ['First cannot be empty']
Learn more about Active Resource’s validation features in the ActiveResource::Validations documentation.
Active Resource relies on HTTP to access RESTful APIs and as such is inherently susceptible to slow or unresponsive servers. In such cases, your Active Resource method calls could timeout. You can control the amount of time before Active Resource times out with the timeout variable.
class Person < ActiveResource::Base self.site = "http://api.people.com:3000/" self.timeout = 5 end
This sets the timeout to 5 seconds. You can adjust the timeout to a value suitable for the RESTful API you are accessing. It is recommended to set this to a reasonably low value to allow your Active Resource clients (especially if you are using Active Resource in a Rails application) to fail-fast (see en.wikipedia.org/wiki/Fail-fast) rather than cause cascading failures that could incapacitate your server.
When a timeout occurs, an ActiveResource::TimeoutError is raised. You should rescue from ActiveResource::TimeoutError in your Active Resource method calls.
Internally, Active Resource relies on Ruby’s Net::HTTP library to make HTTP requests. Setting timeout sets the read_timeout of the internal Net::HTTP instance to the same value. The default read_timeout is 60 seconds on most Ruby implementations.
This is an alias for find(:all). You can pass in all the same arguments to this method as you can to find(:all)
# File lib/active_resource/base.rb, line 838 838: def all(*args) 839: find(:all, *args) 840: end
# File lib/active_resource/base.rb, line 471 471: def auth_type 472: if defined?(@auth_type) 473: @auth_type 474: end 475: end
# File lib/active_resource/base.rb, line 477 477: def auth_type=(auth_type) 478: @connection = nil 479: @auth_type = auth_type 480: end
Builds a new, unsaved record using the default values from the remote server so that it can be used with RESTful forms.
attributes - A hash that overrides the default values from the server.
Returns the new resource instance.
# File lib/active_resource/base.rb, line 716 716: def build(attributes = {}) 717: attrs = self.format.decode(connection.get("#{new_element_path}").body).merge(attributes) 718: self.new(attrs) 719: end
# File lib/active_resource/base.rb, line 574 574: def collection_name 575: @collection_name ||= ActiveSupport::Inflector.pluralize(element_name) 576: end
Gets the collection path for the REST resources. If the query_options parameter is omitted, Rails will split from the prefix_options.
prefix_options - A hash to add a prefix to the request for nested URLs (e.g., :account_id => 19 would yield a URL like /accounts/19/purchases.json).
query_options - A hash to add items to the query string for the request.
Post.collection_path # => /posts.json Comment.collection_path(:post_id => 5) # => /posts/5/comments.json Comment.collection_path(:post_id => 5, :active => 1) # => /posts/5/comments.json?active=1 Comment.collection_path({:post_id => 5}, {:active => 1}) # => /posts/5/comments.json?active=1
# File lib/active_resource/base.rb, line 700 700: def collection_path(prefix_options = {}, query_options = nil) 701: check_prefix_options(prefix_options) 702: prefix_options, query_options = split_options(prefix_options) if query_options.nil? 703: "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}" 704: end
An instance of ActiveResource::Connection that is the base connection to the remote service. The refresh parameter toggles whether or not the connection is refreshed at every request or not (defaults to false).
# File lib/active_resource/base.rb, line 547 547: def connection(refresh = false) 548: if defined?(@connection) || superclass == Object 549: @connection = Connection.new(site, format) if refresh || @connection.nil? 550: @connection.proxy = proxy if proxy 551: @connection.user = user if user 552: @connection.password = password if password 553: @connection.auth_type = auth_type if auth_type 554: @connection.timeout = timeout if timeout 555: @connection.ssl_options = ssl_options if ssl_options 556: @connection 557: else 558: superclass.connection 559: end 560: end
Creates a new resource instance and makes a request to the remote service that it be saved, making it equivalent to the following simultaneous calls:
ryan = Person.new(:first => 'ryan') ryan.save
Returns the newly created resource. If a failure has occurred an exception will be raised (see save). If the resource is invalid and has not been saved then valid? will return false, while new? will still return true.
Person.create(:name => 'Jeremy', :email => 'myname@nospam.com', :enabled => true) my_person = Person.find(:first) my_person.email # => myname@nospam.com dhh = Person.create(:name => 'David', :email => 'dhh@nospam.com', :enabled => true) dhh.valid? # => true dhh.new? # => false # We'll assume that there's a validation that requires the name attribute that_guy = Person.create(:name => '', :email => 'thatguy@nospam.com', :enabled => true) that_guy.valid? # => false that_guy.new? # => true
# File lib/active_resource/base.rb, line 745 745: def create(attributes = {}) 746: self.new(attributes).tap { |resource| resource.save } 747: end
Deletes the resources with the ID in the id parameter.
All options specify prefix and query parameters.
Event.delete(2) # sends DELETE /events/2 Event.create(:name => 'Free Concert', :location => 'Community Center') my_event = Event.find(:first) # let's assume this is event with ID 7 Event.delete(my_event.id) # sends DELETE /events/7 # Let's assume a request to events/5/cancel.json Event.delete(params[:id]) # sends DELETE /events/5
# File lib/active_resource/base.rb, line 857 857: def delete(id, options = {}) 858: connection.delete(element_path(id, options)) 859: end
# File lib/active_resource/base.rb, line 568 568: def element_name 569: @element_name ||= model_name.element 570: end
Gets the element path for the given ID in id. If the query_options parameter is omitted, Rails will split from the prefix options.
prefix_options - A hash to add a prefix to the request for nested URLs (e.g., :account_id => 19
would yield a URL like <tt>/accounts/19/purchases.json</tt>).
query_options - A hash to add items to the query string for the request.
Post.element_path(1) # => /posts/1.json class Comment < ActiveResource::Base self.site = "http://37s.sunrise.i/posts/:post_id/" end Comment.element_path(1, :post_id => 5) # => /posts/5/comments/1.json Comment.element_path(1, :post_id => 5, :active => 1) # => /posts/5/comments/1.json?active=1 Comment.element_path(1, {:post_id => 5}, {:active => 1}) # => /posts/5/comments/1.json?active=1
# File lib/active_resource/base.rb, line 652 652: def element_path(id, prefix_options = {}, query_options = nil) 653: check_prefix_options(prefix_options) 654: 655: prefix_options, query_options = split_options(prefix_options) if query_options.nil? 656: "#{prefix(prefix_options)}#{collection_name}/#{URI.parser.escape id.to_s}.#{format.extension}#{query_string(query_options)}" 657: end
Asserts the existence of a resource, returning true if the resource is found.
Note.create(:title => 'Hello, world.', :body => 'Nothing more for now...') Note.exists?(1) # => true Note.exists(1349) # => false
# File lib/active_resource/base.rb, line 868 868: def exists?(id, options = {}) 869: if id 870: prefix_options, query_options = split_options(options[:params]) 871: path = element_path(id, prefix_options, query_options) 872: response = connection.head(path, headers) 873: response.code.to_i == 200 874: end 875: # id && !find_single(id, options).nil? 876: rescue ActiveResource::ResourceNotFound, ActiveResource::ResourceGone 877: false 878: end
Core method for finding resources. Used similarly to Active Record’s find method.
The first argument is considered to be the scope of the query. That is, how many resources are returned from the request. It can be one of the following.
:one - Returns a single resource.
:first - Returns the first resource found.
:last - Returns the last resource found.
:all - Returns every resource that matches the request.
:from - Sets the path or custom method that resources will be fetched from.
:params - Sets query and prefix (nested URL) parameters.
Person.find(1) # => GET /people/1.json Person.find(:all) # => GET /people.json Person.find(:all, :params => { :title => "CEO" }) # => GET /people.json?title=CEO Person.find(:first, :from => :managers) # => GET /people/managers.json Person.find(:last, :from => :managers) # => GET /people/managers.json Person.find(:all, :from => "/companies/1/people.json") # => GET /companies/1/people.json Person.find(:one, :from => :leader) # => GET /people/leader.json Person.find(:all, :from => :developers, :params => { :language => 'ruby' }) # => GET /people/developers.json?language=ruby Person.find(:one, :from => "/companies/1/manager.json") # => GET /companies/1/manager.json StreetAddress.find(1, :params => { :person_id => 1 }) # => GET /people/1/street_addresses/1.json
A failure to find the requested object raises a ResourceNotFound exception if the find was called with an id. With any other scope, find returns nil when no data is returned. Person.find(1) # => raises ResourceNotFound Person.find(:all) Person.find(:first) Person.find(:last) # => nil
# File lib/active_resource/base.rb, line 808 808: def find(*arguments) 809: scope = arguments.slice!(0) 810: options = arguments.slice!(0) || {} 811: 812: case scope 813: when :all then find_every(options) 814: when :first then find_every(options).first 815: when :last then find_every(options).last 816: when :one then find_one(options) 817: else find_single(scope, options) 818: end 819: end
A convenience wrapper for find(:first, *args). You can pass in all the same arguments to this method as you can to find(:first).
# File lib/active_resource/base.rb, line 825 825: def first(*args) 826: find(:first, *args) 827: end
Returns the current format, default is ActiveResource::Formats::JsonFormat.
# File lib/active_resource/base.rb, line 500 500: def format 501: self._format || ActiveResource::Formats::JsonFormat 502: end
Sets the format that attributes are sent and received in from a mime type reference:
Person.format = :json Person.find(1) # => GET /people/1.json Person.format = ActiveResource::Formats::XmlFormat Person.find(1) # => GET /people/1.xml
Default format is :json.
# File lib/active_resource/base.rb, line 491 491: def format=(mime_type_reference_or_format) 492: format = mime_type_reference_or_format.is_a?(Symbol) ? 493: ActiveResource::Formats[mime_type_reference_or_format] : mime_type_reference_or_format 494: 495: self._format = format 496: connection.format = format if site 497: end
# File lib/active_resource/base.rb, line 562 562: def headers 563: @headers ||= {} 564: end
Returns the list of known attributes for this resource, gathered from the
provided schema Attributes that are known will cause your resource
to return ‘true’ when respond_to? is called on them. A
known attribute will return nil if not set (rather than
# File lib/active_resource/base.rb, line 381 381: def known_attributes 382: @known_attributes ||= [] 383: end
A convenience wrapper for find(:last, *args). You can pass in all the same arguments to this method as you can to find(:last).
# File lib/active_resource/base.rb, line 832 832: def last(*args) 833: find(:last, *args) 834: end
The logger for diagnosing and tracing Active Resource calls.
# File lib/active_resource/base.rb, line 262 262: cattr_accessor :logger
Constructor method for new resources; the optional attributes parameter takes a hash of attributes for the new resource.
my_course = Course.new my_course.name = "Western Civilization" my_course.lecturer = "Don Trotter" my_course.save my_other_course = Course.new(:name => "Philosophy: Reason and Being", :lecturer => "Ralph Cling") my_other_course.save
# File lib/active_resource/base.rb, line 1002 1002: def initialize(attributes = {}, persisted = false) 1003: @attributes = {}.with_indifferent_access 1004: @prefix_options = {} 1005: @persisted = persisted 1006: load(attributes) 1007: end
Gets the new element path for REST resources.
prefix_options - A hash to add a prefix to the request for nested URLs (e.g., :account_id => 19 would yield a URL like /accounts/19/purchases/new.json).
Post.new_element_path # => /posts/new.json class Comment < ActiveResource::Base self.site = "http://37s.sunrise.i/posts/:post_id/" end Comment.collection_path(:post_id => 5) # => /posts/5/comments/new.json
# File lib/active_resource/base.rb, line 675 675: def new_element_path(prefix_options = {}) 676: "#{prefix(prefix_options)}#{collection_name}/new.#{format.extension}" 677: end
Gets the password for REST HTTP authentication.
# File lib/active_resource/base.rb, line 456 456: def password 457: # Not using superclass_delegating_reader. See +site+ for explanation 458: if defined?(@password) 459: @password 460: elsif superclass != Object && superclass.password 461: superclass.password.dup.freeze 462: end 463: end
Sets the password for REST HTTP authentication.
# File lib/active_resource/base.rb, line 466 466: def password=(password) 467: @connection = nil 468: @password = password 469: end
Gets the prefix for a resource’s nested URL (e.g., prefix/collectionname/1.json) This method is regenerated at runtime based on what the prefix is set to.
# File lib/active_resource/base.rb, line 586 586: def prefix(options={}) 587: default = site.path 588: default << '/' unless default[1..1] == '/' 589: # generate the actual method based on the current site path 590: self.prefix = default 591: prefix(options) 592: end
Sets the prefix for a resource’s nested URL (e.g., prefix/collectionname/1.json). Default value is site.path.
# File lib/active_resource/base.rb, line 603 603: def prefix=(value = '/') 604: # Replace :placeholders with '#{embedded options[:lookups]}' 605: prefix_call = value.gsub(/:\w+/) { |key| "\#{URI.parser.escape options[#{key}].to_s}" } 606: 607: # Clear prefix parameters in case they have been cached 608: @prefix_parameters = nil 609: 610: silence_warnings do 611: # Redefine the new methods. 612: instance_eval def prefix_source() "#{value}" end def prefix(options={}) "#{prefix_call}" end, __FILE__, __LINE__ + 1 613: end 614: rescue Exception => e 615: logger.error "Couldn't set prefix: #{e}\n #{code}" if logger 616: raise 617: end
An attribute reader for the source string for the resource path prefix. This method is regenerated at runtime based on what the prefix is set to.
# File lib/active_resource/base.rb, line 596 596: def prefix_source 597: prefix # generate #prefix and #prefix_source methods first 598: prefix_source 599: end
# File lib/active_resource/base.rb, line 580 580: def primary_key 581: @primary_key ||= 'id' 582: end
Gets the proxy variable if a proxy is required
# File lib/active_resource/base.rb, line 424 424: def proxy 425: # Not using superclass_delegating_reader. See +site+ for explanation 426: if defined?(@proxy) 427: @proxy 428: elsif superclass != Object && superclass.proxy 429: superclass.proxy.dup.freeze 430: end 431: end
Sets the URI of the http proxy to the value in the proxy argument.
# File lib/active_resource/base.rb, line 434 434: def proxy=(proxy) 435: @connection = nil 436: @proxy = proxy.nil? ? nil : create_proxy_uri_from(proxy) 437: end
Creates a schema for this resource - setting the attributes that are known prior to fetching an instance from the remote system.
The schema helps define the set of known_attributes of the current resource.
There is no need to specify a schema for your Active Resource. If you do not, the known_attributes will be guessed from the instance attributes returned when an instance is fetched from the remote system.
example: class Person < ActiveResource::Base
schema do # define each attribute separately attribute 'name', :string # or use the convenience methods and pass >=1 attribute names string 'eye_color', 'hair_color' integer 'age' float 'height', 'weight' # unsupported types should be left as strings # overload the accessor methods if you need to convert them attribute 'created_at', 'string' end
end
p = Person.new p.respond_to? :name # => true p.respond_to? :age # => true p.name # => nil p.age # => nil
j = Person.find_by_name(‘John’) #
p.num_children # => NoMethodError
Attribute-types must be one of:
string, integer, float
Note: at present the attribute-type doesn’t do anything, but stay tuned... Shortly it will also cast the value of the returned attribute. ie: j.age # => 34 # cast to an integer j.weight # => ‘65’ # still a string!
# File lib/active_resource/base.rb, line 320 320: def schema(&block) 321: if block_given? 322: schema_definition = Schema.new 323: schema_definition.instance_eval(&block) 324: 325: # skip out if we didn't define anything 326: return unless schema_definition.attrs.present? 327: 328: @schema ||= {}.with_indifferent_access 329: @known_attributes ||= [] 330: 331: schema_definition.attrs.each do |k,v| 332: @schema[k] = v 333: @known_attributes << k 334: end 335: 336: schema 337: else 338: @schema ||= nil 339: end 340: end
Alternative, direct way to specify a schema for this Resource. schema is more flexible, but this is quick for a very simple schema.
Pass the schema as a hash with the keys being the attribute-names and the value being one of the accepted attribute types (as defined in schema)
example:
class Person < ActiveResource::Base
schema = {'name' => :string, 'age' => :integer }
end
The keys/values can be strings or symbols. They will be converted to strings.
# File lib/active_resource/base.rb, line 359 359: def schema=(the_schema) 360: unless the_schema.present? 361: # purposefully nulling out the schema 362: @schema = nil 363: @known_attributes = [] 364: return 365: end 366: 367: raise ArgumentError, "Expected a hash" unless the_schema.kind_of? Hash 368: 369: schema do 370: the_schema.each {|k,v| attribute(k,v) } 371: end 372: end
Gets the URI of the REST resources to map for this class. The site variable is required for Active Resource’s mapping to work.
# File lib/active_resource/base.rb, line 387 387: def site 388: # Not using superclass_delegating_reader because don't want subclasses to modify superclass instance 389: # 390: # With superclass_delegating_reader 391: # 392: # Parent.site = 'http://anonymous@test.com' 393: # Subclass.site # => 'http://anonymous@test.com' 394: # Subclass.site.user = 'david' 395: # Parent.site # => 'http://david@test.com' 396: # 397: # Without superclass_delegating_reader (expected behavior) 398: # 399: # Parent.site = 'http://anonymous@test.com' 400: # Subclass.site # => 'http://anonymous@test.com' 401: # Subclass.site.user = 'david' # => TypeError: can't modify frozen object 402: # 403: if defined?(@site) 404: @site 405: elsif superclass != Object && superclass.site 406: superclass.site.dup.freeze 407: end 408: end
Sets the URI of the REST resources to map for this class to the value in the site argument. The site variable is required for Active Resource’s mapping to work.
# File lib/active_resource/base.rb, line 412 412: def site=(site) 413: @connection = nil 414: if site.nil? 415: @site = nil 416: else 417: @site = create_site_uri_from(site) 418: @user = URI.parser.unescape(@site.user) if @site.user 419: @password = URI.parser.unescape(@site.password) if @site.password 420: end 421: end
Returns the SSL options hash.
# File lib/active_resource/base.rb, line 536 536: def ssl_options 537: if defined?(@ssl_options) 538: @ssl_options 539: elsif superclass != Object && superclass.ssl_options 540: superclass.ssl_options 541: end 542: end
Options that will get applied to an SSL connection.
:key - An OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
:cert - An OpenSSL::X509::Certificate object as client certificate
:ca_file - Path to a CA certification file in PEM format. The file can contain several CA certificates.
:ca_path - Path of a CA certification directory containing certifications in PEM format.
:verify_mode - Flags for server the certification verification at beginning of SSL/TLS session. (OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER is acceptable)
:verify_callback - The verify callback for the server certification verification.
:verify_depth - The maximum depth for the certificate chain verification.
:cert_store - OpenSSL::X509::Store to verify peer certificate.
:ssl_timeout -The SSL timeout in seconds.
# File lib/active_resource/base.rb, line 530 530: def ssl_options=(opts={}) 531: @connection = nil 532: @ssl_options = opts 533: end
Gets the number of seconds after which requests to the REST API should time out.
# File lib/active_resource/base.rb, line 511 511: def timeout 512: if defined?(@timeout) 513: @timeout 514: elsif superclass != Object && superclass.timeout 515: superclass.timeout 516: end 517: end
Sets the number of seconds after which requests to the REST API should time out.
# File lib/active_resource/base.rb, line 505 505: def timeout=(timeout) 506: @connection = nil 507: @timeout = timeout 508: end
Gets the user for REST HTTP authentication.
# File lib/active_resource/base.rb, line 440 440: def user 441: # Not using superclass_delegating_reader. See +site+ for explanation 442: if defined?(@user) 443: @user 444: elsif superclass != Object && superclass.user 445: superclass.user.dup.freeze 446: end 447: end
# File lib/active_resource/base.rb, line 882 882: def check_prefix_options(prefix_options) 883: p_options = HashWithIndifferentAccess.new(prefix_options) 884: prefix_parameters.each do |p| 885: raise(MissingPrefixParam, "#{p} prefix_option is missing") if p_options[p].blank? 886: end 887: end
Accepts a URI and creates the proxy URI from that.
# File lib/active_resource/base.rb, line 945 945: def create_proxy_uri_from(proxy) 946: proxy.is_a?(URI) ? proxy.dup : URI.parser.parse(proxy) 947: end
Accepts a URI and creates the site URI from that.
# File lib/active_resource/base.rb, line 940 940: def create_site_uri_from(site) 941: site.is_a?(URI) ? site.dup : URI.parser.parse(site) 942: end
Find every resource
# File lib/active_resource/base.rb, line 890 890: def find_every(options) 891: begin 892: case from = options[:from] 893: when Symbol 894: instantiate_collection(get(from, options[:params])) 895: when String 896: path = "#{from}#{query_string(options[:params])}" 897: instantiate_collection(format.decode(connection.get(path, headers).body) || []) 898: else 899: prefix_options, query_options = split_options(options[:params]) 900: path = collection_path(prefix_options, query_options) 901: instantiate_collection( (format.decode(connection.get(path, headers).body) || []), prefix_options ) 902: end 903: rescue ActiveResource::ResourceNotFound 904: # Swallowing ResourceNotFound exceptions and return nil - as per 905: # ActiveRecord. 906: nil 907: end 908: end
Find a single resource from a one-off URL
# File lib/active_resource/base.rb, line 911 911: def find_one(options) 912: case from = options[:from] 913: when Symbol 914: instantiate_record(get(from, options[:params])) 915: when String 916: path = "#{from}#{query_string(options[:params])}" 917: instantiate_record(format.decode(connection.get(path, headers).body)) 918: end 919: end
Find a single resource from the default URL
# File lib/active_resource/base.rb, line 922 922: def find_single(scope, options) 923: prefix_options, query_options = split_options(options[:params]) 924: path = element_path(scope, prefix_options, query_options) 925: instantiate_record(format.decode(connection.get(path, headers).body), prefix_options) 926: end
# File lib/active_resource/base.rb, line 928 928: def instantiate_collection(collection, prefix_options = {}) 929: collection.collect! { |record| instantiate_record(record, prefix_options) } 930: end
# File lib/active_resource/base.rb, line 932 932: def instantiate_record(record, prefix_options = {}) 933: new(record, true).tap do |resource| 934: resource.prefix_options = prefix_options 935: end 936: end
contains a set of the current prefix parameters.
# File lib/active_resource/base.rb, line 950 950: def prefix_parameters 951: @prefix_parameters ||= prefix_source.scan(/:\w+/).map { |key| key[1..1].to_sym }.to_set 952: end
Builds the query string for the request.
# File lib/active_resource/base.rb, line 955 955: def query_string(options) 956: "?#{options.to_query}" unless options.nil? || options.empty? 957: end
split an option hash into two hashes, one containing the prefix options, and the other containing the leftovers.
# File lib/active_resource/base.rb, line 961 961: def split_options(options = {}) 962: prefix_options, query_options = {}, {} 963: 964: (options || {}).each do |key, value| 965: next if key.blank? || !key.respond_to?(:to_sym) 966: (prefix_parameters.include?(key.to_sym) ? prefix_options : query_options)[key.to_sym] = value 967: end 968: 969: [ prefix_options, query_options ] 970: end
Test for equality. Resource are equal if and only if other is the same object or is an instance of the same class, is not new?, and has the same id.
ryan = Person.create(:name => 'Ryan') jamie = Person.create(:name => 'Jamie') ryan == jamie # => false (Different name attribute and id) ryan_again = Person.new(:name => 'Ryan') ryan == ryan_again # => false (ryan_again is new?) ryans_clone = Person.create(:name => 'Ryan') ryan == ryans_clone # => false (Different id attributes) ryans_twin = Person.find(ryan.id) ryan == ryans_twin # => true
# File lib/active_resource/base.rb, line 1107 1107: def ==(other) 1108: other.equal?(self) || (other.instance_of?(self.class) && other.id == id && other.prefix_options == prefix_options) 1109: end
Returns a clone of the resource that hasn’t been assigned an id yet and is treated as a new resource.
ryan = Person.find(1) not_ryan = ryan.clone not_ryan.new? # => true
Any active resource member attributes will NOT be cloned, though all other attributes are. This is to prevent the conflict between any prefix_options that refer to the original parent resource and the newly cloned parent resource that does not exist.
ryan = Person.find(1) ryan.address = StreetAddress.find(1, :person_id => ryan.id) ryan.hash = {:not => "an ARes instance"} not_ryan = ryan.clone not_ryan.new? # => true not_ryan.address # => NoMethodError not_ryan.hash # => {:not => "an ARes instance"}
# File lib/active_resource/base.rb, line 1029 1029: def clone 1030: # Clone all attributes except the pk and any nested ARes 1031: cloned = Hash[attributes.reject {|k,v| k == self.class.primary_key || v.is_a?(ActiveResource::Base)}.map { |k, v| [k, v.clone] }] 1032: # Form the new resource - bypass initialize of resource with 'new' as that will call 'load' which 1033: # attempts to convert hashes into member objects and arrays into collections of objects. We want 1034: # the raw objects to be cloned so we bypass load by directly setting the attributes hash. 1035: resource = self.class.new({}) 1036: resource.prefix_options = self.prefix_options 1037: resource.send :instance_variable_set, '@attributes', cloned 1038: resource 1039: end
Deletes the resource from the remote service.
my_id = 3 my_person = Person.find(my_id) my_person.destroy Person.find(my_id) # 404 (Resource Not Found) new_person = Person.create(:name => 'James') new_id = new_person.id # => 7 new_person.destroy Person.find(new_id) # 404 (Resource Not Found)
# File lib/active_resource/base.rb, line 1187 1187: def destroy 1188: connection.delete(element_path, self.class.headers) 1189: end
Duplicates the current resource without saving it.
my_invoice = Invoice.create(:customer => 'That Company') next_invoice = my_invoice.dup next_invoice.new? # => true next_invoice.save next_invoice == my_invoice # => false (different id attributes) my_invoice.customer # => That Company next_invoice.customer # => That Company
# File lib/active_resource/base.rb, line 1134 1134: def dup 1135: self.class.new.tap do |resource| 1136: resource.attributes = @attributes 1137: resource.prefix_options = @prefix_options 1138: end 1139: end
Returns the serialized string representation of the resource in the configured serialization format specified in ActiveResource::Base.format. The options applicable depend on the configured encoding format.
# File lib/active_resource/base.rb, line 1214 1214: def encode(options={}) 1215: send("to_#{self.class.format.extension}", options) 1216: end
Tests for equality (delegates to ==).
# File lib/active_resource/base.rb, line 1112 1112: def eql?(other) 1113: self == other 1114: end
Evaluates to true if this resource is not new? and is found on the remote service. Using this method, you can check for resources that may have been deleted between the object’s instantiation and actions on it.
Person.create(:name => 'Theodore Roosevelt') that_guy = Person.find(:first) that_guy.exists? # => true that_lady = Person.new(:name => 'Paul Bean') that_lady.exists? # => false guys_id = that_guy.id Person.delete(guys_id) that_guy.exists? # => false
# File lib/active_resource/base.rb, line 1207 1207: def exists? 1208: !new? && self.class.exists?(to_param, :params => prefix_options) 1209: end
Delegates to id in order to allow two resources of the same type and id to work with something like:
[(a = Person.find 1), (b = Person.find 2)] & [(c = Person.find 1), (d = Person.find 4)] # => [a]
# File lib/active_resource/base.rb, line 1118 1118: def hash 1119: id.hash 1120: end
Gets the id attribute of the resource.
# File lib/active_resource/base.rb, line 1076 1076: def id 1077: attributes[self.class.primary_key] 1078: end
Sets the id attribute of the resource.
# File lib/active_resource/base.rb, line 1081 1081: def id=(id) 1082: attributes[self.class.primary_key] = id 1083: end
This is a list of known attributes for this resource. Either gathered from the provided schema, or from the attributes set on this instance after it has been fetched from the remote system.
# File lib/active_resource/base.rb, line 986 986: def known_attributes 987: self.class.known_attributes + self.attributes.keys.map(&:to_s) 988: end
A method to manually load attributes from a hash. Recursively loads collections of resources. This method is called in initialize and create when a hash of attributes is provided.
my_attrs = {:name => 'J&J Textiles', :industry => 'Cloth and textiles'} my_attrs = {:name => 'Marty', :colors => ["red", "green", "blue"]} the_supplier = Supplier.find(:first) the_supplier.name # => 'J&M Textiles' the_supplier.load(my_attrs) the_supplier.name('J&J Textiles') # These two calls are the same as Supplier.new(my_attrs) my_supplier = Supplier.new my_supplier.load(my_attrs) # These three calls are the same as Supplier.create(my_attrs) your_supplier = Supplier.new your_supplier.load(my_attrs) your_supplier.save
# File lib/active_resource/base.rb, line 1254 1254: def load(attributes, remove_root = false) 1255: raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash) 1256: @prefix_options, attributes = split_options(attributes) 1257: 1258: if attributes.keys.size == 1 1259: remove_root = self.class.element_name == attributes.keys.first.to_s 1260: end 1261: 1262: attributes = Formats.remove_root(attributes) if remove_root 1263: 1264: attributes.each do |key, value| 1265: @attributes[key.to_s] = 1266: case value 1267: when Array 1268: resource = nil 1269: value.map do |attrs| 1270: if attrs.is_a?(Hash) 1271: resource ||= find_or_create_resource_for_collection(key) 1272: resource.new(attrs) 1273: else 1274: attrs.duplicable? ? attrs.dup : attrs 1275: end 1276: end 1277: when Hash 1278: resource = find_or_create_resource_for(key) 1279: resource.new(value) 1280: else 1281: value.duplicable? ? value.dup : value 1282: end 1283: end 1284: self 1285: end
Returns true if this object hasn’t yet been saved, otherwise, returns false.
not_new = Computer.create(:brand => 'Apple', :make => 'MacBook', :vendor => 'MacMall') not_new.new? # => false is_new = Computer.new(:brand => 'IBM', :make => 'Thinkpad', :vendor => 'IBM') is_new.new? # => true is_new.save is_new.new? # => false
# File lib/active_resource/base.rb, line 1054 1054: def new? 1055: !persisted? 1056: end
Returns true if this object has been saved, otherwise returns false.
persisted = Computer.create(:brand => 'Apple', :make => 'MacBook', :vendor => 'MacMall') persisted.persisted? # => true not_persisted = Computer.new(:brand => 'IBM', :make => 'Thinkpad', :vendor => 'IBM') not_persisted.persisted? # => false not_persisted.save not_persisted.persisted? # => true
# File lib/active_resource/base.rb, line 1071 1071: def persisted? 1072: @persisted 1073: end
A method to reload the attributes of this object from the remote web service.
my_branch = Branch.find(:first) my_branch.name # => "Wislon Raod" # Another client fixes the typo... my_branch.name # => "Wislon Raod" my_branch.reload my_branch.name # => "Wilson Road"
# File lib/active_resource/base.rb, line 1229 1229: def reload 1230: self.load(self.class.find(to_param, :params => @prefix_options).attributes) 1231: end
A method to determine if an object responds to a message (e.g., a method call). In Active Resource, a Person object with a name attribute can answer true to my_person.respond_to?(:name), my_person.respond_to?(:name=), and my_person.respond_to?(:name?).
# File lib/active_resource/base.rb, line 1323 1323: def respond_to?(method, include_priv = false) 1324: method_name = method.to_s 1325: if attributes.nil? 1326: super 1327: elsif known_attributes.include?(method_name) 1328: true 1329: elsif method_name =~ /(?:=|\?)$/ && attributes.include?($`) 1330: true 1331: else 1332: # super must be called at the end of the method, because the inherited respond_to? 1333: # would return true for generated readers, even if the attribute wasn't present 1334: super 1335: end 1336: end
For checking respond_to? without searching the attributes (which is faster).
Saves (POST) or updates (PUT) a resource. Delegates to create if the object is new, update if it exists. If the response to the save includes a body, it will be assumed that this body is Json for the final object as it looked after the save (which would include attributes like created_at that weren’t part of the original submit).
my_company = Company.new(:name => 'RoleModel Software', :owner => 'Ken Auer', :size => 2) my_company.new? # => true my_company.save # sends POST /companies/ (create) my_company.new? # => false my_company.size = 10 my_company.save # sends PUT /companies/1 (update)
# File lib/active_resource/base.rb, line 1154 1154: def save 1155: new? ? create : update 1156: end
Saves the resource.
If the resource is new, it is created via POST, otherwise the existing resource is updated via PUT.
With save! validations always run. If any of them fail ActiveResource::ResourceInvalid gets raised, and nothing is POSTed to the remote system. See ActiveResource::Validations for more information.
There’s a series of callbacks associated with save!. If any of the before_* callbacks return false the action is cancelled and save! raises ActiveResource::ResourceInvalid.
# File lib/active_resource/base.rb, line 1171 1171: def save! 1172: save || raise(ResourceInvalid.new(self)) 1173: end
If no schema has been defined for the class (see ActiveResource::schema=), the default automatic schema is generated from the current instance’s attributes
# File lib/active_resource/base.rb, line 979 979: def schema 980: self.class.schema || self.attributes 981: end
# File lib/active_resource/base.rb, line 1338 1338: def to_json(options={}) 1339: super({ :root => self.class.element_name }.merge(options)) 1340: end
# File lib/active_resource/base.rb, line 1342 1342: def to_xml(options={}) 1343: super({ :root => self.class.element_name }.merge(options)) 1344: end
Updates a single attribute and then saves the object.
Note: Unlike ActiveRecord::Base.update_attribute, this method is subject to normal validation routines as an update sends the whole body of the resource in the request. (See Validations).
As such, this method is equivalent to calling update_attributes with a single attribute/value pair.
If the saving fails because of a connection or remote service error, an exception will be raised. If saving fails because the resource is invalid then false will be returned.
# File lib/active_resource/base.rb, line 1298 1298: def update_attribute(name, value) 1299: self.send("#{name}=".to_sym, value) 1300: self.save 1301: end
Updates this resource with all the attributes from the passed-in Hash and requests that the record be saved.
If the saving fails because of a connection or remote service error, an exception will be raised. If saving fails because the resource is invalid then false will be returned.
Note: Though this request can be made with a partial set of the resource’s attributes, the full body of the request will still be sent in the save request to the remote service.
# File lib/active_resource/base.rb, line 1313 1313: def update_attributes(attributes) 1314: load(attributes, false) && save 1315: end
# File lib/active_resource/base.rb, line 1388 1388: def collection_path(options = nil) 1389: self.class.collection_path(options || prefix_options) 1390: end
# File lib/active_resource/base.rb, line 1347 1347: def connection(refresh = false) 1348: self.class.connection(refresh) 1349: end
Create (i.e., save to the remote service) the new resource.
# File lib/active_resource/base.rb, line 1359 1359: def create 1360: connection.post(collection_path, encode, self.class.headers).tap do |response| 1361: self.id = id_from_response(response) 1362: load_attributes_from_response(response) 1363: end 1364: end
# File lib/active_resource/base.rb, line 1380 1380: def element_path(options = nil) 1381: self.class.element_path(to_param, options || prefix_options) 1382: end
Takes a response from a typical create post and pulls the ID out
# File lib/active_resource/base.rb, line 1376 1376: def id_from_response(response) 1377: response['Location'][/\/([^\/]*?)(\.\w+)?$/, 1] if response['Location'] 1378: end
# File lib/active_resource/base.rb, line 1366 1366: def load_attributes_from_response(response) 1367: if (response_code_allows_body?(response.code) && 1368: (response['Content-Length'].nil? || response['Content-Length'] != "0") && 1369: !response.body.nil? && response.body.strip.size > 0) 1370: load(self.class.format.decode(response.body), true) 1371: @persisted = true 1372: end 1373: end
# File lib/active_resource/base.rb, line 1384 1384: def new_element_path 1385: self.class.new_element_path(prefix_options) 1386: end
Update the resource on the remote service.
# File lib/active_resource/base.rb, line 1352 1352: def update 1353: connection.put(element_path(prefix_options), encode, self.class.headers).tap do |response| 1354: load_attributes_from_response(response) 1355: end 1356: end
Create and return a class definition for a resource inside the current resource
# File lib/active_resource/base.rb, line 1445 1445: def create_resource_for(resource_name) 1446: resource = self.class.const_set(resource_name, Class.new(ActiveResource::Base)) 1447: resource.prefix = self.class.prefix 1448: resource.site = self.class.site 1449: resource 1450: end
Tries to find a resource for a given name; if it fails, then the resource is created
# File lib/active_resource/base.rb, line 1424 1424: def find_or_create_resource_for(name) 1425: resource_name = name.to_s.camelize 1426: 1427: const_args = RUBY_VERSION < "1.9" ? [resource_name] : [resource_name, false] 1428: if self.class.const_defined?(*const_args) 1429: self.class.const_get(*const_args) 1430: else 1431: ancestors = self.class.name.split("::") 1432: if ancestors.size > 1 1433: find_or_create_resource_in_modules(resource_name, ancestors) 1434: else 1435: if Object.const_defined?(*const_args) 1436: Object.const_get(*const_args) 1437: else 1438: create_resource_for(resource_name) 1439: end 1440: end 1441: end 1442: end
Tries to find a resource for a given collection name; if it fails, then the resource is created
# File lib/active_resource/base.rb, line 1404 1404: def find_or_create_resource_for_collection(name) 1405: find_or_create_resource_for(ActiveSupport::Inflector.singularize(name.to_s)) 1406: end
Tries to find a resource in a non empty list of nested modules if it fails, then the resource is created
# File lib/active_resource/base.rb, line 1410 1410: def find_or_create_resource_in_modules(resource_name, module_names) 1411: receiver = Object 1412: namespaces = module_names[0, module_names.size-1].map do |module_name| 1413: receiver = receiver.const_get(module_name) 1414: end 1415: const_args = RUBY_VERSION < "1.9" ? [resource_name] : [resource_name, false] 1416: if namespace = namespaces.reverse.detect { |ns| ns.const_defined?(*const_args) } 1417: namespace.const_get(*const_args) 1418: else 1419: create_resource_for(resource_name) 1420: end 1421: end
# File lib/active_resource/base.rb, line 1394 1394: def read_attribute_for_serialization(n) 1395: attributes[n] 1396: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.