diff options
Diffstat (limited to 'activeresource/lib/active_resource/custom_methods.rb')
| -rw-r--r-- | activeresource/lib/active_resource/custom_methods.rb | 96 |
1 files changed, 55 insertions, 41 deletions
diff --git a/activeresource/lib/active_resource/custom_methods.rb b/activeresource/lib/active_resource/custom_methods.rb index e08c664307..4f5697fcf1 100644 --- a/activeresource/lib/active_resource/custom_methods.rb +++ b/activeresource/lib/active_resource/custom_methods.rb @@ -1,59 +1,73 @@ -# A module to support custom REST methods and sub-resources, allowing you to break out -# of the "default" REST methods with your own custom resource requests. For example, -# say you use Rails to expose a REST service and configure your routes with: -# -# map.resources :people, :new => { :register => :post }, -# :element => { :promote => :put, :deactivate => :delete } -# :collection => { :active => :get } -# -# This route set creates routes for the following http requests: -# -# POST /people/new/register.xml #=> PeopleController.register -# PUT /people/1/promote.xml #=> PeopleController.promote with :id => 1 -# DELETE /people/1/deactivate.xml #=> PeopleController.deactivate with :id => 1 -# GET /people/active.xml #=> PeopleController.active -# -# Using this module, Active Resource can use these custom REST methods just like the -# standard methods. -# -# class Person < ActiveResource::Base -# self.site = "http://37s.sunrise.i:3000" -# end -# -# Person.new(:name => 'Ryan).post(:register) # POST /people/new/register.xml -# # => { :id => 1, :name => 'Ryan' } -# -# Person.find(1).put(:promote, :position => 'Manager') # PUT /people/1/promote.xml -# Person.find(1).delete(:deactivate) # DELETE /people/1/deactivate.xml -# -# Person.get(:active) # GET /people/active.xml -# # => [{:id => 1, :name => 'Ryan'}, {:id => 2, :name => 'Joe'}] -# module ActiveResource + # A module to support custom REST methods and sub-resources, allowing you to break out + # of the "default" REST methods with your own custom resource requests. For example, + # say you use Rails to expose a REST service and configure your routes with: + # + # map.resources :people, :new => { :register => :post }, + # :element => { :promote => :put, :deactivate => :delete } + # :collection => { :active => :get } + # + # This route set creates routes for the following http requests: + # + # POST /people/new/register.xml #=> PeopleController.register + # PUT /people/1/promote.xml #=> PeopleController.promote with :id => 1 + # DELETE /people/1/deactivate.xml #=> PeopleController.deactivate with :id => 1 + # GET /people/active.xml #=> PeopleController.active + # + # Using this module, Active Resource can use these custom REST methods just like the + # standard methods. + # + # class Person < ActiveResource::Base + # self.site = "http://37s.sunrise.i:3000" + # end + # + # Person.new(:name => 'Ryan).post(:register) # POST /people/new/register.xml + # # => { :id => 1, :name => 'Ryan' } + # + # Person.find(1).put(:promote, :position => 'Manager') # PUT /people/1/promote.xml + # Person.find(1).delete(:deactivate) # DELETE /people/1/deactivate.xml + # + # Person.get(:active) # GET /people/active.xml + # # => [{:id => 1, :name => 'Ryan'}, {:id => 2, :name => 'Joe'}] + # module CustomMethods - def self.included(within) - within.class_eval do + def self.included(base) + base.class_eval do extend ActiveResource::CustomMethods::ClassMethods include ActiveResource::CustomMethods::InstanceMethods class << self alias :orig_delete :delete - def get(method_name, options = {}) - connection.get(custom_method_collection_url(method_name, options), headers) + # Invokes a GET to a given custom REST method. For example: + # + # Person.get(:active) # GET /people/active.xml + # # => [{:id => 1, :name => 'Ryan'}, {:id => 2, :name => 'Joe'}] + # + # Person.get(:active, :awesome => true) # GET /people/active.xml?awesome=true + # # => [{:id => 1, :name => 'Ryan'}] + # + # Note: the objects returned from this method are not automatically converted + # into ActiveResource instances - they are ordinary Hashes. If you are expecting + # ActiveResource instances, use the <tt>find</tt> class method with the + # <tt>:from</tt> option. For example: + # + # Person.find(:all, :from => :active) + def get(custom_method_name, options = {}) + connection.get(custom_method_collection_url(custom_method_name, options), headers) end - def post(method_name, options = {}, body = '') - connection.post(custom_method_collection_url(method_name, options), body, headers) + def post(custom_method_name, options = {}, body = '') + connection.post(custom_method_collection_url(custom_method_name, options), body, headers) end - def put(method_name, options = {}, body = '') - connection.put(custom_method_collection_url(method_name, options), body, headers) + def put(custom_method_name, options = {}, body = '') + connection.put(custom_method_collection_url(custom_method_name, options), body, headers) end - # Need to jump through some hoops to retain the original class 'delete' method def delete(custom_method_name, options = {}) - if (custom_method_name.is_a?(Symbol)) + # Need to jump through some hoops to retain the original class 'delete' method + if custom_method_name.is_a?(Symbol) connection.delete(custom_method_collection_url(custom_method_name, options), headers) else orig_delete(custom_method_name, options) |