her 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 458601a1de64f520013856ef805b17e8293bfb9d
-  data.tar.gz: 1e965c550664039d6b6f649a9b10a7821d90f717
+  metadata.gz: 9b11481769c945a97654d3d95432044346945d41
+  data.tar.gz: 5d9d9d9f02a10ccd3424314ed13b870651995637
 SHA512:
-  metadata.gz: e7d147d58050f847942df92440c9e71013c1fc54fbb56d0a6e5dd9d6167a1ffc4e30c329524f1bac07a378d06991198cb1bf44215067ab911f2d0ff1ee5b95f7
-  data.tar.gz: 1c3ab969c7fbe8f90f730945cd9392f9e2d3df6b3df577291f86f97aa7405758f1086a7708e2586760d674a362703c465bd66516f828d1c1a389fb7c304f4a16
+  metadata.gz: 0ba766a53928bf5a48027e5caaee70081768a8c924c1a306afca64dd6e72ded1dc5999da454f3cdd66ca47c96ad41e639ae4bd8bed8df8bd33a269d7d28584cc
+  data.tar.gz: cf562af326ca2bc7d77be3f27de84cfd8d17620775833947815ff985751c11fa89153c4bb4de78027f7bbd36d55209b4cd2f36095e003c250b0ccd9ae5b14d1b

data/.travis.yml

@@ -16,4 +16,7 @@ gemfile:
   - gemfiles/Gemfile.activemodel-4.0
   - gemfiles/Gemfile.activemodel-3.2.x
 
+before_install:
+  - gem install bundler
+
 script: "echo 'COME ON!' && bundle exec rake spec"

data/README.md

@@ -234,7 +234,7 @@ end
 @tweets = Tweet.get("/statuses/home_timeline.json")
 ```
 
-See the *Authentication* middleware section for an example of how to pass different credentials based on the current user.
+See the [*Authentication middleware section*](#authentication) for an example of how to pass different credentials based on the current user.
 
 ### Parsing JSON data
 
@@ -248,7 +248,7 @@ By default, Her handles JSON data. It expects the resource/collection data to be
 [{ "id" : 1, "name" : "Tobias Fünke" }]
 ```
 
-However, if you want Her to be able to parse the data from a single root element (usually based on the model name), you’ll have to use the `parse_root_in_json` method (See the **JSON attributes-wrapping** section).
+However, if you want Her to be able to parse the data from a single root element (usually based on the model name), you’ll have to use the `parse_root_in_json` method (See the [**JSON attributes-wrapping**](#json-attributes-wrapping) section).
 
 Also, you can define your own parsing method using a response middleware. The middleware should set `env[:body]` to a hash with three symbol keys: `:data`, `:errors` and `:metadata`. The following code uses a custom middleware to parse the JSON data:
 
@@ -452,7 +452,7 @@ class Organization
 end
 ```
 
-Her expects all `User` resources to have an `:organization_id` (or `:_organization_id`) attribute. Otherwise, calling mostly all methods, like `User.all`, will thrown an exception like this one:
+Her expects all `User` resources to have an `:organization_id` (or `:_organization_id`) attribute. Otherwise, calling mostly all methods, like `User.all`, will throw an exception like this one:
 
 ```ruby
 Her::Errors::PathError: Missing :_organization_id parameter to build the request path. Path is `organizations/:organization_id/users`. Parameters are `{ … }`.

data/lib/her/api.rb

@@ -89,19 +89,26 @@ module Her
       path = opts.delete(:_path)
       headers = opts.delete(:_headers)
       opts.delete_if { |key, value| key.to_s =~ /^_/ } # Remove all internal parameters
-      response = @connection.send method do |request|
+      if method == :options
+        # Faraday doesn't support the OPTIONS verb because of a name collision with an internal options method
+        # so we need to call run_request directly.
         request.headers.merge!(headers) if headers
-        if method == :get
-          # For GET requests, treat additional parameters as querystring data
-          request.url path, opts
-        else
-          # For POST, PUT and DELETE requests, treat additional parameters as request body
-          request.url path
-          request.body = opts
+        response = @connection.run_request method, path, opts, headers
+      else
+        response = @connection.send method do |request|
+          request.headers.merge!(headers) if headers
+          if method == :get
+            # For GET requests, treat additional parameters as querystring data
+            request.url path, opts
+          else
+            # For POST, PUT and DELETE requests, treat additional parameters as request body
+            request.url path
+            request.body = opts
+          end
         end
       end
-
       { :parsed_data => response.env[:body], :response => response }
+
     end
 
     private

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

@@ -26,11 +26,7 @@ module Her
           return {} unless data[data_key]
 
           klass = klass.her_nearby_class(association[:class_name])
-          if data[data_key].kind_of?(klass)
-            { association[:name] => data[data_key] }
-          else
-            { association[:name] => klass.new(klass.parse(data[data_key])) }
-          end
+          { association[:name] => klass.instantiate_record(klass, data: data[data_key]) }
         end
 
         # @private

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

@@ -31,7 +31,7 @@ module Her
           return {} unless data[data_key]
 
           klass = klass.her_nearby_class(association[:class_name])
-          { association[:name] => Her::Model::Attributes.initialize_collection(klass, :data => data[data_key]) }
+          { association[:name] => klass.instantiate_collection(klass, :data => data[data_key]) }
         end
 
         # Initialize a new object with a foreign key to the parent
@@ -92,7 +92,7 @@ module Her
         # @private
         def assign_nested_attributes(attributes)
           data = attributes.is_a?(Hash) ? attributes.values : attributes
-          @parent.attributes[@name] = Her::Model::Attributes.initialize_collection(@klass, :data => data)
+          @parent.attributes[@name] = @klass.instantiate_collection(@klass, :data => data)
         end
       end
     end

data/lib/her/model/attributes.rb

@@ -16,7 +16,13 @@ module Her
       #     include Her::Model
       #   end
       #
-      #  User.new(name: "Tobias") # => #<User name="Tobias">
+      #   User.new(name: "Tobias")
+      #   # => #<User name="Tobias">
+      #
+      #   User.new do |u|
+      #     u.name = "Tobias"
+      #   end
+      #   # => #<User name="Tobias">
       def initialize(attributes={})
         attributes ||= {}
         @metadata = attributes.delete(:_metadata) || {}
@@ -25,50 +31,10 @@ module Her
 
         attributes = self.class.default_scope.apply_to(attributes)
         assign_attributes(attributes)
-
         yield self if block_given?
         run_callbacks :initialize
       end
 
-      # Initialize a collection of resources
-      #
-      # @private
-      def self.initialize_collection(klass, parsed_data={})
-        collection_data = klass.extract_array(parsed_data).map do |item_data|
-          if item_data.kind_of?(klass)
-            resource = item_data
-          else
-            resource = klass.new(klass.parse(item_data))
-            resource.run_callbacks :find
-          end
-          resource
-        end
-        Her::Collection.new(collection_data, parsed_data[:metadata], parsed_data[:errors])
-      end
-
-      # Use setter methods of model for each key / value pair in params
-      # Return key / value pairs for which no setter method was defined on the model
-      #
-      # @private
-      def self.use_setter_methods(model, params)
-        params ||= {}
-
-        reserved_keys = [:id, model.class.primary_key] + model.class.association_keys
-        model.class.attributes *params.keys.reject { |k| reserved_keys.include?(k) || reserved_keys.map(&:to_s).include?(k) }
-
-        setter_method_names = model.class.setter_method_names
-        params.inject({}) do |memo, (key, value)|
-          setter_method = key.to_s + '='
-          if setter_method_names.include?(setter_method)
-            model.send(setter_method, value)
-          else
-            key = key.to_sym if key.is_a?(String)
-            memo[key] = value
-          end
-          memo
-        end
-      end
-
       # Handles missing methods
       #
       # @private
@@ -89,7 +55,7 @@ module Her
 
       # @private
       def respond_to_missing?(method, include_private = false)
-        method.to_s.end_with?('=') || method.to_s.end_with?('?') || @attributes.include?(method) || super
+        method.to_s =~ /[?=]$/ || @attributes.include?(method) || super
       end
 
       # Assign new attributes to a resource
@@ -105,7 +71,7 @@ module Her
       def assign_attributes(new_attributes)
         @attributes ||= attributes
         # Use setter methods first
-        unset_attributes = Her::Model::Attributes.use_setter_methods(self, new_attributes)
+        unset_attributes = self.class.use_setter_methods(self, new_attributes)
 
         # Then translate attributes of associations into association instances
         parsed_attributes = self.class.parse_associations(unset_attributes)
@@ -139,7 +105,8 @@ module Her
         @attributes[self.class.primary_key]
       end
 
-      # Return `true` if the other object is also a Her::Model and has matching data
+      # Return `true` if the other object is also a Her::Model and has matching
+      # data
       #
       # @private
       def ==(other)
@@ -177,23 +144,69 @@ 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)
+            record
+          else
+            attributes = klass.parse(record).merge(_metadata: parsed_data[:metadata],
+                                                   _errors: parsed_data[:errors])
+            klass.new(attributes).tap do |record|
+              record.run_callbacks :find
+            end
+          end
+        end
+
+        # Initialize a collection of resources
+        #
+        # @private
+        def instantiate_collection(klass, parsed_data = {})
+          items = klass.extract_array(parsed_data).map do |item|
+            instantiate_record(klass, data: item)
+          end
+          Her::Collection.new(items, parsed_data[:metadata], parsed_data[:errors])
+        end
+
         # Initialize a collection of resources with raw data from an HTTP request
         #
         # @param [Array] parsed_data
         # @private
         def new_collection(parsed_data)
-          Her::Model::Attributes.initialize_collection(self, parsed_data)
+          instantiate_collection(self, parsed_data)
         end
 
         # Initialize a new object with the "raw" parsed_data from the parsing middleware
         #
         # @private
         def new_from_parsed_data(parsed_data)
-          parsed_data = parsed_data.with_indifferent_access
-          new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])
+          instantiate_record(self, parsed_data)
+        end
+
+        # Use setter methods of model for each key / value pair in params
+        # Return key / value pairs for which no setter method was defined on the
+        # model
+        #
+        # @private
+        def use_setter_methods(model, params = {})
+          reserved = [:id, model.class.primary_key, *model.class.association_keys]
+          model.class.attributes *params.keys.reject { |k| reserved.include?(k) }
+
+          setter_method_names = model.class.setter_method_names
+          params.each_with_object({}) do |(key, value), memo|
+            setter_method = key.to_s + '='
+            if setter_method_names.include?(setter_method)
+              model.send(setter_method, value)
+            else
+              memo[key.to_sym] = value
+            end
+          end
         end
 
-        # Define attribute method matchers to automatically define them using ActiveModel's define_attribute_methods.
+        # Define attribute method matchers to automatically define them using
+        # ActiveModel's define_attribute_methods.
         #
         # @private
         def define_attribute_method_matchers
@@ -201,18 +214,22 @@ module Her
           attribute_method_suffix '?'
         end
 
-        # Create a mutex for dynamically generated attribute methods or use one defined by ActiveModel.
+        # Create a mutex for dynamically generated attribute methods or use one
+        # defined by ActiveModel.
         #
         # @private
         def attribute_methods_mutex
-          @attribute_methods_mutex ||= if generated_attribute_methods.respond_to? :mu_synchronize
-                                         generated_attribute_methods
-                                       else
-                                         Mutex.new
-                                       end
+          @attribute_methods_mutex ||= begin
+            if generated_attribute_methods.respond_to? :mu_synchronize
+              generated_attribute_methods
+            else
+              Mutex.new
+            end
+          end
         end
 
-        # Define the attributes that will be used to track dirty attributes and validations
+        # Define the attributes that will be used to track dirty attributes and
+        # validations
         #
         # @param [Array] attributes
         # @example
@@ -226,7 +243,8 @@ module Her
           end
         end
 
-        # Define the accessor in which the API response errors (obtained from the parsing middleware) will be stored
+        # Define the accessor in which the API response errors (obtained from
+        # the parsing middleware) will be stored
         #
         # @param [Symbol] store_response_errors
         #
@@ -239,7 +257,8 @@ module Her
           store_her_data(:response_errors, value)
         end
 
-        # Define the accessor in which the API response metadata (obtained from the parsing middleware) will be stored
+        # Define the accessor in which the API response metadata (obtained from
+        # the parsing middleware) will be stored
         #
         # @param [Symbol] store_metadata
         #
@@ -254,9 +273,10 @@ module Her
 
         # @private
         def setter_method_names
-          @_her_setter_method_names ||= instance_methods.inject(Set.new) do |memo, method_name|
-            memo << method_name.to_s if method_name.to_s.end_with?('=')
-            memo
+          @_her_setter_method_names ||= begin
+            instance_methods.each_with_object(Set.new) do |method, memo|
+              memo << method.to_s if method.to_s.end_with?('=')
+            end
           end
         end
 

data/lib/her/model/http.rb

@@ -3,7 +3,7 @@ module Her
     # This module interacts with Her::API to fetch HTTP data
     module HTTP
       extend ActiveSupport::Concern
-      METHODS = [:get, :post, :put, :patch, :delete]
+      METHODS = [:get, :post, :put, :patch, :delete, :options]
 
       # For each HTTP method, define these class methods:
       #
@@ -71,7 +71,7 @@ module Her
                 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])
+                  new_from_parsed_data(parsed_data)
                 end
               end
             end
@@ -91,7 +91,7 @@ module Her
             def #{method}_resource(path, params={})
               path = build_request_path_from_string_or_symbol(path, params)
               send(:"#{method}_raw", path, params) do |parsed_data, response|
-                new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])
+                new_from_parsed_data(parsed_data)
               end
             end
 

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-25 00:00:00.000000000 Z
+date: 2017-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake