her 0.2.3 → 0.2.4

data/README.md

@@ -14,13 +14,21 @@ gem "her"
 
 That’s it!
 
+## Upgrade
+
+Please see the [UPGRADE.md](https://github.com/remiprev/her/blob/master/UPGRADE.md) file for backward compability issues.
+
 ## Usage
 
-First, you have to define which API your models will be bound to. For example, with Rails, you would create a new `config/initializers/her.rb` file with this line:
+First, you have to define which API your models will be bound to. For example, with Rails, you would create a new `config/initializers/her.rb` file with these lines:
 
 ```ruby
 # config/initializers/her.rb
-Her::API.setup :base_uri => "https://api.example.com"
+Her::API.setup :base_uri => "https://api.example.com" do |builder|
+  builder.use Faraday::Request::UrlEncoded
+  builder.use Her::Middleware::DefaultParseJSON
+  builder.use Faraday::Adapter::NetHttp
+end
 ```
 
 And then to add the ORM behavior to a class, you just have to include `Her::Model` in it:
@@ -56,7 +64,7 @@ User.find(1)
 
 ## Middleware
 
-Since Her relies on [Faraday](https://github.com/technoweenie/faraday) to send HTTP requests, you can add additional middleware to handle requests and responses. Using a block in the `setup` call, you have access to Faraday’s `builder` object and are able to customize the middleware stack used on each request and response.
+Since Her relies on [Faraday](https://github.com/technoweenie/faraday) to send HTTP requests, you can add additional middleware to handle requests and responses. Using the block in the `setup` call, you have access to Faraday’s `builder` object and are able to customize the middleware stack used on each request and response.
 
 ### Authentication
 
@@ -77,6 +85,10 @@ end
 Her::API.setup :base_uri => "https://api.example.com" do |builder|
   # This token could be stored in the client session
   builder.use MyAuthentication, :token => "bb2b2dd75413d32c1ac421d39e95b978d1819ff611f68fc2fdd5c8b9c7331192"
+
+  builder.use Faraday::Request::UrlEncoded
+  builder.use Her::Middleware::DefaultParseJSON
+  builder.use Faraday::Adapter::NetHttp
 end
 ```
 
@@ -86,8 +98,6 @@ Now, each HTTP request made by Her will have the `X-API-Token` header.
 
 By default, Her handles JSON data. It expects the resource/collection data to be returned at the first level.
 
-**Note**: *Before 0.2, Her expected the resource/collection data to be returned in a `data` key within the JSON object. If you want the old behavior, you can use the `Her::Middleware::SecondLevelParseJSON` middleware.*
-
 ```javascript
 // The response of GET /users/1
 { "id" : 1, "name" : "Tobias Fünke" }
@@ -111,8 +121,9 @@ class MyCustomParser < Faraday::Response::Middleware
 end
 
 Her::API.setup :base_uri => "https://api.example.com" do |builder|
-  # We use the `swap` method to replace Her’s default parser middleware
-  builder.swap Her::Middleware::DefaultParseJSON, MyCustomParser
+  builder.use Faraday::Request::UrlEncoded
+  builder.use MyCustomParser
+  builder.use Faraday::Adapter::NetHttp
 end
 # User.find(1) will now expect "https://api.example.com/users/1" to return something like '{ "result" => { "id": 1, "name": "Tobias Fünke" }, "errors" => [] }'
 ```
@@ -141,8 +152,10 @@ TWITTER_CREDENTIALS = {
 }
 
 Her::API.setup :base_uri => "https://api.twitter.com/1/" do |builder|
-  # We need to insert the middleware at the beginning of the stack (hence the `insert 0`)
-  builder.insert 0, FaradayMiddleware::OAuth, TWITTER_CREDENTIALS
+  builder.use FaradayMiddleware::OAuth, TWITTER_CREDENTIALS
+  builder.use Faraday::Request::UrlEncoded
+  builder.use Her::Middleware::DefaultParseJSON
+  builder.use Faraday::Adapter::NetHttp
 end
 
 class Tweet
@@ -190,7 +203,10 @@ end
 $cache = MyCache.new
 
 Her::API.setup :base_uri => "https://api.example.com" do |builder|
+  builder.use Faraday::Request::UrlEncoded
   builder.use FaradayMiddleware::Caching, $cache
+  builder.use Her::Middleware::DefaultParseJSON
+  builder.use Faraday::Adapter::NetHttp
 end
 
 class User
@@ -390,10 +406,18 @@ It is possible to use different APIs for different models. Instead of calling `H
 ```ruby
 # config/initializers/her.rb
 $my_api = Her::API.new
-$my_api.setup :base_uri => "https://my_api.example.com"
+$my_api.setup :base_uri => "https://my_api.example.com" do |builder|
+  builder.use Faraday::Request::UrlEncoded
+  builder.use Her::Middleware::DefaultParseJSON
+  builder.use Faraday::Adapter::NetHttp
+end
 
 $other_api = Her::API.new
-$other_api.setup :base_uri => "https://other_api.example.com"
+$other_api.setup :base_uri => "https://other_api.example.com" do |builder|
+  builder.use Faraday::Request::UrlEncoded
+  builder.use Her::Middleware::DefaultParseJSON
+  builder.use Faraday::Adapter::NetHttp
+end
 ```
 
 You can then define which API a model will use:
@@ -429,6 +453,7 @@ Feel free to contribute and submit issues/pull requests [on GitHub](https://gith
 * [@EtienneLem](https://github.com/EtienneLem)
 * [@rafaelss](https://github.com/rafaelss)
 * [@tysontate](https://github.com/tysontate)
+* [@nfo](https://github.com/nfo)
 
 Take a look at the `spec` folder before you do, and make sure `bundle exec rake spec` passes after your modifications :)
 

data/UPGRADE.md

@@ -0,0 +1,30 @@
+Here is a list of backward-incompatible changes that were introduced while Her is still \<1.0. After reaching 1.0, it will follow the [Semantic Versioning](http://semver.org/) system.
+
+## 0.2.4
+
+* Her no longer includes default middleware when making HTTP requests. The user has now to define all the needed middleware. Before:
+
+      Her::API.setup :base_uri => "https://api.example.com" do |builder|
+        builder.insert(0, FaradayMiddle::OAuth)
+      end
+
+  Now:
+    
+      Her::API.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use FaradayMiddle::OAuth
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
+## 0.2
+
+* The default parser middleware has been replaced to treat first-level JSON data as the resource or collection data. Before it expected this:
+
+      { "data": { "id": 1, "name": "Foo" }, "errors": [] }
+        
+   Now it expects this (the `errors` key is not treated as resource data):
+   
+      { "id": 1, "name": "Foo", "errors": [] }
+      
+   If you still want to get the old behavior, you can use `Her::Middleware::SecondLevelParseJSON` instead of `Her::Middleware::FirstLevelParseJSON` in your middleware stack.

data/lib/her/api.rb

@@ -3,7 +3,7 @@ module Her
   # so it knows where to make those requests. In Rails, this is usually done in `config/initializers/her.rb`:
   class API
     # @private
-    attr_reader :base_uri, :middleware, :connection
+    attr_reader :base_uri, :connection
 
     # Setup a default API connection. Accepted arguments and options are the same as {API#setup}.
     def self.setup(attrs={}, &block) # {{{
@@ -15,9 +15,6 @@ module Her
     #
     # @param [Hash] attrs the options to create a message with
     # @option attrs [String] :base_uri The main HTTP API root (eg. `https://api.example.com`)
-    # @option attrs [Array, Class] :middleware **Deprecated** A list of the only middleware Her will use
-    # @option attrs [Array, Class] :add_middleware **Deprecated** A list of middleware to add to Her’s default middleware
-    # @option attrs [Class] :parse_middleware **Deprecated** A middleware that will replace {Her::Middleware::FirstLevelParseJSON} to parse the received JSON
     #
     # @return Faraday::Connection
     #
@@ -50,18 +47,7 @@ module Her
     #   end
     def setup(attrs={}) # {{{
       @base_uri = attrs[:base_uri]
-      @middleware = Her::API.default_middleware
-
-      @middleware = [attrs[:middleware]] if attrs[:middleware]
-      @middleware = [attrs[:add_middleware]] + @middleware if attrs[:add_middleware]
-      @middleware = [attrs[:parse_middleware]] + @middleware.reject { |item| item == Her::Middleware::FirstLevelParseJSON } if attrs[:parse_middleware]
-
-      @middleware.flatten!
-      middleware = @middleware
       @connection = Faraday.new(:url => @base_uri) do |connection|
-        middleware.each do |klass|
-          connection.use klass
-        end
         yield connection.builder if block_given?
       end
     end # }}}
@@ -93,10 +79,5 @@ module Her
     def self.default_api(attrs={}) # {{{
       defined?(@@default_api) ? @@default_api : nil
     end # }}}
-
-    # @private
-    def self.default_middleware # {{{
-      [Her::Middleware::FirstLevelParseJSON, Faraday::Request::UrlEncoded, Faraday::Adapter::NetHttp]
-    end # }}}
   end
 end

data/lib/her/model.rb

@@ -35,7 +35,7 @@ module Her
       extend Her::Model::Paths
 
       # Define default settings
-      base_path = self.name.split("::").last.downcase.pluralize
+      base_path = self.name.split("::").last.underscore.pluralize
       collection_path "/#{base_path}"
       resource_path "/#{base_path}/:id"
       uses_api Her::API.default_api

data/lib/her/model/orm.rb

@@ -42,7 +42,7 @@ module Her
       # @param [Hash] parsed_data The raw `parsed_data` parsed from the HTTP response
       def new_collection(parsed_data) # {{{
         collection_data = parsed_data[:data]
-        Her::Model::ORM.initialize_collection(self.to_s.downcase.to_sym, collection_data)
+        Her::Model::ORM.initialize_collection(self.to_s.underscore, collection_data)
       end # }}}
 
       # Return `true` if a resource was not saved yet

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/api_spec.rb

@@ -26,27 +26,7 @@ describe Her::API do
           builder.use Foo
           builder.use Bar
         end
-        @api.connection.builder.handlers.should == [Her::Middleware::FirstLevelParseJSON, Faraday::Request::UrlEncoded, Faraday::Adapter::NetHttp, Foo, Bar]
-      end # }}}
-
-      it "sets custom middleware with #insert" do # {{{
-        class Foo; end;
-        class Bar; end;
-
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com" do |builder|
-          builder.use Foo
-          builder.insert 0, Bar
-        end
-        @api.connection.builder.handlers.should == [Bar, Her::Middleware::FirstLevelParseJSON, Faraday::Request::UrlEncoded, Faraday::Adapter::NetHttp, Foo]
-      end # }}}
-
-      it "delete some default middleware" do # {{{
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com" do |builder|
-          builder.delete Faraday::Request::UrlEncoded
-        end
-        @api.connection.builder.handlers.should == [Her::Middleware::FirstLevelParseJSON, Faraday::Adapter::NetHttp]
+        @api.connection.builder.handlers.should == [Foo, Bar]
       end # }}}
     end
 
@@ -61,7 +41,12 @@ describe Her::API do
         end
 
         @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com", :parse_middleware => SimpleParser
+        @api.setup :base_uri => "https://api.example.com" do |builder|
+          builder.use SimpleParser
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Adapter::NetHttp
+        end
+
         parsed_data = @api.request(:_method => :get, :_path => "/foo")
         parsed_data[:data] == "Foo, it is."
       end # }}}
@@ -70,7 +55,11 @@ describe Her::API do
         FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => MultiJson.dump({ :id => 1, :name => "George Michael Bluth", :errors => ["This is a single error"], :metadata => { :page => 1, :per_page => 10 } }))
 
         @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com"
+        @api.setup :base_uri => "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Adapter::NetHttp
+        end
         parsed_data = @api.request(:_method => :get, :_path => "users/1")
         parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
         parsed_data[:errors].should == ["This is a single error"]
@@ -94,8 +83,10 @@ describe Her::API do
         end
 
         @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com" do |connection|
-          connection.swap Her::Middleware::DefaultParseJSON, CustomParser
+        @api.setup :base_uri => "https://api.example.com" do |builder|
+          builder.use CustomParser
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Adapter::NetHttp
         end
         parsed_data = @api.request(:_method => :get, :_path => "users/1")
         parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }

data/spec/model/hooks_spec.rb

@@ -110,7 +110,12 @@ describe Her::Model::Hooks do
 
   context "perform hooks on a model" do
       before do # {{{
-        Her::API.setup :base_uri => "https://api.example.com"
+        Her::API.setup :base_uri => "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Adapter::NetHttp
+        end
+
         FakeWeb.register_uri(:post, "https://api.example.com/users", :body => { :id => 1, :name => "Tobias Fünke" }.to_json)
         FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :id => 1, :name => "Tobias Fünke" }.to_json)
         FakeWeb.register_uri(:put, "https://api.example.com/users/1", :body => { :id => 1, :name => "Tobias Fünke" }.to_json)

data/spec/model/http_spec.rb

@@ -29,7 +29,11 @@ describe Her::Model::HTTP do
 
     it "binds two models to two different instances of Her::API" do # {{{
       @api1 = Her::API.new
-      @api1.setup :base_uri => "https://api1.example.com"
+      @api1.setup :base_uri => "https://api1.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
 
       spawn_model :User
       User.uses_api @api1
@@ -39,7 +43,11 @@ describe Her::Model::HTTP do
       end
 
       @api2 = Her::API.new
-      @api2.setup :base_uri => "https://api2.example.com"
+      @api2.setup :base_uri => "https://api2.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
 
       spawn_model :Comment
       Comment.uses_api @api2
@@ -50,7 +58,12 @@ describe Her::Model::HTTP do
     end # }}}
 
     it "binds one model to Her::API and another one to an instance of Her::API" do # {{{
-      Her::API.setup :base_uri => "https://api1.example.com"
+      Her::API.setup :base_uri => "https://api1.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       spawn_model :User
 
       User.class_eval do
@@ -58,7 +71,11 @@ describe Her::Model::HTTP do
       end
 
       @api = Her::API.new
-      @api.setup :base_uri => "https://api2.example.com"
+      @api.setup :base_uri => "https://api2.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
 
       spawn_model :Comment
       Comment.uses_api @api
@@ -72,7 +89,12 @@ describe Her::Model::HTTP do
   context "making HTTP requests" do
     before do # {{{
       @api = Her::API.new
-      @api.setup :base_uri => "https://api.example.com"
+      @api.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       FakeWeb.register_uri(:get, "https://api.example.com/users", :body => [{ :id => 1 }].to_json)
       FakeWeb.register_uri(:get, "https://api.example.com/users?page=2", :body => [{ :id => 2 }].to_json)
       FakeWeb.register_uri(:get, "https://api.example.com/users/popular", :body => [{ :id => 1 }, { :id => 2 }].to_json)
@@ -163,7 +185,12 @@ describe Her::Model::HTTP do
   context "setting custom requests" do
     before do # {{{
       @api = Her::API.new
-      @api.setup :base_uri => "https://api.example.com"
+      @api.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       FakeWeb.register_uri(:get, "https://api.example.com/users/popular", :body => [{ :id => 1 }, { :id => 2 }].to_json)
       FakeWeb.register_uri(:post, "https://api.example.com/users/from_default", :body => { :id => 4 }.to_json)
 

data/spec/model/introspection_spec.rb

@@ -4,7 +4,12 @@ require File.join(File.dirname(__FILE__), "../spec_helper.rb")
 describe Her::Model::Introspection do
   context "introspecting a resource" do
     before do # {{{
-      Her::API.setup :base_uri => "https://api.example.com"
+      Her::API.setup :base_uri => "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Adapter::NetHttp
+        end
+
       FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :id => 1, :name => "Tobias Funke" }.to_json)
       spawn_model :User
     end # }}}

data/spec/model/orm_spec.rb

@@ -5,13 +5,23 @@ describe Her::Model::ORM do
   context "mapping data to Ruby objects" do
     before do # {{{
       api = Her::API.new
-      api.setup :base_uri => "https://api.example.com"
+      api.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :id => 1, :name => "Tobias Fünke" }.to_json)
       FakeWeb.register_uri(:get, "https://api.example.com/users", :body => [{ :id => 1, :name => "Tobias Fünke" }, { :id => 2, :name => "Lindsay Fünke" }].to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/admin_users", :body => [{ :id => 1, :name => "Tobias Fünke" }, { :id => 2, :name => "Lindsay Fünke" }].to_json)
 
       spawn_model :User do
         uses_api api
       end
+
+      spawn_model :AdminUser do
+        uses_api api
+      end
     end # }}}
 
     it "maps a single resource to a Ruby object" do # {{{
@@ -24,6 +34,10 @@ describe Her::Model::ORM do
       @users = User.all
       @users.length.should == 2
       @users.first.name.should == "Tobias Fünke"
+
+      @users = AdminUser.all
+      @users.length.should == 2
+      @users.first.name.should == "Tobias Fünke"
     end # }}}
 
     it "handles new resource" do # {{{
@@ -37,7 +51,12 @@ describe Her::Model::ORM do
 
   context "creating resources" do
     before do # {{{
-      Her::API.setup :base_uri => "https://api.example.com"
+      Her::API.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       FakeWeb.register_uri(:post, "https://api.example.com/users", :body => { :id => 1, :fullname => "Tobias Fünke" }.to_json)
 
       spawn_model :User
@@ -59,7 +78,12 @@ describe Her::Model::ORM do
   context "updating resources" do
     before do # {{{
       @api = Her::API.new
-      @api.setup :base_uri => "https://api.example.com"
+      @api.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :id => 1, :fullname => "Tobias Fünke" }.to_json)
       FakeWeb.register_uri(:put, "https://api.example.com/users/1", :body => { :id => 1, :fullname => "Lindsay Fünke" }.to_json)
 
@@ -89,7 +113,12 @@ describe Her::Model::ORM do
   context "deleting resources" do
     before do # {{{
       @api = Her::API.new
-      @api.setup :base_uri => "https://api.example.com"
+      @api.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :id => 1, :fullname => "Tobias Fünke", :active => true }.to_json)
       FakeWeb.register_uri(:delete, "https://api.example.com/users/1", :body => { :id => 1, :fullname => "Lindsay Fünke", :active => false }.to_json)
 

data/spec/model/paths_spec.rb

@@ -39,6 +39,42 @@ describe Her::Model::Paths do
       end
     end
 
+    context "simple model with multiple words" do
+      before do # {{{
+        spawn_model :AdminUser
+      end # }}}
+
+      describe "#build_request_path" do
+        it "builds paths with defaults" do # {{{
+          AdminUser.build_request_path(:id => "foo").should == "/admin_users/foo"
+          AdminUser.build_request_path.should == "/admin_users"
+        end # }}}
+
+        it "builds paths with custom collection path" do # {{{
+          AdminUser.collection_path "/users"
+          AdminUser.build_request_path(:id => "foo").should == "/users/foo"
+          AdminUser.build_request_path.should == "/users"
+        end # }}}
+
+        it "builds paths with custom collection path with multiple variables" do # {{{
+          AdminUser.collection_path "/organizations/:organization_id/users"
+          AdminUser.build_request_path(:id => "foo", :_organization_id => "acme").should == "/organizations/acme/users/foo"
+          AdminUser.build_request_path(:_organization_id => "acme").should == "/organizations/acme/users"
+        end # }}}
+
+        it "builds paths with custom item path" do # {{{
+          AdminUser.resource_path "/users/:id"
+          AdminUser.build_request_path(:id => "foo").should == "/users/foo"
+          AdminUser.build_request_path.should == "/admin_users"
+        end # }}}
+
+        it "raises exceptions when building a path without required custom variables" do # {{{
+          AdminUser.collection_path "/organizations/:organization_id/users"
+          expect { AdminUser.build_request_path(:id => "foo") }.should raise_error(Her::Errors::PathError)
+        end # }}}
+      end
+    end
+
     context "nested model" do
       before do # {{{
         spawn_submodel :Base, :User
@@ -56,7 +92,12 @@ describe Her::Model::Paths do
   context "making HTTP requests" do
     before do # {{{
       api = Her::API.new
-      api.setup :base_uri => "https://api.example.com"
+      api.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       FakeWeb.register_uri(:get, "https://api.example.com/organizations/2/users", :body => [{ :id => 1, :fullname => "Tobias Fünke", :organization_id => 2 }, { :id => 2, :fullname => "Lindsay Fünke", :organization_id => 2 }].to_json)
       FakeWeb.register_uri(:post, "https://api.example.com/organizations/2/users", :body => { :id => 1, :fullname => "Tobias Fünke", :organization_id => 2 }.to_json)
       FakeWeb.register_uri(:put, "https://api.example.com/organizations/2/users/1", :body => { :id => 1, :fullname => "Lindsay Fünke", :organization_id => 2 }.to_json)

data/spec/model/relationships_spec.rb

@@ -43,7 +43,12 @@ describe Her::Model::Relationships do
 
   context "handling relationships" do
     before do # {{{
-      Her::API.setup :base_uri => "https://api.example.com"
+      Her::API.setup :base_uri => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+
       FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :id => 1, :name => "Tobias Fünke", :comments => [{ :id => 2, :body => "Tobias, you blow hard!" }, { :id => 3, :body => "I wouldn't mind kissing that man between the cheeks, so to speak" }], :role => { :id => 1, :body => "Admin" }, :organization => { :id => 1, :name => "Bluth Company" }, :organization_id => 1 }.to_json)
       FakeWeb.register_uri(:get, "https://api.example.com/users/2", :body => { :id => 2, :name => "Lindsay Fünke", :organization_id => 1 }.to_json)
       FakeWeb.register_uri(:get, "https://api.example.com/users/2/comments", :body => [{ :id => 4, :body => "They're having a FIRESALE?" }, { :id => 5, :body => "Is this the tiny town from Footloose?" }].to_json)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,151 +9,216 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70289715223620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70289715223620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70289715222660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70289715222660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70289715221300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *70289715221300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70289715220480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.17.2
   type: :development
   prerelease: false
-  version_requirements: *70289715220480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.17.2
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70289715219620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.11.3
   type: :development
   prerelease: false
-  version_requirements: *70289715219620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70289715218820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70289715218820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70289715217880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *70289715217880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70289715233320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *70289715233320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70289715232440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :development
   prerelease: false
-  version_requirements: *70289715232440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70289715231640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.3
   type: :development
   prerelease: false
-  version_requirements: *70289715231640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70289715230600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 3.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *70289715230600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.3
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70289715229920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70289715229920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70289715229140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *70289715229140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
 description: Her is an ORM that maps REST resources and collections to Ruby objects
 email:
 - remi@exomel.com
@@ -168,6 +233,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADE.md
 - examples/twitter-oauth/Gemfile
 - examples/twitter-oauth/app.rb
 - examples/twitter-oauth/config.ru
@@ -216,7 +282,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3378238073562667343
+      hash: -3092731316656290620
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -225,10 +291,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3378238073562667343
+      hash: -3092731316656290620
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: A simple Representational State Transfer-based Hypertext Transfer Protocol-powered