Class: ActiveResource::Base
- Inherits:
-
Object
- Object
- ActiveResource::Base
- Extended by:
- ActiveModel::Naming, Associations, ThreadsafeAttributes
- Includes:
- ActiveModel::Conversion, ActiveModel::Serializers::JSON, ActiveModel::Serializers::Xml, Callbacks, CustomMethods, Reflection, Validations
- Defined in:
- lib/active_resource/base.rb,
lib/active_resource/base.rb
Overview
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.
Automated mapping
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 = "https://api.people.com"
end
Now the Person class is mapped to RESTful resources located at https://api.people.com/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 = "https://api.people.com"
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 = "https://api.people.com"
self.proxy = "https://user:[email protected]:8080"
end
Life cycle methods
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.
Custom REST methods
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.
Validations
You can validate resources client side by overriding validation methods in the base class.
class Person < ActiveResource::Base
self.site = "https://api.people.com"
protected
def validate
errors.add("last", "has invalid characters") unless last =~ /[a-zA-Z]*/
end
end
See the ActiveResource::Validations documentation for more information.
Authentication
Many REST APIs require authentication. The HTTP spec describes two ways to make requests with a username and password (see RFC 2617).
Basic authentication simply sends a username and password along with HTTP requests. These sensitive credentials are sent unencrypted, visible to any onlooker, so this scheme should only be used with SSL.
Digest authentication sends a cryptographic hash of the username, password, HTTP method, URI, and a single-use secret key provided by the server. Sensitive credentials aren’t visible to onlookers, so digest authentication doesn’t require SSL. However, this doesn’t mean the connection is secure! Just the username and password.
Another common way to authenticate requests is via bearer tokens, a scheme originally created as part of the OAuth 2.0 protocol (see RFC 6750).
Bearer authentication sends a token, that can maybe only be a short string of hexadecimal characters or even a JWT Token. Similarly to the Basic authentication, this scheme should only be used with SSL.
(You really, really want to use SSL. There’s little reason not to.)
Picking an authentication scheme
Basic authentication is the default. To switch to digest or bearer token authentication, set auth_type
to :digest
or :bearer
:
class Person < ActiveResource::Base
self.auth_type = :digest
end
Setting the username and password
Set user
and password
on the class, or include them in the site
URL.
class Person < ActiveResource::Base
# Set user and password directly:
self.user = "ryan"
self.password = "password"
# Or include them in the site:
self.site = "https://ryan:[email protected]"
end
Setting the bearer token
Set bearer_token
on the class:
class Person < ActiveResource::Base
# Set bearer token directly:
self.auth_type = :bearer
self.bearer_token = "my-bearer-token"
end
Certificate Authentication
You can also authenticate using an X509 certificate. See ssl_options=
for all options.
class Person < ActiveResource::Base
self.site = "https://secure.api.people.com/"
File.open(pem_file_path, 'rb') do |pem_file|
self. = {
cert: OpenSSL::X509::Certificate.new(pem_file),
key: OpenSSL::PKey::RSA.new(pem_file),
ca_path: "/path/to/OpenSSL/formatted/CA_Certs",
verify_mode: OpenSSL::SSL::VERIFY_PEER }
end
end
Errors & Validation
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.
Resource errors
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 https://api.people.com/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
-
412 - ActiveResource::PreconditionFailed
-
422 - ActiveResource::ResourceInvalid (rescued by save as validation errors)
-
429 - ActiveResource::TooManyRequests
-
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 = "https://someip.com/posts/:post_id"
end
Comment.find(1)
# => ActiveResource::MissingPrefixParam: post_id prefix_option is missing
Validation errors
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 JSON or XML 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 https://api.people.com/people/1.xml
# or
# PUT https://api.people.com/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. # => ['First cannot be empty']
For backwards-compatibility with older endpoints, the following formats are also supported in JSON responses:
# {"errors":['First cannot be empty']}
# This was the required format for previous versions of ActiveResource
# {"first":["cannot be empty"]}
# This was the default format produced by respond_with in ActionController <3.2.1
Parsing either of these formats will result in a deprecation warning.
Learn more about Active Resource’s validation features in the ActiveResource::Validations documentation.
Timeouts
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 = "https://api.people.com"
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.
Active Resource also supports distinct open_timeout
(time to connect) and read_timeout
(how long to wait for an upstream response). This is inline with supported Net::HTTP
timeout configuration and allows for finer control of client timeouts depending on context.
class Person < ActiveResource::Base
self.site = "https://api.people.com"
self.open_timeout = 2
self.read_timeout = 10
end
Constant Summary
Constants included from Callbacks
Class Attribute Summary collapse
Instance Attribute Summary collapse
-
#attributes ⇒ Object
:nodoc:.
-
#prefix_options ⇒ Object
:nodoc:.
Class Method Summary collapse
-
.all(*args) ⇒ Object
This is an alias for find(:all).
- .auth_type ⇒ Object
- .auth_type=(auth_type) ⇒ Object
-
.bearer_token ⇒ Object
Gets the bearer_token for REST HTTP authentication.
-
.bearer_token=(bearer_token) ⇒ Object
Sets the bearer_token for REST HTTP authentication.
-
.build(attributes = {}) ⇒ Object
Builds a new, unsaved record using the default values from the remote server so that it can be used with RESTful forms.
- .collection_parser ⇒ Object
-
.collection_parser=(parser_instance) ⇒ Object
Sets the parser to use when a collection is returned.
-
.collection_path(prefix_options = {}, query_options = nil) ⇒ Object
Gets the collection path for the REST resources.
-
.connection(refresh = false) ⇒ Object
An instance of ActiveResource::Connection that is the base connection to the remote service.
-
.create(attributes = {}) ⇒ Object
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:.
-
.create!(attributes = {}) ⇒ Object
Creates a new resource (just like
create
) and makes a request to the remote service that it be saved, but runs validations and raisesActiveResource::ResourceInvalid
, making it equivalent to the following simultaneous calls:. -
.delete(id, options = {}) ⇒ Object
Deletes the resources with the ID in the
id
parameter. -
.element_path(id, prefix_options = {}, query_options = nil) ⇒ Object
Gets the element path for the given ID in
id
. -
.element_url(id, prefix_options = {}, query_options = nil) ⇒ Object
Gets the element url for the given ID in
id
. -
.exists?(id, options = {}) ⇒ Boolean
Asserts the existence of a resource, returning
true
if the resource is found. -
.find(*arguments) ⇒ Object
Core method for finding resources.
-
.first(*args) ⇒ Object
A convenience wrapper for
find(:first, *args)
. -
.format ⇒ Object
Returns the current format, default is ActiveResource::Formats::JsonFormat.
-
.format=(mime_type_reference_or_format) ⇒ Object
Sets the format that attributes are sent and received in from a mime type reference:.
- .format_extension ⇒ Object
- .headers ⇒ Object
-
.known_attributes ⇒ Object
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’ whenrespond_to?
is called on them. -
.last(*args) ⇒ Object
A convenience wrapper for
find(:last, *args)
. - .logger=(logger) ⇒ Object
-
.new_element_path(prefix_options = {}) ⇒ Object
Gets the new element path for REST resources.
-
.open_timeout ⇒ Object
Gets the number of seconds after which connection attempts to the REST API should time out.
-
.open_timeout=(timeout) ⇒ Object
Sets the number of seconds after which connection attempts to the REST API should time out.
-
.password ⇒ Object
Gets the password for REST HTTP authentication.
-
.password=(password) ⇒ Object
Sets the password for REST HTTP authentication.
-
.prefix(options = {}) ⇒ Object
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. -
.prefix=(value = "/") ⇒ Object
(also: set_prefix)
Sets the prefix for a resource’s nested URL (e.g.,
prefix/collectionname/1.json
). -
.prefix_source ⇒ Object
An attribute reader for the source string for the resource path prefix.
-
.proxy ⇒ Object
Gets the proxy variable if a proxy is required.
-
.proxy=(proxy) ⇒ Object
Sets the URI of the http proxy to the value in the
proxy
argument. -
.read_timeout ⇒ Object
Gets the number of seconds after which reads to the REST API should time out.
-
.read_timeout=(timeout) ⇒ Object
Sets the number of seconds after which reads to the REST API should time out.
-
.schema(&block) ⇒ Object
Creates a schema for this resource - setting the attributes that are known prior to fetching an instance from the remote system.
-
.schema=(the_schema) ⇒ Object
Alternative, direct way to specify a
schema
for this Resource. -
.site ⇒ Object
Gets the URI of the REST resources to map for this class.
-
.site=(site) ⇒ Object
Sets the URI of the REST resources to map for this class to the value in the
site
argument. -
.ssl_options ⇒ Object
Returns the SSL options hash.
-
.ssl_options=(options) ⇒ Object
Options that will get applied to an SSL connection.
-
.timeout ⇒ Object
Gets the number of seconds after which requests to the REST API should time out.
-
.timeout=(timeout) ⇒ Object
Sets the number of seconds after which requests to the REST API should time out.
-
.user ⇒ Object
Gets the user for REST HTTP authentication.
-
.user=(user) ⇒ Object
Sets the user for REST HTTP authentication.
- .where(clauses = {}) ⇒ Object
Instance Method Summary collapse
-
#==(other) ⇒ Object
Test for equality.
-
#clone ⇒ Object
Returns a clone of the resource that hasn’t been assigned an
id
yet and is treated as a new resource. -
#destroy ⇒ Object
Deletes the resource from the remote service.
-
#dup ⇒ Object
Duplicates the current resource without saving it.
-
#encode(options = {}) ⇒ Object
Returns the serialized string representation of the resource in the configured serialization format specified in ActiveResource::Base.format.
-
#eql?(other) ⇒ Boolean
Tests for equality (delegates to ==).
-
#exists? ⇒ Boolean
Evaluates to
true
if this resource is notnew?
and is found on the remote service. -
#hash ⇒ Object
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].
-
#id ⇒ Object
Gets the
\id
attribute of the resource. -
#id=(id) ⇒ Object
Sets the
\id
attribute of the resource. -
#initialize(attributes = {}, persisted = false) ⇒ Base
constructor
Constructor method for new resources; the optional
attributes
parameter takes a hash of attributes for the new resource. -
#known_attributes ⇒ Object
This is a list of known attributes for this resource.
-
#load(attributes, remove_root = false, persisted = false) ⇒ Object
A method to manually load attributes from a hash.
-
#logger ⇒ Object
:singleton-method: The logger for diagnosing and tracing Active Resource calls.
-
#new? ⇒ Boolean
(also: #new_record?)
Returns
true
if this object hasn’t yet been saved, otherwise, returnsfalse
. -
#persisted? ⇒ Boolean
Returns
true
if this object has been saved, otherwise returnsfalse
. - #read_attribute_for_serialization(n) ⇒ Object
-
#reload ⇒ Object
A method to reload the attributes of this object from the remote web service.
-
#respond_to_missing?(method, include_priv = false) ⇒ Boolean
A method to determine if an object responds to a message (e.g., a method call).
-
#save ⇒ Object
Saves (
POST
) or updates (PUT
) a resource. -
#save! ⇒ Object
Saves the resource.
-
#schema ⇒ Object
If no schema has been defined for the class (see
ActiveResource::schema=
), the default automatic schema is generated from the current instance’s attributes. - #to_json(options = {}) ⇒ Object
- #to_xml(options = {}) ⇒ Object
-
#update_attribute(name, value) ⇒ Object
Updates a single attribute and then saves the object.
-
#update_attributes(attributes) ⇒ Object
Updates this resource with all the attributes from the passed-in Hash and requests that the record be saved.
Methods included from ThreadsafeAttributes
Methods included from Associations
belongs_to, defines_belongs_to_finder_method, defines_has_many_finder_method, defines_has_one_finder_method, has_many, has_one
Methods included from CustomMethods
#delete, #get, #patch, #post, #put
Methods included from Validations
#errors, #load_remote_errors, #save_with_validation, #valid?
Constructor Details
#initialize(attributes = {}, persisted = false) ⇒ Base
Constructor method for new resources; the optional attributes
parameter takes a hash of attributes for the new resource.
Examples
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
1213 1214 1215 1216 1217 1218 |
# File 'lib/active_resource/base.rb', line 1213 def initialize(attributes = {}, persisted = false) @attributes = {}.with_indifferent_access @prefix_options = {} @persisted = persisted load(attributes, false, persisted) end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method_symbol, *arguments) ⇒ Object (private)
:nodoc:
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 |
# File 'lib/active_resource/base.rb', line 1701 def method_missing(method_symbol, *arguments) # :nodoc: method_name = method_symbol.to_s if method_name =~ /(=|\?)$/ case $1 when "=" attributes[$`] = arguments.first when "?" attributes[$`] end else return attributes[method_name] if attributes.include?(method_name) # not set right now but we know about it return nil if known_attributes.include?(method_name) super end end |
Class Attribute Details
.collection_name ⇒ Object
714 715 716 |
# File 'lib/active_resource/base.rb', line 714 def collection_name @collection_name ||= ActiveSupport::Inflector.pluralize(element_name) end |
.element_name ⇒ Object
708 709 710 |
# File 'lib/active_resource/base.rb', line 708 def element_name @element_name ||= model_name.element end |
.primary_key ⇒ Object
720 721 722 723 724 725 726 727 728 729 730 |
# File 'lib/active_resource/base.rb', line 720 def primary_key if defined?(@primary_key) @primary_key elsif superclass != Object && superclass.primary_key primary_key = superclass.primary_key return primary_key if primary_key.is_a?(Symbol) primary_key.dup.freeze else "id" end end |
Instance Attribute Details
#attributes ⇒ Object
:nodoc:
1184 1185 1186 |
# File 'lib/active_resource/base.rb', line 1184 def attributes @attributes end |
#prefix_options ⇒ Object
:nodoc:
1185 1186 1187 |
# File 'lib/active_resource/base.rb', line 1185 def @prefix_options end |
Class Method Details
.all(*args) ⇒ Object
This is an alias for find(:all). You can pass in all the same arguments to this method as you can to find(:all)
1039 1040 1041 |
# File 'lib/active_resource/base.rb', line 1039 def all(*args) find(:all, *args) end |
.auth_type ⇒ Object
562 563 564 565 566 |
# File 'lib/active_resource/base.rb', line 562 def auth_type if defined?(@auth_type) @auth_type end end |
.auth_type=(auth_type) ⇒ Object
568 569 570 571 |
# File 'lib/active_resource/base.rb', line 568 def auth_type=(auth_type) self._connection = nil @auth_type = auth_type end |
.bearer_token ⇒ Object
Gets the bearer_token for REST HTTP authentication.
547 548 549 550 551 552 553 554 |
# File 'lib/active_resource/base.rb', line 547 def bearer_token # Not using superclass_delegating_reader. See +site+ for explanation if _bearer_token_defined? _bearer_token elsif superclass != Object && superclass.bearer_token superclass.bearer_token.dup.freeze end end |
.bearer_token=(bearer_token) ⇒ Object
Sets the bearer_token for REST HTTP authentication.
557 558 559 560 |
# File 'lib/active_resource/base.rb', line 557 def bearer_token=(bearer_token) self._connection = nil self._bearer_token = bearer_token end |
.build(attributes = {}) ⇒ Object
Builds a new, unsaved record using the default values from the remote server so that it can be used with RESTful forms.
Options
-
attributes
- A hash that overrides the default values from the server.
Returns the new resource instance.
899 900 901 902 |
# File 'lib/active_resource/base.rb', line 899 def build(attributes = {}) attrs = self.format.decode(connection.get("#{new_element_path(attributes)}", headers).body).merge(attributes) self.new(attrs) end |
.collection_parser ⇒ Object
601 602 603 |
# File 'lib/active_resource/base.rb', line 601 def collection_parser self._collection_parser || ActiveResource::Collection end |
.collection_parser=(parser_instance) ⇒ Object
Sets the parser to use when a collection is returned. The parser must be Enumerable.
596 597 598 599 |
# File 'lib/active_resource/base.rb', line 596 def collection_parser=(parser_instance) parser_instance = parser_instance.constantize if parser_instance.is_a?(String) self._collection_parser = parser_instance end |
.collection_path(prefix_options = {}, query_options = nil) ⇒ Object
Gets the collection path for the REST resources. If the query_options
parameter is omitted, Rails will split from the prefix_options
.
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.
Examples
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
883 884 885 886 887 |
# File 'lib/active_resource/base.rb', line 883 def collection_path( = {}, = nil) () , = () if .nil? "#{prefix()}#{collection_name}#{format_extension}#{query_string()}" end |
.connection(refresh = false) ⇒ Object
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
).
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 |
# File 'lib/active_resource/base.rb', line 678 def connection(refresh = false) if _connection_defined? || superclass == Object self._connection = connection_class.new( site, format, logger: logger ) if refresh || _connection.nil? _connection.proxy = proxy if proxy _connection.user = user if user _connection.password = password if password _connection.bearer_token = bearer_token if bearer_token _connection.auth_type = auth_type if auth_type _connection.timeout = timeout if timeout _connection.open_timeout = open_timeout if open_timeout _connection.read_timeout = read_timeout if read_timeout _connection. = if _connection else superclass.connection end end |
.create(attributes = {}) ⇒ Object
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
.
Examples
Person.create(:name => 'Jeremy', :email => '[email protected]', :enabled => true)
my_person = Person.find(:first)
my_person.email # => [email protected]
dhh = Person.create(:name => 'David', :email => '[email protected]', :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 => '[email protected]', :enabled => true)
that_guy.valid? # => false
that_guy.new? # => true
928 929 930 |
# File 'lib/active_resource/base.rb', line 928 def create(attributes = {}) self.new(attributes).tap { |resource| resource.save } end |
.create!(attributes = {}) ⇒ Object
Creates a new resource (just like create
) and makes a request to the remote service that it be saved, but runs validations and raises ActiveResource::ResourceInvalid
, making it equivalent to the following simultaneous calls:
ryan = Person.new(:first => 'ryan')
ryan.save!
939 940 941 |
# File 'lib/active_resource/base.rb', line 939 def create!(attributes = {}) self.new(attributes).tap { |resource| resource.save! } end |
.delete(id, options = {}) ⇒ Object
Deletes the resources with the ID in the id
parameter.
Options
All options specify prefix and query parameters.
Examples
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
1063 1064 1065 |
# File 'lib/active_resource/base.rb', line 1063 def delete(id, = {}) connection.delete(element_path(id, ), headers) end |
.element_path(id, prefix_options = {}, query_options = nil) ⇒ Object
Gets the element path for the given ID in id
. If the query_options
parameter is omitted, Rails will split from the prefix options.
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.
Examples
Post.element_path(1)
# => /posts/1.json
class Comment < ActiveResource::Base
self.site = "https://37s.sunrise.com/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
805 806 807 808 809 810 |
# File 'lib/active_resource/base.rb', line 805 def element_path(id, = {}, = nil) () , = () if .nil? "#{prefix()}#{collection_name}/#{URI.encode_www_form_component(id.to_s)}#{format_extension}#{query_string()}" end |
.element_url(id, prefix_options = {}, query_options = nil) ⇒ Object
Gets the element url for the given ID in id
. If the query_options
parameter is omitted, Rails will split from the prefix options.
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 https://37s.sunrise.com/accounts/19/purchases.json
).
query_options
- A hash to add items to the query string for the request.
Examples
Post.element_url(1)
# => https://37s.sunrise.com/posts/1.json
class Comment < ActiveResource::Base
self.site = "https://37s.sunrise.com/posts/:post_id"
end
Comment.element_url(1, :post_id => 5)
# => https://37s.sunrise.com/posts/5/comments/1.json
Comment.element_url(1, :post_id => 5, :active => 1)
# => https://37s.sunrise.com/posts/5/comments/1.json?active=1
Comment.element_url(1, {:post_id => 5}, {:active => 1})
# => https://37s.sunrise.com/posts/5/comments/1.json?active=1
838 839 840 |
# File 'lib/active_resource/base.rb', line 838 def element_url(id, = {}, = nil) URI.join(site, element_path(id, , )).to_s end |
.exists?(id, options = {}) ⇒ Boolean
Asserts the existence of a resource, returning true
if the resource is found.
Examples
Note.create(:title => 'Hello, world.', :body => 'Nothing more for now...')
Note.exists?(1) # => true
Note.exists(1349) # => false
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 |
# File 'lib/active_resource/base.rb', line 1074 def exists?(id, = {}) return false unless id , = ([:params]) path = element_path(id, , ) response = connection.head(path, headers) (200..206).include?(response.code.to_i) rescue ActiveResource::ResourceNotFound, ActiveResource::ResourceGone false end |
.find(*arguments) ⇒ Object
Core method for finding resources. Used similarly to Active Record’s find
method.
Arguments
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.
Options
-
:from
- Sets the path or custom method that resources will be fetched from. -
:params
- Sets query and prefix (nested URL) parameters.
Examples
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
Failure or missing data
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
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 |
# File 'lib/active_resource/base.rb', line 1002 def find(*arguments) scope = arguments.slice!(0) = arguments.slice!(0) || {} case scope when :all find_every() when :first collection = find_every() collection && collection.first when :last collection = find_every() collection && collection.last when :one find_one() else find_single(scope, ) end end |
.first(*args) ⇒ Object
A convenience wrapper for find(:first, *args)
. You can pass in all the same arguments to this method as you can to find(:first)
.
1026 1027 1028 |
# File 'lib/active_resource/base.rb', line 1026 def first(*args) find(:first, *args) end |
.format ⇒ Object
Returns the current format, default is ActiveResource::Formats::JsonFormat.
591 592 593 |
# File 'lib/active_resource/base.rb', line 591 def format self._format || ActiveResource::Formats::JsonFormat end |
.format=(mime_type_reference_or_format) ⇒ Object
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
.
582 583 584 585 586 587 588 |
# File 'lib/active_resource/base.rb', line 582 def format=(mime_type_reference_or_format) format = mime_type_reference_or_format.is_a?(Symbol) ? ActiveResource::Formats[mime_type_reference_or_format] : mime_type_reference_or_format self._format = format connection.format = format if site end |
.format_extension ⇒ Object
775 776 777 |
# File 'lib/active_resource/base.rb', line 775 def format_extension include_format_in_path ? ".#{format.extension}" : "" end |
.headers ⇒ Object
698 699 700 701 702 703 704 |
# File 'lib/active_resource/base.rb', line 698 def headers self._headers ||= if superclass != Object InheritingHash.new(superclass.headers) else {} end end |
.known_attributes ⇒ Object
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 MethodNotFound
); thus known attributes can be used with validates_presence_of
without a getter-method.
456 457 458 |
# File 'lib/active_resource/base.rb', line 456 def known_attributes @known_attributes ||= [] end |
.last(*args) ⇒ Object
A convenience wrapper for find(:last, *args)
. You can pass in all the same arguments to this method as you can to find(:last)
.
1033 1034 1035 |
# File 'lib/active_resource/base.rb', line 1033 def last(*args) find(:last, *args) end |
.logger=(logger) ⇒ Object
325 326 327 328 |
# File 'lib/active_resource/base.rb', line 325 def self.logger=(logger) self._connection = nil @@logger = logger end |
.new_element_path(prefix_options = {}) ⇒ Object
Gets the new element path for REST resources.
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/new.json
).
Examples
Post.new_element_path
# => /posts/new.json
class Comment < ActiveResource::Base
self.site = "https://37s.sunrise.com/posts/:post_id"
end
Comment.collection_path(:post_id => 5)
# => /posts/5/comments/new.json
858 859 860 |
# File 'lib/active_resource/base.rb', line 858 def new_element_path( = {}) "#{prefix()}#{collection_name}/new#{format_extension}" end |
.open_timeout ⇒ Object
Gets the number of seconds after which connection attempts to the REST API should time out.
633 634 635 636 637 638 639 |
# File 'lib/active_resource/base.rb', line 633 def open_timeout if defined?(@open_timeout) @open_timeout elsif superclass != Object && superclass.open_timeout superclass.open_timeout end end |
.open_timeout=(timeout) ⇒ Object
Sets the number of seconds after which connection attempts to the REST API should time out.
612 613 614 615 |
# File 'lib/active_resource/base.rb', line 612 def open_timeout=(timeout) self._connection = nil @open_timeout = timeout end |
.password ⇒ Object
Gets the password for REST HTTP authentication.
531 532 533 534 535 536 537 538 |
# File 'lib/active_resource/base.rb', line 531 def password # Not using superclass_delegating_reader. See +site+ for explanation if _password_defined? _password elsif superclass != Object && superclass.password superclass.password.dup.freeze end end |
.password=(password) ⇒ Object
Sets the password for REST HTTP authentication.
541 542 543 544 |
# File 'lib/active_resource/base.rb', line 541 def password=(password) self._connection = nil self._password = password end |
.prefix(options = {}) ⇒ Object
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.
734 735 736 737 738 739 740 |
# File 'lib/active_resource/base.rb', line 734 def prefix( = {}) default = site.path default << "/" unless default[-1..-1] == "/" # generate the actual method based on the current site path self.prefix = default prefix() end |
.prefix=(value = "/") ⇒ Object Also known as: set_prefix
Sets the prefix for a resource’s nested URL (e.g., prefix/collectionname/1.json
). Default value is site.path
.
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 |
# File 'lib/active_resource/base.rb', line 751 def prefix=(value = "/") # Replace :placeholders with '#{embedded options[:lookups]}' prefix_call = value.gsub(/:\w+/) { |key| "\#{URI::DEFAULT_PARSER.escape options[#{key}].to_s}" } # Clear prefix parameters in case they have been cached @prefix_parameters = nil silence_warnings do # Redefine the new methods. instance_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1 def prefix_source() "#{value}" end def prefix(options={}) "#{prefix_call}" end RUBY_EVAL end rescue Exception => e logger.error "Couldn't set prefix: #{e}\n #{code}" if logger raise end |
.prefix_source ⇒ Object
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.
744 745 746 747 |
# File 'lib/active_resource/base.rb', line 744 def prefix_source prefix # generate #prefix and #prefix_source methods first prefix_source end |
.proxy ⇒ Object
Gets the proxy variable if a proxy is required
499 500 501 502 503 504 505 506 |
# File 'lib/active_resource/base.rb', line 499 def proxy # Not using superclass_delegating_reader. See +site+ for explanation if _proxy_defined? _proxy elsif superclass != Object && superclass.proxy superclass.proxy.dup.freeze end end |
.proxy=(proxy) ⇒ Object
Sets the URI of the http proxy to the value in the proxy
argument.
509 510 511 512 |
# File 'lib/active_resource/base.rb', line 509 def proxy=(proxy) self._connection = nil self._proxy = proxy.nil? ? nil : create_proxy_uri_from(proxy) end |
.read_timeout ⇒ Object
Gets the number of seconds after which reads to the REST API should time out.
642 643 644 645 646 647 648 |
# File 'lib/active_resource/base.rb', line 642 def read_timeout if defined?(@read_timeout) @read_timeout elsif superclass != Object && superclass.read_timeout superclass.read_timeout end end |
.read_timeout=(timeout) ⇒ Object
Sets the number of seconds after which reads to the REST API should time out.
618 619 620 621 |
# File 'lib/active_resource/base.rb', line 618 def read_timeout=(timeout) self._connection = nil @read_timeout = timeout end |
.schema(&block) ⇒ Object
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')
<person><name>John</name><age>34</age><num_children>3</num_children></person>
j.respond_to? :name # => true
j.respond_to? :age # => true
j.name # => 'John'
j.age # => '34' # note this is a string!
j.num_children # => '3' # note this is a string!
p.num_children # => NoMethodError
Attribute-types must be one of: string, text, integer, float, decimal, datetime, timestamp, time, date, binary, boolean
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!
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 |
# File 'lib/active_resource/base.rb', line 395 def schema(&block) if block_given? schema_definition = Schema.new schema_definition.instance_eval(&block) # skip out if we didn't define anything return unless schema_definition.attrs.present? @schema ||= {}.with_indifferent_access @known_attributes ||= [] schema_definition.attrs.each do |k, v| @schema[k] = v @known_attributes << k end @schema else @schema ||= nil end end |
.schema=(the_schema) ⇒ Object
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
self.schema = {'name' => :string, 'age' => :integer }
end
The keys/values can be strings or symbols. They will be converted to strings.
434 435 436 437 438 439 440 441 442 443 444 445 446 447 |
# File 'lib/active_resource/base.rb', line 434 def schema=(the_schema) unless the_schema.present? # purposefully nulling out the schema @schema = nil @known_attributes = [] return end raise ArgumentError, "Expected a hash" unless the_schema.kind_of? Hash schema do the_schema.each { |k, v| attribute(k, v) } end end |
.site ⇒ Object
Gets the URI of the REST resources to map for this class. The site variable is required for Active Resource’s mapping to work.
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 |
# File 'lib/active_resource/base.rb', line 462 def site # Not using superclass_delegating_reader because don't want subclasses to modify superclass instance # # With superclass_delegating_reader # # Parent.site = 'https://[email protected]' # Subclass.site # => 'https://[email protected]' # Subclass.site.user = 'david' # Parent.site # => 'https://[email protected]' # # Without superclass_delegating_reader (expected behavior) # # Parent.site = 'https://[email protected]' # Subclass.site # => 'https://[email protected]' # Subclass.site.user = 'david' # => TypeError: can't modify frozen object # if _site_defined? _site elsif superclass != Object && superclass.site superclass.site.dup.freeze end end |
.site=(site) ⇒ Object
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.
487 488 489 490 491 492 493 494 495 496 |
# File 'lib/active_resource/base.rb', line 487 def site=(site) self._connection = nil if site.nil? self._site = nil else self._site = create_site_uri_from(site) self._user = URI::DEFAULT_PARSER.unescape(_site.user) if _site.user self._password = URI::DEFAULT_PARSER.unescape(_site.password) if _site.password end end |
.ssl_options ⇒ Object
Returns the SSL options hash.
667 668 669 670 671 672 673 |
# File 'lib/active_resource/base.rb', line 667 def if defined?(@ssl_options) @ssl_options elsif superclass != Object && superclass. superclass. end end |
.ssl_options=(options) ⇒ Object
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.
661 662 663 664 |
# File 'lib/active_resource/base.rb', line 661 def () self._connection = nil @ssl_options = end |
.timeout ⇒ Object
Gets the number of seconds after which requests to the REST API should time out.
624 625 626 627 628 629 630 |
# File 'lib/active_resource/base.rb', line 624 def timeout if defined?(@timeout) @timeout elsif superclass != Object && superclass.timeout superclass.timeout end end |
.timeout=(timeout) ⇒ Object
Sets the number of seconds after which requests to the REST API should time out.
606 607 608 609 |
# File 'lib/active_resource/base.rb', line 606 def timeout=(timeout) self._connection = nil @timeout = timeout end |
.user ⇒ Object
Gets the user for REST HTTP authentication.
515 516 517 518 519 520 521 522 |
# File 'lib/active_resource/base.rb', line 515 def user # Not using superclass_delegating_reader. See +site+ for explanation if _user_defined? _user elsif superclass != Object && superclass.user superclass.user.dup.freeze end end |
.user=(user) ⇒ Object
Sets the user for REST HTTP authentication.
525 526 527 528 |
# File 'lib/active_resource/base.rb', line 525 def user=(user) self._connection = nil self._user = user end |
.where(clauses = {}) ⇒ Object
1043 1044 1045 1046 |
# File 'lib/active_resource/base.rb', line 1043 def where(clauses = {}) raise ArgumentError, "expected a clauses Hash, got #{clauses.inspect}" unless clauses.is_a? Hash find(:all, params: clauses) end |
Instance Method Details
#==(other) ⇒ Object
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
.
Examples
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
1318 1319 1320 |
# File 'lib/active_resource/base.rb', line 1318 def ==(other) other.equal?(self) || (other.instance_of?(self.class) && other.id == id && other. == ) end |
#clone ⇒ Object
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"}
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 |
# File 'lib/active_resource/base.rb', line 1240 def clone # Clone all attributes except the pk and any nested ARes cloned = attributes.reject { |k, v| k == self.class.primary_key || v.is_a?(ActiveResource::Base) }.transform_values { |v| v.clone } # Form the new resource - bypass initialize of resource with 'new' as that will call 'load' which # attempts to convert hashes into member objects and arrays into collections of objects. We want # the raw objects to be cloned so we bypass load by directly setting the attributes hash. resource = self.class.new({}) resource. = self. resource.send :instance_variable_set, "@attributes", cloned resource end |
#destroy ⇒ Object
Deletes the resource from the remote service.
Examples
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)
1400 1401 1402 1403 1404 |
# File 'lib/active_resource/base.rb', line 1400 def destroy run_callbacks :destroy do connection.delete(element_path, self.class.headers) end end |
#dup ⇒ Object
Duplicates the current resource without saving it.
Examples
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
1345 1346 1347 1348 1349 1350 |
# File 'lib/active_resource/base.rb', line 1345 def dup self.class.new.tap do |resource| resource.attributes = @attributes resource. = @prefix_options end end |
#encode(options = {}) ⇒ Object
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.
1429 1430 1431 |
# File 'lib/active_resource/base.rb', line 1429 def encode( = {}) send("to_#{self.class.format.extension}", ) end |
#eql?(other) ⇒ Boolean
Tests for equality (delegates to ==).
1323 1324 1325 |
# File 'lib/active_resource/base.rb', line 1323 def eql?(other) self == other end |
#exists? ⇒ Boolean
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.
Examples
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
1422 1423 1424 |
# File 'lib/active_resource/base.rb', line 1422 def exists? !new? && self.class.exists?(to_param, params: ) end |
#hash ⇒ Object
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]
1329 1330 1331 |
# File 'lib/active_resource/base.rb', line 1329 def hash id.hash end |
#id ⇒ Object
Gets the \id
attribute of the resource.
1287 1288 1289 |
# File 'lib/active_resource/base.rb', line 1287 def id attributes[self.class.primary_key] end |
#id=(id) ⇒ Object
Sets the \id
attribute of the resource.
1292 1293 1294 |
# File 'lib/active_resource/base.rb', line 1292 def id=(id) attributes[self.class.primary_key] = id end |
#known_attributes ⇒ Object
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.
1197 1198 1199 |
# File 'lib/active_resource/base.rb', line 1197 def known_attributes (self.class.known_attributes + self.attributes.keys.map(&:to_s)).uniq end |
#load(attributes, remove_root = false, persisted = false) ⇒ Object
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.
Examples
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
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 |
# File 'lib/active_resource/base.rb', line 1469 def load(attributes, remove_root = false, persisted = false) unless attributes.respond_to?(:to_hash) raise ArgumentError, "expected attributes to be able to convert to Hash, got #{attributes.inspect}" end attributes = attributes.to_hash @prefix_options, attributes = (attributes) if attributes.keys.size == 1 remove_root = self.class.element_name == attributes.keys.first.to_s end attributes = Formats.remove_root(attributes) if remove_root attributes.each do |key, value| @attributes[key.to_s] = case value when Array resource = nil value.map do |attrs| if attrs.is_a?(Hash) resource ||= find_or_create_resource_for_collection(key) resource.new(attrs, persisted) else attrs.duplicable? ? attrs.dup : attrs end end when Hash resource = find_or_create_resource_for(key) resource.new(value, persisted) else value.duplicable? ? value.dup : value end end self end |
#logger ⇒ Object
:singleton-method: The logger for diagnosing and tracing Active Resource calls.
323 |
# File 'lib/active_resource/base.rb', line 323 cattr_reader :logger |
#new? ⇒ Boolean Also known as: new_record?
Returns true
if this object hasn’t yet been saved, otherwise, returns false
.
Examples
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
1265 1266 1267 |
# File 'lib/active_resource/base.rb', line 1265 def new? !persisted? end |
#persisted? ⇒ Boolean
Returns true
if this object has been saved, otherwise returns false
.
Examples
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
1282 1283 1284 |
# File 'lib/active_resource/base.rb', line 1282 def persisted? @persisted end |
#read_attribute_for_serialization(n) ⇒ Object
1565 1566 1567 1568 1569 1570 1571 |
# File 'lib/active_resource/base.rb', line 1565 def read_attribute_for_serialization(n) if !attributes[n].nil? attributes[n] elsif respond_to?(n) send(n) end end |
#reload ⇒ Object
A method to reload the attributes of this object from the remote web service.
Examples
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"
1444 1445 1446 |
# File 'lib/active_resource/base.rb', line 1444 def reload self.load(self.class.find(to_param, params: @prefix_options).attributes, false, true) end |
#respond_to_missing?(method, include_priv = false) ⇒ Boolean
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?)
.
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 |
# File 'lib/active_resource/base.rb', line 1542 def respond_to_missing?(method, include_priv = false) method_name = method.to_s if attributes.nil? super elsif known_attributes.include?(method_name) true elsif method_name =~ /(?:=|\?)$/ && attributes.include?($`) true else # super must be called at the end of the method, because the inherited respond_to? # would return true for generated readers, even if the attribute wasn't present super end end |
#save ⇒ Object
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).
Examples
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)
1365 1366 1367 1368 1369 |
# File 'lib/active_resource/base.rb', line 1365 def save run_callbacks :save do new? ? create : update end end |
#save! ⇒ Object
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.
1384 1385 1386 |
# File 'lib/active_resource/base.rb', line 1384 def save! save || raise(ResourceInvalid.new(self)) end |
#schema ⇒ Object
If no schema has been defined for the class (see ActiveResource::schema=
), the default automatic schema is generated from the current instance’s attributes
1190 1191 1192 |
# File 'lib/active_resource/base.rb', line 1190 def schema self.class.schema || self.attributes end |
#to_json(options = {}) ⇒ Object
1557 1558 1559 |
# File 'lib/active_resource/base.rb', line 1557 def to_json( = {}) super(include_root_in_json ? { root: self.class.element_name }.merge() : ) end |
#to_xml(options = {}) ⇒ Object
1561 1562 1563 |
# File 'lib/active_resource/base.rb', line 1561 def to_xml( = {}) super({ root: self.class.element_name }.merge()) end |
#update_attribute(name, value) ⇒ Object
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.
1517 1518 1519 1520 |
# File 'lib/active_resource/base.rb', line 1517 def update_attribute(name, value) self.send("#{name}=".to_sym, value) self.save end |
#update_attributes(attributes) ⇒ Object
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.
1532 1533 1534 |
# File 'lib/active_resource/base.rb', line 1532 def update_attributes(attributes) load(attributes, false) && save end |