Module: ApiResource::CustomMethods

Extended by:
ActiveSupport::Concern
Defined in:
lib/api_resource/custom_methods.rb

Overview

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 }, :member => { :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 # => [=> 1, :name => 'Ryan', => 2, :name => 'Joe']

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#delete(method_name, options = {}) ⇒ Object 



103
104
105
 
# File 'lib/api_resource/custom_methods.rb', line 103

def delete(method_name, options = {})
  connection.delete(custom_method_element_url(method_name, options), self.class.headers)
end

#get(method_name, options = {}) ⇒ Object 



86
87
88
 
# File 'lib/api_resource/custom_methods.rb', line 86

def get(method_name, options = {})
  connection.get(custom_method_element_url(method_name, options), self.class.headers)
end

#post(method_name, options = {}, body = nil) ⇒ Object 



90
91
92
93
94
95
96
97
 
# File 'lib/api_resource/custom_methods.rb', line 90

def post(method_name, options = {}, body = nil)
  request_body = body.blank? ? encode : body
  if new?
    connection.post(custom_method_new_element_url(method_name, options), request_body, self.class.headers)
  else
    connection.post(custom_method_element_url(method_name, options), request_body, self.class.headers)
  end
end

#put(method_name, options = {}, body = '') ⇒ Object 



99
100
101
 
# File 'lib/api_resource/custom_methods.rb', line 99

def put(method_name, options = {}, body = '')
  connection.put(custom_method_element_url(method_name, options), body, self.class.headers)
end