her 0.7 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f5ffa339d778a9e0c1bdf8284bb6df2452584b9
-  data.tar.gz: f37e2a93474b2290a0b676ec70c793232ad49eb7
+  metadata.gz: 7626abb2e0aa83555379ffb426c47f766e7e5175
+  data.tar.gz: 9036b8f208b4e9462740eb22fa1b6d21ef48b9c1
 SHA512:
-  metadata.gz: 9d6670525bc4efb9c658cf9692ffda8fdb2c9ae24267f0b44c48980b39330b9b3fd51f47b73ad024f8cbb53f45ebff43d8adafe5adf6cae91f739a17aa5715bd
-  data.tar.gz: 45e82cff66d8f55e5887769a103a8015deff104c27e0d9e1fc0daff79dd53bc9e67681437ff3b692017d7c74596a9a2b3d5cd133906db0cbec9a01a3874057bb
+  metadata.gz: d6a8734624af88d8261d6f26147c517626530c925f886770b284471dde1f9903c455dd77a1dd6e7d21fc8a720d98d293fed0f3f967ccc3516dc05a1528a58b70
+  data.tar.gz: 4badd683f1cc2550dc34758573c6a57b46843b52b1a12b213eb917b6b2c60542cb05ff47038c9cc5aa8d497571fbf8569432a7d56024e7109c83fcf200dedc5b

data/README.md

@@ -576,10 +576,28 @@ class User
 end
 
 user = Users.find(1)
-# GET "/users/1", response is { "user": { "id": 1, "fullname": "Lindsay Fünke"} }
+# GET "/users/1", response is { "user": { "id": 1, "fullname": "Lindsay Fünke" } }
 
 users = Users.all
-# GET "/users", response is { "users": [{ "id": 1, "fullname": "Lindsay Fünke"}] }
+# GET "/users", response is { "users": [{ "id": 1, "fullname": "Lindsay Fünke" }, { "id": 1, "fullname": "Tobias Fünke" }] }
+```
+
+#### JSON API support
+
+If the API returns data in the [JSON API format](http://jsonapi.org/) you need
+to configure Her as follows:
+
+```ruby
+class User
+  include Her::Model
+  parse_root_in_json true, format: :json_api
+end
+
+user = Users.find(1)
+# GET "/users/1", response is { "users": [{ "id": 1, "fullname": "Lindsay Fünke" }] }
+
+users = Users.all
+# GET "/users", response is { "users": [{ "id": 1, "fullname": "Lindsay Fünke" }, { "id": 2, "fullname": "Tobias Fünke" }] }
 ```
 
 ### Custom requests
@@ -964,6 +982,8 @@ These [fine folks](https://github.com/remiprev/her/contributors) helped with Her
 * [@aclevy](https://github.com/aclevy)
 * [@stevschmid](https://github.com/stevschmid)
 * [@prognostikos](https://github.com/prognostikos)
+* [@dturnerTS](https://github.com/dturnerTS)
+* [@kritik](https://github.com/kritik)
 
 ## License
 

data/lib/her/model.rb

@@ -40,6 +40,7 @@ module Her
     # Supported ActiveModel modules
     include ActiveModel::AttributeMethods
     include ActiveModel::Validations
+    include ActiveModel::Validations::Callbacks
     include ActiveModel::Conversion
     include ActiveModel::Dirty
     include ActiveModel::Naming

data/lib/her/model/associations/has_many_association.rb

@@ -49,6 +49,8 @@ module Her
         #   user = User.find(1)
         #   new_comment = user.comments.build(:body => "Hello!")
         #   new_comment # => #<Comment user_id=1 body="Hello!">
+        # TODO: This only merges the id of the parents, handle the case
+        #       where this is more deeply nested
         def build(attributes = {})
           @klass.build(attributes.merge(:"#{@parent.singularized_resource_name}_id" => @parent.id))
         end
@@ -89,7 +91,8 @@ module Her
 
         # @private
         def assign_nested_attributes(attributes)
-          @parent.attributes[@name] = Her::Model::Attributes.initialize_collection(@klass, :data => attributes)
+          data = attributes.is_a?(Hash) ? attributes.values : attributes
+          @parent.attributes[@name] = Her::Model::Attributes.initialize_collection(@klass, :data => data)
         end
       end
     end

data/lib/her/model/http.rb

@@ -68,7 +68,7 @@ module Her
               path = build_request_path_from_string_or_symbol(path, params)
               params = to_params(params) unless #{method.to_sym.inspect} == :get
               send(:'#{method}_raw', path, params) do |parsed_data, response|
-                if parsed_data[:data].is_a?(Array) || active_model_serializers_format?
+                if parsed_data[:data].is_a?(Array) || active_model_serializers_format? || json_api_format?
                   new_collection(parsed_data)
                 else
                   new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])

data/lib/her/model/parse.rb

@@ -19,19 +19,54 @@ module Her
         # @param [Hash] data
         # @private
         def parse(data)
-          parse_root_in_json? ? data.fetch(parsed_root_element) { data } : data
+          if parse_root_in_json? && root_element_included?(data)
+            if json_api_format?
+              data.fetch(parsed_root_element).first
+            else
+              data.fetch(parsed_root_element) { data }
+            end
+          else
+            data
+          end
         end
 
         # @private
         def to_params(attributes, changes={})
           filtered_attributes = attributes.dup.symbolize_keys
+          filtered_attributes.merge!(embeded_params(attributes))
           if her_api.options[:send_only_modified_attributes]
             filtered_attributes = changes.symbolize_keys.keys.inject({}) do |hash, attribute|
               hash[attribute] = filtered_attributes[attribute]
               hash
             end
           end
-          include_root_in_json? ? { included_root_element => filtered_attributes } : filtered_attributes
+
+          if include_root_in_json?
+            if json_api_format?
+              { included_root_element => [filtered_attributes] }
+            else
+              { included_root_element => filtered_attributes }
+            end
+          else
+            filtered_attributes
+          end
+        end
+
+
+        # @private
+        # TODO: Handle has_one
+        def embeded_params(attributes)
+          associations[:has_many].select { |a| attributes.include?(a[:data_key])}.compact.inject({}) do |hash, association|
+            params = attributes[association[:data_key]].map(&:to_params)
+            next if params.empty?
+            if association[:class_name].constantize.include_root_in_json?
+              root = association[:class_name].constantize.root_element
+              hash[association[:data_key]] = params.map { |n| n[root] }
+            else
+              hash[association[:data_key]] = params
+            end
+            hash
+          end
         end
 
         # Return or change the value of `include_root_in_json`
@@ -41,30 +76,33 @@ module Her
         #     include Her::Model
         #     include_root_in_json true
         #   end
-        def include_root_in_json(value)
+        def include_root_in_json(value, options = {})
           @_her_include_root_in_json = value
+          @_her_include_root_in_json_format = options[:format]
         end
 
-        def include_root_in_json?
-          @_her_include_root_in_json || (superclass.respond_to?(:include_root_in_json?) && superclass.include_root_in_json?)
-        end
-
-        # Return or change the value of `parse_root_in`
+        # Return or change the value of `parse_root_in_json`
         #
         # @example
         #   class User
         #     include Her::Model
         #     parse_root_in_json true
         #   end
+        #
+        #   class User
+        #     include Her::Model
+        #     parse_root_in_json true, format: :active_model_serializers
+        #   end
+        #
+        #   class User
+        #     include Her::Model
+        #     parse_root_in_json true, format: :json_api
+        #   end
         def parse_root_in_json(value, options = {})
           @_her_parse_root_in_json = value
           @_her_parse_root_in_json_format = options[:format]
         end
 
-        def parse_root_in_json?
-          @_her_parse_root_in_json || (superclass.respond_to?(:parse_root_in_json?) && superclass.parse_root_in_json?)
-        end
-
         # Return or change the value of `request_new_object_on_build`
         #
         # @example
@@ -76,10 +114,6 @@ module Her
           @_her_request_new_object_on_build = value
         end
 
-        def request_new_object_on_build?
-          @_her_request_new_object_on_build || (superclass.respond_to?(:request_new_object_on_build?) && superclass.request_new_object_on_build?)
-        end
-
         # Return or change the value of `root_element`. Always defaults to the base name of the class.
         #
         # @example
@@ -93,12 +127,26 @@ module Her
         #   user.name # => "Tobias"
         def root_element(value = nil)
           if value.nil?
-            @_her_root_element ||= self.name.split("::").last.underscore.to_sym
+            if json_api_format?
+              @_her_root_element ||= self.name.split("::").last.pluralize.underscore.to_sym
+            else
+              @_her_root_element ||= self.name.split("::").last.underscore.to_sym
+            end
           else
             @_her_root_element = value.to_sym
           end
         end
 
+        # @private
+        def root_element_included?(data)
+          data.keys.to_s.include? @_her_root_element.to_s
+        end
+
+        # @private
+        def included_root_element
+          include_root_in_json? == true ? root_element : include_root_in_json?
+        end
+
         # Extract an array from the request data
         #
         # @example
@@ -118,8 +166,10 @@ module Her
         #
         #   users = User.all # [ { :id => 1, :name => "Tobias" } ]
         #   users.first.name # => "Tobias"
+        #
+        # @private
         def extract_array(request_data)
-          if active_model_serializers_format?
+          if active_model_serializers_format? || json_api_format?
             request_data[:data][pluralized_parsed_root_element]
           else
             request_data[:data]
@@ -131,11 +181,6 @@ module Her
           parsed_root_element.to_s.pluralize.to_sym
         end
 
-        # @private
-        def included_root_element
-          include_root_in_json? == true ? root_element : include_root_in_json?
-        end
-
         # @private
         def parsed_root_element
           parse_root_in_json? == true ? root_element : parse_root_in_json?
@@ -145,6 +190,26 @@ module Her
         def active_model_serializers_format?
           @_her_parse_root_in_json_format == :active_model_serializers || (superclass.respond_to?(:active_model_serializers_format?) && superclass.active_model_serializers_format?)
         end
+
+        # @private
+        def json_api_format?
+          @_her_parse_root_in_json_format == :json_api || (superclass.respond_to?(:json_api_format?) && superclass.json_api_format?)
+        end
+
+        # @private
+        def request_new_object_on_build?
+          @_her_request_new_object_on_build || (superclass.respond_to?(:request_new_object_on_build?) && superclass.request_new_object_on_build?)
+        end
+
+        # @private
+        def include_root_in_json?
+          @_her_include_root_in_json || (superclass.respond_to?(:include_root_in_json?) && superclass.include_root_in_json?)
+        end
+
+        # @private
+        def parse_root_in_json?
+          @_her_parse_root_in_json || (superclass.respond_to?(:parse_root_in_json?) && superclass.parse_root_in_json?)
+        end
       end
     end
   end

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.7"
+  VERSION = "0.7.1"
 end

data/spec/model/associations_spec.rb

@@ -111,7 +111,7 @@ describe Her::Model::Associations do
       end
 
       spawn_model "Foo::User" do
-        has_many :comments
+        has_many :comments, class_name: "Foo::Comment"
         has_one :role
         belongs_to :organization
         has_many :posts, :inverse_of => :admin
@@ -222,6 +222,12 @@ describe Her::Model::Associations do
       @user_without_included_data.organization.should_not be_empty
     end
 
+    it 'includes has_many relationships in params by default' do
+      params = @user_with_included_data.to_params
+      params[:comments].should be_kind_of(Array)
+      params[:comments].length.should eq(2)
+    end
+
     [:create, :save_existing, :destroy].each do |type|
       context "after #{type}" do
         let(:subject) { self.send("user_with_included_data_after_#{type}")}

data/spec/model/nested_attributes_spec.rb

@@ -96,6 +96,34 @@ describe Her::Model::NestedAttributes do
     end
   end
 
+  context "with a has_many association as a Hash" do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+      end
+
+      spawn_model "Foo::User" do
+        has_many :pets
+        accepts_nested_attributes_for :pets
+      end
+
+      spawn_model "Foo::Pet"
+
+      @user_with_data_through_nested_attributes_as_hash = Foo::User.new :name => "Test", :pets_attributes => { '0' => { :name => "Hasi" }, '1' => { :name => "Rodriguez" }}
+    end
+
+    context "when children do not yet exist" do
+      it "creates an instance of the associated class" do
+        @user_with_data_through_nested_attributes_as_hash.pets.length.should == 2
+        @user_with_data_through_nested_attributes_as_hash.pets[0].should be_a(Foo::Pet)
+        @user_with_data_through_nested_attributes_as_hash.pets[1].should be_a(Foo::Pet)
+        @user_with_data_through_nested_attributes_as_hash.pets[0].name.should == "Hasi"
+        @user_with_data_through_nested_attributes_as_hash.pets[1].name.should == "Rodriguez"
+      end
+    end
+  end
+
   context "with an unknown association" do
     it "raises an error" do
       expect {

data/spec/model/parse_spec.rb

@@ -231,6 +231,95 @@ describe Her::Model::Parse do
     end
   end
 
+  context "when parse_root_in_json set json_api to true" do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.adapter :test do |stub|
+          stub.get("/users") { |env| [200, {},  { :users => [{ :id => 1, :fullname => "Lindsay Fünke" }] }.to_json] }
+          stub.get("/users/admins") { |env| [200, {}, { :users => [{ :id => 1, :fullname => "Lindsay Fünke" }] }.to_json] }
+          stub.get("/users/1") { |env| [200, {}, { :users => [{ :id => 1, :fullname => "Lindsay Fünke" }] }.to_json] }
+          stub.post("/users") { |env| [200, {}, { :users => [{ :fullname => "Lindsay Fünke" }] }.to_json] }
+          stub.put("/users/1") { |env| [200, {}, { :users => [{ :id => 1, :fullname => "Tobias Fünke Jr." }] }.to_json] }
+        end
+      end
+
+      spawn_model("Foo::User") do
+        parse_root_in_json true, :format => :json_api
+        include_root_in_json true
+        custom_get :admins
+      end
+    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 an arbitrary HTTP request" do
+      @new_user = Foo::User.admins
+      @new_user.first.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
+
+    it "parse the data from the JSON root element after new/save" do
+      @user = Foo::User.new
+      @user.fullname = "Lindsay Fünke (before save)"
+      @user.save
+      @user.fullname.should == "Lindsay Fünke"
+    end
+  end
+
+  context "when include_root_in_json set json_api" do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+      end
+
+      Her::API.default_api.connection.adapter :test do |stub|
+        stub.post("/users") { |env| [200, {}, { :users => [{ :id => 1, :fullname => params(env)[:users][:fullname] }] }.to_json] }
+      end
+    end
+
+    context "to true" do
+      before do
+        spawn_model "Foo::User" do
+          include_root_in_json true
+          parse_root_in_json true, format: :json_api
+          custom_post :admins
+        end
+      end
+
+      it "wraps params in the element name in `to_params`" do
+        @new_user = Foo::User.new(:fullname => "Tobias Fünke")
+        @new_user.to_params.should == { :users => [{ :fullname => "Tobias Fünke" }] }
+      end
+
+      it "wraps params in the element name in `.where`" do
+        @new_user = Foo::User.where(:fullname => "Tobias Fünke").build
+        @new_user.fullname.should == "Tobias Fünke"
+      end
+    end
+  end
+
   context 'when send_only_modified_attributes is set' do
     before do
       Her::API.setup :url => "https://api.example.com", :send_only_modified_attributes => true do |builder|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.7.1
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake