Changeset 7098

Timestamp:

06/23/07 17:29:54 (2 years ago)

Author:

david

Message:

Big documentation upgrade for ARes (closes #8694) [jeremymcanally]

Files:

• trunk/activeresource/lib/active_resource/base.rb (modified) (17 diffs)
• trunk/activeresource/lib/active_resource/connection.rb (modified) (6 diffs)
• trunk/activeresource/lib/active_resource/custom_methods.rb (modified) (2 diffs)
• trunk/activeresource/lib/active_resource/validations.rb (modified) (12 diffs)
• trunk/activeresource/README (modified) (3 diffs)

trunk/activeresource/lib/active_resource/base.rb

@@ -4 +4 @@
-
-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 link:files/README.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 = "http://api.people.com:3000/"
+  #             end
+  # 
+  # Now the Person class is mapped to RESTful resources located at <tt>http://api.people.com:3000/people/</tt>, and
+  # you can now use Active Resource's lifecycles methods to manipulate resources.  
+  # 
+  # == Lifecycle 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 create Person object
+  # 
+  #     ryan.first = 'Rizzle'
+  #     ryan.save  #=> true
+  # 
+  #     ryan.destroy  #=> true
+  #
+  # As you can see, these are very similar to Active Record's lifecycle methods for database records.
+  # You can read more about each of these methods in their respective documentation.
+  # 
+  # === Custom REST methods
+  #
+  # Since simple CRUD/lifecycle methods can't accomplish every task, Active Resource also supports
+  # defining your own custom REST methods.
+  # 
+  #   Person.new(:name => 'Ryan).post(:register)                                                
+  #   # => { :id => 1, :name => 'Ryan', :position => 'Clerk' }
+  #
+  #   Person.find(1).put(:promote, :position => 'Manager')              
+  #   # => { :id => 1, :name => 'Ryan', :position => 'Manager' }
+  # 
+  # For more information on creating and 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 = "http://api.people.com:3000/"
+  #                protected
+  #                  def validate
+  #                    errors.add("last", "has invalid characters") unless last =~ /[a-zA-Z]*/
+  #                  end
+  #             end
+  # 
+  # See the ActiveResource::Validations documentation for more information.
+  #
+  # == Authentication
+  # 
+  # Many REST APIs will require authentication, usually in the form of basic
+  # HTTP authentication.  Authentication can be specified by putting the credentials
+  # in the +site+ variable of the Active Resource class you need to authenticate.
+  # 
+  #   class Person < ActiveResource::Base
+  #     self.site = "http://ryan:password@api.people.com:3000/"
+  #   end
+  # 
+  # For obvious security reasons, it is probably best if such services are available 
+  # over HTTPS.
+  # 
+  # == 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 http://api.people.com:3000/people/999.xml
+  #   ryan = Person.find(999) # => Raises ActiveResource::ResourceNotFound
+  #   # => Response = 404
+  # 
+  # +404+ is just one of the HTTP error response codes that ActiveResource will handle with its own exception. The 
+  # following HTTP response codes will also result in these exceptions:
+  # 
+  # 200 - 399:: Valid response, no exception
+  # 404:: ActiveResource::ResourceNotFound
+  # 409:: ActiveResource::ResourceConflict
+  # 422:: ActiveResource::ResourceInvalid (rescued by save as validation errors)
+  # 401 - 499:: ActiveResource::ClientError
+  # 500 - 599:: ActiveResource::ServerError
+  #
+  # 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
+  #
+  # === Validation errors
+  # 
+  # Active Resource supports validations on resources and will return errors if any these validations fail
+  # (e.g., "First name can not be blank" and so on).  These types of errors are denoted in the response by 
+  # a response code of +422+ and an XML representation of the validation errors.  The save operation will 
+  # then fail (with a +false+ return value) and the validation errors can be accessed on the resource in question.
+  # 
+  #   ryan = Person.find(1)
+  #   ryan.first #=> ''
+  #   ryan.save  #=> false
+  #
+  #   # When 
+  #   # PUT http://api.people.com:3000/people/1.xml
+  #   # is requested with invalid values, the response is:
+  #   #
+  #   # Response (422):
+  #   # <errors><error>First cannot be empty</error></errors>
+  #   #
+  #
+  #   ryan.errors.invalid?(:first)  #=> true
+  #   ryan.errors.full_messages  #=> ['First cannot be empty']
+  # 
+  # Learn more about Active Resource's validation features in the ActiveResource::Validations documentation.
+  #
-  class Base
-Res
+ctive Resource
-    cattr_accessor :logger
-
-    class << self
-
+
+
-      def site
-        if defined?(@site)
@@ -18 +161 @@
-      end
-
-
+
+
-      def site=(site)
-        @connection = nil
@@ -24 +168 @@
-      end
-
-
+
+
+
-      def connection(refresh = false)
-        @connection = Connection.new(site) if refresh || @connection.nil?
@@ -41 +187 @@
-      attr_accessor_with_default(:primary_key, 'id') #:nodoc:
-      
-resource prefix
- prefix/collectionname/1.xml
+prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.xml</tt>)
+This method is regenerated at runtime based on what the prefix is set to.
-      def prefix(options={})
-        default = site.path
@@ -51 +197 @@
-      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
@@ -56 +204 @@
-      end
-
-resource prefix
- prefix/collectionname/1.xml
+prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.xml</tt>).
+Default value is <tt>site.path</tt>.
-      def prefix=(value = '/')
-        # Replace :placeholders with '#{embedded options[:lookups]}'
@@ -78 +226 @@
-      alias_method :set_collection_name, :collection_name=  #:nodoc:
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      def element_path(id, prefix_options = {}, query_options = nil)
-        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
@@ -89 +252 @@
-      end
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      def collection_path(prefix_options = {}, query_options = nil)
-        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
@@ -103 +281 @@
-
-      # Create a new resource instance and request to the remote service
-.  This is
+, making it
-      #
-      #   ryan = Person.new(:first => 'ryan')
@@ -110 +288 @@
-      # The newly created resource is returned.  If a failure has occurred an
-      # exception will be raised (see save).  If the resource is invalid and
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      def create(attributes = {})
-        returning(self.new(attributes)) { |res| res.save }        
@@ -119 +316 @@
-      # Core method for finding resources.  Used similarly to Active Record's find method.
-      #
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      def find(*arguments)
-        scope   = arguments.slice!(0)
@@ -139 +364 @@
-      end
-
+      # Deletes the resources with the ID in the +id+ parameter.
+      #
+      # ==== Options
+      # All options specify prefix and query parameters.
+      #
+      # ==== Examples
+      #   Event.delete(2)
+      #   # => DELETE /events/2
+      #
+      #   Event.create(:name => 'Free Concert', :location => 'Community Center')
+      #   my_event = Event.find(:first)
+      #   # => Events (id: 7)
+      #   Event.delete(my_event.id)
+      #   # => DELETE /events/7
+      #
+      #   # Let's assume a request to events/5/cancel.xml
+      #   Event.delete(params[:id])
+      #   # => DELETE /events/5
+      #
-      def delete(id, options = {})
-        connection.delete(element_path(id, options))
-      end
-
-
+
+
+
+
+
+
+
+
+
-      def exists?(id, options = {})
-        id && !find_single(id, options).nil?
@@ -227 +479 @@
-    attr_accessor :prefix_options #:nodoc:
-
+    # 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 = {})
-      @attributes     = {}
@@ -233 +496 @@
-    end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def new?
-      id.nil?
-    end
-
-id of the object
++id+ attribute of the resource
-    def id
-      attributes[self.class.primary_key]
-    end
-
-id of the object
++id+ attribute of the resource
-    def id=(id)
-      attributes[self.class.primary_key] = id
-    end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def ==(other)
-      other.equal?(self) || (other.instance_of?(self.class) && !other.new? && other.id == id)
-    end
-
-Delegates to ==
+Tests for equality (delegates to ==).
-    def eql?(other)
-      self == other
@@ -264 +562 @@
-    end
-    
+    # Duplicate 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
-      returning new do |resource|
@@ -271 +585 @@
-    end
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def save
-      new? ? create : update
-    end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def destroy
-      connection.delete(element_path, self.class.headers)
-    end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def exists?
-      !new? && self.class.exists?(id, :params => prefix_options)
-    end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def to_xml(options={})
-      attributes.to_xml({:root => self.class.element_name}.merge(options))
-    end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def reload
-      self.load(self.class.find(id, :params => @prefix_options).attributes)
-    end
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def load(attributes)
-      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
@@ -322 +738 @@
-    alias_method :respond_to_without_attributes?, :respond_to?
-
-
-
+
+
+
-    def respond_to?(method, include_priv = false)
-      method_name = method.to_s

trunk/activeresource/lib/active_resource/connection.rb

@@ -6 +6 @@
-
-module ActiveResource
-
+ # :nodoc:
-    attr_reader :response
-
@@ -19 +19 @@
-  end
-
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
-
-  # 405 Method Not Allowed
-
+ # :nodoc:
-    def allowed_methods
-      @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym }
@@ -32 +38 @@
-  end
-
-
+
+
+
-  class Connection
-    attr_reader :site
@@ -47 +55 @@
-    end
-
+    # The +site+ parameter is required and will set the +site+
+    # attribute to the URI for the remote resource service.
-    def initialize(site)
-      raise ArgumentError, 'Missing site URI' unless site
@@ -84 +94 @@
-      from_xml_data(Hash.from_xml(response.body))
-    end
-
-
-    private
@@ -153 +162 @@
-        end
-      end
-      
-  end
-end

trunk/activeresource/lib/active_resource/custom_methods.rb

@@ -1 @@
-
+
+
+
-#
-
+
+
+
-#
-
-
-
+
-#
-
+
+
+
+
-#
-
-
-
-
-
-
-
+
+
-#
-#   class Person < ActiveResource::Base
@@ -21 +21 @@
-#   end
-#
-
+
+
-#
-
-
+ # PUT /people/1/promote.xml
+ # DELETE /people/1/deactivate.xml
-#
-
+
+
+
-module ActiveResource
-  module CustomMethods 

trunk/activeresource/lib/active_resource/validations.rb

@@ -15 +15 @@
-    end
-
+    # Add an error to the base Active Resource object rather than an attribute.
+    #
+    # ==== Examples
+    #   my_folder = Folder.find(1)
+    #   my_folder.errors.add_to_base("You can't edit an existing folder")
+    #   my_folder.errors.on_base
+    #   # => "You can't edit an existing folder"
+    #
+    #   my_folder.errors.add_to_base("This folder has been tagged as frozen")
+    #   my_folder.valid?
+    #   # => false
+    #   my_folder.errors.on_base
+    #   # => ["You can't edit an existing folder", "This folder has been tagged as frozen"]
+    #
-    def add_to_base(msg)
-      add(:base, msg)
-    end
-
+    # Adds an error to an Active Resource object's attribute (named for the +attribute+ parameter)
+    # with the error message in +msg+.
+    #
+    # ==== Examples
+    #   my_resource = Node.find(1)
+    #   my_resource.errors.add('name', 'can not be "base"') if my_resource.name == 'base'
+    #   my_resource.errors.on('name')
+    #   # => 'can not be "base"!'
+    #
+    #   my_resource.errors.add('desc', 'can not be blank') if my_resource.desc == ''
+    #   my_resource.valid?
+    #   # => false
+    #   my_resource.errors.on('desc')
+    #   # => 'can not be blank!'
+    #
-    def add(attribute, msg)
-      @errors[attribute.to_s] = [] if @errors[attribute.to_s].nil?
@@ -25 +54 @@
-
-    # Returns true if the specified +attribute+ has errors associated with it.
+    #
+    # ==== Examples
+    #   my_resource = Disk.find(1)
+    #   my_resource.errors.add('location', 'must be Main') unless my_resource.location == 'Main'
+    #   my_resource.errors.on('location')
+    #   # => 'must be Main!'
+    #
+    #   my_resource.errors.invalid?('location')
+    #   # => true
+    #   my_resource.errors.invalid?('name')
+    #   # => false
-    def invalid?(attribute)
-      !@errors[attribute.to_s].nil?
-    end
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def on(attribute)
-      errors = @errors[attribute.to_s]
@@ -40 +93 @@
-    alias :[] :on
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def on_base
-      on(:base)
@@ -46 +115 @@
-
-    # Yields each attribute and associated message per error added.
+    #
+    # ==== Examples
+    #   my_person = Person.new(params[:person])
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.errors.add('password', 'can not be empty') if my_person.password == ''
+    #   messages = ''
+    #   my_person.errors.each {|attr, msg| messages += attr.humanize + " " + msg + "<br />"}
+    #   messages
+    #   # => "Login can not be empty<br />Password can not be empty<br />"
+    #
-    def each
-      @errors.each_key { |attr| @errors[attr].each { |msg| yield attr, msg } }
@@ -52 +132 @@
-    # Yields each full error message added. So Person.errors.add("first_name", "can't be empty") will be returned
-    # through iteration as "First name can't be empty".
+    #
+    # ==== Examples
+    #   my_person = Person.new(params[:person])
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.errors.add('password', 'can not be empty') if my_person.password == ''
+    #   messages = ''
+    #   my_person.errors.each_full {|msg| messages += msg + "<br/>"}
+    #   messages
+    #   # => "Login can not be empty<br />Password can not be empty<br />"
+    #
-    def each_full
-      full_messages.each { |msg| yield msg }
@@ -57 +148 @@
-
-    # Returns all the full error messages in an array.
+    #
+    # ==== Examples
+    #   my_person = Person.new(params[:person])
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.errors.add('password', 'can not be empty') if my_person.password == ''
+    #   messages = ''
+    #   my_person.errors.full_messages.each {|msg| messages += msg + "<br/>"}
+    #   messages
+    #   # => "Login can not be empty<br />Password can not be empty<br />"
+    #
-    def full_messages
-      full_messages = []
@@ -80 +182 @@
-    # Returns the total number of errors added. Two errors added to the same attribute will be counted as such
-    # with this as well.
+    #
+    # ==== Examples
+    #   my_person = Person.new(params[:person])
+    #   my_person.errors.size
+    #   # => 0
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.errors.add('password', 'can not be empty') if my_person.password == ''
+    #   my_person.error.size
+    #   # => 2
+    #
-    def size
-      @errors.values.inject(0) { |error_count, attribute| error_count + attribute.size }
@@ -87 +200 @@
-    alias_method :length, :size
-    
+    # Grabs errors from the XML response.
-    def from_xml(xml)
-      clear
@@ -103 +217 @@
-  end
-  
-
-
-
+
+
+
+
+
+
-  #
-  #   class Person < ActiveResource::Base
@@ -134 +251 @@
-  #   person.save                         # => true (and person is now saved to the remote service)
-  #
-  # An Errors object is automatically created for every resource.
-  module Validations
-    def self.included(base) # :nodoc:
@@ -142 +258 @@
-    end
-
+    # Validate a resource and save (POST) it to the remote web service.
-    def save_with_validation
-      save_without_validation
@@ -150 +267 @@
-    end
-
+    # Checks for errors on an object (i.e., is resource.errors empty?).
+    # 
+    # ==== Examples
+    #   my_person = Person.create(params[:person])
+    #   my_person.valid?
+    #   # => true
+    #
+    #   my_person.errors.add('login', 'can not be empty') if my_person.login == ''
+    #   my_person.valid?
+    #   # => false
-    def valid?
-      errors.empty?

trunk/activeresource/README

@@ -1 @@
- -- Object-oriented REST services
+
-
-
-
-
+
+
+
+
-
-= Configuration & Usage
+ Philosophy
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-   class Person < ActiveResource::Base
@@ -14 +30 @@
-   end
-
-Person is now REST enable
+Now the Person class is REST enabled
-lifecycle methods that operate against a persistent store.
-
-   # Find a person with id = 1
-   # This will invoke the following Http call:
-   # GET http://api.people.com:3000/people/1.xml
-   # and will load up the XML response into a new
-   # Person object
-   #
-   ryan = Person.find(1)
-   Person.exists?(1)  #=> true
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
+
-
-
-
-
-
-
-
+
+
+
-
-
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
+
+
-
-==== Find
@@ -170 +162 @@
-
-
-
+
-
-Error handling and validation is handled in much the same manner as you're used to seeing in
-ActiveRecord.  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 http://api.people.com:3000/people/1.xml
-  # #=> Response (404)
-  #
-  ryan = Person.find(1) #=> Raises ActiveResource::ResourceNotFound
-
-==== Validation errors
-
-Creating and updating resources can lead to validation errors - i.e. 'First name cannot be empty' etc...
-These types of errors are denoted in the response by a response code of 422 and the 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.
-
-  # When 
-  #
-  # PUT http://api.people.com:3000/people/1.xml
-  #
-  # is requested with invalid values, the expected response is:
-  #
-  # Response (422):
-  # <errors><error>First cannot be empty</error></errors>
-  #
-  ryan = Person.find(1)
-  ryan.first #=> ''
-  ryan.save  #=> false
-  ryan.errors.invalid?(:first)  #=> true
-  ryan.errors.full_messages  #=> ['First cannot be empty']
-
-
-==== Response errors
-
-If the underlying Http request for an ARes operation results in an error response code, an
-exception will be raised.  The following Http response codes will result in these exceptions:
-
-   200 - 399: Valid response, no exception
-   404: ActiveResource::ResourceNotFound
-   409: ActiveResource::ResourceConflict
-   422: ActiveResource::ResourceInvalid (rescued by save as validation errors)
-   401 - 499: ActiveResource::ClientError
-   500 - 599: ActiveResource::ServerError
-
-
-=== Authentication
-
-Many REST apis will require username/password authentication, usually in the form of
-Http authentication.  This can easily be specified by putting the username and password
-in the Url of the ARes site:
-
-   class Person < ActiveResource::Base
-     self.site = "http://ryan:password@api.people.com:3000/"
-   end
-
-For obvious reasons it is best if such services are available over https.