Ticket #8694: active_resource_docs.diff

activeresource/lib/active_resource/validations.rb

@@ -14 +14 @@
-      @base, @errors = base, {}
-    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?
-      @errors[attribute.to_s] << msg
-    end
-
-    # 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]
-      return nil if errors.nil?
@@ -39 +92 @@
-    
-    alias :[] :on
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def on_base
-      on(:base)
-    end
-
-    # 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 } }
-    end
-
-    # 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 }
-    end
-
-    # 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 = []
-
@@ -79 +181 @@
-
-    # 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 }
-    end
@@ -86 +199 @@
-    alias_method :count, :size
-    alias_method :length, :size
-    
+    # Grabs errors from the XML response.
-    def from_xml(xml)
-      clear
-      humanized_attributes = @base.attributes.keys.inject({}) { |h, attr_name| h.update(attr_name.humanize => attr_name) }
@@ -102 +216 @@
-    end
-  end
-  
-
-
-
+
+
+
+
-  #
+  # ==== Example
+  #
-  #   class Person < ActiveResource::Base
-  #      self.site = "http://www.localhost.com:3000/"
-  #      protected
@@ -133 +250 @@
-  #   person.attributes = { "last_name" => "Halpert", "phone_number" => "555-5555" }
-  #   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:
-      base.class_eval do
@@ -141 +257 @@
-      end
-    end
-
+    # Validate a resource and save (POST) it to the remote web service.
-    def save_with_validation
-      save_without_validation
-      true
@@ -149 +266 @@
-      false
-    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?
-    end

activeresource/lib/active_resource/custom_methods.rb

@@ -1 @@
-
+
+
+
-#
-
+
+
+
-#
-
-
-
+
-#
-
+
+
+
+
-#
-
-
-
-
+
+
-#
-# This module provides the ability for Active Resource to call these
-# custom REST methods and get the response back.
-#
-#   class Person < ActiveResource::Base
-#     self.site = "http://37s.sunrise.i:3000"
-#   end
-#
-
+
+
-#
-
-
+ # PUT /people/1/promote.xml
+ # DELETE /people/1/deactivate.xml
-#
-
+
+
+
-module ActiveResource
-  module CustomMethods 
-    def self.included(within)

activeresource/lib/active_resource/connection.rb

@@ -5 +5 @@
-require 'benchmark'
-
-module ActiveResource
-
+ # :nodoc:
-    attr_reader :response
-
-    def initialize(response, message = nil)
@@ -18 +18 @@
-    end
-  end
-
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
-
-  # 405 Method Not Allowed
-
+ # :nodoc:
-    def allowed_methods
-      @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym }
-    end
-  end
-
-
+
+
+
-  class Connection
-    attr_reader :site
-
@@ -46 +54 @@
-      end
-    end
-
+    # Method to create a new instance of the Connection class.
+    # 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
-      self.site = site
-    end
-
-Set URI for
+Attribute writer to set the URI for the
-    def site=(site)
-      @site = site.is_a?(URI) ? site : URI.parse(site)
-    end
-
-.
-(find) resources
+ on the remote service. 
+resources (e.g., ActiveResource::Base#find)
-    def get(path, headers = {})
-      xml_from_response(request(:get, path, build_request_headers(headers)))
-    end
-
-
-
+
+
+
-    def delete(path, headers = {})
-      request(:delete, path, build_request_headers(headers))
-    end
-
-
-
+
+
+
-    def put(path, body = '', headers = {})
-      request(:put, path, body, build_request_headers(headers))
-    end
-
-
-
+ on the remote service
+ (e.g., ActiveResource::Base#create and ActiveResource::Base#save)
-    def post(path, body = '', headers = {})
-      request(:post, path, body, build_request_headers(headers))
-    end
-
+    # A method to convert XML from the response body into a usable +Hash+ instance.
-    def xml_from_response(response)
-      if response = from_xml_data(Hash.from_xml(response.body))
-        response.first
@@ -88 +102 @@
-      end
-    end
-
-
-    private
-      # Makes request to remote service.
-      def request(method, path, *arguments)

activeresource/lib/active_resource/base.rb

@@ -3 +3 @@
-require 'set'
-
-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)
-          @site
@@ -17 +160 @@
-        end
-      end
-
-
+
+
-      def site=(site)
-        @connection = nil
-        @site = create_site_uri_from(site)
-      end
-
-
+
+
+
-      def connection(refresh = false)
-        @connection = Connection.new(site) if refresh || @connection.nil?
-        @connection
@@ -40 +186 @@
-      attr_accessor_with_default(:collection_name) { element_name.pluralize } #:nodoc:
-      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
-        default << '/' unless default[-1..-1] == '/'
@@ -50 +196 @@
-        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
-
-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]}'
-        prefix_call = value.gsub(/:\w+/) { |key| "\#{options[#{key}]}" }
@@ -77 +225 @@
-      alias_method :set_element_name, :element_name=  #:nodoc:
-      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?
-        "#{prefix(prefix_options)}#{collection_name}/#{id}.xml#{query_string(query_options)}"
-      end
-
-
+
+
-      #
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      def collection_path(prefix_options = {}, query_options = nil)
-        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-        "#{prefix(prefix_options)}#{collection_name}.xml#{query_string(query_options)}"
@@ -102 +280 @@
-      alias_method :set_primary_key, :primary_key=  #:nodoc:
-
-      # Create a new resource instance and request to the remote service
-.  This is
+, making it
-      #
-      #   ryan = Person.new(:first => 'ryan')
-      #   ryan.save
-      #
-      # 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 }        
-      end
-
-      # Core method for finding resources.  Used similarly to Active Record's find method.
-      #
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      def find(*arguments)
-        scope   = arguments.slice!(0)
-        options = arguments.slice!(0) || {}
@@ -138 +363 @@
-        end
-      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?
-      rescue ActiveResource::ResourceNotFound
@@ -226 +478 @@
-    attr_accessor :attributes #:nodoc:
-    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     = {}
-      @prefix_options = {}
-      load(attributes)
-    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
-    end
@@ -263 +561 @@
-      id.hash
-    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|
-        resource.attributes     = @attributes
@@ -270 +585 @@
-      end
-    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
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+