her 0.3.8 → 0.4

data/README.md

@@ -372,6 +372,58 @@ The available hooks are:
 * `after_destroy`
 * `after_find`
 
+### JSON attributes-wrapping
+
+Her supports *sending* and *parsing* JSON data wrapped in a root element (to be compatible with Rails’ `include_root_in_json` setting), like so:
+
+#### Sending
+
+If you want to send all data to your API wrapped in a *root* element based on the model name.
+
+```ruby
+class User
+  include Her::Model
+  include_root_in_json true
+end
+
+class Article
+  include Her::Model
+  include_root_in_json :post
+end
+
+User.create(:fullname => "Tobias Fünke")
+# POST { "user": { "fullname": "Tobias Fünke" } } to /users
+
+Article.create(:title => "Hello world.")
+# POST { "post": { "title": "Hello world." } } to /articles
+```
+
+#### Parsing
+
+If the API returns data wrapped in a *root* element based on the model name.
+
+```ruby
+class User
+  include Her::Model
+  parse_root_in_json true
+end
+
+class Article
+  include Her::Model
+  parse_root_in_json :post
+end
+
+# POST /users returns { "user": { "fullname": "Tobias Fünke" } }
+user = User.create(:fullname => "Tobias Fünke")
+user.fullname # => "Tobias Fünke"
+
+# POST /articles returns { "post": { "title": "Hello world." } }
+article = Article.create(:title => "Hello world.")
+article.title # => "Hello world."
+```
+
+Of course, you can use both `include_root_in_json` and `parse_root_in_json` at the same time.
+
 ### Custom requests
 
 You can easily define custom requests for your models using `custom_get`, `custom_post`, etc.
@@ -662,6 +714,7 @@ These fine folks helped with Her:
 * [@pencil](https://github.com/pencil)
 * [@joanniclaborde](https://github.com/joanniclaborde)
 * [@seanreads](https://github.com/seanreads)
+* [@jonkarna](https://github.com/jonkarna)
 
 ## License
 

data/lib/her/model.rb

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

data/lib/her/model/orm.rb

@@ -24,7 +24,7 @@ module Her
       # @private
       def self.initialize_collection(klass, parsed_data={})
         collection_data = parsed_data[:data].map do |item_data|
-          resource = klass.new(item_data)
+          resource = klass.new(klass.parse(item_data))
           klass.wrap_in_hooks(resource, :find)
           resource
         end
@@ -150,7 +150,7 @@ module Her
 
         self.class.wrap_in_hooks(resource, *hooks) do |resource, klass|
           klass.request(params.merge(:_method => method, :_path => "#{request_path}")) do |parsed_data|
-            self.data = parsed_data[:data] if parsed_data[:data].any?
+            self.data = self.class.parse(parsed_data[:data]) if parsed_data[:data].any?
             self.metadata = parsed_data[:metadata]
             self.errors = parsed_data[:errors]
 
@@ -171,7 +171,7 @@ module Her
         resource = self
         self.class.wrap_in_hooks(resource, :destroy) do |resource, klass|
           klass.request(:_method => :delete, :_path => "#{request_path}") do |parsed_data|
-            self.data = parsed_data[:data]
+            self.data = self.class.parse(parsed_data[:data])
             self.metadata = parsed_data[:metadata]
             self.errors = parsed_data[:errors]
           end
@@ -185,7 +185,11 @@ module Her
       #   @user.to_params
       #   # => { :id => 1, :name => 'John Smith' }
       def to_params
-        @data.dup
+        if self.class.include_root_in_json
+          { (self.class.include_root_in_json == true ? self.class.root_element : self.class.include_root_in_json) => @data.dup }
+        else
+          @data.dup
+        end
       end
 
       module ClassMethods
@@ -196,6 +200,17 @@ module Her
           Her::Model::ORM.initialize_collection(self, parsed_data)
         end
 
+        # Parse data before assigning it to a resource
+        #
+        # @param [Hash] data
+        def parse(data)
+          if parse_root_in_json
+            parse_root_in_json == true ? data[root_element.to_sym] : data[parse_root_in_json]
+          else
+            data
+          end
+        end
+
         # Fetch specific resource(s) by their ID
         #
         # @example
@@ -210,7 +225,7 @@ module Her
           results = ids.flatten.compact.uniq.map do |id|
             resource = nil
             request(params.merge(:_method => :get, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data|
-              resource = new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
+              resource = new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
               wrap_in_hooks(resource, :find)
             end
             resource
@@ -243,8 +258,9 @@ module Her
           wrap_in_hooks(resource, :create, :save) do |resource, klass|
             params = resource.to_params
             request(params.merge(:_method => :post, :_path => "#{build_request_path(params)}")) do |parsed_data|
+              data = parse(parsed_data[:data])
               resource.instance_eval do
-                @data = parsed_data[:data]
+                @data = data
                 @metadata = parsed_data[:metadata]
                 @errors = parsed_data[:errors]
               end
@@ -271,7 +287,7 @@ module Her
         #   # Called via DELETE "/users/1"
         def destroy_existing(id, params={})
           request(params.merge(:_method => :delete, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data|
-            new(parsed_data[:data])
+            new(parse(parsed_data[:data]))
           end
         end
 
@@ -282,6 +298,18 @@ module Her
             memo
           end
         end
+
+        # Return or change the value of `include_root_in_json`
+        def include_root_in_json(value=nil)
+          return @include_root_in_json if value.nil?
+          @include_root_in_json = value
+        end
+
+        # Return or change the value of `parse_root_in`
+        def parse_root_in_json(value=nil)
+          return @parse_root_in_json if value.nil?
+          @parse_root_in_json = value
+        end
       end
     end
   end

data/lib/her/model/paths.rb

@@ -16,6 +16,7 @@ module Her
       end
 
       module ClassMethods
+
         # Defines a custom collection path for the resource
         #
         # @example
@@ -69,6 +70,12 @@ module Her
             parameters.delete($1.to_sym) || parameters.delete("_#{$1}".to_sym) || raise(Her::Errors::PathError.new("Missing :_#{$1} parameter to build the request path (#{path})."))
           end
         end
+
+        # Return or change the value of `root_element`
+        def root_element(value=nil)
+          return @root_element if value.nil?
+          @root_element = value
+        end
       end
     end
   end

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.3.8"
+  VERSION = "0.4"
 end

data/spec/model/orm_spec.rb

@@ -462,4 +462,91 @@ describe Her::Model::ORM do
       hash.should == { user => false }
     end
   end
+
+  context "when include_root_in_json is true" do
+    context "when include_root_in_json is true" do
+      before do
+        spawn_model "Foo::User" do
+          include_root_in_json true
+        end
+      end
+
+      it "wraps params in the element name" do
+        @new_user = Foo::User.new(:fullname => "Tobias Fünke")
+        @new_user.to_params.should == { 'user' => { :fullname => "Tobias Fünke" } }
+      end
+    end
+
+    context "when include_root_in_json is set to another value" do
+      before do
+        spawn_model "Foo::User" do
+          include_root_in_json :person
+        end
+      end
+
+      it "wraps params in the specified value" do
+        @new_user = Foo::User.new(:fullname => "Tobias Fünke")
+        @new_user.to_params.should == { :person => { :fullname => "Tobias Fünke" } }
+      end
+    end
+  end
+
+  context "when parse_root_in_json is set" do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+      end
+    end
+
+    context "when parse_root_in_json is true" do
+      before do
+        Her::API.default_api.connection.adapter :test do |stub|
+          stub.post("/users") { |env| [200, {}, { :user => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json] }
+          stub.get("/users") { |env| [200, {}, [{ :user => { :id => 1, :fullname => "Lindsay Fünke" } }].to_json] }
+          stub.get("/users/1") { |env| [200, {}, { :user => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json] }
+          stub.put("/users/1") { |env| [200, {}, { :user => { :id => 1, :fullname => "Tobias Fünke Jr." } }.to_json] }
+        end
+
+        spawn_model("Foo::User") { parse_root_in_json true }
+      end
+
+      it "parse the data from the JSON root element after .create" do
+        @new_user = Foo::User.create(:fullname => "Lindsay Fünke")
+        @new_user.fullname.should == "Lindsay Fünke"
+      end
+
+      it "parse the data from the JSON root element after .all" do
+        @users = Foo::User.all
+        @users.first.fullname.should == "Lindsay Fünke"
+      end
+
+      it "parse the data from the JSON root element after .find" do
+        @user = Foo::User.find(1)
+        @user.fullname.should == "Lindsay Fünke"
+      end
+
+      it "parse the data from the JSON root element after .save" do
+        @user = Foo::User.find(1)
+        @user.fullname = "Tobias Fünke"
+        @user.save
+        @user.fullname.should == "Tobias Fünke Jr."
+      end
+    end
+
+    context "when parse_root_in_json is set to a symbol" do
+      before do
+        Her::API.default_api.connection.adapter :test do |stub|
+          stub.post("/users") { |env| [200, {}, { :person => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json] }
+        end
+
+        spawn_model("Foo::User") { parse_root_in_json :person }
+      end
+
+      it "parse the data with the symbol" do
+        @new_user = Foo::User.create(:fullname => "Lindsay Fünke")
+        @new_user.fullname.should == "Lindsay Fünke"
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -177,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2988245247515927159
+      hash: -2845158545991818661
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -186,10 +186,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2988245247515927159
+      hash: -2845158545991818661
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A simple Representational State Transfer-based Hypertext Transfer Protocol-powered