Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Remove Active Resource source files from the repository

Dear Active Resource,

It's not that I hate you or anything, but you didn't get much attention lately. There're so many alternatives out there, and I think people have made their choice to use them than you. I think it's time for you to have a big rest, peacefully in this Git repository.

I will miss you,

@sikachu.
  • Loading branch information...
commit f1637bf2bb00490203503fbd943b73406e043d1d 1 parent a85714a
@sikachu sikachu authored
Showing with 13 additions and 7,147 deletions.
  1. +1 −7 Rakefile
  2. +2 −2 actionpack/lib/action_controller/record_identifier.rb
  3. +1 −1  actionpack/lib/action_view/helpers/url_helper.rb
  4. +1 −1  activemodel/activemodel.gemspec
  5. +0 −390 activeresource/CHANGELOG.md
  6. +0 −20 activeresource/MIT-LICENSE
  7. +0 −189 activeresource/README.rdoc
  8. +0 −66 activeresource/Rakefile
  9. +0 −24 activeresource/activeresource.gemspec
  10. +0 −70 activeresource/examples/performance.rb
  11. +0 −45 activeresource/lib/active_resource.rb
  12. +0 −1,515 activeresource/lib/active_resource/base.rb
  13. +0 −284 activeresource/lib/active_resource/connection.rb
  14. +0 −127 activeresource/lib/active_resource/custom_methods.rb
  15. +0 −82 activeresource/lib/active_resource/exceptions.rb
  16. +0 −22 activeresource/lib/active_resource/formats.rb
  17. +0 −25 activeresource/lib/active_resource/formats/json_format.rb
  18. +0 −25 activeresource/lib/active_resource/formats/xml_format.rb
  19. +0 −332 activeresource/lib/active_resource/http_mock.rb
  20. +0 −15 activeresource/lib/active_resource/log_subscriber.rb
  21. +0 −29 activeresource/lib/active_resource/observing.rb
  22. +0 −14 activeresource/lib/active_resource/railtie.rb
  23. +0 −59 activeresource/lib/active_resource/schema.rb
  24. +0 −172 activeresource/lib/active_resource/validations.rb
  25. +0 −10 activeresource/lib/active_resource/version.rb
  26. +0 −143 activeresource/test/abstract_unit.rb
  27. +0 −251 activeresource/test/cases/authorization_test.rb
  28. +0 −101 activeresource/test/cases/base/custom_methods_test.rb
  29. +0 −52 activeresource/test/cases/base/equality_test.rb
  30. +0 −199 activeresource/test/cases/base/load_test.rb
  31. +0 −411 activeresource/test/cases/base/schema_test.rb
  32. +0 −137 activeresource/test/cases/base_errors_test.rb
  33. +0 −1,177 activeresource/test/cases/base_test.rb
  34. +0 −275 activeresource/test/cases/connection_test.rb
  35. +0 −139 activeresource/test/cases/finder_test.rb
  36. +0 −118 activeresource/test/cases/format_test.rb
  37. +0 −202 activeresource/test/cases/http_mock_test.rb
  38. +0 −32 activeresource/test/cases/log_subscriber_test.rb
  39. +0 −55 activeresource/test/cases/observing_test.rb
  40. +0 −67 activeresource/test/cases/validations_test.rb
  41. +0 −19 activeresource/test/fixtures/address.rb
  42. +0 −14 activeresource/test/fixtures/beast.rb
  43. +0 −3  activeresource/test/fixtures/customer.rb
  44. +0 −3  activeresource/test/fixtures/person.rb
  45. +0 −18 activeresource/test/fixtures/project.rb
  46. +0 −4 activeresource/test/fixtures/proxy.rb
  47. +0 −9 activeresource/test/fixtures/sound.rb
  48. +0 −4 activeresource/test/fixtures/street_address.rb
  49. +0 −5 activeresource/test/fixtures/subscription_plan.rb
  50. +0 −26 activeresource/test/setter_trap.rb
  51. +0 −1  ci/travis.rb
  52. +1 −1  install.rb
  53. +0 −1  rails.gemspec
  54. +2 −0  railties/CHANGELOG.md
  55. +0 −120 railties/guides/source/active_resource_basics.textile
  56. +0 −1  railties/guides/source/command_line.textile
  57. +0 −8 railties/guides/source/configuring.textile
  58. +0 −7 railties/guides/source/getting_started.textile
  59. +0 −2  railties/guides/source/initialization.textile
  60. +0 −1  railties/lib/rails/all.rb
  61. +0 −1  railties/lib/rails/generators/rails/app/templates/config/application.rb
  62. +0 −1  railties/lib/rails/generators/rails/plugin_new/templates/rails/application.rb
  63. +2 −2 railties/lib/rails/info.rb
  64. +1 −1  railties/lib/rails/railtie.rb
  65. +0 −6 railties/lib/rails/tasks/documentation.rake
  66. +1 −2  railties/test/isolation/abstract_unit.rb
  67. +1 −1  tasks/release.rb
  68. +0 −1  tools/profile
View
8 Rakefile
@@ -13,7 +13,7 @@ task :build => "all:build"
desc "Release all gems to gemcutter and create a tag"
task :release => "all:release"
-PROJECTS = %w(activesupport activemodel actionpack actionmailer activeresource activerecord railties)
+PROJECTS = %w(activesupport activemodel actionpack actionmailer activerecord railties)
desc 'Run all tests by default'
task :default => %w(test test:isolated)
@@ -109,11 +109,6 @@ RDoc::Task.new do |rdoc|
rdoc.rdoc_files.include('activerecord/lib/active_record/**/*.rb')
rdoc.rdoc_files.exclude('activerecord/lib/active_record/vendor/*')
- rdoc.rdoc_files.include('activeresource/README.rdoc')
- rdoc.rdoc_files.include('activeresource/CHANGELOG.md')
- rdoc.rdoc_files.include('activeresource/lib/active_resource.rb')
- rdoc.rdoc_files.include('activeresource/lib/active_resource/*')
-
rdoc.rdoc_files.include('actionpack/README.rdoc')
rdoc.rdoc_files.include('actionpack/CHANGELOG.md')
rdoc.rdoc_files.include('actionpack/lib/abstract_controller/**/*.rb')
@@ -157,7 +152,6 @@ task :update_versions do
"activemodel" => "ActiveModel",
"actionpack" => "ActionPack",
"actionmailer" => "ActionMailer",
- "activeresource" => "ActiveResource",
"activerecord" => "ActiveRecord",
"railties" => "Rails"
}
View
4 actionpack/lib/action_controller/record_identifier.rb
@@ -2,8 +2,8 @@
module ActionController
# The record identifier encapsulates a number of naming conventions for dealing with records, like Active Records or
- # Active Resources or pretty much any other model type that has an id. These patterns are then used to try elevate
- # the view actions to a higher logical level. Example:
+ # pretty much any other model type that has an id. These patterns are then used to try elevate the view actions to
+ # a higher logical level. Example:
#
# # routes
# resources :posts
View
2  actionpack/lib/action_view/helpers/url_helper.rb
@@ -60,7 +60,7 @@ def optimize_routes_generation? #:nodoc:
#
# ==== Relying on named routes
#
- # Passing a record (like an Active Record or Active Resource) instead of a Hash as the options parameter will
+ # Passing a record (like an Active Record) instead of a Hash as the options parameter will
# trigger the named route for that record. The lookup will happen on the name of the class. So passing a
# Workshop object will attempt to use the +workshop_path+ route. If you have a nested route, such as
# +admin_workshop_path+ you'll have to call that explicitly (it's impossible for +url_for+ to guess that route).
View
2  activemodel/activemodel.gemspec
@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
s.name = 'activemodel'
s.version = version
s.summary = 'A toolkit for building modeling frameworks (part of Rails).'
- s.description = 'A toolkit for building modeling frameworks like Active Record and Active Resource. Rich support for attributes, callbacks, validations, observers, serialization, internationalization, and testing.'
+ s.description = 'A toolkit for building modeling frameworks like Active Record. Rich support for attributes, callbacks, validations, observers, serialization, internationalization, and testing.'
s.required_ruby_version = '>= 1.9.3'
View
390 activeresource/CHANGELOG.md
@@ -1,390 +0,0 @@
-## Rails 4.0.0 (unreleased) ##
-
-* Adds support for PATCH requests. *dlee*
-
-
-## Rails 3.2.2 (March 1, 2012) ##
-
-* No changes.
-
-
-## Rails 3.2.1 (January 26, 2012) ##
-
-* Documentation fixes.
-
-
-## Rails 3.2.0 (January 20, 2012) ##
-
-* Redirect responses: 303 See Other and 307 Temporary Redirect now behave like
- 301 Moved Permanently and 302 Found. GH #3302.
-
- *Jim Herz*
-
-
-## Rails 3.1.4 (March 1, 2012) ##
-
-* No changes
-
-
-## Rails 3.1.3 (November 20, 2011) ##
-
-* No changes
-
-
-## Rails 3.1.2 (November 18, 2011) ##
-
-* No changes
-
-
-## Rails 3.1.1 (October 7, 2011) ##
-
-* No changes.
-
-
-## Rails 3.1.0 (August 30, 2011) ##
-
-* The default format has been changed to JSON for all requests. If you want to continue to use XML you will need to set `self.format = :xml` in the class. eg.
-
- class User < ActiveResource::Base self.format = :xml
- end
-
-
-## Rails 3.0.12 (March 1, 2012) ##
-
-* No changes.
-
-
-## Rails 3.0.11 (November 18, 2011) ##
-
-* No changes.
-
-
-## Rails 3.0.10 (August 16, 2011) ##
-
-* No changes.
-
-
-## Rails 3.0.9 (June 16, 2011) ##
-
-* No changes.
-
-
-## Rails 3.0.8 (June 7, 2011) ##
-
-* No Changes
-
-
-## Rails 3.0.7 (April 18, 2011) ##
-
-* No changes.
-
-
-## Rails 3.0.6 (April 5, 2011) ##
-
-* No changes.
-
-
-## Rails 3.0.5 (February 26, 2011) ##
-
-* No changes.
-
-
-## Rails 3.0.4 (February 8, 2011) ##
-
-* No changes.
-
-
-## Rails 3.0.3 (November 16, 2010) ##
-
-* No changes.
-
-
-## Rails 3.0.2 (November 15, 2010) ##
-
-* No changes
-
-
-## Rails 3.0.1 (October 15, 2010) ##
-
-* No Changes, just a version bump.
-
-
-## Rails 3.0.0 (August 29, 2010) ##
-
-* JSON: set Base.include_root_in_json = true to include a root value in the JSON: {"post": {"title": ...}}. Mirrors the Active Record option. *Santiago Pastorino*
-
-* Add support for errors in JSON format. #1956 *Fabien Jakimowicz*
-
-* Recognizes 410 as Resource Gone. #2316 *Jordan Brough, Jatinder Singh*
-
-* More thorough SSL support. #2370 *Roy Nicholson*
-
-* HTTP proxy support. #2133 *Marshall Huss, Sébastien Dabet*
-
-
-## 2.3.2 Final (March 15, 2009) ##
-
-* Nothing new, just included in 2.3.2
-
-
-## 2.2.1 RC2 (November 14th, 2008) ##
-
-* Fixed that ActiveResource#post would post an empty string when it shouldn't be posting anything #525 *Paolo Angelini*
-
-
-## 2.2.0 RC1 (October 24th, 2008) ##
-
-* Add ActiveResource::Base#to_xml and ActiveResource::Base#to_json. #1011 *Rasik Pandey, Cody Fauser*
-
-* Add ActiveResource::Base.find(:last). [#754 state:resolved] (Adrian Mugnolo)
-
-* Fixed problems with the logger used if the logging string included %'s [#840 state:resolved] (Jamis Buck)
-
-* Fixed Base#exists? to check status code as integer [#299 state:resolved] (Wes Oldenbeuving)
-
-
-## 2.1.0 (May 31st, 2008) ##
-
-* Fixed response logging to use length instead of the entire thing (seangeo) *#27*
-
-* Fixed that to_param should be used and honored instead of hardcoding the id #11406 *gspiers*
-
-* Improve documentation. *Ryan Bigg, Jan De Poorter, Cheah Chu Yeow, Xavier Shay, Jack Danger Canty, Emilio Tagua, Xavier Noria, Sunny Ripert*
-
-* Use HEAD instead of GET in exists? *bscofield*
-
-* Fix small documentation typo. Closes #10670 *Luca Guidi*
-
-* find_or_create_resource_for handles module nesting. #10646 *xavier*
-
-* Allow setting ActiveResource::Base#format before #site. *Rick Olson*
-
-* Support agnostic formats when calling custom methods. Closes #10635 *joerichsen*
-
-* Document custom methods. #10589 *Cheah Chu Yeow*
-
-* Ruby 1.9 compatibility. *Jeremy Kemper*
-
-
-## 2.0.2 (December 16th, 2007) ##
-
-* Added more specific exceptions for 400, 401, and 403 (all descending from ClientError so existing rescues will work) #10326 *trek*
-
-* Correct empty response handling. #10445 *seangeo*
-
-
-## 2.0.1 (December 7th, 2007) ##
-
-* Don't cache net/http object so that ActiveResource is more thread-safe. Closes #10142 *kou*
-
-* Update XML documentation examples to include explicit type attributes. Closes #9754 *Josh Susser*
-
-* Added one-off declarations of mock behavior [David Heinemeier Hansson]. Example:
-
- Before:
- ActiveResource::HttpMock.respond_to do |mock|
- mock.get "/people/1.xml", {}, "<person><name>David</name></person>"
- end
-
- Now:
- ActiveResource::HttpMock.respond_to.get "/people/1.xml", {}, "<person><name>David</name></person>"
-
-* Added ActiveResource.format= which defaults to :xml but can also be set to :json [David Heinemeier Hansson]. Example:
-
- class Person < ActiveResource::Base
- self.site = "http://app/"
- self.format = :json
- end
-
- person = Person.find(1) # => GET http://app/people/1.json
- person.name = "David"
- person.save # => PUT http://app/people/1.json {name: "David"}
-
- Person.format = :xml
- person.name = "Mary"
- person.save # => PUT http://app/people/1.json <person><name>Mary</name></person>
-
-* Fix reload error when path prefix is used. #8727 *Ian Warshak*
-
-* Remove ActiveResource::Struct because it hasn't proven very useful. Creating a new ActiveResource::Base subclass is often less code and always clearer. #8612 *Josh Peek*
-
-* Fix query methods on resources. *Cody Fauser*
-
-* pass the prefix_options to the instantiated record when using find without a specific id. Closes #8544 *Eloy Duran*
-
-* Recognize and raise an exception on 405 Method Not Allowed responses. #7692 *Josh Peek*
-
-* Handle string and symbol param keys when splitting params into prefix params and query params.
-
- Comment.find(:all, :params => { :article_id => 5, :page => 2 }) or Comment.find(:all, :params => { 'article_id' => 5, :page => 2 })
-
-* Added find-one with symbol [David Heinemeier Hansson]. Example: Person.find(:one, :from => :leader) # => GET /people/leader.xml
-
-* BACKWARDS INCOMPATIBLE: Changed the finder API to be more extensible with :params and more strict usage of scopes [David Heinemeier Hansson]. Changes:
-
- Person.find(:all, :title => "CEO") ...becomes: Person.find(:all, :params => { :title => "CEO" })
- Person.find(:managers) ...becomes: Person.find(:all, :from => :managers)
- Person.find("/companies/1/manager.xml") ...becomes: Person.find(:one, :from => "/companies/1/manager.xml")
-
-* Add support for setting custom headers per Active Resource model *Rick Olson*
-
- class Project
- headers['X-Token'] = 'foo'
- end
-
- \# makes the GET request with the custom X-Token header
- Project.find(:all)
-
-* Added find-by-path options to ActiveResource::Base.find [David Heinemeier Hansson]. Examples:
-
- employees = Person.find(:all, :from => "/companies/1/people.xml") # => GET /companies/1/people.xml
- manager = Person.find("/companies/1/manager.xml") # => GET /companies/1/manager.xml
-
-
-* Added support for using classes from within a single nested module [David Heinemeier Hansson]. Example:
-
- module Highrise
- class Note < ActiveResource::Base
- self.site = "http://37s.sunrise.i:3000"
- end
-
- class Comment < ActiveResource::Base
- self.site = "http://37s.sunrise.i:3000"
- end
- end
-
- assert_kind_of Highrise::Comment, Note.find(1).comments.first
-
-
-* Added load_attributes_from_response as a way of loading attributes from other responses than just create *David Heinemeier Hansson*
-
- class Highrise::Task < ActiveResource::Base
- def complete
- load_attributes_from_response(post(:complete))
- end
- end
-
- ...will set "done_at" when complete is called.
-
-
-* Added support for calling custom methods #6979 *rwdaigle*
-
- Person.find(:managers) # => GET /people/managers.xml
- Kase.find(1).post(:close) # => POST /kases/1/close.xml
-
-* Remove explicit prefix_options parameter for ActiveResource::Base#initialize. *Rick Olson*
- ActiveResource splits the prefix_options from it automatically.
-
-* Allow ActiveResource::Base.delete with custom prefix. *Rick Olson*
-
-* Add ActiveResource::Base#dup *Rick Olson*
-
-* Fixed constant warning when fetching the same object multiple times *David Heinemeier Hansson*
-
-* Added that saves which get a body response (and not just a 201) will use that response to update themselves *David Heinemeier Hansson*
-
-* Disregard namespaces from the default element name, so Highrise::Person will just try to fetch from "/people", not "/highrise/people" *David Heinemeier Hansson*
-
-* Allow array and hash query parameters. #7756 *Greg Spurrier*
-
-* Loading a resource preserves its prefix_options. #7353 *Ryan Daigle*
-
-* Carry over the convenience of #create from ActiveRecord. Closes #7340. *Ryan Daigle*
-
-* Increase ActiveResource::Base test coverage. Closes #7173, #7174 *Rich Collins*
-
-* Interpret 422 Unprocessable Entity as ResourceInvalid. #7097 *dkubb*
-
-* Mega documentation patches. #7025, #7069 *rwdaigle*
-
-* Base.exists?(id, options) and Base#exists? check whether the resource is found. #6970 *rwdaigle*
-
-* Query string support. *untext, Jeremy Kemper*
- # GET /forums/1/topics.xml?sort=created_at
- Topic.find(:all, :forum_id => 1, :sort => 'created_at')
-
-* Base#==, eql?, and hash methods. == returns true if its argument is identical to self or if it's an instance of the same class, is not new?, and has the same id. eql? is an alias for ==. hash delegates to id. *Jeremy Kemper*
-
-* Allow subclassed resources to share the site info *Rick Olson, Jeremy Kemper*
- d class BeastResource < ActiveResource::Base
- self.site = 'http://beast.caboo.se'
- end
-
- class Forum < BeastResource
- # taken from BeastResource
- # self.site = 'http://beast.caboo.se'
- end
-
- class Topic < BeastResource
- self.site += '/forums/:forum_id'
- end
-
-* Fix issues with ActiveResource collection handling. Closes #6291. *bmilekic*
-
-* Use attr_accessor_with_default to dry up attribute initialization. References #6538. *Stuart Halloway*
-
-* Add basic logging support for logging outgoing requests. *Jamis Buck*
-
-* Add Base.delete for deleting resources without having to instantiate them first. *Jamis Buck*
-
-* Make #save behavior mimic AR::Base#save (true on success, false on failure). *Jamis Buck*
-
-* Add Basic HTTP Authentication to ActiveResource (closes #6305). *jonathan*
-
-* Extracted #id_from_response as an entry point for customizing how a created resource gets its own ID.
- By default, it extracts from the Location response header.
-
-* Optimistic locking: raise ActiveResource::ResourceConflict on 409 Conflict response. *Jeremy Kemper*
-
- # Example controller action
- def update
- @person.save!
- rescue ActiveRecord::StaleObjectError
- render :xml => @person.reload.to_xml, :status => '409 Conflict'
- end
-
-* Basic validation support *Rick Olson*
-
- Parses the xml response of ActiveRecord::Errors#to_xml with a similar interface to ActiveRecord::Errors.
-
- render :xml => @person.errors.to_xml, :status => '400 Validation Error'
-
-* Deep hashes are converted into collections of resources. *Jeremy Kemper*
- Person.new :name => 'Bob',
- :address => { :id => 1, :city => 'Portland' },
- :contacts => [{ :id => 1 }, { :id => 2 }]
- Looks for Address and Contact resources and creates them if unavailable.
- So clients can fetch a complex resource in a single request if you e.g.
- render :xml => @person.to_xml(:include => [:address, :contacts])
- in your controller action.
-
-* Major updates *Rick Olson*
-
- * Add full support for find/create/update/destroy
- * Add support for specifying prefixes.
- * Allow overriding of element_name, collection_name, and primary key
- * Provide simpler HTTP mock interface for testing
-
- # rails routing code
- map.resources :posts do |post|
- post.resources :comments
- end
-
- # ActiveResources
- class Post < ActiveResource::Base
- self.site = "http://37s.sunrise.i:3000/"
- end
-
- class Comment < ActiveResource::Base
- self.site = "http://37s.sunrise.i:3000/posts/:post_id/"
- end
-
- @post = Post.find 5
- @comments = Comment.find :all, :post_id => @post.id
-
- @comment = Comment.new({:body => 'hello world'}, {:post_id => @post.id})
- @comment.save
-
-* Base.site= accepts URIs. 200...400 are valid response codes. PUT and POST request bodies default to ''. *Jeremy Kemper*
-
-* Initial checkin: object-oriented client for restful HTTP resources which follow the Rails convention. *David Heinemeier Hansson*
View
20 activeresource/MIT-LICENSE
@@ -1,20 +0,0 @@
-Copyright (c) 2006-2012 David Heinemeier Hansson
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
189 activeresource/README.rdoc
@@ -1,189 +0,0 @@
-= Active Resource
-
-Active Resource (ARes) connects business objects and Representational State Transfer (REST)
-web services. It implements object-relational mapping for REST web services to provide transparent
-proxying capabilities between a client (ActiveResource) and a RESTful service (which is provided by Simply RESTful routing
-in ActionController::Resources).
-
-== Philosophy
-
-Active Resource attempts to provide a coherent wrapper object-relational mapping for REST
-web services. It follows the same philosophy as Active Record, in that one of its prime aims
-is to reduce the amount of code needed to map to these resources. This is made possible
-by relying on a number of code- and protocol-based conventions that make it easy for Active Resource
-to infer complex relations and structures. These conventions are outlined in detail in the documentation
-for ActiveResource::Base.
-
-== Overview
-
-Model classes are mapped to remote REST resources by Active Resource much the same way Active Record maps model classes to database
-tables. When a request is made to a remote resource, a REST XML request is generated, transmitted, and the result
-received and serialized into a usable Ruby object.
-
-== Download and installation
-
-The latest version of Active Support can be installed with RubyGems:
-
- % [sudo] gem install activeresource
-
-Source code can be downloaded as part of the Rails project on GitHub
-
-* https://github.com/rails/rails/tree/master/activeresource
-
-=== Configuration and Usage
-
-Putting Active Resource to use is very similar to Active Record. It's as simple as creating a model class
-that inherits from ActiveResource::Base and providing a <tt>site</tt> class variable to it:
-
- class Person < ActiveResource::Base
- self.site = "http://api.people.com:3000"
- end
-
-Now the Person class is REST enabled and can invoke REST services very similarly to how Active Record invokes
-life cycle methods that operate against a persistent store.
-
- # Find a person with id = 1
- ryan = Person.find(1)
- Person.exists?(1) # => true
-
-As you can see, the methods are quite similar to Active Record's methods for dealing with database
-records. But rather than dealing directly with a database record, you're dealing with HTTP resources (which may or may not be database records).
-
-==== Protocol
-
-Active Resource is built on a standard XML format for requesting and submitting resources over HTTP. It mirrors the RESTful routing
-built into Action Controller but will also work with any other REST service that properly implements the protocol.
-REST uses HTTP, but unlike "typical" web applications, it makes use of all the verbs available in the HTTP specification:
-
-* GET requests are used for finding and retrieving resources.
-* POST requests are used to create new resources.
-* PUT requests are used to update existing resources.
-* DELETE requests are used to delete resources.
-
-For more information on how this protocol works with Active Resource, see the ActiveResource::Base documentation;
-for more general information on REST web services, see the article here[http://en.wikipedia.org/wiki/Representational_State_Transfer].
-
-==== Find
-
-Find requests use the GET method and expect the XML form of whatever resource/resources is/are being requested. So,
-for a request for a single element, the XML of that item is expected in response:
-
- # Expects a response of
- #
- # <person><id type="integer">1</id><attribute1>value1</attribute1><attribute2>..</attribute2></person>
- #
- # for GET http://api.people.com:3000/people/1.xml
- #
- ryan = Person.find(1)
-
-The XML document that is received is used to build a new object of type Person, with each
-XML element becoming an attribute on the object.
-
- ryan.is_a? Person # => true
- ryan.attribute1 # => 'value1'
-
-Any complex element (one that contains other elements) becomes its own object:
-
- # With this response:
- #
- # <person><id>1</id><attribute1>value1</attribute1><complex><attribute2>value2</attribute2></complex></person>
- #
- # for GET http://api.people.com:3000/people/1.xml
- #
- ryan = Person.find(1)
- ryan.complex # => <Person::Complex::xxxxx>
- ryan.complex.attribute2 # => 'value2'
-
-Collections can also be requested in a similar fashion
-
- # Expects a response of
- #
- # <people type="array">
- # <person><id type="integer">1</id><first>Ryan</first></person>
- # <person><id type="integer">2</id><first>Jim</first></person>
- # </people>
- #
- # for GET http://api.people.com:3000/people.xml
- #
- people = Person.all
- people.first # => <Person::xxx 'first' => 'Ryan' ...>
- people.last # => <Person::xxx 'first' => 'Jim' ...>
-
-==== Create
-
-Creating a new resource submits the XML form of the resource as the body of the request and expects
-a 'Location' header in the response with the RESTful URL location of the newly created resource. The
-id of the newly created resource is parsed out of the Location response header and automatically set
-as the id of the ARes object.
-
- # <person><first>Ryan</first></person>
- #
- # is submitted as the body on
- #
- # POST http://api.people.com:3000/people.xml
- #
- # when save is called on a new Person object. An empty response is
- # is expected with a 'Location' header value:
- #
- # Response (201): Location: http://api.people.com:3000/people/2
- #
- ryan = Person.new(:first => 'Ryan')
- ryan.new? # => true
- ryan.save # => true
- ryan.new? # => false
- ryan.id # => 2
-
-==== Update
-
-'save' is also used to update an existing resource and follows the same protocol as creating a resource
-with the exception that no response headers are needed -- just an empty response when the update on the
-server side was successful.
-
- # <person><first>Ryan</first></person>
- #
- # is submitted as the body on
- #
- # PUT http://api.people.com:3000/people/1.xml
- #
- # when save is called on an existing Person object. An empty response is
- # is expected with code (204)
- #
- ryan = Person.find(1)
- ryan.first # => 'Ryan'
- ryan.first = 'Rizzle'
- ryan.save # => true
-
-==== Delete
-
-Destruction of a resource can be invoked as a class and instance method of the resource.
-
- # A request is made to
- #
- # DELETE http://api.people.com:3000/people/1.xml
- #
- # for both of these forms. An empty response with
- # is expected with response code (200)
- #
- ryan = Person.find(1)
- ryan.destroy # => true
- ryan.exists? # => false
- Person.delete(2) # => true
- Person.exists?(2) # => false
-
-== License
-
-Active Support is released under the MIT license:
-
-* http://www.opensource.org/licenses/MIT
-
-== Support
-
-API documentation is at
-
-* http://api.rubyonrails.org
-
-Bug reports and feature requests can be filed with the rest for the Ruby on Rails project here:
-
-* https://github.com/rails/rails/issues
-
-You can find more usage information in the ActiveResource::Base documentation.
View
66 activeresource/Rakefile
@@ -1,66 +0,0 @@
-#!/usr/bin/env rake
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rubygems/package_task'
-
-desc "Default Task"
-task :default => [ :test ]
-
-# Run the unit tests
-
-Rake::TestTask.new { |t|
- t.libs << "test"
- t.pattern = 'test/**/*_test.rb'
- t.warning = true
- t.verbose = true
-}
-
-namespace :test do
- task :isolated do
- ruby = File.join(*RbConfig::CONFIG.values_at('bindir', 'RUBY_INSTALL_NAME'))
- activesupport_path = "#{File.dirname(__FILE__)}/../activesupport/lib"
- Dir.glob("test/**/*_test.rb").all? do |file|
- sh(ruby, '-w', "-Ilib:test:#{activesupport_path}", file)
- end or raise "Failures"
- end
-end
-
-spec = eval(File.read('activeresource.gemspec'))
-
-Gem::PackageTask.new(spec) do |p|
- p.gem_spec = spec
-end
-
-task :lines do
- lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
-
- FileList["lib/active_resource/**/*.rb"].each do |file_name|
- next if file_name =~ /vendor/
- f = File.open(file_name)
-
- while line = f.gets
- lines += 1
- next if line =~ /^\s*$/
- next if line =~ /^\s*#/
- codelines += 1
- end
- puts "L: #{sprintf("%4d", lines)}, LOC #{sprintf("%4d", codelines)} | #{file_name}"
-
- total_lines += lines
- total_codelines += codelines
-
- lines, codelines = 0, 0
- end
-
- puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
-end
-
-
-# Publishing ------------------------------------------------------
-
-desc "Release to gemcutter"
-task :release => :package do
- require 'rake/gemcutter'
- Rake::Gemcutter::Tasks.new(spec).define
- Rake::Task['gem:push'].invoke
-end
View
24 activeresource/activeresource.gemspec
@@ -1,24 +0,0 @@
-version = File.read(File.expand_path("../../RAILS_VERSION", __FILE__)).strip
-
-Gem::Specification.new do |s|
- s.platform = Gem::Platform::RUBY
- s.name = 'activeresource'
- s.version = version
- s.summary = 'REST modeling framework (part of Rails).'
- s.description = 'REST on Rails. Wrap your RESTful web app with Ruby classes and work with them like Active Record models.'
-
- s.required_ruby_version = '>= 1.9.3'
-
- s.author = 'David Heinemeier Hansson'
- s.email = 'david@loudthinking.com'
- s.homepage = 'http://www.rubyonrails.org'
-
- s.files = Dir['CHANGELOG.md', 'MIT-LICENSE', 'README.rdoc', 'examples/**/*', 'lib/**/*']
- s.require_path = 'lib'
-
- s.extra_rdoc_files = %w( README.rdoc )
- s.rdoc_options.concat ['--main', 'README.rdoc']
-
- s.add_dependency('activesupport', version)
- s.add_dependency('activemodel', version)
-end
View
70 activeresource/examples/performance.rb
@@ -1,70 +0,0 @@
-require 'rubygems'
-require 'active_resource'
-require 'benchmark'
-
-TIMES = (ENV['N'] || 10_000).to_i
-
-# deep nested resource
-attrs = {
- :id => 1,
- :name => 'Luis',
- :age => 21,
- :friends => [
- {
- :name => 'JK',
- :age => 24,
- :colors => ['red', 'green', 'blue'],
- :brothers => [
- {
- :name => 'Mateo',
- :age => 35,
- :children => [{ :name => 'Edith', :age => 5 }, { :name => 'Martha', :age => 4 }]
- },
- {
- :name => 'Felipe',
- :age => 33,
- :children => [{ :name => 'Bryan', :age => 1 }, { :name => 'Luke', :age => 0 }]
- }
- ]
- },
- {
- :name => 'Eduardo',
- :age => 20,
- :colors => [],
- :brothers => [
- {
- :name => 'Sebas',
- :age => 23,
- :children => [{ :name => 'Andres', :age => 0 }, { :name => 'Jorge', :age => 2 }]
- },
- {
- :name => 'Elsa',
- :age => 19,
- :children => [{ :name => 'Natacha', :age => 1 }]
- },
- {
- :name => 'Milena',
- :age => 16,
- :children => []
- }
- ]
- }
- ]
-}
-
-class Customer < ActiveResource::Base
- self.site = "http://37s.sunrise.i:3000"
-end
-
-module Nested
- class Customer < ActiveResource::Base
- self.site = "http://37s.sunrise.i:3000"
- end
-end
-
-Benchmark.bm(40) do |x|
- x.report('Model.new (instantiation)') { TIMES.times { Customer.new } }
- x.report('Nested::Model.new (instantiation)') { TIMES.times { Nested::Customer.new } }
- x.report('Model.new (setting attributes)') { TIMES.times { Customer.new attrs } }
- x.report('Nested::Model.new (setting attributes)') { TIMES.times { Nested::Customer.new attrs } }
-end
View
45 activeresource/lib/active_resource.rb
@@ -1,45 +0,0 @@
-#--
-# Copyright (c) 2006-2012 David Heinemeier Hansson
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
-activesupport_path = File.expand_path('../../../activesupport/lib', __FILE__)
-$:.unshift(activesupport_path) if File.directory?(activesupport_path) && !$:.include?(activesupport_path)
-
-activemodel_path = File.expand_path('../../../activemodel/lib', __FILE__)
-$:.unshift(activemodel_path) if File.directory?(activemodel_path) && !$:.include?(activemodel_path)
-
-require 'active_support'
-require 'active_model'
-require 'active_resource/version'
-
-module ActiveResource
- extend ActiveSupport::Autoload
-
- autoload :Base
- autoload :Connection
- autoload :CustomMethods
- autoload :Formats
- autoload :HttpMock
- autoload :Observing
- autoload :Schema
- autoload :Validations
-end
View
1,515 activeresource/lib/active_resource/base.rb
@@ -1,1515 +0,0 @@
-require 'active_support'
-require 'active_support/core_ext/class/attribute_accessors'
-require 'active_support/core_ext/class/attribute'
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/kernel/reporting'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/core_ext/module/aliasing'
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/object/to_query'
-require 'active_support/core_ext/object/duplicable'
-require 'set'
-require 'uri'
-
-require 'active_support/core_ext/uri'
-require 'active_resource/exceptions'
-require 'active_resource/connection'
-require 'active_resource/formats'
-require 'active_resource/schema'
-require 'active_resource/log_subscriber'
-
-module ActiveResource
- # 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}[link:files/activeresource/README_rdoc.html].
- #
- # == 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 <tt>https://api.people.com/people/</tt>, 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:password@proxy.people.com: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 <tt>get</tt>,
- # <tt>post</tt>, <tt>put</tt> and <tt>\delete</tt> 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 crytographic 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.
- #
- # (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 authentication,
- # set +auth_type+ to +:digest+:
- #
- # 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:password@api.people.com"
- # end
- #
- # === Certificate Authentication
- #
- # You can also authenticate using an X509 certificate. <tt>See ssl_options=</tt> for all options.
- #
- # class Person < ActiveResource::Base
- # self.site = "https://secure.api.people.com/"
- #
- # File.open(pem_file_path, 'rb') do |pem_file|
- # self.ssl_options = {
- # 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 <tt>404</tt> (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
- #
- #
- # <tt>404</tt> 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 = "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 <tt>422</tt> and an XML or JSON representation of the validation errors. The save operation will
- # then fail (with a <tt>false</tt> 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.full_messages # => ['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
- # http://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 <tt>read_timeout</tt> of the internal Net::HTTP instance to the same value. The default
- # <tt>read_timeout</tt> is 60 seconds on most Ruby implementations.
- class Base
- ##
- # :singleton-method:
- # The logger for diagnosing and tracing Active Resource calls.
- cattr_accessor :logger
-
- class_attribute :_format
-
- class << self
- # 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 <tt>known_attributes</tt> of the
- # current resource.
- #
- # There is no need to specify a schema for your Active Resource. If
- # you do not, the <tt>known_attributes</tt> 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, 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!
- #
- 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
-
- # Alternative, direct way to specify a <tt>schema</tt> for this
- # Resource. <tt>schema</tt> 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 <tt>schema</tt>)
- #
- # 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.
- #
- 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
-
- # Returns the list of known attributes for this resource, gathered
- # from the provided <tt>schema</tt>
- # Attributes that are known will cause your resource to return 'true'
- # when <tt>respond_to?</tt> is called on them. A known attribute will
- # return nil if not set (rather than <t>MethodNotFound</tt>); thus
- # known attributes can be used with <tt>validates_presence_of</tt>
- # without a getter-method.
- def known_attributes
- @known_attributes ||= []
- 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.
- def site
- # Not using superclass_delegating_reader because don't want subclasses to modify superclass instance
- #
- # With superclass_delegating_reader
- #
- # Parent.site = 'https://anonymous@test.com'
- # Subclass.site # => 'https://anonymous@test.com'
- # Subclass.site.user = 'david'
- # Parent.site # => 'https://david@test.com'
- #
- # Without superclass_delegating_reader (expected behavior)
- #
- # Parent.site = 'https://anonymous@test.com'
- # Subclass.site # => 'https://anonymous@test.com'
- # Subclass.site.user = 'david' # => TypeError: can't modify frozen object
- #
- if defined?(@site)
- @site
- elsif superclass != Object && superclass.site
- superclass.site.dup.freeze
- end
- 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.
- def site=(site)
- @connection = nil
- if site.nil?
- @site = nil
- else
- @site = create_site_uri_from(site)
- @user = URI.parser.unescape(@site.user) if @site.user
- @password = URI.parser.unescape(@site.password) if @site.password
- end
- end
-
- # Gets the \proxy variable if a proxy is required
- def proxy
- # Not using superclass_delegating_reader. See +site+ for explanation
- if defined?(@proxy)
- @proxy
- elsif superclass != Object && superclass.proxy
- superclass.proxy.dup.freeze
- end
- end
-
- # Sets the URI of the http proxy to the value in the +proxy+ argument.
- def proxy=(proxy)
- @connection = nil
- @proxy = proxy.nil? ? nil : create_proxy_uri_from(proxy)
- end
-
- # Gets the \user for REST HTTP authentication.
- def user
- # Not using superclass_delegating_reader. See +site+ for explanation
- if defined?(@user)
- @user
- elsif superclass != Object && superclass.user
- superclass.user.dup.freeze
- end
- end
-
- # Sets the \user for REST HTTP authentication.
- def user=(user)
- @connection = nil
- @user = user
- end
-
- # Gets the \password for REST HTTP authentication.
- def password
- # Not using superclass_delegating_reader. See +site+ for explanation
- if defined?(@password)
- @password
- elsif superclass != Object && superclass.password
- superclass.password.dup.freeze
- end
- end
-
- # Sets the \password for REST HTTP authentication.
- def password=(password)
- @connection = nil
- @password = password
- end
-
- def auth_type
- if defined?(@auth_type)
- @auth_type
- end
- end
-
- def auth_type=(auth_type)
- @connection = nil
- @auth_type = auth_type
- 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 <tt>:json</tt>.
- 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
-
- # Returns the current format, default is ActiveResource::Formats::JsonFormat.
- def format
- self._format || ActiveResource::Formats::JsonFormat
- end
-
- # Sets the number of seconds after which requests to the REST API should time out.
- def timeout=(timeout)
- @connection = nil
- @timeout = timeout
- end
-
- # Gets the number of seconds after which requests to the REST API should time out.
- def timeout
- if defined?(@timeout)
- @timeout
- elsif superclass != Object && superclass.timeout
- superclass.timeout
- end
- end
-
- # Options that will get applied to an SSL connection.
- #
- # * <tt>:key</tt> - An OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
- # * <tt>:cert</tt> - An OpenSSL::X509::Certificate object as client certificate
- # * <tt>:ca_file</tt> - Path to a CA certification file in PEM format. The file can contain several CA certificates.
- # * <tt>:ca_path</tt> - Path of a CA certification directory containing certifications in PEM format.
- # * <tt>:verify_mode</tt> - Flags for server the certification verification at beginning of SSL/TLS session. (OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER is acceptable)
- # * <tt>:verify_callback</tt> - The verify callback for the server certification verification.
- # * <tt>:verify_depth</tt> - The maximum depth for the certificate chain verification.
- # * <tt>:cert_store</tt> - OpenSSL::X509::Store to verify peer certificate.
- # * <tt>:ssl_timeout</tt> -The SSL timeout in seconds.
- def ssl_options=(opts={})
- @connection = nil
- @ssl_options = opts
- end
-
- # Returns the SSL options hash.
- def ssl_options
- if defined?(@ssl_options)
- @ssl_options
- elsif superclass != Object && superclass.ssl_options
- superclass.ssl_options
- end
- 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 <tt>false</tt>).
- def connection(refresh = false)
- if defined?(@connection) || superclass == Object
- @connection = Connection.new(site, format) if refresh || @connection.nil?
- @connection.proxy = proxy if proxy
- @connection.user = user if user
- @connection.password = password if password
- @connection.auth_type = auth_type if auth_type
- @connection.timeout = timeout if timeout
- @connection.ssl_options = ssl_options if ssl_options
- @connection
- else
- superclass.connection
- end
- end
-
- def headers
- @headers ||= {}
-
- if superclass != Object && superclass.headers
- @headers = superclass.headers.merge(@headers)
- else
- @headers
- end
- end
-
- attr_writer :element_name
-
- def element_name
- @element_name ||= model_name.element
- end
-
- attr_writer :collection_name
-
- def collection_name
- @collection_name ||= ActiveSupport::Inflector.pluralize(element_name)
- end
-
- attr_writer :primary_key
-
- def primary_key
- @primary_key ||= 'id'
- end
-
- # Gets the \prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.json</tt>)
- # This method is regenerated at runtime based on what the \prefix is set to.
- def prefix(options={})
- default = site.path
- default << '/' unless default[-1..-1] == '/'
- # generate the actual method based on the current site path
- self.prefix = default
- prefix(options)
- 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.
- def prefix_source
- prefix # generate #prefix and #prefix_source methods first
- prefix_source
- end
-
- # Sets the \prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.json</tt>).
- # Default value is <tt>site.path</tt>.
- def prefix=(value = '/')
- # Replace :placeholders with '#{embedded options[:lookups]}'
- prefix_call = value.gsub(/:\w+/) { |key| "\#{URI.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
-
- alias_method :set_prefix, :prefix= #:nodoc:
-
- alias_method :set_element_name, :element_name= #:nodoc:
- alias_method :set_collection_name, :collection_name= #:nodoc:
-
- # 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., <tt>:account_id => 19</tt>
- # 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.
- #
- # ==== 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
- #
- def element_path(id, prefix_options = {}, query_options = nil)
- check_prefix_options(prefix_options)
-
- prefix_options, query_options = split_options(prefix_options) if query_options.nil?
- "#{prefix(prefix_options)}#{collection_name}/#{URI.parser.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
- end
-
- # 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., <tt>:account_id => 19</tt>
- # would yield a URL like <tt>/accounts/19/purchases/new.json</tt>).
- #
- # ==== 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
- def new_element_path(prefix_options = {})
- "#{prefix(prefix_options)}#{collection_name}/new.#{format.extension}"
- end
-
- # 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., <tt>:account_id => 19</tt>
- # 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.
- #
- # ==== 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
- #
- def collection_path(prefix_options = {}, query_options = nil)
- check_prefix_options(prefix_options)
- prefix_options, query_options = split_options(prefix_options) if query_options.nil?
- "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
- end
-
- alias_method :set_primary_key, :primary_key= #:nodoc:
-
- # 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.
- #
- def build(attributes = {})
- attrs = self.format.decode(connection.get("#{new_element_path}").body).merge(attributes)
- self.new(attrs)
- 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 <tt>save</tt>). If the resource is invalid and
- # has not been saved then <tt>valid?</tt> will return <tt>false</tt>,
- # while <tt>new?</tt> will still return <tt>true</tt>.
- #
- # ==== Examples
- # 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
- def create(attributes = {})
- self.new(attributes).tap { |resource| resource.save }
- end
-
- # 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.
- #
- # * <tt>:one</tt> - Returns a single resource.
- # * <tt>:first</tt> - Returns the first resource found.
- # * <tt>:last</tt> - Returns the last resource found.
- # * <tt>:all</tt> - Returns every resource that matches the request.
- #
- # ==== Options
- #
- # * <tt>:from</tt> - Sets the path or custom method that resources will be fetched from.
- # * <tt>:params</tt> - 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
- def find(*arguments)
- scope = arguments.slice!(0)
- options = arguments.slice!(0) || {}
-
- case scope
- when :all then find_every(options)
- when :first then find_every(options).first
- when :last then find_every(options).last
- when :one then find_one(options)
- else find_single(scope, options)
- end
- end
-
-
- # A convenience wrapper for <tt>find(:first, *args)</tt>. You can pass
- # in all the same arguments to this method as you can to
- # <tt>find(:first)</tt>.
- def first(*args)
- find(:first, *args)
- end
-
- # A convenience wrapper for <tt>find(:last, *args)</tt>. You can pass
- # in all the same arguments to this method as you can to
- # <tt>find(:last)</tt>.
- def last(*args)
- find(:last, *args)
- end
-
- # This is an alias for find(:all). You can pass in all the same
- # arguments to this method as you can to <tt>find(:all)</tt>
- def all(*args)
- find(:all, *args)
- end
-
-
- # 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
- def delete(id, options = {})
- connection.delete(element_path(id, options))
- end
-
- # Asserts the existence of a resource, returning <tt>true</tt> if the resource is found.
- #
- # ==== Examples
- # Note.create(:title => 'Hello, world.', :body => 'Nothing more for now...')
- # Note.exists?(1) # => true
- #
- # Note.exists(1349) # => false
- def exists?(id, options = {})
- if id
- prefix_options, query_options = split_options(options[:params])
- path = element_path(id, prefix_options, query_options)
- response = connection.head(path, headers)
- response.code.to_i == 200
- end
- # id && !find_single(id, options).nil?
- rescue ActiveResource::ResourceNotFound, ActiveResource::ResourceGone
- false
- end
-
- private
-
- def check_prefix_options(prefix_options)
- p_options = HashWithIndifferentAccess.new(prefix_options)
- prefix_parameters.each do |p|
- raise(MissingPrefixParam, "#{p} prefix_option is missing") if p_options[p].blank?
- end
- end
-
- # Find every resource
- def find_every(options)
- begin
- case from = options[:from]
- when Symbol
- instantiate_collection(get(from, options[:params]))
- when String
- path = "#{from}#{query_string(options[:params])}"
- instantiate_collection(format.decode(connection.get(path, headers).body) || [])
- else
- prefix_options, query_options = split_options(options[:params])
- path = collection_path(prefix_options, query_options)
- instantiate_collection( (format.decode(connection.get(path, headers).body) || []), prefix_options )
- end
- rescue ActiveResource::ResourceNotFound
- # Swallowing ResourceNotFound exceptions and return nil - as per
- # ActiveRecord.
- nil
- end
- end
-
- # Find a single resource from a one-off URL
- def find_one(options)
- case from = options[:from]
- when Symbol
- instantiate_record(get(from, options[:params]))
- when String
- path = "#{from}#{query_string(options[:params])}"
- instantiate_record(format.decode(connection.get(path, headers).body))
- end
- end
-
- # Find a single resource from the default URL
- def find_single(scope, options)
- prefix_options, query_options = split_options(options[:params])
- path = element_path(scope, prefix_options, query_options)
- instantiate_record(format.decode(connection.get(path, headers).body), prefix_options)
- end
-
- def instantiate_collection(collection, prefix_options = {})
- collection.collect! { |record| instantiate_record(record, prefix_options) }
- end
-
- def instantiate_record(record, prefix_options = {})
- new(record, true).tap do |resource|
- resource.prefix_options = prefix_options
- end
- end
-
-
- # Accepts a URI and creates the site URI from that.
- def create_site_uri_from(site)
- site.is_a?(URI) ? site.dup : URI.parse(site)
- end
-
- # Accepts a URI and creates the proxy URI from that.
- def create_proxy_uri_from(proxy)
- proxy.is_a?(URI) ? proxy.dup : URI.parse(proxy)
- end
-
- # contains a set of the current prefix parameters.
- def prefix_parameters
- @prefix_parameters ||= prefix_source.scan(/:\w+/).map { |key| key[1..-1].to_sym }.to_set
- end
-
- # Builds the query string for the request.
- def query_string(options)
- "?#{options.to_query}" unless options.nil? || options.empty?
- end
-
- # split an option hash into two hashes, one containing the prefix options,
- # and the other containing the leftovers.
- def split_options(options = {})
- prefix_options, query_options = {}, {}
-
- (options || {}).each do |key, value|
- next if key.blank? || !key.respond_to?(:to_sym)
- (prefix_parameters.include?(key.to_sym) ? prefix_options : query_options)[key.to_sym] = value
- end
-
- [ prefix_options, query_options ]
- end
- end
-
- attr_accessor :attributes #:nodoc:
- attr_accessor :prefix_options #:nodoc:
-
- # If no schema has been defined for the class (see
- # <tt>ActiveResource::schema=</tt>), the default automatic schema is
- # generated from the current instance's attributes
- def schema
- self.class.schema || self.attributes
- end
-
- # This is a list of known attributes for this resource. Either
- # gathered from the provided <tt>schema</tt>, or from the attributes
- # set on this instance after it has been fetched from the remote system.
- def known_attributes
- self.class.known_attributes + self.attributes.keys.map(&:to_s)
- end
-
-
- # 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
- def initialize(attributes = {}, persisted = false)
- @attributes = {}.with_indifferent_access
- @prefix_options = {}
- @persisted = persisted
- load(attributes)
- 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"}
- def clone
- # Clone all attributes except the pk and any nested ARes
- cloned = Hash[attributes.reject {|k,v| k == self.class.primary_key || v.is_a?(ActiveResource::Base)}.map { |k, v| [k, 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.prefix_options = self.prefix_options
- resource.send :instance_variable_set, '@attributes', cloned
- resource
- end
-
-
- # 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
- #
- def new?
- !persisted?
- end
- alias :new_record? :new?
-
- # 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
- #
- def persisted?
- @persisted
- end
-
- # Gets the <tt>\id</tt> attribute of the resource.
- def id
- attributes[self.class.primary_key]
- end
-
- # Sets the <tt>\id</tt> attribute of the resource.
- def id=(id)
- attributes[self.class.primary_key] = id
- 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 <tt>new?</tt>, 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
- #
- def ==(other)
- other.equal?(self) || (other.instance_of?(self.class) && other.id == id && other.prefix_options == prefix_options)
- end
-
- # Tests for equality (delegates to ==).
- def eql?(other)
- self == other
- 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]
- def hash
- id.hash
- end
-
- # 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
- def dup
- self.class.new.tap do |resource|
- resource.attributes = @attributes
- resource.prefix_options = @prefix_options
- end
- end
-
- # 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)
- def save
- new? ? create : update
- end
-
- # Saves the resource.
- #
- # If the resource is new, it is created via +POST+, otherwise the
- # existing resource is updated via +PUT+.
- #
- # With <tt>save!</tt> 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 <tt>save!</tt>. If any
- # of the <tt>before_*</tt> callbacks return +false+ the action is
- # cancelled and <tt>save!</tt> raises ActiveResource::ResourceInvalid.
- def save!
- save || raise(ResourceInvalid.new(self))
- end
-
- # 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)
- def destroy
- connection.delete(element_path, self.class.headers)
- end
-
- # Evaluates to <tt>true</tt> if this resource is not <tt>new?</tt> 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
- def exists?
- !new? && self.class.exists?(to_param, :params => prefix_options)
- 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.
- def encode(options={})
- send("to_#{self.class.format.extension}", options)
- end
-
- # 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"
- def reload
- self.load(self.class.find(to_param, :params => @prefix_options).attributes)
- 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.
- #
- # ==== 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
- def load(attributes, remove_root = false)
- raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
- @prefix_options, attributes = split_options(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)
- else
- attrs.duplicable? ? attrs.dup : attrs
- end
- end
- when Hash
- resource = find_or_create_resource_for(key)
- resource.new(value)
- else
- value.duplicable? ? value.dup : value
- end
- end
- self
- end
-
- # Updates a single attribute and then saves the object.
- #
- # Note: Unlike ActiveRecord::Base.update_attribute, this method <b>is</b>
- # 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 <tt>false</tt> will be returned.
- def update_attribute(name, value)
- self.send("#{name}=".to_sym, value)
- self.save
- 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 <tt>false</tt> 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.
- def update_attributes(attributes)
- load(attributes, false) && save
- end
-
- # For checking <tt>respond_to?</tt> without searching the attributes (which is faster).
- alias_method :respond_to_without_attributes?, :respond_to?
-
- # 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 <tt>true</tt> to <tt>my_person.respond_to?(:name)</tt>, <tt>my_person.respond_to?(:name=)</tt>, and
- # <tt>my_person.respond_to?(:name?)</tt>.
- def respond_to?(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
-
- def to_json(options={})
- super({ :root => self.class.element_name }.merge(options))
- end
-
- def to_xml(options={})
- super({ :root => self.class.element_name }.merge(options))
- end
-
- protected
- def connection(refresh = false)
- self.class.connection(refresh)
- end
-
- # Update the resource on the remote service.
- def update
- connection.put(element_path(prefix_options), encode, self.class.headers).tap do |response|
- load_attributes_from_response(response)
- end
- end
-
- # Create (i.e., \save to the remote service) the \new resource.
- def create
- connection.post(collection_path, encode, self.class.headers).tap do |response|
- self.id = id_from_response(response)
- load_attributes_from_response(response)
- end
- end
-
- def load_attributes_from_response(response)
- if (response_code_allows_body?(response.code) &&
- (response['Content-Length'].nil? || response['Content-Length'] != "0") &&
- !response.body.nil? && response.body.strip.size > 0)
- load(self.class.format.decode(response.body), true)
- @persisted = true
- end
- end
-
- # Takes a response from a typical create post and pulls the ID out
- def id_from_response(response)
- response['Location'][/\/([^\/]*?)(\.\w+)?$/, 1] if response['Location']
- end
-
- def element_path(options = nil)
- self.class.element_path(to_param, options || prefix_options)
- end
-
- def new_element_path
- self.class.new_element_path(prefix_options)
- end
-
- def collection_path(options = nil)
- self.class.collection_path(options || prefix_options)
- end
-
- private
-
- def read_attribute_for_serialization(n)
- attributes[n]
- end
-
- # Determine whether the response is allowed to have a body per HTTP 1.1 spec section 4.4.1
- def response_code_allows_body?(c)
- !((100..199).include?(c) || [204,304].include?(c))
- end
-
- # Tries to find a resource for a given collection name; if it fails, then the resource is created
- def find_or_create_resource_for_collection(name)
- find_or_create_resource_for(ActiveSupport::Inflector.singularize(name.to_s))
- end
-
- # Tries to find a resource in a non empty list of nested modules
- # if it fails, then the resource is created
- def find_or_create_resource_in_modules(resource_name, module_names)
- receiver = Object
- namespaces = module_names[0, module_names.size-1].map do |module_name|
- receiver = receiver.const_get(module_name)
- end
- const_args = [resource_name, false]
- if namespace = namespaces.reverse.detect { |ns| ns.const_defined?(*const_args) }
- namespace.const_get(*const_args)
- else
- create_resource_for(resource_name)
- end
- end
-
- # Tries to find a resource for a given name; if it fails, then the resource is created
- def find_or_create_resource_for(name)
- resource_name = name.to_s.camelize
-
- const_args = [resource_name, false]
- if self.class.const_defined?(*const_args)
- self.class.const_get(*const_args)
- else
- ancestors = self.class.name.split("::")
- if ancestors.size > 1
- find_or_create_resource_in_modules(resource_name, ancestors)
- else
- if Object.const_defined?(*const_args)
- Object.const_get(*const_args)
- else
- create_resource_for(resource_name)
- end