activeresource 2.0.1

data/CHANGELOG

@@ -0,0 +1,216 @@
+*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 [hasmanyjosh]
+
+* Added one-off declarations of mock behavior [DHH]. 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 [DHH]. 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 [alloy]
+
+* 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 [DHH]. 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 [DHH]. 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]
+
+  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 [DHH]. 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 [DHH]. 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 [DHH]
+
+    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]
+  ActiveResource splits the prefix_options from it automatically.
+
+* Allow ActiveResource::Base.delete with custom prefix. [Rick]
+
+* Add ActiveResource::Base#dup [Rick]
+
+* Fixed constant warning when fetching the same object multiple times [DHH]
+
+* Added that saves which get a body response (and not just a 201) will use that response to update themselves [DHH]
+
+* Disregard namespaces from the default element name, so Highrise::Person will just try to fetch from "/people", not "/highrise/people" [DHH]
+
+* 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, 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. [DHH]

data/README

@@ -0,0 +1,165 @@
+= Active Resource
+
+Active Resource (ARes) connects business objects and Representational State Transfer (REST)
+web services.  It implements object-relational mapping for REST webservices 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.
+
+=== Configuration and Usage
+
+Putting ActiveResource to use is very similar to ActiveRecord.  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 ActiveRecord invokes
+lifecycle 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 with 
+
+==== Protocol
+
+Active Resource is built on a standard XML format for requesting and submitting resources over HTTP.  It mirrors the RESTful routing 
+built into ActionController 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
+
+GET Http requests 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.find(: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
+
+
+You can find more usage information in the ActiveResource::Base documentation.
+

data/Rakefile

@@ -0,0 +1,133 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require File.join(File.dirname(__FILE__), 'lib', 'active_resource', 'version')
+
+PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+PKG_NAME      = 'activeresource'
+PKG_VERSION   = ActiveResource::VERSION::STRING + PKG_BUILD
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "activerecord"
+RUBY_FORGE_USER    = "webster132"
+
+PKG_FILES = FileList[
+    "lib/**/*", "test/**/*", "[A-Z]*", "Rakefile"
+].exclude(/\bCVS\b|~$/)
+
+desc "Default Task"
+task :default => [ :test ]
+
+# Run the unit tests
+
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = true
+}
+
+
+# Generate the RDoc documentation
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Active Resource -- Object-oriented REST services"
+  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  rdoc.rdoc_files.include('README', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+
+# Create compressed packages
+
+dist_dirs = [ "lib", "test", "examples", "dev-utils" ]
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "Think Active Record for web resources."
+  s.description = %q{Wraps web resources in model classes that can be manipulated through XML over REST.}
+
+  s.files = [ "Rakefile", "README", "CHANGELOG" ]
+  dist_dirs.each do |dir|
+    s.files = s.files + Dir.glob( "#{dir}/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  end
+  
+  s.add_dependency('activesupport', '= 2.0.1' + PKG_BUILD)
+
+  s.require_path = 'lib'
+  s.autorequire = 'active_resource'
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w( README )
+  s.rdoc_options.concat ['--main',  'README']
+  
+  s.author = "David Heinemeier Hansson"
+  s.email = "david@loudthinking.com"
+  s.homepage = "http://www.rubyonrails.org"
+  s.rubyforge_project = "activeresource"
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+task :lines do
+  lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
+
+  for file_name in FileList["lib/active_resource/**/*.rb"]
+    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 "Publish the beta gem"
+task :pgem => [:package] do 
+  Rake::SshFilePublisher.new("davidhh@wrath.rubyonrails.org", "public_html/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
+  `ssh davidhh@wrath.rubyonrails.org './gemupdate.sh'`
+end
+
+desc "Publish the API documentation"
+task :pdoc => [:rdoc] do 
+  Rake::SshDirPublisher.new("davidhh@wrath.rubyonrails.org", "public_html/ar", "doc").upload
+end
+
+desc "Publish the release files to RubyForge."
+task :release => [ :package ] do
+  `rubyforge login`
+
+  for ext in %w( gem tgz zip )
+    release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} 'REL #{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}"
+    puts release_command
+    system(release_command)
+  end
+end