her 1.0.0 → 1.1.1

data/lib/her/json_api/model.rb

@@ -1,13 +1,12 @@
 module Her
   module JsonApi
     module Model
-      
       def self.included(klass)
         klass.class_eval do
           include Her::Model
 
           [:parse_root_in_json, :include_root_in_json, :root_element, :primary_key].each do |method|
-            define_method method do |*args|
+            define_method method do |*_|
               raise NoMethodError, "Her::JsonApi::Model does not support the #{method} configuration option"
             end
           end
@@ -15,24 +14,21 @@ module Her
           method_for :update, :patch
 
           @type = name.demodulize.tableize
-          
+
           def self.parse(data)
             data.fetch(:attributes).merge(data.slice(:id))
           end
 
-          def self.to_params(attributes, changes={})
-            request_data = { type: @type }.tap { |request_body| 
-              attrs = attributes.dup.symbolize_keys.tap { |filtered_attributes|
+          def self.to_params(attributes, changes = {})
+            request_data = { type: @type }.tap do |request_body|
+              attrs = attributes.dup.symbolize_keys.tap do |filtered_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
-              }
+              end
               request_body[:id] = attrs.delete(:id) if attrs[:id]
               request_body[:attributes] = attrs
-            }
+            end
             { data: request_data }
           end
 

data/lib/her/middleware.rb

@@ -7,6 +7,6 @@ module Her
   module Middleware
     DefaultParseJSON = FirstLevelParseJSON
 
-    autoload :JsonApiParser,   'her/middleware/json_api_parser'
+    autoload :JsonApiParser, 'her/middleware/json_api_parser'
   end
 end

data/lib/her/middleware/accept_json.rb

@@ -2,6 +2,7 @@ module Her
   module Middleware
     # This middleware adds a "Accept: application/json" HTTP header
     class AcceptJSON < Faraday::Middleware
+
       # @private
       def add_header(headers)
         headers.merge! "Accept" => "application/json"

data/lib/her/middleware/first_level_parse_json.rb

@@ -2,6 +2,7 @@ module Her
   module Middleware
     # This middleware treat the received first-level JSON structure as the resource data.
     class FirstLevelParseJSON < ParseJSON
+
       # Parse the response body
       #
       # @param [String] body The response body
@@ -25,11 +26,11 @@ module Her
       # @private
       def on_complete(env)
         env[:body] = case env[:status]
-        when 204
-          parse('{}')
-        else
-          parse(env[:body])
-        end
+                     when 204
+                       parse('{}')
+                     else
+                       parse(env[:body])
+                     end
       end
     end
   end

data/lib/her/middleware/json_api_parser.rb

@@ -3,6 +3,7 @@ module Her
     # This middleware expects the resource/collection data to be contained in the `data`
     # key of the JSON object
     class JsonApiParser < ParseJSON
+
       # Parse the response body
       #
       # @param [String] body The response body
@@ -25,11 +26,11 @@ module Her
       # @private
       def on_complete(env)
         env[:body] = case env[:status]
-        when 204, 304
-          parse('{}')
-        else
-          parse(env[:body])
-        end
+                     when 204, 304
+                       parse('{}')
+                     else
+                       parse(env[:body])
+                     end
       end
     end
   end

data/lib/her/middleware/parse_json.rb

@@ -1,6 +1,7 @@
 module Her
   module Middleware
     class ParseJSON < Faraday::Response::Middleware
+
       # @private
       def parse_json(body = nil)
         body = '{}' if body.blank?
@@ -12,7 +13,7 @@ module Her
           raise Her::Errors::ParseError, message
         end
 
-        raise Her::Errors::ParseError, message unless json.is_a?(Hash) or json.is_a?(Array)
+        raise Her::Errors::ParseError, message unless json.is_a?(Hash) || json.is_a?(Array)
 
         json
       end

data/lib/her/middleware/second_level_parse_json.rb

@@ -3,6 +3,7 @@ module Her
     # This middleware expects the resource/collection data to be contained in the `data`
     # key of the JSON object
     class SecondLevelParseJSON < ParseJSON
+
       # Parse the response body
       #
       # @param [String] body The response body
@@ -25,11 +26,11 @@ module Her
       # @private
       def on_complete(env)
         env[:body] = case env[:status]
-        when 204
-          parse('{}')
-        else
-          parse(env[:body])
-        end
+                     when 204
+                       parse('{}')
+                     else
+                       parse(env[:body])
+                     end
       end
     end
   end

data/lib/her/model/associations.rb

@@ -32,18 +32,18 @@ module Her
         # @private
         def associations
           @_her_associations ||= begin
-            superclass.respond_to?(:associations) ? superclass.associations.dup : Hash.new { |h,k| h[k] = [] }
+            superclass.respond_to?(:associations) ? superclass.associations.dup : Hash.new { |h, k| h[k] = [] }
           end
         end
 
         # @private
         def association_names
-          associations.inject([]) { |memo, (name, details)| memo << details }.flatten.map { |a| a[:name] }
+          associations.inject([]) { |memo, (_, details)| memo << details }.flatten.map { |a| a[:name] }
         end
 
         # @private
         def association_keys
-          associations.inject([]) { |memo, (name, details)| memo << details }.flatten.map { |a| a[:data_key] }
+          associations.inject([]) { |memo, (_, details)| memo << details }.flatten.map { |a| a[:data_key] }
         end
 
         # Parse associations data after initializing a new object
@@ -81,7 +81,7 @@ module Her
         #   @user = User.find(1)
         #   @user.articles # => [#<Article(articles/2) id=2 title="Hello world.">]
         #   # Fetched via GET "/users/1/articles"
-        def has_many(name, opts={})
+        def has_many(name, opts = {})
           Her::Model::Associations::HasManyAssociation.attach(self, name, opts)
         end
 
@@ -106,7 +106,7 @@ module Her
         #   @user = User.find(1)
         #   @user.organization # => #<Organization(organizations/2) id=2 name="Foobar Inc.">
         #   # Fetched via GET "/users/1/organization"
-        def has_one(name, opts={})
+        def has_one(name, opts = {})
           Her::Model::Associations::HasOneAssociation.attach(self, name, opts)
         end
 
@@ -116,7 +116,7 @@ module Her
         # @param [Hash] opts Options
         # @option opts [String] :class_name The name of the class to map objects to
         # @option opts [Symbol] :data_key The attribute where the data is stored
-        # @option opts [Path] :path The relative path where to fetch the data (defaults to `/{class_name}.pluralize/{id}`)
+        # @option opts [Path] :path The relative path where to fetch the data
         # @option opts [Symbol] :foreign_key The foreign key used to build the `:id` part of the path (defaults to `{name}_id`)
         #
         # @example
@@ -132,7 +132,7 @@ module Her
         #   @user = User.find(1) # => #<User(users/1) id=1 team_id=2 name="Tobias">
         #   @user.team # => #<Team(teams/2) id=2 name="Developers">
         #   # Fetched via GET "/teams/2"
-        def belongs_to(name, opts={})
+        def belongs_to(name, opts = {})
           Her::Model::Associations::BelongsToAssociation.attach(self, name, opts)
         end
       end

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

@@ -2,6 +2,7 @@ module Her
   module Model
     module Associations
       class Association
+
         # @private
         attr_accessor :params
 
@@ -47,7 +48,7 @@ module Her
           return @parent.attributes[@name] unless @params.any? || @parent.attributes[@name].blank?
           return @opts[:default].try(:dup) if @parent.new?
 
-          path = build_association_path lambda { "#{@parent.request_path(@params)}#{@opts[:path]}" }
+          path = build_association_path -> { "#{@parent.request_path(@params)}#{@opts[:path]}" }
           @klass.get(path, @params).tap do |result|
             @cached_result = result unless @params.any?
           end
@@ -55,11 +56,9 @@ module Her
 
         # @private
         def build_association_path(code)
-          begin
-            instance_exec(&code)
-          rescue Her::Errors::PathError
-            return nil
-          end
+          instance_exec(&code)
+        rescue Her::Errors::PathError
+          nil
         end
 
         # @private
@@ -81,7 +80,7 @@ module Her
         #   user.comments.where(:approved => 1) # Fetched via GET "/users/1/comments?approved=1
         def where(params = {})
           return self if params.blank? && @parent.attributes[@name].blank?
-          AssociationProxy.new self.clone.tap { |a| a.params = a.params.merge(params) }
+          AssociationProxy.new clone.tap { |a| a.params = a.params.merge(params) }
         end
         alias all where
 
@@ -97,7 +96,7 @@ module Her
         #   user.comments.find(3) # Fetched via GET "/users/1/comments/3
         def find(id)
           return nil if id.blank?
-          path = build_association_path lambda { "#{@parent.request_path(@params)}#{@opts[:path]}/#{id}" }
+          path = build_association_path -> { "#{@parent.request_path(@params)}#{@opts[:path]}/#{id}" }
           @klass.get_resource(path, @params)
         end
 
@@ -123,7 +122,6 @@ module Her
           reset
           fetch
         end
-
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Her
         end
 
         install_proxy_methods :association,
-          :build, :create, :where, :find, :all, :assign_nested_attributes, :reload
+                              :build, :create, :where, :find, :all, :assign_nested_attributes, :reload
 
         # @private
         def initialize(association)
@@ -28,7 +28,7 @@ module Her
 
         # @private
         def method_missing(name, *args, &block)
-          if :object_id == name # avoid redefining object_id
+          if name == :object_id # avoid redefining object_id
             return association.fetch.object_id
           end
 
@@ -38,7 +38,6 @@ module Her
           # resend message to fetched object
           __send__(name, *args, &block)
         end
-
       end
     end
   end

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

@@ -10,8 +10,7 @@ module Her
             :name => name,
             :data_key => name,
             :default => nil,
-            :foreign_key => "#{name}_id",
-            :path => "/#{name.to_s.pluralize}/:id"
+            :foreign_key => "#{name}_id"
           }.merge(opts)
           klass.associations[:belongs_to] << opts
 
@@ -80,7 +79,7 @@ module Her
           return @parent.attributes[@name] unless @params.any? || @parent.attributes[@name].blank?
 
           path_params = @parent.attributes.merge(@params.merge(@klass.primary_key => foreign_key_value))
-          path = build_association_path lambda { @klass.build_request_path(path_params) }
+          path = build_association_path -> { @klass.build_request_path(@opts[:path], path_params) }
           @klass.get_resource(path, @params).tap do |result|
             @cached_result = result if @params.blank?
           end

data/lib/her/model/attributes.rb

@@ -23,7 +23,7 @@ module Her
       #     u.name = "Tobias"
       #   end
       #   # => #<User name="Tobias">
-      def initialize(attributes={})
+      def initialize(attributes = {})
         attributes ||= {}
         @metadata = attributes.delete(:_metadata) || {}
         @response_errors = attributes.delete(:_errors) || {}
@@ -69,7 +69,15 @@ module Her
       #   user.assign_attributes(name: "Lindsay")
       #   user.changes # => { :name => ["Tobias", "Lindsay"] }
       def assign_attributes(new_attributes)
+        if !new_attributes.respond_to?(:to_hash)
+          raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
+        end
+
+        # Coerce new_attributes to hash in case of strong parameters
+        new_attributes = new_attributes.to_hash
+
         @_her_attributes ||= attributes
+
         # Use setter methods first
         unset_attributes = self.class.use_setter_methods(self, new_attributes)
 
@@ -151,19 +159,18 @@ module Her
       end
 
       module ClassMethods
-
         # Initialize a single resource
         #
         # @private
         def instantiate_record(klass, parsed_data)
-          if record = parsed_data[:data] and record.kind_of?(klass)
+          if (record = parsed_data[:data]) && record.is_a?(klass)
             record
           else
             attributes = klass.parse(record).merge(_metadata: parsed_data[:metadata],
                                                    _errors: parsed_data[:errors])
-            klass.new(attributes).tap do |record|
-              record.send :clear_changes_information
-              record.run_callbacks :find
+            klass.new(attributes).tap do |record_instance|
+              record_instance.send :clear_changes_information
+              record_instance.run_callbacks :find
             end
           end
         end
@@ -289,6 +296,7 @@ module Her
         end
 
         private
+
         # @private
         def store_her_data(name, value)
           class_eval <<-RUBY, __FILE__, __LINE__ + 1

data/lib/her/model/base.rb

@@ -11,7 +11,7 @@ module Her
       # @private
       def has_key?(attribute_name)
         has_attribute?(attribute_name) ||
-        has_association?(attribute_name)
+          has_association?(attribute_name)
       end
 
       # Returns
@@ -21,7 +21,7 @@ module Her
       # @private
       def [](attribute_name)
         get_attribute(attribute_name) ||
-        get_association(attribute_name)
+          get_association(attribute_name)
       end
 
       # @private

data/lib/her/model/http.rb

@@ -52,7 +52,7 @@ module Her
         # Main request wrapper around Her::API. Used to make custom request to the API.
         #
         # @private
-        def request(params={})
+        def request(params = {})
           request = her_api.request(params)
 
           if block_given?
@@ -97,7 +97,12 @@ module Her
 
             def custom_#{method}(*paths)
               metaclass = (class << self; self; end)
-              opts = paths.last.is_a?(Hash) ? paths.pop : Hash.new
+
+              # TODO: Remove this check after January 2020
+              if paths.last.is_a?(Hash)
+                warn("[DEPRECATION] options for custom request methods are deprecated and will be removed on or after January 2020.")
+                paths.pop
+              end
 
               paths.each do |path|
                 metaclass.send(:define_method, path) do |*params|

data/lib/her/model/introspection.rb

@@ -22,6 +22,7 @@ module Her
       end
 
       private
+
       def attribute_for_inspect(value)
         if value.is_a?(String) && value.length > 50
           "#{value[0..50]}...".inspect
@@ -42,11 +43,12 @@ module Her
         end
 
         protected
+
         # Looks for a class at the same level as this one with the given name.
         #
         # @private
         def her_sibling_class(name)
-          if mod = self.her_containing_module
+          if mod = her_containing_module
             @_her_sibling_class ||= Hash.new { Hash.new }
             @_her_sibling_class[mod][name] ||= "#{mod.name}::#{name}".constantize rescue nil
           end
@@ -56,8 +58,8 @@ module Her
         #
         # @private
         def her_containing_module
-          return unless self.name =~ /::/
-          self.name.split("::")[0..-2].join("::").constantize
+          return unless name =~ /::/
+          name.split("::")[0..-2].join("::").constantize
         end
       end
     end