her 1.0.0 → 1.1.1

data/lib/her/model/nested_attributes.rb

@@ -25,7 +25,7 @@ module Her
 
           associations.each do |association_name|
             unless allowed_association_names.include?(association_name)
-              raise Her::Errors::AssociationUnknownError.new("Unknown association name :#{association_name}")
+              raise Her::Errors::AssociationUnknownError, "Unknown association name :#{association_name}"
             end
 
             class_eval <<-RUBY, __FILE__, __LINE__ + 1

data/lib/her/model/orm.rb

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 module Her
   module Model
     # This module adds ORM-like capabilities to the model
@@ -54,12 +55,22 @@ module Her
 
       # Similar to save(), except that ResourceInvalid is raised if the save fails
       def save!
-        if !self.save
+        unless save
           raise Her::Errors::ResourceInvalid, self
         end
         self
       end
 
+      # Update a resource and return it
+      #
+      # @example
+      #   @user = User.find(1)
+      #   @user.update_attributes(:name => "Tobias Fünke")
+      #   # Called via PUT "/users/1"
+      def update_attributes(attributes)
+        assign_attributes(attributes) && save
+      end
+
       # Destroy a resource
       #
       # @example
@@ -195,7 +206,7 @@ module Her
         #
         #   User.all # Called via GET "/users?admin=1"
         #   User.new.admin # => 1
-        def default_scope(block=nil)
+        def default_scope(block = nil)
           @_her_default_scope ||= (!respond_to?(:default_scope) && superclass.respond_to?(:default_scope)) ? superclass.default_scope : scoped
           @_her_default_scope = @_her_default_scope.instance_exec(&block) unless block.nil?
           @_her_default_scope
@@ -217,8 +228,15 @@ module Her
         #   @user = User.save_existing(1, { :fullname => "Tobias Fünke" })
         #   # Called via PUT "/users/1"
         def save_existing(id, params)
+          save_existing!(id, params)
+        rescue Her::Errors::ResourceInvalid => e
+          e.resource
+        end
+
+        # Similar to .save_existing but raises ResourceInvalid if save fails
+        def save_existing!(id, params)
           resource = new(params.merge(primary_key => id))
-          resource.save
+          resource.save!
           resource
         end
 
@@ -227,7 +245,7 @@ module Her
         # @example
         #   User.destroy_existing(1)
         #   # Called via DELETE "/users/1"
-        def destroy_existing(id, params={})
+        def destroy_existing(id, params = {})
           request(params.merge(:_method => method_for(:destroy), :_path => build_request_path(params.merge(primary_key => id)))) do |parsed_data, response|
             data = parse(parsed_data[:data])
             metadata = parsed_data[:metadata]
@@ -256,15 +274,15 @@ module Her
         # If the request_new_object_on_build flag is set, the new object is requested via API.
         def build(attributes = {})
           params = attributes
-          return self.new(params) unless self.request_new_object_on_build?
+          return new(params) unless request_new_object_on_build?
 
-          path = self.build_request_path(params.merge(self.primary_key => 'new'))
-          method = self.method_for(:new)
+          path = build_request_path(params.merge(primary_key => 'new'))
+          method = method_for(:new)
 
           resource = nil
-          self.request(params.merge(:_method => method, :_path => path)) do |parsed_data, response|
+          request(params.merge(:_method => method, :_path => path)) do |parsed_data, response|
             if response.success?
-              resource = self.new_from_parsed_data(parsed_data)
+              resource = new_from_parsed_data(parsed_data)
             end
           end
           resource

data/lib/her/model/parse.rb

@@ -10,7 +10,7 @@ module Her
       #   @user.to_params
       #   # => { :id => 1, :name => 'John Smith' }
       def to_params
-        self.class.to_params(self.attributes, self.changes)
+        self.class.to_params(attributes, changes)
       end
 
       module ClassMethods
@@ -31,7 +31,7 @@ module Her
         end
 
         # @private
-        def to_params(attributes, changes={})
+        def to_params(attributes, changes = {})
           filtered_attributes = attributes.each_with_object({}) do |(key, value), memo|
             case value
             when Her::Model
@@ -45,10 +45,7 @@ module Her
           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
+            filtered_attributes.slice! *changes.keys.map(&:to_sym)
           end
 
           if include_root_in_json?
@@ -133,11 +130,11 @@ module Her
         #   user.name # => "Tobias"
         def root_element(value = nil)
           if value.nil?
-            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
+            @_her_root_element ||= if json_api_format?
+                                     name.split("::").last.pluralize.underscore.to_sym
+                                   else
+                                     name.split("::").last.underscore.to_sym
+                                   end
           else
             @_her_root_element = value.to_sym
           end
@@ -145,7 +142,8 @@ module Her
 
         # @private
         def root_element_included?(data)
-          data.keys.to_s.include? @_her_root_element.to_s
+          element = data[parsed_root_element]
+          element.is_a?(Hash) || element.is_a?(Array)
         end
 
         # @private

data/lib/her/model/paths.rb

@@ -19,7 +19,6 @@ module Her
       end
 
       module ClassMethods
-
         # Define the primary key field that will be used to find and save records
         #
         # @example
@@ -88,13 +87,13 @@ module Her
         # Return a custom path based on the collection path and variable parameters
         #
         # @private
-        def build_request_path(path=nil, parameters={})
+        def build_request_path(path = nil, parameters = {})
           parameters = parameters.try(:with_indifferent_access)
 
           unless path.is_a?(String)
             parameters = path.try(:with_indifferent_access) || parameters
             path =
-              if parameters.include?(primary_key) && parameters[primary_key] && !parameters[primary_key].kind_of?(Array)
+              if parameters.include?(primary_key) && parameters[primary_key] && !parameters[primary_key].is_a?(Array)
                 resource_path.dup
               else
                 collection_path.dup
@@ -117,7 +116,7 @@ module Her
         end
 
         # @private
-        def build_request_path_from_string_or_symbol(path, params={})
+        def build_request_path_from_string_or_symbol(path, params = {})
           path.is_a?(Symbol) ? "#{build_request_path(params)}/#{path}" : path
         end
       end

data/lib/her/model/relation.rb

@@ -1,6 +1,7 @@
 module Her
   module Model
     class Relation
+
       # @private
       attr_accessor :params
       attr_writer :parent
@@ -32,7 +33,7 @@ module Her
       #   # Fetched via GET "/users?approved=1"
       def where(params = {})
         return self if params.blank? && !@_fetch.nil?
-        self.clone.tap do |r|
+        clone.tap do |r|
           r.params = r.params.merge(params)
           r.clear_fetch_cache!
         end
@@ -58,7 +59,7 @@ module Her
 
       # @private
       def kind_of?(thing)
-        fetch.kind_of?(thing)
+        fetch.is_a?(thing)
       end
 
       # Fetch a collection of resources
@@ -68,7 +69,7 @@ module Her
         @_fetch ||= begin
           path = @parent.build_request_path(@parent.collection_path, @params)
           method = @parent.method_for(:find)
-          @parent.request(@params.merge(:_method => method, :_path => path)) do |parsed_data, response|
+          @parent.request(@params.merge(:_method => method, :_path => path)) do |parsed_data, _|
             @parent.new_collection(parsed_data)
           end
         end
@@ -106,7 +107,7 @@ module Her
           resource
         end
 
-        ids.length > 1 || ids.first.kind_of?(Array) ? results : results.first
+        ids.length > 1 || ids.first.is_a?(Array) ? results : results.first
       end
 
       # Fetch first resource with the given attributes.

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/spec/api_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require File.join(File.dirname(__FILE__), "spec_helper.rb")
 
 describe Her::API do
@@ -32,6 +33,7 @@ describe Her::API do
     describe "#request" do
       before do
         class SimpleParser < Faraday::Response::Middleware
+
           def on_complete(env)
             env[:body] = { data: env[:body] }
           end
@@ -85,6 +87,7 @@ describe Her::API do
         let(:parsed_data) { subject.request(_method: :get, _path: "users/1")[:parsed_data] }
         before do
           class CustomParser < Faraday::Response::Middleware
+
             def on_complete(env)
               json = MultiJson.load(env[:body], symbolize_keys: true)
               errors = json.delete(:errors) || []

data/spec/middleware/accept_json_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require "spec_helper"
 
 describe Her::Middleware::AcceptJSON do

data/spec/middleware/first_level_parse_json_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require "spec_helper"
 
 describe Her::Middleware::FirstLevelParseJSON do
@@ -31,7 +32,7 @@ describe Her::Middleware::FirstLevelParseJSON do
   end
 
   it "ensures the errors are a hash if there are no errors" do
-    expect(subject.parse(body_with_errors)[:errors]).to eq(name: %w(not_valid should_be_present))
+    expect(subject.parse(body_with_errors)[:errors]).to eq(name: %w[not_valid should_be_present])
   end
 
   it "ensures that malformed JSON throws an exception" do

data/spec/middleware/json_api_parser_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require "spec_helper"
 
 describe Her::Middleware::JsonApiParser do

data/spec/middleware/second_level_parse_json_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require "spec_helper"
 
 describe Her::Middleware::SecondLevelParseJSON do

data/spec/model/associations/association_proxy_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require "spec_helper"
 
 describe Her::Model::Associations::AssociationProxy do

data/spec/model/associations_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require File.join(File.dirname(__FILE__), "../spec_helper.rb")
 
 describe Her::Model::Associations do
@@ -111,8 +112,7 @@ describe Her::Model::Associations do
             data_key: :organization,
             default: nil,
             class_name: "Organization",
-            foreign_key: "organization_id",
-            path: "/organizations/:id"
+            foreign_key: "organization_id"
           }
         end
         before { Foo::User.belongs_to :organization }
@@ -120,7 +120,8 @@ describe Her::Model::Associations do
         it { is_expected.to eql [organization_association] }
       end
 
-      context "multiple" do
+      context "specifying non-default path" do
+        let(:path) { 'my_special_path' }
         let(:organization_association) do
           {
             name: :organization,
@@ -128,7 +129,22 @@ describe Her::Model::Associations do
             default: nil,
             class_name: "Organization",
             foreign_key: "organization_id",
-            path: "/organizations/:id"
+            path: path
+          }
+        end
+        before { Foo::User.belongs_to :organization, path: path }
+
+        it { is_expected.to eql [organization_association] }
+      end
+
+      context "multiple" do
+        let(:organization_association) do
+          {
+            name: :organization,
+            data_key: :organization,
+            default: nil,
+            class_name: "Organization",
+            foreign_key: "organization_id"
           }
         end
         let(:family_association) do
@@ -137,8 +153,7 @@ describe Her::Model::Associations do
             data_key: :family,
             default: nil,
             class_name: "Family",
-            foreign_key: "family_id",
-            path: "/families/:id"
+            foreign_key: "family_id"
           }
         end
         before do
@@ -215,8 +230,7 @@ describe Her::Model::Associations do
               data_key: :org,
               default: true,
               class_name: "Business",
-              foreign_key: "org_id",
-              path: "/organizations/:id"
+              foreign_key: "org_id"
             }
           end
           before do
@@ -296,7 +310,7 @@ describe Her::Model::Associations do
             stub.get("/users/1/comments") { [200, {}, [{ comment: { id: 4, body: "They're having a FIRESALE?" } }].to_json] }
             stub.get("/users/1/role") { [200, {}, { id: 3, body: "User" }.to_json] }
             stub.get("/users/1/posts") { [200, {}, [{ id: 1, body: "blogging stuff", admin_id: 1 }].to_json] }
-            stub.get("/organizations/1") { [200, {}, { organization:  { id: 1, name: "Bluth Company Foo" } }.to_json] }
+            stub.get("/organizations/1") { [200, {}, { organization: { id: 1, name: "Bluth Company Foo" } }.to_json] }
           end
         end
       end
@@ -446,6 +460,9 @@ describe Her::Model::Associations 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/1") { [200, {}, { id: 1, name: "Lindsay Fünke", organization_id: 2 }.to_json] }
+          end
         end
       end
 
@@ -526,6 +543,74 @@ describe Her::Model::Associations do
     end
   end
 
+  context "handling associations with collection_path" do
+    before do
+      spawn_model "Foo::Organization" do
+        has_many :users
+        parse_root_in_json true
+        collection_path '/special/organizations'
+      end
+      spawn_model "Foo::User" do
+        belongs_to :organization
+      end
+    end
+
+    context "without included data" do
+      before(:context) 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/2") { [200, {}, { id: 2, name: "Lindsay Fünke", organization_id: 2 }.to_json] }
+            stub.get("/special/organizations/2") { [200, {}, { organization: { id: 2, name: "Bluth Company" } }.to_json] }
+          end
+        end
+      end
+
+      let(:user) { Foo::User.find(2) }
+
+      it "fetches data that was not included through belongs_to" do
+        expect(user.organization).to be_a(Foo::Organization)
+        expect(user.organization.id).to eq(2)
+        expect(user.organization.name).to eq("Bluth Company")
+      end
+    end
+  end
+
+  context "handling associations with path_prefix" do
+    before do
+      spawn_model "Foo::Organization" do
+        has_many :users
+        parse_root_in_json true
+      end
+      spawn_model "Foo::User" do
+        belongs_to :organization
+      end
+    end
+
+    context "without included data" do
+      before(:context) do
+        Her::API.setup url: "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.use Faraday::Request::UrlEncoded
+          builder.path_prefix = 'special'
+          builder.adapter :test do |stub|
+            stub.get("/special/users/2") { [200, {}, { id: 2, name: "Lindsay Fünke", organization_id: 2 }.to_json] }
+            stub.get("/special/organizations/2") { [200, {}, { organization: { id: 2, name: "Bluth Company" } }.to_json] }
+          end
+        end
+      end
+
+      let(:user) { Foo::User.find(2) }
+
+      it "fetches data that was not included through belongs_to" do
+        expect(user.organization).to be_a(Foo::Organization)
+        expect(user.organization.id).to eq(2)
+        expect(user.organization.name).to eq("Bluth Company")
+      end
+    end
+  end
+
   context "handling associations with details in active_model_serializers format" do
     before do
       spawn_model "Foo::User" do
@@ -558,7 +643,7 @@ describe Her::Model::Associations do
           builder.adapter :test do |stub|
             stub.get("/users/1") { [200, {}, { user: { id: 1, name: "Tobias Fünke", comments: [{ id: 2, body: "Tobias, you blow hard!", user_id: 1 }, { id: 3, body: "I wouldn't mind kissing that man between the cheeks, so to speak", user_id: 1 }], role: { id: 1, body: "Admin" }, organization: { id: 1, name: "Bluth Company" }, organization_id: 1 } }.to_json] }
             stub.get("/users/1/comments") { [200, {}, { comments: [{ id: 4, body: "They're having a FIRESALE?" }] }.to_json] }
-            stub.get("/organizations/1") { [200, {}, { organization:  { id: 1, name: "Bluth Company Foo" } }.to_json] }
+            stub.get("/organizations/1") { [200, {}, { organization: { id: 1, name: "Bluth Company Foo" } }.to_json] }
           end
         end
       end
@@ -616,7 +701,7 @@ describe Her::Model::Associations do
             stub.get("/users/2") { [200, {}, { user: { id: 2, name: "Lindsay Fünke", organization_id: 1 } }.to_json] }
             stub.get("/users/2/comments") { [200, {}, { comments: [{ id: 4, body: "They're having a FIRESALE?" }, { id: 5, body: "Is this the tiny town from Footloose?" }] }.to_json] }
             stub.get("/users/2/comments/5") { [200, {}, { comment: { id: 5, body: "Is this the tiny town from Footloose?" } }.to_json] }
-            stub.get("/organizations/1") { [200, {}, { organization:  { id: 1, name: "Bluth Company Foo" } }.to_json] }
+            stub.get("/organizations/1") { [200, {}, { organization: { id: 1, name: "Bluth Company Foo" } }.to_json] }
           end
         end
       end
@@ -661,8 +746,7 @@ describe Her::Model::Associations do
           builder.adapter :test do |stub|
             stub.get("/users/1") { [200, {}, { id: 1, name: "Tobias Fünke", organization: { id: 1, name: "Bluth Company Inc." }, organization_id: 1 }.to_json] }
             stub.get("/users/4") { [200, {}, { id: 1, name: "Tobias Fünke", organization: { id: 1, name: "Bluth Company Inc." } }.to_json] }
-            stub.get("/users/3") { [200, {}, { id: 2, name: "Lindsay Fünke", company: nil }.to_json] }
-            stub.get("/companies/1") { [200, {}, { id: 1, name: "Bluth Company" }.to_json] }
+            stub.get("/users/3") { [200, {}, { id: 2, name: "Lindsay Fünke", organization: nil }.to_json] }
           end
         end
       end
@@ -699,7 +783,7 @@ describe Her::Model::Associations do
           builder.use Faraday::Request::UrlEncoded
           builder.adapter :test do |stub|
             stub.get("/users/2") { [200, {}, { id: 2, name: "Lindsay Fünke", organization_id: 1 }.to_json] }
-            stub.get("/companies/1") { [200, {}, { id: 1, name: "Bluth Company" }.to_json] }
+            stub.get("/organizations/1") { [200, {}, { id: 1, name: "Bluth Company" }.to_json] }
           end
         end
       end