vendor/rails/activeresource/CHANGELOG

   1 * Don't cache net/http object so that ActiveResource is more thread-safe.  Closes #10142 [kou]
   2
   3 * Update XML documentation examples to include explicit type attributes. Closes #9754 [hasmanyjosh]
   4
   5 *2.0.0 [Preview Release]* (September 29th, 2007)
   6
   7 * Added one-off declarations of mock behavior [DHH]. Example:
   8
   9     Before:
  10       ActiveResource::HttpMock.respond_to do |mock|
  11         mock.get "/people/1.xml", {}, "<person><name>David</name></person>"
  12       end
  13
  14     Now:
  15       ActiveResource::HttpMock.respond_to.get "/people/1.xml", {}, "<person><name>David</name></person>"
  16
  17 * Added ActiveResource.format= which defaults to :xml but can also be set to :json [DHH]. Example:
  18
  19     class Person < ActiveResource::Base
  20       self.site   = "http://app/"
  21       self.format = :json
  22     end
  23
  24     person = Person.find(1) # => GET http://app/people/1.json
  25     person.name = "David"
  26     person.save             # => PUT http://app/people/1.json {name: "David"}
  27
  28     Person.format = :xml
  29     person.name = "Mary"
  30     person.save             # => PUT http://app/people/1.json <person><name>Mary</name></person>
  31
  32 * Fix reload error when path prefix is used.  #8727 [Ian Warshak]
  33
  34 * 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]
  35
  36 * Fix query methods on resources. [Cody Fauser]
  37
  38 * pass the prefix_options to the instantiated record when using find without a specific id. Closes #8544 [alloy]
  39
  40 * Recognize and raise an exception on 405 Method Not Allowed responses.  #7692 [Josh Peek]
  41
  42 * Handle string and symbol param keys when splitting params into prefix params and query params.
  43
  44     Comment.find(:all, :params => { :article_id => 5, :page => 2 }) or Comment.find(:all, :params => { 'article_id' => 5, :page => 2 })
  45
  46 * Added find-one with symbol [DHH]. Example: Person.find(:one, :from => :leader) # => GET /people/leader.xml
  47
  48 * BACKWARDS INCOMPATIBLE: Changed the finder API to be more extensible with :params and more strict usage of scopes [DHH]. Changes:
  49
  50     Person.find(:all, :title => "CEO")      ...becomes: Person.find(:all, :params => { :title => "CEO" })
  51     Person.find(:managers)                  ...becomes: Person.find(:all, :from => :managers)
  52     Person.find("/companies/1/manager.xml") ...becomes: Person.find(:one, :from => "/companies/1/manager.xml")
  53
  54 * Add support for setting custom headers per Active Resource model [Rick]
  55
  56   class Project
  57     headers['X-Token'] = 'foo'
  58   end
  59
  60   # makes the GET request with the custom X-Token header
  61   Project.find(:all)
  62
  63 * Added find-by-path options to ActiveResource::Base.find [DHH]. Examples:
  64
  65     employees = Person.find(:all, :from => "/companies/1/people.xml") # => GET /companies/1/people.xml
  66     manager   = Person.find("/companies/1/manager.xml")               # => GET /companies/1/manager.xml
  67
  68
  69 * Added support for using classes from within a single nested module [DHH]. Example:
  70
  71     module Highrise
  72       class Note < ActiveResource::Base
  73         self.site = "http://37s.sunrise.i:3000"
  74       end
  75
  76       class Comment < ActiveResource::Base
  77         self.site = "http://37s.sunrise.i:3000"
  78       end
  79     end
  80
  81   assert_kind_of Highrise::Comment, Note.find(1).comments.first
  82
  83
  84 * Added load_attributes_from_response as a way of loading attributes from other responses than just create [DHH]
  85
  86     class Highrise::Task < ActiveResource::Base
  87       def complete
  88         load_attributes_from_response(post(:complete))
  89       end
  90     end
  91
  92   ...will set "done_at" when complete is called.
  93
  94
  95 * Added support for calling custom methods #6979 [rwdaigle]
  96
  97     Person.find(:managers)    # => GET /people/managers.xml
  98     Kase.find(1).post(:close) # => POST /kases/1/close.xml
  99
 100 * Remove explicit prefix_options parameter for ActiveResource::Base#initialize. [Rick]
 101   ActiveResource splits the prefix_options from it automatically.
 102
 103 * Allow ActiveResource::Base.delete with custom prefix. [Rick]
 104
 105 * Add ActiveResource::Base#dup [Rick]
 106
 107 * Fixed constant warning when fetching the same object multiple times [DHH]
 108
 109 * Added that saves which get a body response (and not just a 201) will use that response to update themselves [DHH]
 110
 111 * Disregard namespaces from the default element name, so Highrise::Person will just try to fetch from "/people", not "/highrise/people" [DHH]
 112
 113 * Allow array and hash query parameters.  #7756 [Greg Spurrier]
 114
 115 * Loading a resource preserves its prefix_options.  #7353 [Ryan Daigle]
 116
 117 * Carry over the convenience of #create from ActiveRecord.  Closes #7340.  [Ryan Daigle]
 118
 119 * Increase ActiveResource::Base test coverage.  Closes #7173, #7174 [Rich Collins]
 120
 121 * Interpret 422 Unprocessable Entity as ResourceInvalid.  #7097 [dkubb]
 122
 123 * Mega documentation patches. #7025, #7069 [rwdaigle]
 124
 125 * Base.exists?(id, options) and Base#exists? check whether the resource is found.  #6970 [rwdaigle]
 126
 127 * Query string support.  [untext, Jeremy Kemper]
 128     # GET /forums/1/topics.xml?sort=created_at
 129     Topic.find(:all, :forum_id => 1, :sort => 'created_at')
 130
 131 * 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]
 132
 133 * Allow subclassed resources to share the site info [Rick, Jeremy Kemper]
 134 d
 135     class BeastResource < ActiveResource::Base
 136       self.site = 'http://beast.caboo.se'
 137     end
 138
 139     class Forum < BeastResource
 140       # taken from BeastResource
 141       # self.site = 'http://beast.caboo.se'
 142     end
 143
 144     class Topic < BeastResource
 145       self.site += '/forums/:forum_id'
 146     end
 147
 148 * Fix issues with ActiveResource collection handling.  Closes #6291. [bmilekic]
 149
 150 * Use attr_accessor_with_default to dry up attribute initialization. References #6538. [Stuart Halloway]
 151
 152 * Add basic logging support for logging outgoing requests. [Jamis Buck]
 153
 154 * Add Base.delete for deleting resources without having to instantiate them first. [Jamis Buck]
 155
 156 * Make #save behavior mimic AR::Base#save (true on success, false on failure). [Jamis Buck]
 157
 158 * Add Basic HTTP Authentication to ActiveResource (closes #6305). [jonathan]
 159
 160 * Extracted #id_from_response as an entry point for customizing how a created resource gets its own ID.
 161   By default, it extracts from the Location response header.
 162
 163 * Optimistic locking: raise ActiveResource::ResourceConflict on 409 Conflict response. [Jeremy Kemper]
 164
 165     # Example controller action
 166     def update
 167       @person.save!
 168     rescue ActiveRecord::StaleObjectError
 169       render :xml => @person.reload.to_xml, :status => '409 Conflict'
 170     end
 171
 172 * Basic validation support [Rick Olson]
 173
 174   Parses the xml response of ActiveRecord::Errors#to_xml with a similar interface to ActiveRecord::Errors.
 175
 176     render :xml => @person.errors.to_xml, :status => '400 Validation Error'
 177
 178 * Deep hashes are converted into collections of resources.  [Jeremy Kemper]
 179     Person.new :name => 'Bob',
 180                :address => { :id => 1, :city => 'Portland' },
 181                :contacts => [{ :id => 1 }, { :id => 2 }]
 182   Looks for Address and Contact resources and creates them if unavailable.
 183   So clients can fetch a complex resource in a single request if you e.g.
 184     render :xml => @person.to_xml(:include => [:address, :contacts])
 185   in your controller action.
 186
 187 * Major updates [Rick Olson]
 188
 189   * Add full support for find/create/update/destroy
 190   * Add support for specifying prefixes.
 191   * Allow overriding of element_name, collection_name, and primary key
 192   * Provide simpler HTTP mock interface for testing
 193
 194     # rails routing code
 195     map.resources :posts do |post|
 196       post.resources :comments
 197     end
 198
 199     # ActiveResources
 200     class Post < ActiveResource::Base
 201       self.site = "http://37s.sunrise.i:3000/"
 202     end
 203
 204     class Comment < ActiveResource::Base
 205       self.site = "http://37s.sunrise.i:3000/posts/:post_id/"
 206     end
 207
 208     @post     = Post.find 5
 209     @comments = Comment.find :all, :post_id => @post.id
 210
 211     @comment  = Comment.new({:body => 'hello world'}, {:post_id => @post.id})
 212     @comment.save
 213
 214 * Base.site= accepts URIs. 200...400 are valid response codes. PUT and POST request bodies default to ''. [Jeremy Kemper]
 215
 216 * Initial checkin: object-oriented client for restful HTTP resources which follow the Rails convention. [DHH]