diff options
Diffstat (limited to 'vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0')
27 files changed, 4111 insertions, 0 deletions
diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/CHANGELOG b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/CHANGELOG new file mode 100644 index 000000000..e124e40dd --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/CHANGELOG @@ -0,0 +1,246 @@ +*2.1.0 (May 31st, 2008)* + +* Fixed response logging to use length instead of the entire thing (seangeo) [#27] + +* Fixed that to_param should be used and honored instead of hardcoding the id #11406 [gspiers] + +* Improve documentation. [Radar, Jan De Poorter, chuyeow, xaviershay, danger, miloops, Xavier Noria, Sunny Ripert] + +* Use HEAD instead of GET in exists? [bscofield] + +* Fix small documentation typo. Closes #10670 [l.guidi] + +* find_or_create_resource_for handles module nesting. #10646 [xavier] + +* Allow setting ActiveResource::Base#format before #site. [rick] + +* Support agnostic formats when calling custom methods. Closes #10635 [joerichsen] + +* Document custom methods. #10589 [Cheah Chu Yeow] + +* Ruby 1.9 compatibility. [Jeremy Kemper] + + +*2.0.2* (December 16th, 2007) + +* Added more specific exceptions for 400, 401, and 403 (all descending from ClientError so existing rescues will work) #10326 [trek] + +* Correct empty response handling. #10445 [seangeo] + + +*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] diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/README b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/README new file mode 100644 index 000000000..bcb7b3cbc --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/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. + diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/Rakefile b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/Rakefile new file mode 100644 index 000000000..9fd0ec492 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/Rakefile @@ -0,0 +1,135 @@ +require 'rubygems' +require 'rake' +require 'rake/testtask' +require 'rake/rdoctask' +require 'rake/packagetask' +require 'rake/gempackagetask' +require 'rake/contrib/sshpublisher' + +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.platform = Gem::Platform::RUBY + 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.1.0' + 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 diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource.rb new file mode 100644 index 000000000..18347457a --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource.rb @@ -0,0 +1,47 @@ +#-- +# Copyright (c) 2006 David Heinemeier Hansson +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be +# included in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +#++ + +$:.unshift(File.dirname(__FILE__)) unless + $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__))) + +unless defined?(ActiveSupport) + begin + $:.unshift(File.dirname(__FILE__) + "/../../activesupport/lib") + require 'active_support' + rescue LoadError + require 'rubygems' + gem 'activesupport' + end +end + +require 'active_resource/formats' +require 'active_resource/base' +require 'active_resource/validations' +require 'active_resource/custom_methods' + +module ActiveResource + Base.class_eval do + include Validations + include CustomMethods + end +end
\ No newline at end of file diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/base.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/base.rb new file mode 100644 index 000000000..463ee9f1e --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/base.rb @@ -0,0 +1,1014 @@ +require 'active_resource/connection' +require 'cgi' +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/vendor/rails/activeresource/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. In the case where you already have + # an existing model with the same name as the desired RESTful resource you can set the +element_name+ value. + # + # class PersonResource < ActiveResource::Base + # self.site = "http://api.people.com:3000/" + # self.element_name = "person" + # end + # + # + # == 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 created 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. To invoke them, Active Resource provides the <tt>get</tt>, + # <tt>post</tt>, <tt>put</tt> and <tt>delete</tt> methods where you can specify a custom REST method + # name to invoke. + # + # # POST to the custom 'register' REST method, i.e. POST /people/new/register.xml. + # Person.new(:name => 'Ryan').post(:register) + # # => { :id => 1, :name => 'Ryan', :position => 'Clerk' } + # + # # PUT an update by invoking the 'promote' REST method, i.e. PUT /people/1/promote.xml?position=Manager. + # Person.find(1).put(:promote, :position => 'Manager') + # # => { :id => 1, :name => 'Ryan', :position => 'Manager' } + # + # # GET all the positions available, i.e. GET /people/positions.xml. + # Person.get(:positions) + # # => [{:name => 'Manager'}, {:name => 'Clerk'}] + # + # # DELETE to 'fire' a person, i.e. DELETE /people/1/fire.xml. + # Person.find(1).delete(:fire) + # + # For more information on 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 URL for the +site+ variable. + # + # class Person < ActiveResource::Base + # self.site = "http://ryan:password@api.people.com:3000/" + # end + # + # * defining +user+ and/or +password+ variables + # + # class Person < ActiveResource::Base + # self.site = "http://api.people.com:3000/" + # self.user = "ryan" + # self.password = "password" + # end + # + # For obvious security reasons, it is probably best if such services are available + # over HTTPS. + # + # Note: Some values cannot be provided in the URL passed to site. e.g. email addresses + # as usernames. In those situations you should use the seperate user and password option. + # == 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 <tt>404</tt> (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) # 404, raises ActiveResource::ResourceNotFound + # + # <tt>404</tt> is just one of the HTTP error response codes that Active Resource 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 <tt>422</tt> and an XML representation of the validation errors. The save operation will + # then fail (with a <tt>false</tt> 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 type="array"><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. + # + # === Timeouts + # + # Active Resource relies on HTTP to access RESTful APIs and as such is inherently susceptible to slow or + # unresponsive servers. In such cases, your Active Resource method calls could timeout. You can control the + # amount of time before Active Resource times out with the +timeout+ variable. + # + # class Person < ActiveResource::Base + # self.site = "http://api.people.com:3000/" + # self.timeout = 5 + # end + # + # This sets the +timeout+ to 5 seconds. You can adjust the +timeout+ to a value suitable for the RESTful API + # you are accessing. It is recommended to set this to a reasonably low value to allow your Active Resource + # clients (especially if you are using Active Resource in a Rails application) to fail-fast (see + # http://en.wikipedia.org/wiki/Fail-fast) rather than cause cascading failures that could incapacitate your + # server. + # + # When a timeout occurs, an ActiveResource::TimeoutError is raised. You should rescue from + # ActiveResource::TimeoutError in your Active Resource method calls. + # + # Internally, Active Resource relies on Ruby's Net::HTTP library to make HTTP requests. Setting +timeout+ + # sets the <tt>read_timeout</tt> of the internal Net::HTTP instance to the same value. The default + # <tt>read_timeout</tt> is 60 seconds on most Ruby implementations. + class Base + # The logger for diagnosing and tracing Active Resource calls. + cattr_accessor :logger + + class << self + # Gets the URI of the REST resources to map for this class. The site variable is required + # Active Resource's mapping to work. + def site + # Not using superclass_delegating_reader because don't want subclasses to modify superclass instance + # + # With superclass_delegating_reader + # + # Parent.site = 'http://anonymous@test.com' + # Subclass.site # => 'http://anonymous@test.com' + # Subclass.site.user = 'david' + # Parent.site # => 'http://david@test.com' + # + # Without superclass_delegating_reader (expected behaviour) + # + # Parent.site = 'http://anonymous@test.com' + # Subclass.site # => 'http://anonymous@test.com' + # Subclass.site.user = 'david' # => TypeError: can't modify frozen object + # + if defined?(@site) + @site + elsif superclass != Object && superclass.site + superclass.site.dup.freeze + end + end + + # Sets the URI of the REST resources to map for this class to the value in the +site+ argument. + # The site variable is required Active Resource's mapping to work. + def site=(site) + @connection = nil + if site.nil? + @site = nil + else + @site = create_site_uri_from(site) + @user = URI.decode(@site.user) if @site.user + @password = URI.decode(@site.password) if @site.password + end + end + + # Gets the user for REST HTTP authentication. + def user + # Not using superclass_delegating_reader. See +site+ for explanation + if defined?(@user) + @user + elsif superclass != Object && superclass.user + superclass.user.dup.freeze + end + end + + # Sets the user for REST HTTP authentication. + def user=(user) + @connection = nil + @user = user + end + + # Gets the password for REST HTTP authentication. + def password + # Not using superclass_delegating_reader. See +site+ for explanation + if defined?(@password) + @password + elsif superclass != Object && superclass.password + superclass.password.dup.freeze + end + end + + # Sets the password for REST HTTP authentication. + def password=(password) + @connection = nil + @password = password + end + + # Sets the format that attributes are sent and received in from a mime type reference: + # + # Person.format = :json + # Person.find(1) # => GET /people/1.json + # + # Person.format = ActiveResource::Formats::XmlFormat + # Person.find(1) # => GET /people/1.xml + # + # Default format is <tt>:xml</tt>. + def format=(mime_type_reference_or_format) + format = mime_type_reference_or_format.is_a?(Symbol) ? + ActiveResource::Formats[mime_type_reference_or_format] : mime_type_reference_or_format + + write_inheritable_attribute("format", format) + connection.format = format if site + end + + # Returns the current format, default is ActiveResource::Formats::XmlFormat. + def format # :nodoc: + read_inheritable_attribute("format") || ActiveResource::Formats[:xml] + end + + # Sets the number of seconds after which requests to the REST API should time out. + def timeout=(timeout) + @connection = nil + @timeout = timeout + end + + # Gets tthe number of seconds after which requests to the REST API should time out. + def timeout + if defined?(@timeout) + @timeout + elsif superclass != Object && superclass.timeout + superclass.timeout + end + end + + # An instance of ActiveResource::Connection that is the base connection to the remote service. + # The +refresh+ parameter toggles whether or not the connection is refreshed at every request + # or not (defaults to <tt>false</tt>). + def connection(refresh = false) + if defined?(@connection) || superclass == Object + @connection = Connection.new(site, format) if refresh || @connection.nil? + @connection.user = user if user + @connection.password = password if password + @connection.timeout = timeout if timeout + @connection + else + superclass.connection + end + end + + def headers + @headers ||= {} + end + + # Do not include any modules in the default element name. This makes it easier to seclude ARes objects + # in a separate namespace without having to set element_name repeatedly. + attr_accessor_with_default(:element_name) { to_s.split("::").last.underscore } #:nodoc: + + attr_accessor_with_default(:collection_name) { element_name.pluralize } #:nodoc: + attr_accessor_with_default(:primary_key, 'id') #:nodoc: + + # Gets the 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] == '/' + # generate the actual method based on the current site path + self.prefix = default + 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 + + # Sets the 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}]}" } + + # Redefine the new methods. + code = <<-end_code + def prefix_source() "#{value}" end + def prefix(options={}) "#{prefix_call}" end + end_code + silence_warnings { instance_eval code, __FILE__, __LINE__ } + rescue + logger.error "Couldn't set prefix: #{$!}\n #{code}" + raise + end + + alias_method :set_prefix, :prefix= #:nodoc: + + alias_method :set_element_name, :element_name= #:nodoc: + alias_method :set_collection_name, :collection_name= #:nodoc: + + # Gets the element path for the given ID in +id+. If the +query_options+ parameter is omitted, Rails + # will split from the prefix options. + # + # ==== Options + # +prefix_options+ - A hash to add a prefix to the request for nested URLs (e.g., <tt>:account_id => 19</tt> + # would yield a URL like <tt>/accounts/19/purchases.xml</tt>). + # +query_options+ - A hash to add items to the query string for the request. + # + # ==== Examples + # Post.element_path(1) + # # => /posts/1.xml + # + # Comment.element_path(1, :post_id => 5) + # # => /posts/5/comments/1.xml + # + # Comment.element_path(1, :post_id => 5, :active => 1) + # # => /posts/5/comments/1.xml?active=1 + # + # Comment.element_path(1, {:post_id => 5}, {:active => 1}) + # # => /posts/5/comments/1.xml?active=1 + # + 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}.#{format.extension}#{query_string(query_options)}" + end + + # Gets the collection path for the REST resources. If the +query_options+ parameter is omitted, Rails + # will split from the +prefix_options+. + # + # ==== Options + # * +prefix_options+ - A hash to add a prefix to the request for nested URL's (e.g., <tt>:account_id => 19</tt> + # would yield a URL like <tt>/accounts/19/purchases.xml</tt>). + # * +query_options+ - A hash to add items to the query string for the request. + # + # ==== Examples + # Post.collection_path + # # => /posts.xml + # + # Comment.collection_path(:post_id => 5) + # # => /posts/5/comments.xml + # + # Comment.collection_path(:post_id => 5, :active => 1) + # # => /posts/5/comments.xml?active=1 + # + # Comment.collection_path({:post_id => 5}, {:active => 1}) + # # => /posts/5/comments.xml?active=1 + # + 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}.#{format.extension}#{query_string(query_options)}" + end + + alias_method :set_primary_key, :primary_key= #:nodoc: + + # Create a new resource instance and request to the remote service + # that it be saved, making it equivalent to the following simultaneous calls: + # + # 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 + # has not been saved then valid? will return <tt>false</tt>, + # while new? will still return <tt>true</tt>. + # + # ==== Examples + # Person.create(:name => 'Jeremy', :email => 'myname@nospam.com', :enabled => true) + # my_person = Person.find(:first) + # my_person.email # => myname@nospam.com + # + # dhh = Person.create(:name => 'David', :email => 'dhh@nospam.com', :enabled => true) + # dhh.valid? # => true + # dhh.new? # => false + # + # # We'll assume that there's a validation that requires the name attribute + # that_guy = Person.create(:name => '', :email => 'thatguy@nospam.com', :enabled => true) + # that_guy.valid? # => false + # that_guy.new? # => true + def create(attributes = {}) + returning(self.new(attributes)) { |res| res.save } + end + + # Core method for finding resources. Used similarly to Active Record's +find+ method. + # + # ==== Arguments + # The first argument is considered to be the scope of the query. That is, how many + # resources are returned from the request. It can be one of the following. + # + # * <tt>:one</tt> - Returns a single resource. + # * <tt>:first</tt> - Returns the first resource found. + # * <tt>:all</tt> - Returns every resource that matches the request. + # + # ==== Options + # + # * <tt>:from</tt> - Sets the path or custom method that resources will be fetched from. + # * <tt>:params</tt> - Sets query and prefix (nested URL) parameters. + # + # ==== Examples + # Person.find(1) + # # => GET /people/1.xml + # + # Person.find(:all) + # # => GET /people.xml + # + # Person.find(:all, :params => { :title => "CEO" }) + # # => GET /people.xml?title=CEO + # + # Person.find(:first, :from => :managers) + # # => GET /people/managers.xml + # + # Person.find(:all, :from => "/companies/1/people.xml") + # # => GET /companies/1/people.xml + # + # Person.find(:one, :from => :leader) + # # => GET /people/leader.xml + # + # Person.find(:all, :from => :developers, :params => { :language => 'ruby' }) + # # => GET /people/developers.xml?language=ruby + # + # Person.find(:one, :from => "/companies/1/manager.xml") + # # => GET /companies/1/manager.xml + # + # StreetAddress.find(1, :params => { :person_id => 1 }) + # # => GET /people/1/street_addresses/1.xml + def find(*arguments) + scope = arguments.slice!(0) + options = arguments.slice!(0) || {} + + case scope + when :all then find_every(options) + when :first then find_every(options).first + when :one then find_one(options) + else find_single(scope, options) + end + end + + # Deletes the resources with the ID in the +id+ parameter. + # + # ==== Options + # All options specify prefix and query parameters. + # + # ==== Examples + # Event.delete(2) # sends DELETE /events/2 + # + # Event.create(:name => 'Free Concert', :location => 'Community Center') + # my_event = Event.find(:first) # let's assume this is event with ID 7 + # Event.delete(my_event.id) # sends DELETE /events/7 + # + # # Let's assume a request to events/5/cancel.xml + # Event.delete(params[:id]) # sends DELETE /events/5 + def delete(id, options = {}) + connection.delete(element_path(id, options)) + end + + # Asserts the existence of a resource, returning <tt>true</tt> if the resource is found. + # + # ==== Examples + # Note.create(:title => 'Hello, world.', :body => 'Nothing more for now...') + # Note.exists?(1) # => true + # + # Note.exists(1349) # => false + def exists?(id, options = {}) + if id + prefix_options, query_options = split_options(options[:params]) + path = element_path(id, prefix_options, query_options) + response = connection.head(path, headers) + response.code == 200 + end + # id && !find_single(id, options).nil? + rescue ActiveResource::ResourceNotFound + false + end + + private + # Find every resource + def find_every(options) + case from = options[:from] + when Symbol + instantiate_collection(get(from, options[:params])) + when String + path = "#{from}#{query_string(options[:params])}" + instantiate_collection(connection.get(path, headers) || []) + else + prefix_options, query_options = split_options(options[:params]) + path = collection_path(prefix_options, query_options) + instantiate_collection( (connection.get(path, headers) || []), prefix_options ) + end + end + + # Find a single resource from a one-off URL + def find_one(options) + case from = options[:from] + when Symbol + instantiate_record(get(from, options[:params])) + when String + path = "#{from}#{query_string(options[:params])}" + instantiate_record(connection.get(path, headers)) + end + end + + # Find a single resource from the default URL + def find_single(scope, options) + prefix_options, query_options = split_options(options[:params]) + path = element_path(scope, prefix_options, query_options) + instantiate_record(connection.get(path, headers), prefix_options) + end + + def instantiate_collection(collection, prefix_options = {}) + collection.collect! { |record| instantiate_record(record, prefix_options) } + end + + def instantiate_record(record, prefix_options = {}) + returning new(record) do |resource| + resource.prefix_options = prefix_options + end + end + + + # Accepts a URI and creates the site URI from that. + def create_site_uri_from(site) + site.is_a?(URI) ? site.dup : URI.parse(site) + end + + # contains a set of the current prefix parameters. + def prefix_parameters + @prefix_parameters ||= prefix_source.scan(/:\w+/).map { |key| key[1..-1].to_sym }.to_set + end + + # Builds the query string for the request. + def query_string(options) + "?#{options.to_query}" unless options.nil? || options.empty? + end + + # split an option hash into two hashes, one containing the prefix options, + # and the other containing the leftovers. + def split_options(options = {}) + prefix_options, query_options = {}, {} + + (options || {}).each do |key, value| + next if key.blank? + (prefix_parameters.include?(key.to_sym) ? prefix_options : query_options)[key.to_sym] = value + end + + [ prefix_options, query_options ] + end + end + + 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 + + # Returns a clone of the resource that hasn't been assigned an +id+ yet and + # is treated as a new resource. + # + # ryan = Person.find(1) + # not_ryan = ryan.clone + # not_ryan.new? # => true + # + # Any active resource member attributes will NOT be cloned, though all other + # attributes are. This is to prevent the conflict between any +prefix_options+ + # that refer to the original parent resource and the newly cloned parent + # resource that does not exist. + # + # ryan = Person.find(1) + # ryan.address = StreetAddress.find(1, :person_id => ryan.id) + # ryan.hash = {:not => "an ARes instance"} + # + # not_ryan = ryan.clone + # not_ryan.new? # => true + # not_ryan.address # => NoMethodError + # not_ryan.hash # => {:not => "an ARes instance"} + def clone + # Clone all attributes except the pk and any nested ARes + cloned = attributes.reject {|k,v| k == self.class.primary_key || v.is_a?(ActiveResource::Base)}.inject({}) do |attrs, (k, v)| + attrs[k] = v.clone + attrs + end + # Form the new resource - bypass initialize of resource with 'new' as that will call 'load' which + # attempts to convert hashes into member objects and arrays into collections of objects. We want + # the raw objects to be cloned so we bypass load by directly setting the attributes hash. + resource = self.class.new({}) + resource.prefix_options = self.prefix_options + resource.send :instance_variable_set, '@attributes', cloned + resource + end + + + # A method to determine if the resource a new object (i.e., it has not been POSTed to the remote service yet). + # + # ==== Examples + # not_new = Computer.create(:brand => 'Apple', :make => 'MacBook', :vendor => 'MacMall') + # not_new.new? # => false + # + # is_new = Computer.new(:brand => 'IBM', :make => 'Thinkpad', :vendor => 'IBM') + # is_new.new? # => true + # + # is_new.save + # is_new.new? # => false + # + def new? + id.nil? + end + + # Get the +id+ attribute of the resource. + def id + attributes[self.class.primary_key] + end + + # Set the +id+ attribute of the resource. + def id=(id) + attributes[self.class.primary_key] = id + end + + # Allows Active Resource objects to be used as parameters in Action Pack URL generation. + def to_param + id && id.to_s + end + + # Test for equality. Resource are equal if and only if +other+ is the same object or + # is an instance of the same class, is not <tt>new?</tt>, and has the same +id+. + # + # ==== Examples + # ryan = Person.create(:name => 'Ryan') + # jamie = Person.create(:name => 'Jamie') + # + # ryan == jamie + # # => false (Different name attribute and id) + # + # ryan_again = Person.new(:name => 'Ryan') + # ryan == ryan_again + # # => false (ryan_again is new?) + # + # ryans_clone = Person.create(:name => 'Ryan') + # ryan == ryans_clone + # # => false (Different id attributes) + # + # ryans_twin = Person.find(ryan.id) + # ryan == ryans_twin + # # => true + # + def ==(other) + other.equal?(self) || (other.instance_of?(self.class) && !other.new? && other.id == id) + end + + # Tests for equality (delegates to ==). + def eql?(other) + self == other + end + + # Delegates to id in order to allow two resources of the same type and id to work with something like: + # [Person.find(1), Person.find(2)] & [Person.find(1), Person.find(4)] # => [Person.find(1)] + def hash + 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 self.class.new do |resource| + resource.attributes = @attributes + resource.prefix_options = @prefix_options + end + end + + # A method to save (+POST+) or update (+PUT+) a resource. It delegates to +create+ if a new object, + # +update+ if it is existing. If the response to the save includes a body, it will be assumed that this body + # is XML for the final object as it looked after the save (which would include attributes like +created_at+ + # that weren't part of the original submit). + # + # ==== Examples + # my_company = Company.new(:name => 'RoleModel Software', :owner => 'Ken Auer', :size => 2) + # my_company.new? # => true + # my_company.save # sends POST /companies/ (create) + # + # my_company.new? # => false + # my_company.size = 10 + # my_company.save # sends PUT /companies/1 (update) + def save + new? ? create : update + end + + # Deletes the resource from the remote service. + # + # ==== Examples + # my_id = 3 + # my_person = Person.find(my_id) + # my_person.destroy + # Person.find(my_id) # 404 (Resource Not Found) + # + # new_person = Person.create(:name => 'James') + # new_id = new_person.id # => 7 + # new_person.destroy + # Person.find(new_id) # 404 (Resource Not Found) + def destroy + connection.delete(element_path, self.class.headers) + end + + # Evaluates to <tt>true</tt> if this resource is not <tt>new?</tt> and is + # found on the remote service. Using this method, you can check for + # resources that may have been deleted between the object's instantiation + # and actions on it. + # + # ==== Examples + # Person.create(:name => 'Theodore Roosevelt') + # that_guy = Person.find(:first) + # that_guy.exists? # => true + # + # that_lady = Person.new(:name => 'Paul Bean') + # that_lady.exists? # => false + # + # guys_id = that_guy.id + # Person.delete(guys_id) + # that_guy.exists? # => false + def exists? + !new? && self.class.exists?(to_param, :params => prefix_options) + end + + # A method to convert the the resource to an XML string. + # + # ==== Options + # The +options+ parameter is handed off to the +to_xml+ method on each + # attribute, so it has the same options as the +to_xml+ methods in + # Active Support. + # + # * <tt>:indent</tt> - Set the indent level for the XML output (default is +2+). + # * <tt>:dasherize</tt> - Boolean option to determine whether or not element names should + # replace underscores with dashes (default is <tt>false</tt>). + # * <tt>:skip_instruct</tt> - Toggle skipping the +instruct!+ call on the XML builder + # that generates the XML declaration (default is <tt>false</tt>). + # + # ==== Examples + # my_group = SubsidiaryGroup.find(:first) + # my_group.to_xml + # # => <?xml version="1.0" encoding="UTF-8"?> + # # <subsidiary_group> [...] </subsidiary_group> + # + # my_group.to_xml(:dasherize => true) + # # => <?xml version="1.0" encoding="UTF-8"?> + # # <subsidiary-group> [...] </subsidiary-group> + # + # my_group.to_xml(:skip_instruct => true) + # # => <subsidiary_group> [...] </subsidiary_group> + def to_xml(options={}) + attributes.to_xml({:root => self.class.element_name}.merge(options)) + end + + # A method to reload the attributes of this object from the remote web service. + # + # ==== Examples + # my_branch = Branch.find(:first) + # my_branch.name # => "Wislon Raod" + # + # # Another client fixes the typo... + # + # my_branch.name # => "Wislon Raod" + # my_branch.reload + # my_branch.name # => "Wilson Road" + def reload + self.load(self.class.find(to_param, :params => @prefix_options).attributes) + end + + # A method to manually load attributes from a hash. Recursively loads collections of + # resources. This method is called in +initialize+ and +create+ when a hash of attributes + # is provided. + # + # ==== Examples + # my_attrs = {:name => 'J&J Textiles', :industry => 'Cloth and textiles'} + # + # the_supplier = Supplier.find(:first) + # the_supplier.name # => 'J&M Textiles' + # the_supplier.load(my_attrs) + # the_supplier.name('J&J Textiles') + # + # # These two calls are the same as Supplier.new(my_attrs) + # my_supplier = Supplier.new + # my_supplier.load(my_attrs) + # + # # These three calls are the same as Supplier.create(my_attrs) + # your_supplier = Supplier.new + # your_supplier.load(my_attrs) + # your_supplier.save + def load(attributes) + raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash) + @prefix_options, attributes = split_options(attributes) + attributes.each do |key, value| + @attributes[key.to_s] = + case value + when Array + resource = find_or_create_resource_for_collection(key) + value.map { |attrs| resource.new(attrs) } + when Hash + resource = find_or_create_resource_for(key) + resource.new(value) + else + value.dup rescue value + end + end + self + end + + # For checking <tt>respond_to?</tt> without searching the attributes (which is faster). + alias_method :respond_to_without_attributes?, :respond_to? + + # A method to determine if an object responds to a message (e.g., a method call). In Active Resource, a Person object with a + # +name+ attribute can answer <tt>true</tt> to <tt>my_person.respond_to?("name")</tt>, <tt>my_person.respond_to?("name=")</tt>, and + # <tt>my_person.respond_to?("name?")</tt>. + def respond_to?(method, include_priv = false) + method_name = method.to_s + if attributes.nil? + return super + elsif attributes.has_key?(method_name) + return true + elsif ['?','='].include?(method_name.last) && attributes.has_key?(method_name.first(-1)) + return true + end + # super must be called at the end of the method, because the inherited respond_to? + # would return true for generated readers, even if the attribute wasn't present + super + end + + + protected + def connection(refresh = false) + self.class.connection(refresh) + end + + # Update the resource on the remote service. + def update + returning connection.put(element_path(prefix_options), to_xml, self.class.headers) do |response| + load_attributes_from_response(response) + end + end + + # Create (i.e., save to the remote service) the new resource. + def create + returning connection.post(collection_path, to_xml, self.class.headers) do |response| + self.id = id_from_response(response) + load_attributes_from_response(response) + end + end + + def load_attributes_from_response(response) + if response['Content-Length'] != "0" && response.body.strip.size > 0 + load(self.class.format.decode(response.body)) + end + end + + # Takes a response from a typical create post and pulls the ID out + def id_from_response(response) + response['Location'][/\/([^\/]*?)(\.\w+)?$/, 1] + end + + def element_path(options = nil) + self.class.element_path(to_param, options || prefix_options) + end + + def collection_path(options = nil) + self.class.collection_path(options || prefix_options) + end + + private + # Tries to find a resource for a given collection name; if it fails, then the resource is created + def find_or_create_resource_for_collection(name) + find_or_create_resource_for(name.to_s.singularize) + end + + # Tries to find a resource in a non empty list of nested modules + # Raises a NameError if it was not found in any of the given nested modules + def find_resource_in_modules(resource_name, module_names) + receiver = Object + namespaces = module_names[0, module_names.size-1].map do |module_name| + receiver = receiver.const_get(module_name) + end + if namespace = namespaces.reverse.detect { |ns| ns.const_defined?(resource_name) } + return namespace.const_get(resource_name) + else + raise NameError + end + end + + # Tries to find a resource for a given name; if it fails, then the resource is created + def find_or_create_resource_for(name) + resource_name = name.to_s.camelize + ancestors = self.class.name.split("::") + if ancestors.size > 1 + find_resource_in_modules(resource_name, ancestors) + else + self.class.const_get(resource_name) + end + rescue NameError + resource = self.class.const_set(resource_name, Class.new(ActiveResource::Base)) + resource.prefix = self.class.prefix + resource.site = self.class.site + resource + end + + def split_options(options = {}) + self.class.send!(:split_options, options) + end + + def method_missing(method_symbol, *arguments) #:nodoc: + method_name = method_symbol.to_s + + case method_name.last + when "=" + attributes[method_name.first(-1)] = arguments.first + when "?" + attributes[method_name.first(-1)] + else + attributes.has_key?(method_name) ? attributes[method_name] : super + end + end + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/connection.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/connection.rb new file mode 100644 index 000000000..0c4ea432d --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/connection.rb @@ -0,0 +1,207 @@ +require 'net/https' +require 'date' +require 'time' +require 'uri' +require 'benchmark' + +module ActiveResource + class ConnectionError < StandardError # :nodoc: + attr_reader :response + + def initialize(response, message = nil) + @response = response + @message = message + end + + def to_s + "Failed with #{response.code} #{response.message if response.respond_to?(:message)}" + end + end + + # Raised when a Timeout::Error occurs. + class TimeoutError < ConnectionError + def initialize(message) + @message = message + end + def to_s; @message ;end + end + + # 3xx Redirection + class Redirection < ConnectionError # :nodoc: + def to_s; response['Location'] ? "#{super} => #{response['Location']}" : super; end + end + + # 4xx Client Error + class ClientError < ConnectionError; end # :nodoc: + + # 400 Bad Request + class BadRequest < ClientError; end # :nodoc + + # 401 Unauthorized + class UnauthorizedAccess < ClientError; end # :nodoc + + # 403 Forbidden + class ForbiddenAccess < ClientError; end # :nodoc + + # 404 Not Found + class ResourceNotFound < ClientError; end # :nodoc: + + # 409 Conflict + class ResourceConflict < ClientError; end # :nodoc: + + # 5xx Server Error + class ServerError < ConnectionError; end # :nodoc: + + # 405 Method Not Allowed + class MethodNotAllowed < ClientError # :nodoc: + def allowed_methods + @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym } + end + end + + # Class to handle connections to remote web services. + # This class is used by ActiveResource::Base to interface with REST + # services. + class Connection + attr_reader :site, :user, :password, :timeout + attr_accessor :format + + class << self + def requests + @@requests ||= [] + end + end + + # The +site+ parameter is required and will set the +site+ + # attribute to the URI for the remote resource service. + def initialize(site, format = ActiveResource::Formats[:xml]) + raise ArgumentError, 'Missing site URI' unless site + @user = @password = nil + self.site = site + self.format = format + end + + # Set URI for remote service. + def site=(site) + @site = site.is_a?(URI) ? site : URI.parse(site) + @user = URI.decode(@site.user) if @site.user + @password = URI.decode(@site.password) if @site.password + end + + # Set user for remote service. + def user=(user) + @user = user + end + + # Set password for remote service. + def password=(password) + @password = password + end + + # Set the number of seconds after which HTTP requests to the remote service should time out. + def timeout=(timeout) + @timeout = timeout + end + + # Execute a GET request. + # Used to get (find) resources. + def get(path, headers = {}) + format.decode(request(:get, path, build_request_headers(headers)).body) + end + + # Execute a DELETE request (see HTTP protocol documentation if unfamiliar). + # Used to delete resources. + def delete(path, headers = {}) + request(:delete, path, build_request_headers(headers)) + end + + # Execute a PUT request (see HTTP protocol documentation if unfamiliar). + # Used to update resources. + def put(path, body = '', headers = {}) + request(:put, path, body.to_s, build_request_headers(headers)) + end + + # Execute a POST request. + # Used to create new resources. + def post(path, body = '', headers = {}) + request(:post, path, body.to_s, build_request_headers(headers)) + end + + # Execute a HEAD request. + # Used to obtain meta-information about resources, such as whether they exist and their size (via response headers). + def head(path, headers = {}) + request(:head, path, build_request_headers(headers)) + end + + + private + # Makes request to remote service. + def request(method, path, *arguments) + logger.info "#{method.to_s.upcase} #{site.scheme}://#{site.host}:#{site.port}#{path}" if logger + result = nil + time = Benchmark.realtime { result = http.send(method, path, *arguments) } + logger.info "--> #{result.code} #{result.message} (#{result.body ? result.body.length : 0}b %.2fs)" % time if logger + handle_response(result) + rescue Timeout::Error => e + raise TimeoutError.new(e.message) + end + + # Handles response and error codes from remote service. + def handle_response(response) + case response.code.to_i + when 301,302 + raise(Redirection.new(response)) + when 200...400 + response + when 400 + raise(BadRequest.new(response)) + when 401 + raise(UnauthorizedAccess.new(response)) + when 403 + raise(ForbiddenAccess.new(response)) + when 404 + raise(ResourceNotFound.new(response)) + when 405 + raise(MethodNotAllowed.new(response)) + when 409 + raise(ResourceConflict.new(response)) + when 422 + raise(ResourceInvalid.new(response)) + when 401...500 + raise(ClientError.new(response)) + when 500...600 + raise(ServerError.new(response)) + else + raise(ConnectionError.new(response, "Unknown response code: #{response.code}")) + end + end + + # Creates new Net::HTTP instance for communication with + # remote service and resources. + def http + http = Net::HTTP.new(@site.host, @site.port) + http.use_ssl = @site.is_a?(URI::HTTPS) + http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl + http.read_timeout = @timeout if @timeout # If timeout is not set, the default Net::HTTP timeout (60s) is used. + http + end + + def default_header + @default_header ||= { 'Content-Type' => format.mime_type } + end + + # Builds headers for request to remote service. + def build_request_headers(headers) + authorization_header.update(default_header).update(headers) + end + + # Sets authorization header + def authorization_header + (@user || @password ? { 'Authorization' => 'Basic ' + ["#{@user}:#{ @password}"].pack('m').delete("\r\n") } : {}) + end + + def logger #:nodoc: + ActiveResource::Base.logger + end + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/custom_methods.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/custom_methods.rb new file mode 100644 index 000000000..4c8699288 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/custom_methods.rb @@ -0,0 +1,119 @@ +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 }, + # :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 + # # => [{:id => 1, :name => 'Ryan'}, {:id => 2, :name => 'Joe'}] + # + module CustomMethods + def self.included(base) + base.class_eval do + extend ActiveResource::CustomMethods::ClassMethods + include ActiveResource::CustomMethods::InstanceMethods + + class << self + alias :orig_delete :delete + + # 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 Active Resource instances - they are ordinary Hashes. If you are expecting + # Active Resource 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(custom_method_name, options = {}, body = '') + connection.post(custom_method_collection_url(custom_method_name, options), body, headers) + end + + def put(custom_method_name, options = {}, body = '') + connection.put(custom_method_collection_url(custom_method_name, options), body, headers) + end + + def delete(custom_method_name, options = {}) + # 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) + end + end + end + end + end + + module ClassMethods + def custom_method_collection_url(method_name, options = {}) + prefix_options, query_options = split_options(options) + "#{prefix(prefix_options)}#{collection_name}/#{method_name}.#{format.extension}#{query_string(query_options)}" + end + end + + module InstanceMethods + def get(method_name, options = {}) + connection.get(custom_method_element_url(method_name, options), self.class.headers) + end + + def post(method_name, options = {}, body = '') + if new? + connection.post(custom_method_new_element_url(method_name, options), (body.nil? ? to_xml : body), self.class.headers) + else + connection.post(custom_method_element_url(method_name, options), body, self.class.headers) + end + end + + def put(method_name, options = {}, body = '') + connection.put(custom_method_element_url(method_name, options), body, self.class.headers) + end + + def delete(method_name, options = {}) + connection.delete(custom_method_element_url(method_name, options), self.class.headers) + end + + + private + def custom_method_element_url(method_name, options = {}) + "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/#{id}/#{method_name}.#{self.class.format.extension}#{self.class.send!(:query_string, options)}" + end + + def custom_method_new_element_url(method_name, options = {}) + "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/new/#{method_name}.#{self.class.format.extension}#{self.class.send!(:query_string, options)}" + end + end + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats.rb new file mode 100644 index 000000000..28864cf58 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats.rb @@ -0,0 +1,14 @@ +module ActiveResource + module Formats + # Lookup the format class from a mime type reference symbol. Example: + # + # ActiveResource::Formats[:xml] # => ActiveResource::Formats::XmlFormat + # ActiveResource::Formats[:json] # => ActiveResource::Formats::JsonFormat + def self.[](mime_type_reference) + ActiveResource::Formats.const_get(mime_type_reference.to_s.camelize + "Format") + end + end +end + +require 'active_resource/formats/xml_format' +require 'active_resource/formats/json_format'
\ No newline at end of file diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats/json_format.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats/json_format.rb new file mode 100644 index 000000000..df0d6ca37 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats/json_format.rb @@ -0,0 +1,23 @@ +module ActiveResource + module Formats + module JsonFormat + extend self + + def extension + "json" + end + + def mime_type + "application/json" + end + + def encode(hash) + hash.to_json + end + + def decode(json) + ActiveSupport::JSON.decode(json) + end + end + end +end
\ No newline at end of file diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats/xml_format.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats/xml_format.rb new file mode 100644 index 000000000..5e97ffa77 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/formats/xml_format.rb @@ -0,0 +1,34 @@ +module ActiveResource + module Formats + module XmlFormat + extend self + + def extension + "xml" + end + + def mime_type + "application/xml" + end + + def encode(hash) + hash.to_xml + end + + def decode(xml) + from_xml_data(Hash.from_xml(xml)) + end + + private + # Manipulate from_xml Hash, because xml_simple is not exactly what we + # want for Active Resource. + def from_xml_data(data) + if data.is_a?(Hash) && data.keys.size == 1 + data.values.first + else + data + end + end + end + end +end
\ No newline at end of file diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/http_mock.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/http_mock.rb new file mode 100644 index 000000000..22f83ae91 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/http_mock.rb @@ -0,0 +1,217 @@ +require 'active_resource/connection' + +module ActiveResource + class InvalidRequestError < StandardError; end #:nodoc: + + # One thing that has always been a pain with remote web services is testing. The HttpMock + # class makes it easy to test your Active Resource models by creating a set of mock responses to specific + # requests. + # + # To test your Active Resource model, you simply call the ActiveResource::HttpMock.respond_to + # method with an attached block. The block declares a set of URIs with expected input, and the output + # each request should return. The passed in block has any number of entries in the following generalized + # format: + # + # mock.http_method(path, request_headers = {}, body = nil, status = 200, response_headers = {}) + # + # * <tt>http_method</tt> - The HTTP method to listen for. This can be +get+, +post+, +put+, +delete+ or + # +head+. + # * <tt>path</tt> - A string, starting with a "/", defining the URI that is expected to be + # called. + # * <tt>request_headers</tt> - Headers that are expected along with the request. This argument uses a + # hash format, such as <tt>{ "Content-Type" => "application/xml" }</tt>. This mock will only trigger + # if your tests sends a request with identical headers. + # * <tt>body</tt> - The data to be returned. This should be a string of Active Resource parseable content, + # such as XML. + # * <tt>status</tt> - The HTTP response code, as an integer, to return with the response. + # * <tt>response_headers</tt> - Headers to be returned with the response. Uses the same hash format as + # <tt>request_headers</tt> listed above. + # + # In order for a mock to deliver its content, the incoming request must match by the <tt>http_method</tt>, + # +path+ and <tt>request_headers</tt>. If no match is found an InvalidRequestError exception + # will be raised letting you know you need to create a new mock for that request. + # + # ==== Example + # def setup + # @matz = { :id => 1, :name => "Matz" }.to_xml(:root => "person") + # ActiveResource::HttpMock.respond_to do |mock| + # mock.post "/people.xml", {}, @matz, 201, "Location" => "/people/1.xml" + # mock.get "/people/1.xml", {}, @matz + # mock.put "/people/1.xml", {}, nil, 204 + # mock.delete "/people/1.xml", {}, nil, 200 + # end + # end + # + # def test_get_matz + # person = Person.find(1) + # assert_equal "Matz", person.name + # end + # + class HttpMock + class Responder #:nodoc: + def initialize(responses) + @responses = responses + end + + for method in [ :post, :put, :get, :delete, :head ] + module_eval <<-EOE, __FILE__, __LINE__ + def #{method}(path, request_headers = {}, body = nil, status = 200, response_headers = {}) + @responses[Request.new(:#{method}, path, nil, request_headers)] = Response.new(body || "", status, response_headers) + end + EOE + end + end + + class << self + + # Returns an array of all request objects that have been sent to the mock. You can use this to check + # wether or not your model actually sent an HTTP request. + # + # ==== Example + # def setup + # @matz = { :id => 1, :name => "Matz" }.to_xml(:root => "person") + # ActiveResource::HttpMock.respond_to do |mock| + # mock.get "/people/1.xml", {}, @matz + # end + # end + # + # def test_should_request_remote_service + # person = Person.find(1) # Call the remote service + # + # # This request object has the same HTTP method and path as declared by the mock + # expected_request = ActiveResource::Request.new(:get, "/people/1.xml") + # + # # Assert that the mock received, and responded to, the expected request from the model + # assert ActiveResource::HttpMock.requests.include?(expected_request) + # end + def requests + @@requests ||= [] + end + + # Returns a hash of <tt>request => response</tt> pairs for all all responses this mock has delivered, where +request+ + # is an instance of ActiveResource::Request and the response is, naturally, an instance of + # ActiveResource::Response. + def responses + @@responses ||= {} + end + + # Accepts a block which declares a set of requests and responses for the HttpMock to respond to. See the main + # ActiveResource::HttpMock description for a more detailed explanation. + def respond_to(pairs = {}) #:yields: mock + reset! + pairs.each do |(path, response)| + responses[path] = response + end + + if block_given? + yield Responder.new(responses) + else + Responder.new(responses) + end + end + + # Deletes all logged requests and responses. + def reset! + requests.clear + responses.clear + end + end + + for method in [ :post, :put ] + module_eval <<-EOE, __FILE__, __LINE__ + def #{method}(path, body, headers) + request = ActiveResource::Request.new(:#{method}, path, body, headers) + self.class.requests << request + self.class.responses[request] || raise(InvalidRequestError.new("No response recorded for \#{request}")) + end + EOE + end + + for method in [ :get, :delete, :head ] + module_eval <<-EOE, __FILE__, __LINE__ + def #{method}(path, headers) + request = ActiveResource::Request.new(:#{method}, path, nil, headers) + self.class.requests << request + self.class.responses[request] || raise(InvalidRequestError.new("No response recorded for \#{request}")) + end + EOE + end + + def initialize(site) #:nodoc: + @site = site + end + end + + class Request + attr_accessor :path, :method, :body, :headers + + def initialize(method, path, body = nil, headers = {}) + @method, @path, @body, @headers = method, path, body, headers.reverse_merge('Content-Type' => 'application/xml') + end + + def ==(other_request) + other_request.hash == hash + end + + def eql?(other_request) + self == other_request + end + + def to_s + "<#{method.to_s.upcase}: #{path} [#{headers}] (#{body})>" + end + + def hash + "#{path}#{method}#{headers}".hash + end + end + + class Response + attr_accessor :body, :message, :code, :headers + + def initialize(body, message = 200, headers = {}) + @body, @message, @headers = body, message.to_s, headers + @code = @message[0,3].to_i + + resp_cls = Net::HTTPResponse::CODE_TO_OBJ[@code.to_s] + if resp_cls && !resp_cls.body_permitted? + @body = nil + end + + if @body.nil? + self['Content-Length'] = "0" + else + self['Content-Length'] = body.size.to_s + end + end + + def success? + (200..299).include?(code) + end + + def [](key) + headers[key] + end + + def []=(key, value) + headers[key] = value + end + + def ==(other) + if (other.is_a?(Response)) + other.body == body && other.message == message && other.headers == headers + else + false + end + end + end + + class Connection + private + silence_warnings do + def http + @http ||= HttpMock.new(@site) + end + end + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/validations.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/validations.rb new file mode 100644 index 000000000..a7c624f30 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/validations.rb @@ -0,0 +1,288 @@ +module ActiveResource + class ResourceInvalid < ClientError #:nodoc: + end + + # Active Resource validation is reported to and from this object, which is used by Base#save + # to determine whether the object in a valid state to be saved. See usage example in Validations. + class Errors + include Enumerable + attr_reader :errors + + delegate :empty?, :to => :errors + + def initialize(base) # :nodoc: + @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 + + # A method to return the errors associated with +attribute+, which returns nil, if no errors are + # associated with the specified +attribute+, the error message if one error is associated with the specified +attribute+, + # or an array of error messages if more than one error is associated with the specified +attribute+. + # + # ==== Examples + # my_person = Person.new(params[:person]) + # my_person.errors.on('login') + # # => nil + # + # my_person.errors.add('login', 'can not be empty') if my_person.login == '' + # my_person.errors.on('login') + # # => 'can not be empty' + # + # my_person.errors.add('login', 'can not be longer than 10 characters') if my_person.login.length > 10 + # my_person.errors.on('login') + # # => ['can not be empty', 'can not be longer than 10 characters'] + def on(attribute) + errors = @errors[attribute.to_s] + return nil if errors.nil? + errors.size == 1 ? errors.first : errors + end + + alias :[] :on + + # A method to return errors assigned to +base+ object through add_to_base, which returns nil, if no errors are + # associated with the specified +attribute+, the error message if one error is associated with the specified +attribute+, + # or an array of error messages if more than one error is associated with the specified +attribute+. + # + # ==== Examples + # my_account = Account.find(1) + # my_account.errors.on_base + # # => nil + # + # my_account.errors.add_to_base("This account is frozen") + # my_account.errors.on_base + # # => "This account is frozen" + # + # my_account.errors.add_to_base("This account has been closed") + # my_account.errors.on_base + # # => ["This account is frozen", "This account has been closed"] + # + 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 = [] + + @errors.each_key do |attr| + @errors[attr].each do |msg| + next if msg.nil? + + if attr == "base" + full_messages << msg + else + full_messages << [attr.humanize, msg].join(' ') + end + end + end + full_messages + end + + def clear + @errors = {} + end + + # 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 + + 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) } + messages = Hash.from_xml(xml)['errors']['error'] rescue [] + messages.each do |message| + attr_message = humanized_attributes.keys.detect do |attr_name| + if message[0, attr_name.size + 1] == "#{attr_name} " + add humanized_attributes[attr_name], message[(attr_name.size + 1)..-1] + end + end + + add_to_base message if attr_message.nil? + end + end + end + + # Module to allow validation of Active Resource objects, which creates an Errors instance for every resource. + # Methods are implemented by overriding Base#validate or its variants Each of these methods can inspect + # the state of the object, which usually means ensuring that a number of attributes have a certain value + # (such as not empty, within a given range, matching a certain regular expression and so on). + # + # ==== Example + # + # class Person < ActiveResource::Base + # self.site = "http://www.localhost.com:3000/" + # protected + # def validate + # errors.add_on_empty %w( first_name last_name ) + # errors.add("phone_number", "has invalid format") unless phone_number =~ /[0-9]*/ + # end + # + # def validate_on_create # is only run the first time a new object is saved + # unless valid_member?(self) + # errors.add("membership_discount", "has expired") + # end + # end + # + # def validate_on_update + # errors.add_to_base("No changes have occurred") if unchanged_attributes? + # end + # end + # + # person = Person.new("first_name" => "Jim", "phone_number" => "I will not tell you.") + # person.save # => false (and doesn't do the save) + # person.errors.empty? # => false + # person.errors.count # => 2 + # person.errors.on "last_name" # => "can't be empty" + # person.attributes = { "last_name" => "Halpert", "phone_number" => "555-5555" } + # person.save # => true (and person is now saved to the remote service) + # + module Validations + def self.included(base) # :nodoc: + base.class_eval do + alias_method_chain :save, :validation + end + end + + # Validate a resource and save (POST) it to the remote web service. + def save_with_validation + save_without_validation + true + rescue ResourceInvalid => error + errors.from_xml(error.response.body) + 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 + + # Returns the Errors object that holds all information about attribute error messages. + def errors + @errors ||= Errors.new(self) + end + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/version.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/version.rb new file mode 100644 index 000000000..88798ea1c --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/active_resource/version.rb @@ -0,0 +1,9 @@ +module ActiveResource + module VERSION #:nodoc: + MAJOR = 2 + MINOR = 1 + TINY = 0 + + STRING = [MAJOR, MINOR, TINY].join('.') + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/activeresource.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/activeresource.rb new file mode 100644 index 000000000..e076455b1 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/lib/activeresource.rb @@ -0,0 +1 @@ +require 'active_resource' diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/abstract_unit.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/abstract_unit.rb new file mode 100644 index 000000000..615a6d922 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/abstract_unit.rb @@ -0,0 +1,22 @@ +require 'test/unit' + +$:.unshift "#{File.dirname(__FILE__)}/../lib" +require 'active_resource' +require 'active_resource/http_mock' + +$:.unshift "#{File.dirname(__FILE__)}/../test" +require 'setter_trap' + +ActiveResource::Base.logger = Logger.new("#{File.dirname(__FILE__)}/debug.log") + +# Wrap tests that use Mocha and skip if unavailable. +def uses_mocha(test_name) + unless Object.const_defined?(:Mocha) + require 'mocha' + require 'stubba' + end + yield +rescue LoadError => load_error + raise unless load_error.message =~ /mocha/i + $stderr.puts "Skipping #{test_name} tests. `gem install mocha` and try again." +end
\ No newline at end of file diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/authorization_test.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/authorization_test.rb new file mode 100644 index 000000000..921522762 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/authorization_test.rb @@ -0,0 +1,122 @@ +require 'abstract_unit' + +class AuthorizationTest < Test::Unit::TestCase + Response = Struct.new(:code) + + def setup + @conn = ActiveResource::Connection.new('http://localhost') + @matz = { :id => 1, :name => 'Matz' }.to_xml(:root => 'person') + @david = { :id => 2, :name => 'David' }.to_xml(:root => 'person') + @authenticated_conn = ActiveResource::Connection.new("http://david:test123@localhost") + @authorization_request_header = { 'Authorization' => 'Basic ZGF2aWQ6dGVzdDEyMw==' } + + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/2.xml", @authorization_request_header, @david + mock.put "/people/2.xml", @authorization_request_header, nil, 204 + mock.delete "/people/2.xml", @authorization_request_header, nil, 200 + mock.post "/people/2/addresses.xml", @authorization_request_header, nil, 201, 'Location' => '/people/1/addresses/5' + end + end + + def test_authorization_header + authorization_header = @authenticated_conn.send!(:authorization_header) + assert_equal @authorization_request_header['Authorization'], authorization_header['Authorization'] + authorization = authorization_header["Authorization"].to_s.split + + assert_equal "Basic", authorization[0] + assert_equal ["david", "test123"], ActiveSupport::Base64.decode64(authorization[1]).split(":")[0..1] + end + + def test_authorization_header_with_username_but_no_password + @conn = ActiveResource::Connection.new("http://david:@localhost") + authorization_header = @conn.send!(:authorization_header) + authorization = authorization_header["Authorization"].to_s.split + + assert_equal "Basic", authorization[0] + assert_equal ["david"], ActiveSupport::Base64.decode64(authorization[1]).split(":")[0..1] + end + + def test_authorization_header_with_password_but_no_username + @conn = ActiveResource::Connection.new("http://:test123@localhost") + authorization_header = @conn.send!(:authorization_header) + authorization = authorization_header["Authorization"].to_s.split + + assert_equal "Basic", authorization[0] + assert_equal ["", "test123"], ActiveSupport::Base64.decode64(authorization[1]).split(":")[0..1] + end + + def test_authorization_header_with_decoded_credentials_from_url + @conn = ActiveResource::Connection.new("http://my%40email.com:%31%32%33@localhost") + authorization_header = @conn.send!(:authorization_header) + authorization = authorization_header["Authorization"].to_s.split + + assert_equal "Basic", authorization[0] + assert_equal ["my@email.com", "123"], ActiveSupport::Base64.decode64(authorization[1]).split(":")[0..1] + end + + def test_authorization_header_explicitly_setting_username_and_password + @authenticated_conn = ActiveResource::Connection.new("http://@localhost") + @authenticated_conn.user = 'david' + @authenticated_conn.password = 'test123' + authorization_header = @authenticated_conn.send!(:authorization_header) + assert_equal @authorization_request_header['Authorization'], authorization_header['Authorization'] + authorization = authorization_header["Authorization"].to_s.split + + assert_equal "Basic", authorization[0] + assert_equal ["david", "test123"], ActiveSupport::Base64.decode64(authorization[1]).split(":")[0..1] + end + + def test_authorization_header_explicitly_setting_username_but_no_password + @conn = ActiveResource::Connection.new("http://@localhost") + @conn.user = "david" + authorization_header = @conn.send!(:authorization_header) + authorization = authorization_header["Authorization"].to_s.split + + assert_equal "Basic", authorization[0] + assert_equal ["david"], ActiveSupport::Base64.decode64(authorization[1]).split(":")[0..1] + end + + def test_authorization_header_explicitly_setting_password_but_no_username + @conn = ActiveResource::Connection.new("http://@localhost") + @conn.password = "test123" + authorization_header = @conn.send!(:authorization_header) + authorization = authorization_header["Authorization"].to_s.split + + assert_equal "Basic", authorization[0] + assert_equal ["", "test123"], ActiveSupport::Base64.decode64(authorization[1]).split(":")[0..1] + end + + def test_get + david = @authenticated_conn.get("/people/2.xml") + assert_equal "David", david["name"] + end + + def test_post + response = @authenticated_conn.post("/people/2/addresses.xml") + assert_equal "/people/1/addresses/5", response["Location"] + end + + def test_put + response = @authenticated_conn.put("/people/2.xml") + assert_equal 204, response.code + end + + def test_delete + response = @authenticated_conn.delete("/people/2.xml") + assert_equal 200, response.code + end + + def test_raises_invalid_request_on_unauthorized_requests + assert_raises(ActiveResource::InvalidRequestError) { @conn.post("/people/2.xml") } + assert_raises(ActiveResource::InvalidRequestError) { @conn.post("/people/2/addresses.xml") } + assert_raises(ActiveResource::InvalidRequestError) { @conn.put("/people/2.xml") } + assert_raises(ActiveResource::InvalidRequestError) { @conn.delete("/people/2.xml") } + end + + protected + def assert_response_raises(klass, code) + assert_raise(klass, "Expected response code #{code} to raise #{klass}") do + @conn.send!(:handle_response, Response.new(code)) + end + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/custom_methods_test.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/custom_methods_test.rb new file mode 100644 index 000000000..62c33ef9b --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/custom_methods_test.rb @@ -0,0 +1,99 @@ +require 'abstract_unit' +require 'fixtures/person' +require 'fixtures/street_address' + +class CustomMethodsTest < Test::Unit::TestCase + def setup + @matz = { :id => 1, :name => 'Matz' }.to_xml(:root => 'person') + @matz_deep = { :id => 1, :name => 'Matz', :other => 'other' }.to_xml(:root => 'person') + @matz_array = [{ :id => 1, :name => 'Matz' }].to_xml(:root => 'people') + @ryan = { :name => 'Ryan' }.to_xml(:root => 'person') + @addy = { :id => 1, :street => '12345 Street' }.to_xml(:root => 'address') + @addy_deep = { :id => 1, :street => '12345 Street', :zip => "27519" }.to_xml(:root => 'address') + @default_request_headers = { 'Content-Type' => 'application/xml' } + + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/1.xml", {}, @matz + mock.get "/people/1/shallow.xml", {}, @matz + mock.get "/people/1/deep.xml", {}, @matz_deep + mock.get "/people/retrieve.xml?name=Matz", {}, @matz_array + mock.get "/people/managers.xml", {}, @matz_array + mock.post "/people/hire.xml?name=Matz", {}, nil, 201 + mock.put "/people/1/promote.xml?position=Manager", {}, nil, 204 + mock.put "/people/promote.xml?name=Matz", {}, nil, 204, {} + mock.put "/people/sort.xml?by=name", {}, nil, 204 + mock.delete "/people/deactivate.xml?name=Matz", {}, nil, 200 + mock.delete "/people/1/deactivate.xml", {}, nil, 200 + mock.post "/people/new/register.xml", {}, @ryan, 201, 'Location' => '/people/5.xml' + mock.post "/people/1/register.xml", {}, @matz, 201 + mock.get "/people/1/addresses/1.xml", {}, @addy + mock.get "/people/1/addresses/1/deep.xml", {}, @addy_deep + mock.put "/people/1/addresses/1/normalize_phone.xml?locale=US", {}, nil, 204 + mock.put "/people/1/addresses/sort.xml?by=name", {}, nil, 204 + mock.post "/people/1/addresses/new/link.xml", {}, { :street => '12345 Street' }.to_xml(:root => 'address'), 201, 'Location' => '/people/1/addresses/2.xml' + end + + Person.user = nil + Person.password = nil + end + + def teardown + ActiveResource::HttpMock.reset! + end + + def test_custom_collection_method + # GET + assert_equal([{ "id" => 1, "name" => 'Matz' }], Person.get(:retrieve, :name => 'Matz')) + + # POST + assert_equal(ActiveResource::Response.new("", 201, {}), Person.post(:hire, :name => 'Matz')) + + # PUT + assert_equal ActiveResource::Response.new("", 204, {}), + Person.put(:promote, {:name => 'Matz'}, 'atestbody') + assert_equal ActiveResource::Response.new("", 204, {}), Person.put(:sort, :by => 'name') + + # DELETE + Person.delete :deactivate, :name => 'Matz' + + # Nested resource + assert_equal ActiveResource::Response.new("", 204, {}), StreetAddress.put(:sort, :person_id => 1, :by => 'name') + end + + def test_custom_element_method + # Test GET against an element URL + assert_equal Person.find(1).get(:shallow), {"id" => 1, "name" => 'Matz'} + assert_equal Person.find(1).get(:deep), {"id" => 1, "name" => 'Matz', "other" => 'other'} + + # Test PUT against an element URL + assert_equal ActiveResource::Response.new("", 204, {}), Person.find(1).put(:promote, {:position => 'Manager'}, 'body') + + # Test DELETE against an element URL + assert_equal ActiveResource::Response.new("", 200, {}), Person.find(1).delete(:deactivate) + + # With nested resources + assert_equal StreetAddress.find(1, :params => { :person_id => 1 }).get(:deep), + { "id" => 1, "street" => '12345 Street', "zip" => "27519" } + assert_equal ActiveResource::Response.new("", 204, {}), + StreetAddress.find(1, :params => { :person_id => 1 }).put(:normalize_phone, :locale => 'US') + end + + def test_custom_new_element_method + # Test POST against a new element URL + ryan = Person.new(:name => 'Ryan') + assert_equal ActiveResource::Response.new(@ryan, 201, {'Location' => '/people/5.xml'}), ryan.post(:register) + + # Test POST against a nested collection URL + addy = StreetAddress.new(:street => '123 Test Dr.', :person_id => 1) + assert_equal ActiveResource::Response.new({ :street => '12345 Street' }.to_xml(:root => 'address'), + 201, {'Location' => '/people/1/addresses/2.xml'}), + addy.post(:link) + + matz = Person.new(:id => 1, :name => 'Matz') + assert_equal ActiveResource::Response.new(@matz, 201), matz.post(:register) + end + + def test_find_custom_resources + assert_equal 'Matz', Person.find(:all, :from => :managers).first.name + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/equality_test.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/equality_test.rb new file mode 100644 index 000000000..1fb8938e9 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/equality_test.rb @@ -0,0 +1,43 @@ +require 'abstract_unit' +require "fixtures/person" +require "fixtures/street_address" + +class BaseEqualityTest < Test::Unit::TestCase + def setup + @new = Person.new + @one = Person.new(:id => 1) + @two = Person.new(:id => 2) + @street = StreetAddress.new(:id => 2) + end + + def test_should_equal_self + assert @new == @new, '@new == @new' + assert @one == @one, '@one == @one' + end + + def test_shouldnt_equal_new_resource + assert @new != @one, '@new != @one' + assert @one != @new, '@one != @new' + end + + def test_shouldnt_equal_different_class + assert @two != @street, 'person != street_address with same id' + assert @street != @two, 'street_address != person with same id' + end + + def test_eql_should_alias_equals_operator + assert_equal @new == @new, @new.eql?(@new) + assert_equal @new == @one, @new.eql?(@one) + + assert_equal @one == @one, @one.eql?(@one) + assert_equal @one == @new, @one.eql?(@new) + + assert_equal @one == @street, @one.eql?(@street) + end + + def test_hash_should_be_id_hash + [@new, @one, @two, @street].each do |resource| + assert_equal resource.id.hash, resource.hash + end + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/load_test.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/load_test.rb new file mode 100644 index 000000000..737afb174 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base/load_test.rb @@ -0,0 +1,146 @@ +require 'abstract_unit' +require "fixtures/person" +require "fixtures/street_address" + +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 + + module Deeply + module Nested + + class Note < ActiveResource::Base + self.site = "http://37s.sunrise.i:3000" + end + + class Comment < ActiveResource::Base + self.site = "http://37s.sunrise.i:3000" + end + + module TestDifferentLevels + + class Note < ActiveResource::Base + self.site = "http://37s.sunrise.i:3000" + end + + end + + end + end + +end + + +class BaseLoadTest < Test::Unit::TestCase + def setup + @matz = { :id => 1, :name => 'Matz' } + + @first_address = { :id => 1, :street => '12345 Street' } + @addresses = [@first_address, { :id => 2, :street => '67890 Street' }] + @addresses_from_xml = { :street_addresses => @addresses } + @addresses_from_xml_single = { :street_addresses => [ @first_address ] } + + @deep = { :id => 1, :street => { + :id => 1, :state => { :id => 1, :name => 'Oregon', + :notable_rivers => [ + { :id => 1, :name => 'Willamette' }, + { :id => 2, :name => 'Columbia', :rafted_by => @matz }] }}} + + @person = Person.new + end + + def test_load_expects_hash + assert_raise(ArgumentError) { @person.load nil } + assert_raise(ArgumentError) { @person.load '<person id="1"/>' } + end + + def test_load_simple_hash + assert_equal Hash.new, @person.attributes + assert_equal @matz.stringify_keys, @person.load(@matz).attributes + end + + def test_load_one_with_existing_resource + address = @person.load(:street_address => @first_address).street_address + assert_kind_of StreetAddress, address + assert_equal @first_address.stringify_keys, address.attributes + end + + def test_load_one_with_unknown_resource + address = silence_warnings { @person.load(:address => @first_address).address } + assert_kind_of Person::Address, address + assert_equal @first_address.stringify_keys, address.attributes + end + + def test_load_collection_with_existing_resource + addresses = @person.load(@addresses_from_xml).street_addresses + assert_kind_of Array, addresses + addresses.each { |address| assert_kind_of StreetAddress, address } + assert_equal @addresses.map(&:stringify_keys), addresses.map(&:attributes) + end + + def test_load_collection_with_unknown_resource + Person.send!(:remove_const, :Address) if Person.const_defined?(:Address) + assert !Person.const_defined?(:Address), "Address shouldn't exist until autocreated" + addresses = silence_warnings { @person.load(:addresses => @addresses).addresses } + assert Person.const_defined?(:Address), "Address should have been autocreated" + addresses.each { |address| assert_kind_of Person::Address, address } + assert_equal @addresses.map(&:stringify_keys), addresses.map(&:attributes) + end + + def test_load_collection_with_single_existing_resource + addresses = @person.load(@addresses_from_xml_single).street_addresses + assert_kind_of Array, addresses + addresses.each { |address| assert_kind_of StreetAddress, address } + assert_equal [ @first_address ].map(&:stringify_keys), addresses.map(&:attributes) + end + + def test_load_collection_with_single_unknown_resource + Person.send!(:remove_const, :Address) if Person.const_defined?(:Address) + assert !Person.const_defined?(:Address), "Address shouldn't exist until autocreated" + addresses = silence_warnings { @person.load(:addresses => [ @first_address ]).addresses } + assert Person.const_defined?(:Address), "Address should have been autocreated" + addresses.each { |address| assert_kind_of Person::Address, address } + assert_equal [ @first_address ].map(&:stringify_keys), addresses.map(&:attributes) + end + + def test_recursively_loaded_collections + person = @person.load(@deep) + assert_equal @deep[:id], person.id + + street = person.street + assert_kind_of Person::Street, street + assert_equal @deep[:street][:id], street.id + + state = street.state + assert_kind_of Person::Street::State, state + assert_equal @deep[:street][:state][:id], state.id + + rivers = state.notable_rivers + assert_kind_of Array, rivers + assert_kind_of Person::Street::State::NotableRiver, rivers.first + assert_equal @deep[:street][:state][:notable_rivers].first[:id], rivers.first.id + assert_equal @matz[:id], rivers.last.rafted_by.id + end + + def test_nested_collections_within_the_same_namespace + n = Highrise::Note.new(:comments => [{ :name => "1" }]) + assert_kind_of Highrise::Comment, n.comments.first + end + + def test_nested_collections_within_deeply_nested_namespace + n = Highrise::Deeply::Nested::Note.new(:comments => [{ :name => "1" }]) + assert_kind_of Highrise::Deeply::Nested::Comment, n.comments.first + end + + def test_nested_collections_in_different_levels_of_namespaces + n = Highrise::Deeply::Nested::TestDifferentLevels::Note.new(:comments => [{ :name => "1" }]) + assert_kind_of Highrise::Deeply::Nested::Comment, n.comments.first + end + + +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base_errors_test.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base_errors_test.rb new file mode 100644 index 000000000..7ae92c7d9 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base_errors_test.rb @@ -0,0 +1,48 @@ +require 'abstract_unit' +require "fixtures/person" + +class BaseErrorsTest < Test::Unit::TestCase + def setup + ActiveResource::HttpMock.respond_to do |mock| + mock.post "/people.xml", {}, "<?xml version=\"1.0\" encoding=\"UTF-8\"?><errors><error>Age can't be blank</error><error>Name can't be blank</error><error>Name must start with a letter</error><error>Person quota full for today.</error></errors>", 422 + end + @person = Person.new(:name => '', :age => '') + assert_equal @person.save, false + end + + def test_should_mark_as_invalid + assert !@person.valid? + end + + def test_should_parse_xml_errors + assert_kind_of ActiveResource::Errors, @person.errors + assert_equal 4, @person.errors.size + end + + def test_should_parse_errors_to_individual_attributes + assert @person.errors.invalid?(:name) + assert_equal "can't be blank", @person.errors.on(:age) + assert_equal ["can't be blank", "must start with a letter"], @person.errors[:name] + assert_equal "Person quota full for today.", @person.errors.on_base + end + + def test_should_iterate_over_errors + errors = [] + @person.errors.each { |attribute, message| errors << [attribute, message] } + assert errors.include?(["name", "can't be blank"]) + end + + def test_should_iterate_over_full_errors + errors = [] + @person.errors.each_full { |message| errors << message } + assert errors.include?("Name can't be blank") + end + + def test_should_format_full_errors + full = @person.errors.full_messages + assert full.include?("Age can't be blank") + assert full.include?("Name can't be blank") + assert full.include?("Name must start with a letter") + assert full.include?("Person quota full for today.") + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base_test.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base_test.rb new file mode 100644 index 000000000..9e2f6c183 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/base_test.rb @@ -0,0 +1,791 @@ +require 'abstract_unit' +require "fixtures/person" +require "fixtures/street_address" +require "fixtures/beast" + +class BaseTest < Test::Unit::TestCase + def setup + @matz = { :id => 1, :name => 'Matz' }.to_xml(:root => 'person') + @david = { :id => 2, :name => 'David' }.to_xml(:root => 'person') + @greg = { :id => 3, :name => 'Greg' }.to_xml(:root => 'person') + @addy = { :id => 1, :street => '12345 Street' }.to_xml(:root => 'address') + @default_request_headers = { 'Content-Type' => 'application/xml' } + @rick = { :name => "Rick", :age => 25 }.to_xml(:root => "person") + @people = [{ :id => 1, :name => 'Matz' }, { :id => 2, :name => 'David' }].to_xml(:root => 'people') + @people_david = [{ :id => 2, :name => 'David' }].to_xml(:root => 'people') + @addresses = [{ :id => 1, :street => '12345 Street' }].to_xml(:root => 'addresses') + + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/1.xml", {}, @matz + mock.get "/people/2.xml", {}, @david + mock.get "/people/Greg.xml", {}, @greg + mock.get "/people/4.xml", {'key' => 'value'}, nil, 404 + mock.put "/people/1.xml", {}, nil, 204 + mock.delete "/people/1.xml", {}, nil, 200 + mock.delete "/people/2.xml", {}, nil, 400 + mock.get "/people/99.xml", {}, nil, 404 + mock.post "/people.xml", {}, @rick, 201, 'Location' => '/people/5.xml' + mock.get "/people.xml", {}, @people + mock.get "/people/1/addresses.xml", {}, @addresses + mock.get "/people/1/addresses/1.xml", {}, @addy + mock.get "/people/1/addresses/2.xml", {}, nil, 404 + mock.get "/people/2/addresses/1.xml", {}, nil, 404 + mock.get "/people/Greg/addresses/1.xml", {}, @addy + mock.put "/people/1/addresses/1.xml", {}, nil, 204 + mock.delete "/people/1/addresses/1.xml", {}, nil, 200 + mock.post "/people/1/addresses.xml", {}, nil, 201, 'Location' => '/people/1/addresses/5' + mock.get "/people//addresses.xml", {}, nil, 404 + mock.get "/people//addresses/1.xml", {}, nil, 404 + mock.put "/people//addresses/1.xml", {}, nil, 404 + mock.delete "/people//addresses/1.xml", {}, nil, 404 + mock.post "/people//addresses.xml", {}, nil, 404 + mock.head "/people/1.xml", {}, nil, 200 + mock.head "/people/Greg.xml", {}, nil, 200 + mock.head "/people/99.xml", {}, nil, 404 + mock.head "/people/1/addresses/1.xml", {}, nil, 200 + mock.head "/people/1/addresses/2.xml", {}, nil, 404 + mock.head "/people/2/addresses/1.xml", {}, nil, 404 + mock.head "/people/Greg/addresses/1.xml", {}, nil, 200 + end + + Person.user = nil + Person.password = nil + end + + + def test_site_accessor_accepts_uri_or_string_argument + site = URI.parse('http://localhost') + + assert_nothing_raised { Person.site = 'http://localhost' } + assert_equal site, Person.site + + assert_nothing_raised { Person.site = site } + assert_equal site, Person.site + end + + def test_should_use_site_prefix_and_credentials + assert_equal 'http://foo:bar@beast.caboo.se', Forum.site.to_s + assert_equal 'http://foo:bar@beast.caboo.se/forums/:forum_id', Topic.site.to_s + end + + def test_site_variable_can_be_reset + actor = Class.new(ActiveResource::Base) + assert_nil actor.site + actor.site = 'http://localhost:31337' + actor.site = nil + assert_nil actor.site + end + + def test_should_accept_setting_user + Forum.user = 'david' + assert_equal('david', Forum.user) + assert_equal('david', Forum.connection.user) + end + + def test_should_accept_setting_password + Forum.password = 'test123' + assert_equal('test123', Forum.password) + assert_equal('test123', Forum.connection.password) + end + + def test_should_accept_setting_timeout + Forum.timeout = 5 + assert_equal(5, Forum.timeout) + assert_equal(5, Forum.connection.timeout) + end + + def test_user_variable_can_be_reset + actor = Class.new(ActiveResource::Base) + actor.site = 'http://cinema' + assert_nil actor.user + actor.user = 'username' + actor.user = nil + assert_nil actor.user + assert_nil actor.connection.user + end + + def test_password_variable_can_be_reset + actor = Class.new(ActiveResource::Base) + actor.site = 'http://cinema' + assert_nil actor.password + actor.password = 'username' + actor.password = nil + assert_nil actor.password + assert_nil actor.connection.password + end + + def test_timeout_variable_can_be_reset + actor = Class.new(ActiveResource::Base) + actor.site = 'http://cinema' + assert_nil actor.timeout + actor.timeout = 5 + actor.timeout = nil + assert_nil actor.timeout + assert_nil actor.connection.timeout + end + + def test_credentials_from_site_are_decoded + actor = Class.new(ActiveResource::Base) + actor.site = 'http://my%40email.com:%31%32%33@cinema' + assert_equal("my@email.com", actor.user) + assert_equal("123", actor.password) + end + + def test_site_reader_uses_superclass_site_until_written + # Superclass is Object so returns nil. + assert_nil ActiveResource::Base.site + assert_nil Class.new(ActiveResource::Base).site + + # Subclass uses superclass site. + actor = Class.new(Person) + assert_equal Person.site, actor.site + + # Subclass returns frozen superclass copy. + assert !Person.site.frozen? + assert actor.site.frozen? + + # Changing subclass site doesn't change superclass site. + actor.site = 'http://localhost:31337' + assert_not_equal Person.site, actor.site + + # Changed subclass site is not frozen. + assert !actor.site.frozen? + + # Changing superclass site doesn't overwrite subclass site. + Person.site = 'http://somewhere.else' + assert_not_equal Person.site, actor.site + + # Changing superclass site after subclassing changes subclass site. + jester = Class.new(actor) + actor.site = 'http://nomad' + assert_equal actor.site, jester.site + assert jester.site.frozen? + + # Subclasses are always equal to superclass site when not overridden + fruit = Class.new(ActiveResource::Base) + apple = Class.new(fruit) + + fruit.site = 'http://market' + assert_equal fruit.site, apple.site, 'subclass did not adopt changes from parent class' + + fruit.site = 'http://supermarket' + assert_equal fruit.site, apple.site, 'subclass did not adopt changes from parent class' + end + + def test_user_reader_uses_superclass_user_until_written + # Superclass is Object so returns nil. + assert_nil ActiveResource::Base.user + assert_nil Class.new(ActiveResource::Base).user + Person.user = 'anonymous' + + # Subclass uses superclass user. + actor = Class.new(Person) + assert_equal Person.user, actor.user + + # Subclass returns frozen superclass copy. + assert !Person.user.frozen? + assert actor.user.frozen? + + # Changing subclass user doesn't change superclass user. + actor.user = 'david' + assert_not_equal Person.user, actor.user + + # Changing superclass user doesn't overwrite subclass user. + Person.user = 'john' + assert_not_equal Person.user, actor.user + + # Changing superclass user after subclassing changes subclass user. + jester = Class.new(actor) + actor.user = 'john.doe' + assert_equal actor.user, jester.user + + # Subclasses are always equal to superclass user when not overridden + fruit = Class.new(ActiveResource::Base) + apple = Class.new(fruit) + + fruit.user = 'manager' + assert_equal fruit.user, apple.user, 'subclass did not adopt changes from parent class' + + fruit.user = 'client' + assert_equal fruit.user, apple.user, 'subclass did not adopt changes from parent class' + end + + def test_password_reader_uses_superclass_password_until_written + # Superclass is Object so returns nil. + assert_nil ActiveResource::Base.password + assert_nil Class.new(ActiveResource::Base).password + Person.password = 'my-password' + + # Subclass uses superclass password. + actor = Class.new(Person) + assert_equal Person.password, actor.password + + # Subclass returns frozen superclass copy. + assert !Person.password.frozen? + assert actor.password.frozen? + + # Changing subclass password doesn't change superclass password. + actor.password = 'secret' + assert_not_equal Person.password, actor.password + + # Changing superclass password doesn't overwrite subclass password. + Person.password = 'super-secret' + assert_not_equal Person.password, actor.password + + # Changing superclass password after subclassing changes subclass password. + jester = Class.new(actor) + actor.password = 'even-more-secret' + assert_equal actor.password, jester.password + + # Subclasses are always equal to superclass password when not overridden + fruit = Class.new(ActiveResource::Base) + apple = Class.new(fruit) + + fruit.password = 'mega-secret' + assert_equal fruit.password, apple.password, 'subclass did not adopt changes from parent class' + + fruit.password = 'ok-password' + assert_equal fruit.password, apple.password, 'subclass did not adopt changes from parent class' + end + + def test_timeout_reader_uses_superclass_timeout_until_written + # Superclass is Object so returns nil. + assert_nil ActiveResource::Base.timeout + assert_nil Class.new(ActiveResource::Base).timeout + Person.timeout = 5 + + # Subclass uses superclass timeout. + actor = Class.new(Person) + assert_equal Person.timeout, actor.timeout + + # Changing subclass timeout doesn't change superclass timeout. + actor.timeout = 10 + assert_not_equal Person.timeout, actor.timeout + + # Changing superclass timeout doesn't overwrite subclass timeout. + Person.timeout = 15 + assert_not_equal Person.timeout, actor.timeout + + # Changing superclass timeout after subclassing changes subclass timeout. + jester = Class.new(actor) + actor.timeout = 20 + assert_equal actor.timeout, jester.timeout + + # Subclasses are always equal to superclass timeout when not overridden. + fruit = Class.new(ActiveResource::Base) + apple = Class.new(fruit) + + fruit.timeout = 25 + assert_equal fruit.timeout, apple.timeout, 'subclass did not adopt changes from parent class' + + fruit.timeout = 30 + assert_equal fruit.timeout, apple.timeout, 'subclass did not adopt changes from parent class' + end + + def test_updating_baseclass_site_object_wipes_descendent_cached_connection_objects + # Subclasses are always equal to superclass site when not overridden + fruit = Class.new(ActiveResource::Base) + apple = Class.new(fruit) + + fruit.site = 'http://market' + assert_equal fruit.connection.site, apple.connection.site + first_connection = apple.connection.object_id + + fruit.site = 'http://supermarket' + assert_equal fruit.connection.site, apple.connection.site + second_connection = apple.connection.object_id + assert_not_equal(first_connection, second_connection, 'Connection should be re-created') + end + + def test_updating_baseclass_user_wipes_descendent_cached_connection_objects + # Subclasses are always equal to superclass user when not overridden + fruit = Class.new(ActiveResource::Base) + apple = Class.new(fruit) + fruit.site = 'http://market' + + fruit.user = 'david' + assert_equal fruit.connection.user, apple.connection.user + first_connection = apple.connection.object_id + + fruit.user = 'john' + assert_equal fruit.connection.user, apple.connection.user + second_connection = apple.connection.object_id + assert_not_equal(first_connection, second_connection, 'Connection should be re-created') + end + + def test_updating_baseclass_password_wipes_descendent_cached_connection_objects + # Subclasses are always equal to superclass password when not overridden + fruit = Class.new(ActiveResource::Base) + apple = Class.new(fruit) + fruit.site = 'http://market' + + fruit.password = 'secret' + assert_equal fruit.connection.password, apple.connection.password + first_connection = apple.connection.object_id + + fruit.password = 'supersecret' + assert_equal fruit.connection.password, apple.connection.password + second_connection = apple.connection.object_id + assert_not_equal(first_connection, second_connection, 'Connection should be re-created') + end + + def test_updating_baseclass_timeout_wipes_descendent_cached_connection_objects + # Subclasses are always equal to superclass timeout when not overridden + fruit = Class.new(ActiveResource::Base) + apple = Class.new(fruit) + fruit.site = 'http://market' + + fruit.timeout = 5 + assert_equal fruit.connection.timeout, apple.connection.timeout + first_connection = apple.connection.object_id + + fruit.timeout = 10 + assert_equal fruit.connection.timeout, apple.connection.timeout + second_connection = apple.connection.object_id + assert_not_equal(first_connection, second_connection, 'Connection should be re-created') + end + + def test_collection_name + assert_equal "people", Person.collection_name + end + + def test_collection_path + assert_equal '/people.xml', Person.collection_path + end + + def test_collection_path_with_parameters + assert_equal '/people.xml?gender=male', Person.collection_path(:gender => 'male') + assert_equal '/people.xml?gender=false', Person.collection_path(:gender => false) + assert_equal '/people.xml?gender=', Person.collection_path(:gender => nil) + + assert_equal '/people.xml?gender=male', Person.collection_path('gender' => 'male') + + # Use includes? because ordering of param hash is not guaranteed + assert Person.collection_path(:gender => 'male', :student => true).include?('/people.xml?') + assert Person.collection_path(:gender => 'male', :student => true).include?('gender=male') + assert Person.collection_path(:gender => 'male', :student => true).include?('student=true') + + assert_equal '/people.xml?name%5B%5D=bob&name%5B%5D=your+uncle%2Bme&name%5B%5D=&name%5B%5D=false', Person.collection_path(:name => ['bob', 'your uncle+me', nil, false]) + + assert_equal '/people.xml?struct%5Ba%5D%5B%5D=2&struct%5Ba%5D%5B%5D=1&struct%5Bb%5D=fred', Person.collection_path(:struct => {:a => [2,1], 'b' => 'fred'}) + end + + def test_custom_element_path + assert_equal '/people/1/addresses/1.xml', StreetAddress.element_path(1, :person_id => 1) + assert_equal '/people/1/addresses/1.xml', StreetAddress.element_path(1, 'person_id' => 1) + assert_equal '/people/Greg/addresses/1.xml', StreetAddress.element_path(1, 'person_id' => 'Greg') + end + + def test_custom_element_path_with_redefined_to_param + Person.module_eval do + alias_method :original_to_param_element_path, :to_param + def to_param + name + end + end + + # Class method. + assert_equal '/people/Greg.xml', Person.element_path('Greg') + + # Protected Instance method. + assert_equal '/people/Greg.xml', Person.find('Greg').send(:element_path) + + ensure + # revert back to original + Person.module_eval do + # save the 'new' to_param so we don't get a warning about discarding the method + alias_method :element_path_to_param, :to_param + alias_method :to_param, :original_to_param_element_path + end + end + + def test_custom_element_path_with_parameters + assert_equal '/people/1/addresses/1.xml?type=work', StreetAddress.element_path(1, :person_id => 1, :type => 'work') + assert_equal '/people/1/addresses/1.xml?type=work', StreetAddress.element_path(1, 'person_id' => 1, :type => 'work') + assert_equal '/people/1/addresses/1.xml?type=work', StreetAddress.element_path(1, :type => 'work', :person_id => 1) + assert_equal '/people/1/addresses/1.xml?type%5B%5D=work&type%5B%5D=play+time', StreetAddress.element_path(1, :person_id => 1, :type => ['work', 'play time']) + end + + def test_custom_element_path_with_prefix_and_parameters + assert_equal '/people/1/addresses/1.xml?type=work', StreetAddress.element_path(1, {:person_id => 1}, {:type => 'work'}) + end + + def test_custom_collection_path + assert_equal '/people/1/addresses.xml', StreetAddress.collection_path(:person_id => 1) + assert_equal '/people/1/addresses.xml', StreetAddress.collection_path('person_id' => 1) + end + + def test_custom_collection_path_with_parameters + assert_equal '/people/1/addresses.xml?type=work', StreetAddress.collection_path(:person_id => 1, :type => 'work') + assert_equal '/people/1/addresses.xml?type=work', StreetAddress.collection_path('person_id' => 1, :type => 'work') + end + + def test_custom_collection_path_with_prefix_and_parameters + assert_equal '/people/1/addresses.xml?type=work', StreetAddress.collection_path({:person_id => 1}, {:type => 'work'}) + end + + def test_custom_element_name + assert_equal 'address', StreetAddress.element_name + end + + def test_custom_collection_name + assert_equal 'addresses', StreetAddress.collection_name + end + + def test_prefix + assert_equal "/", Person.prefix + assert_equal Set.new, Person.send!(:prefix_parameters) + end + + def test_set_prefix + SetterTrap.rollback_sets(Person) do |person_class| + person_class.prefix = "the_prefix" + assert_equal "the_prefix", person_class.prefix + end + end + + def test_set_prefix_with_inline_keys + SetterTrap.rollback_sets(Person) do |person_class| + person_class.prefix = "the_prefix:the_param" + assert_equal "the_prefixthe_param_value", person_class.prefix(:the_param => "the_param_value") + end + end + + def test_set_prefix_with_default_value + SetterTrap.rollback_sets(Person) do |person_class| + person_class.set_prefix + assert_equal "/", person_class.prefix + end + end + + def test_custom_prefix + assert_equal '/people//', StreetAddress.prefix + assert_equal '/people/1/', StreetAddress.prefix(:person_id => 1) + assert_equal [:person_id].to_set, StreetAddress.send!(:prefix_parameters) + end + + def test_find_by_id + matz = Person.find(1) + assert_kind_of Person, matz + assert_equal "Matz", matz.name + assert matz.name? + end + + def test_respond_to + matz = Person.find(1) + assert matz.respond_to?(:name) + assert matz.respond_to?(:name=) + assert matz.respond_to?(:name?) + assert !matz.respond_to?(:super_scalable_stuff) + end + + def test_find_by_id_with_custom_prefix + addy = StreetAddress.find(1, :params => { :person_id => 1 }) + assert_kind_of StreetAddress, addy + assert_equal '12345 Street', addy.street + end + + def test_find_all + all = Person.find(:all) + assert_equal 2, all.size + assert_kind_of Person, all.first + assert_equal "Matz", all.first.name + assert_equal "David", all.last.name + end + + def test_find_first + matz = Person.find(:first) + assert_kind_of Person, matz + assert_equal "Matz", matz.name + end + + def test_custom_header + Person.headers['key'] = 'value' + assert_raises(ActiveResource::ResourceNotFound) { Person.find(4) } + ensure + Person.headers.delete('key') + end + + def test_find_by_id_not_found + assert_raises(ActiveResource::ResourceNotFound) { Person.find(99) } + assert_raises(ActiveResource::ResourceNotFound) { StreetAddress.find(1) } + end + + def test_find_all_by_from + ActiveResource::HttpMock.respond_to { |m| m.get "/companies/1/people.xml", {}, @people_david } + + people = Person.find(:all, :from => "/companies/1/people.xml") + assert_equal 1, people.size + assert_equal "David", people.first.name + end + + def test_find_all_by_from_with_options + ActiveResource::HttpMock.respond_to { |m| m.get "/companies/1/people.xml", {}, @people_david } + + people = Person.find(:all, :from => "/companies/1/people.xml") + assert_equal 1, people.size + assert_equal "David", people.first.name + end + + def test_find_all_by_symbol_from + ActiveResource::HttpMock.respond_to { |m| m.get "/people/managers.xml", {}, @people_david } + + people = Person.find(:all, :from => :managers) + assert_equal 1, people.size + assert_equal "David", people.first.name + end + + def test_find_single_by_from + ActiveResource::HttpMock.respond_to { |m| m.get "/companies/1/manager.xml", {}, @david } + + david = Person.find(:one, :from => "/companies/1/manager.xml") + assert_equal "David", david.name + end + + def test_find_single_by_symbol_from + ActiveResource::HttpMock.respond_to { |m| m.get "/people/leader.xml", {}, @david } + + david = Person.find(:one, :from => :leader) + assert_equal "David", david.name + end + + def test_save + rick = Person.new + assert_equal true, rick.save + assert_equal '5', rick.id + end + + def test_id_from_response + p = Person.new + resp = {'Location' => '/foo/bar/1'} + assert_equal '1', p.send!(:id_from_response, resp) + + resp['Location'] << '.xml' + assert_equal '1', p.send!(:id_from_response, resp) + end + + def test_create_with_custom_prefix + matzs_house = StreetAddress.new(:person_id => 1) + matzs_house.save + assert_equal '5', matzs_house.id + end + + # Test that loading a resource preserves its prefix_options. + def test_load_preserves_prefix_options + address = StreetAddress.find(1, :params => { :person_id => 1 }) + ryan = Person.new(:id => 1, :name => 'Ryan', :address => address) + assert_equal address.prefix_options, ryan.address.prefix_options + end + + def test_reload_works_with_prefix_options + address = StreetAddress.find(1, :params => { :person_id => 1 }) + assert_equal address, address.reload + end + + def test_reload_with_redefined_to_param + Person.module_eval do + alias_method :original_to_param_reload, :to_param + def to_param + name + end + end + + person = Person.find('Greg') + assert_equal person, person.reload + + ensure + # revert back to original + Person.module_eval do + # save the 'new' to_param so we don't get a warning about discarding the method + alias_method :reload_to_param, :to_param + alias_method :to_param, :original_to_param_reload + end + end + + def test_reload_works_without_prefix_options + person = Person.find(:first) + assert_equal person, person.reload + end + + + def test_create + rick = Person.create(:name => 'Rick') + assert rick.valid? + assert !rick.new? + assert_equal '5', rick.id + + # test additional attribute returned on create + assert_equal 25, rick.age + + # Test that save exceptions get bubbled up too + ActiveResource::HttpMock.respond_to do |mock| + mock.post "/people.xml", {}, nil, 409 + end + assert_raises(ActiveResource::ResourceConflict) { Person.create(:name => 'Rick') } + end + + def test_clone + matz = Person.find(1) + matz_c = matz.clone + assert matz_c.new? + matz.attributes.each do |k, v| + assert_equal v, matz_c.send(k) if k != Person.primary_key + end + end + + def test_nested_clone + addy = StreetAddress.find(1, :params => {:person_id => 1}) + addy_c = addy.clone + assert addy_c.new? + addy.attributes.each do |k, v| + assert_equal v, addy_c.send(k) if k != StreetAddress.primary_key + end + assert_equal addy.prefix_options, addy_c.prefix_options + end + + def test_complex_clone + matz = Person.find(1) + matz.address = StreetAddress.find(1, :params => {:person_id => matz.id}) + matz.non_ar_hash = {:not => "an ARes instance"} + matz.non_ar_arr = ["not", "ARes"] + matz_c = matz.clone + assert matz_c.new? + assert_raises(NoMethodError) {matz_c.address} + assert_equal matz.non_ar_hash, matz_c.non_ar_hash + assert_equal matz.non_ar_arr, matz_c.non_ar_arr + + # Test that actual copy, not just reference copy + matz.non_ar_hash[:not] = "changed" + assert_not_equal matz.non_ar_hash, matz_c.non_ar_hash + end + + def test_update + matz = Person.find(:first) + matz.name = "David" + assert_kind_of Person, matz + assert_equal "David", matz.name + assert_equal true, matz.save + end + + def test_update_with_custom_prefix_with_specific_id + addy = StreetAddress.find(1, :params => { :person_id => 1 }) + addy.street = "54321 Street" + assert_kind_of StreetAddress, addy + assert_equal "54321 Street", addy.street + addy.save + end + + def test_update_with_custom_prefix_without_specific_id + addy = StreetAddress.find(:first, :params => { :person_id => 1 }) + addy.street = "54321 Lane" + assert_kind_of StreetAddress, addy + assert_equal "54321 Lane", addy.street + addy.save + end + + def test_update_conflict + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/2.xml", {}, @david + mock.put "/people/2.xml", @default_request_headers, nil, 409 + end + assert_raises(ActiveResource::ResourceConflict) { Person.find(2).save } + end + + def test_destroy + assert Person.find(1).destroy + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/1.xml", {}, nil, 404 + end + assert_raises(ActiveResource::ResourceNotFound) { Person.find(1).destroy } + end + + def test_destroy_with_custom_prefix + assert StreetAddress.find(1, :params => { :person_id => 1 }).destroy + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/1/addresses/1.xml", {}, nil, 404 + end + assert_raises(ActiveResource::ResourceNotFound) { StreetAddress.find(1, :params => { :person_id => 1 }) } + end + + def test_delete + assert Person.delete(1) + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/1.xml", {}, nil, 404 + end + assert_raises(ActiveResource::ResourceNotFound) { Person.find(1) } + end + + def test_delete_with_custom_prefix + assert StreetAddress.delete(1, :person_id => 1) + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/1/addresses/1.xml", {}, nil, 404 + end + assert_raises(ActiveResource::ResourceNotFound) { StreetAddress.find(1, :params => { :person_id => 1 }) } + end + + def test_exists + # Class method. + assert !Person.exists?(nil) + assert Person.exists?(1) + assert !Person.exists?(99) + + # Instance method. + assert !Person.new.exists? + assert Person.find(1).exists? + assert !Person.new(:id => 99).exists? + + # Nested class method. + assert StreetAddress.exists?(1, :params => { :person_id => 1 }) + assert !StreetAddress.exists?(1, :params => { :person_id => 2 }) + assert !StreetAddress.exists?(2, :params => { :person_id => 1 }) + + # Nested instance method. + assert StreetAddress.find(1, :params => { :person_id => 1 }).exists? + assert !StreetAddress.new({:id => 1, :person_id => 2}).exists? + assert !StreetAddress.new({:id => 2, :person_id => 1}).exists? + end + + def test_exists_with_redefined_to_param + Person.module_eval do + alias_method :original_to_param_exists, :to_param + def to_param + name + end + end + + # Class method. + assert Person.exists?('Greg') + + # Instance method. + assert Person.find('Greg').exists? + + # Nested class method. + assert StreetAddress.exists?(1, :params => { :person_id => Person.find('Greg').to_param }) + + # Nested instance method. + assert StreetAddress.find(1, :params => { :person_id => Person.find('Greg').to_param }).exists? + + ensure + # revert back to original + Person.module_eval do + # save the 'new' to_param so we don't get a warning about discarding the method + alias_method :exists_to_param, :to_param + alias_method :to_param, :original_to_param_exists + end + end + + def test_to_xml + matz = Person.find(1) + xml = matz.to_xml + assert xml.starts_with?('<?xml version="1.0" encoding="UTF-8"?>') + assert xml.include?('<name>Matz</name>') + assert xml.include?('<id type="integer">1</id>') + end + + def test_to_param_quacks_like_active_record + new_person = Person.new + assert_nil new_person.to_param + matz = Person.find(1) + assert_equal '1', matz.to_param + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/connection_test.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/connection_test.rb new file mode 100644 index 000000000..8e43e451f --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/connection_test.rb @@ -0,0 +1,190 @@ +require 'abstract_unit' + +class ConnectionTest < Test::Unit::TestCase + ResponseCodeStub = Struct.new(:code) + + def setup + @conn = ActiveResource::Connection.new('http://localhost') + @matz = { :id => 1, :name => 'Matz' } + @david = { :id => 2, :name => 'David' } + @people = [ @matz, @david ].to_xml(:root => 'people') + @people_single = [ @matz ].to_xml(:root => 'people-single-elements') + @people_empty = [ ].to_xml(:root => 'people-empty-elements') + @matz = @matz.to_xml(:root => 'person') + @david = @david.to_xml(:root => 'person') + @header = {'key' => 'value'}.freeze + + @default_request_headers = { 'Content-Type' => 'application/xml' } + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/2.xml", @header, @david + mock.get "/people.xml", {}, @people + mock.get "/people_single_elements.xml", {}, @people_single + mock.get "/people_empty_elements.xml", {}, @people_empty + mock.get "/people/1.xml", {}, @matz + mock.put "/people/1.xml", {}, nil, 204 + mock.put "/people/2.xml", {}, @header, 204 + mock.delete "/people/1.xml", {}, nil, 200 + mock.delete "/people/2.xml", @header, nil, 200 + mock.post "/people.xml", {}, nil, 201, 'Location' => '/people/5.xml' + mock.post "/members.xml", {}, @header, 201, 'Location' => '/people/6.xml' + mock.head "/people/1.xml", {}, nil, 200 + end + end + + def test_handle_response + # 2xx and 3xx are valid responses. + [200, 299, 300, 399].each do |code| + expected = ResponseCodeStub.new(code) + assert_equal expected, handle_response(expected) + end + + # 400 is a bad request (e.g. malformed URI or missing request parameter) + assert_response_raises ActiveResource::BadRequest, 400 + + # 401 is an unauthorized request + assert_response_raises ActiveResource::UnauthorizedAccess, 401 + + # 403 is a forbidden requst (and authorizing will not help) + assert_response_raises ActiveResource::ForbiddenAccess, 403 + + # 404 is a missing resource. + assert_response_raises ActiveResource::ResourceNotFound, 404 + + # 405 is a missing not allowed error + assert_response_raises ActiveResource::MethodNotAllowed, 405 + + # 409 is an optimistic locking error + assert_response_raises ActiveResource::ResourceConflict, 409 + + # 422 is a validation error + assert_response_raises ActiveResource::ResourceInvalid, 422 + + # 4xx are client errors. + [402, 499].each do |code| + assert_response_raises ActiveResource::ClientError, code + end + + # 5xx are server errors. + [500, 599].each do |code| + assert_response_raises ActiveResource::ServerError, code + end + + # Others are unknown. + [199, 600].each do |code| + assert_response_raises ActiveResource::ConnectionError, code + end + end + + ResponseHeaderStub = Struct.new(:code, :message, 'Allow') + def test_should_return_allowed_methods_for_method_no_allowed_exception + begin + handle_response ResponseHeaderStub.new(405, "HTTP Failed...", "GET, POST") + rescue ActiveResource::MethodNotAllowed => e + assert_equal "Failed with 405 HTTP Failed...", e.message + assert_equal [:get, :post], e.allowed_methods + end + end + + def test_initialize_raises_argument_error_on_missing_site + assert_raise(ArgumentError) { ActiveResource::Connection.new(nil) } + end + + def test_site_accessor_accepts_uri_or_string_argument + site = URI.parse("http://localhost") + + assert_raise(URI::InvalidURIError) { @conn.site = nil } + + assert_nothing_raised { @conn.site = "http://localhost" } + assert_equal site, @conn.site + + assert_nothing_raised { @conn.site = site } + assert_equal site, @conn.site + end + + def test_timeout_accessor + @conn.timeout = 5 + assert_equal 5, @conn.timeout + end + + def test_get + matz = @conn.get("/people/1.xml") + assert_equal "Matz", matz["name"] + end + + def test_head + response = @conn.head("/people/1.xml") + assert response.body.blank? + assert_equal 200, response.code + end + + def test_get_with_header + david = @conn.get("/people/2.xml", @header) + assert_equal "David", david["name"] + end + + def test_get_collection + people = @conn.get("/people.xml") + assert_equal "Matz", people[0]["name"] + assert_equal "David", people[1]["name"] + end + + def test_get_collection_single + people = @conn.get("/people_single_elements.xml") + assert_equal "Matz", people[0]["name"] + end + + def test_get_collection_empty + people = @conn.get("/people_empty_elements.xml") + assert_equal [], people + end + + def test_post + response = @conn.post("/people.xml") + assert_equal "/people/5.xml", response["Location"] + end + + def test_post_with_header + response = @conn.post("/members.xml", @header) + assert_equal "/people/6.xml", response["Location"] + end + + def test_put + response = @conn.put("/people/1.xml") + assert_equal 204, response.code + end + + def test_put_with_header + response = @conn.put("/people/2.xml", @header) + assert_equal 204, response.code + end + + def test_delete + response = @conn.delete("/people/1.xml") + assert_equal 200, response.code + end + + def test_delete_with_header + response = @conn.delete("/people/2.xml", @header) + assert_equal 200, response.code + end + + uses_mocha('test_timeout') do + def test_timeout + @http = mock('new Net::HTTP') + @conn.expects(:http).returns(@http) + @http.expects(:get).raises(Timeout::Error, 'execution expired') + assert_raises(ActiveResource::TimeoutError) { @conn.get('/people_timeout.xml') } + end + end + + protected + def assert_response_raises(klass, code) + assert_raise(klass, "Expected response code #{code} to raise #{klass}") do + handle_response ResponseCodeStub.new(code) + end + end + + def handle_response(response) + @conn.send!(:handle_response, response) + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/beast.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/beast.rb new file mode 100644 index 000000000..e31ec5834 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/beast.rb @@ -0,0 +1,14 @@ +class BeastResource < ActiveResource::Base + self.site = 'http://beast.caboo.se' + site.user = 'foo' + site.password = 'bar' +end + +class Forum < BeastResource + # taken from BeastResource + # self.site = 'http://beast.caboo.se' +end + +class Topic < BeastResource + self.site += '/forums/:forum_id' +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/person.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/person.rb new file mode 100644 index 000000000..e88bb6931 --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/person.rb @@ -0,0 +1,3 @@ +class Person < ActiveResource::Base + self.site = "http://37s.sunrise.i:3000" +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/street_address.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/street_address.rb new file mode 100644 index 000000000..94a86702b --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/fixtures/street_address.rb @@ -0,0 +1,4 @@ +class StreetAddress < ActiveResource::Base + self.site = "http://37s.sunrise.i:3000/people/:person_id/" + self.element_name = 'address' +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/format_test.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/format_test.rb new file mode 100644 index 000000000..3c81803fc --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/format_test.rb @@ -0,0 +1,83 @@ +require 'abstract_unit' +require "fixtures/person" + +class FormatTest < Test::Unit::TestCase + def setup + @matz = { :id => 1, :name => 'Matz' } + @david = { :id => 2, :name => 'David' } + + @programmers = [ @matz, @david ] + end + + def test_formats_on_single_element + for format in [ :json, :xml ] + using_format(Person, format) do + ActiveResource::HttpMock.respond_to.get "/people/1.#{format}", {}, ActiveResource::Formats[format].encode(@david) + assert_equal @david[:name], Person.find(1).name + end + end + end + + def test_formats_on_collection + for format in [ :json, :xml ] + using_format(Person, format) do + ActiveResource::HttpMock.respond_to.get "/people.#{format}", {}, ActiveResource::Formats[format].encode(@programmers) + remote_programmers = Person.find(:all) + assert_equal 2, remote_programmers.size + assert remote_programmers.select { |p| p.name == 'David' } + end + end + end + + def test_formats_on_custom_collection_method + for format in [ :json, :xml ] + using_format(Person, format) do + ActiveResource::HttpMock.respond_to.get "/people/retrieve.#{format}?name=David", {}, ActiveResource::Formats[format].encode([@david]) + remote_programmers = Person.get(:retrieve, :name => 'David') + assert_equal 1, remote_programmers.size + assert_equal @david[:id], remote_programmers[0]['id'] + assert_equal @david[:name], remote_programmers[0]['name'] + end + end + end + + def test_formats_on_custom_element_method + for format in [ :json, :xml ] + using_format(Person, format) do + ActiveResource::HttpMock.respond_to do |mock| + mock.get "/people/2.#{format}", {}, ActiveResource::Formats[format].encode(@david) + mock.get "/people/2/shallow.#{format}", {}, ActiveResource::Formats[format].encode(@david) + end + remote_programmer = Person.find(2).get(:shallow) + assert_equal @david[:id], remote_programmer['id'] + assert_equal @david[:name], remote_programmer['name'] + end + end + + for format in [ :json, :xml ] + ryan = ActiveResource::Formats[format].encode({ :name => 'Ryan' }) + using_format(Person, format) do + ActiveResource::HttpMock.respond_to.post "/people/new/register.#{format}", {}, ryan, 201, 'Location' => "/people/5.#{format}" + remote_ryan = Person.new(:name => 'Ryan') + assert_equal ActiveResource::Response.new(ryan, 201, {'Location' => "/people/5.#{format}"}), remote_ryan.post(:register) + end + end + end + + def test_setting_format_before_site + resource = Class.new(ActiveResource::Base) + resource.format = :json + resource.site = 'http://37s.sunrise.i:3000' + assert_equal ActiveResource::Formats[:json], resource.connection.format + end + + private + def using_format(klass, mime_type_reference) + previous_format = klass.format + klass.format = mime_type_reference + + yield + ensure + klass.format = previous_format + end +end diff --git a/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/setter_trap.rb b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/setter_trap.rb new file mode 100644 index 000000000..9a899b0fa --- /dev/null +++ b/vendor/rails-2.1.0/activeresource/pkg/activeresource-2.1.0/test/setter_trap.rb @@ -0,0 +1,27 @@ +class SetterTrap < ActiveSupport::BasicObject + class << self + def rollback_sets(obj) + returning yield(setter_trap = new(obj)) do + setter_trap.rollback_sets + end + end + end + + def initialize(obj) + @cache = {} + @obj = obj + end + + def respond_to?(method) + @obj.respond_to?(method) + end + + def method_missing(method, *args, &proc) + @cache[method] ||= @obj.send($`) if method.to_s =~ /=$/ + @obj.send method, *args, &proc + end + + def rollback_sets + @cache.each { |k, v| @obj.send k, v } + end +end |