her 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b11481769c945a97654d3d95432044346945d41
-  data.tar.gz: 5d9d9d9f02a10ccd3424314ed13b870651995637
+  metadata.gz: b1d26b46a64420261f94f9394f9552d0f6152d27
+  data.tar.gz: '009e2b3a0c746e2ff24d2c96e7b3e110852b6e5c'
 SHA512:
-  metadata.gz: 0ba766a53928bf5a48027e5caaee70081768a8c924c1a306afca64dd6e72ded1dc5999da454f3cdd66ca47c96ad41e639ae4bd8bed8df8bd33a269d7d28584cc
-  data.tar.gz: cf562af326ca2bc7d77be3f27de84cfd8d17620775833947815ff985751c11fa89153c4bb4de78027f7bbd36d55209b4cd2f36095e003c250b0ccd9ae5b14d1b
+  metadata.gz: 119265f2cfea3d575768faf7f5b9dbec5e88da8536068dd51957251cdf921b275e4527767ca57f647172951341bfcca6a3d0363ff0091cbb2f40b0ec89c922fc
+  data.tar.gz: d74157011df12022512bc46df0ae02cc48f69bd89753a72eac0e32b88921d9356e2073c8b63e238d925304f3bf4ba07418d7c58898bf87308e8deebbacc46b48

data/.travis.yml

@@ -3,9 +3,9 @@ language: ruby
 sudo: false
 
 rvm:
-  - 2.4.1
-  - 2.3.1
-  - 2.2.2
+  - 2.4.2
+  - 2.3.5
+  - 2.2.8
   - 2.1.6
   - 2.0.0
   - 1.9.3

data/README.md

@@ -1,9 +1,3 @@
-# Maintenance Update 29th Sept 2016
-
-Hi folks, [@edtjones](https://github.com/edtjones) here. Rémi has handed me the keys to Her and [@foxpaul](https://github.com/foxpaul) and I will be trying to do the library justice with the help of the community. There's loads to do; we'll get in touch with everyone who's raised a PR as soon as possible and figure out a plan of action.
-
-# Rails 5 support
-If you need Rails 5 support, version 0.8.2 is for you!
 
 <p align="center">
   <a href="https://github.com/remiprev/her">
@@ -996,6 +990,7 @@ See the [UPGRADE.md](https://github.com/remiprev/her/blob/master/UPGRADE.md) for
 Most projects I know that use Her are internal or private projects but here’s a list of public ones:
 
 * [tumbz](https://github.com/remiprev/tumbz)
+* [zoho-ruby](https://github.com/errorstudio/zoho-ruby)
 * [crowdher](https://github.com/simonprev/crowdher)
 * [vodka](https://github.com/magnolia-fan/vodka)
 * [webistrano_cli](https://github.com/chytreg/webistrano_cli)
@@ -1007,6 +1002,9 @@ I told myself a few months ago that it would be great to build a gem to replace
 
 Most of Her’s core concepts were written on a Saturday morning of April 2012 ([first commit](https://github.com/remiprev/her/commit/689d8e88916dc2ad258e69a2a91a283f061cbef2) at 7am!).
 
+## Maintainers
+The gem is currently maintained by [@zacharywelch](https://github.com/zacharywelch) and [@edtjones](https://github.com/edtjones).
+
 ## Contribute
 
 Yes please! Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/her/issues). There’s no such thing as a bad pull request — even if it’s for a typo, a small improvement to the code or the documentation!

data/her.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", "~> 3.5"
   s.add_development_dependency "json", "~> 1.8"
 
-  s.add_runtime_dependency "activemodel", ">= 3.0.0", "<= 6.0.0"
-  s.add_runtime_dependency "activesupport", ">= 3.0.0", "<= 6.0.0"
+  s.add_runtime_dependency "activemodel", ">= 3.0.0", "< 5.2.0"
+  s.add_runtime_dependency "activesupport", ">= 3.0.0", "< 5.2.0"
   s.add_runtime_dependency "faraday", ">= 0.8", "< 1.0"
   s.add_runtime_dependency "multi_json", "~> 1.7"
 end

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

@@ -85,7 +85,7 @@ module Her
         def fetch
           super.tap do |o|
             inverse_of = @opts[:inverse_of] || @parent.singularized_resource_name
-            o.each { |entry| entry.send("#{inverse_of}=", @parent) }
+            o.each { |entry| entry.attributes[inverse_of] = @parent }
           end
         end
 

data/lib/her/model/attributes.rb

@@ -39,7 +39,7 @@ module Her
       #
       # @private
       def method_missing(method, *args, &blk)
-        if method.to_s =~ /[?=]$/ || @attributes.include?(method)
+        if method.to_s =~ /[?=]$/ || @_her_attributes.include?(method)
           # Extract the attribute
           attribute = method.to_s.sub(/[?=]$/, '')
 
@@ -55,7 +55,7 @@ module Her
 
       # @private
       def respond_to_missing?(method, include_private = false)
-        method.to_s =~ /[?=]$/ || @attributes.include?(method) || super
+        method.to_s =~ /[?=]$/ || @_her_attributes.include?(method) || super
       end
 
       # Assign new attributes to a resource
@@ -69,40 +69,47 @@ module Her
       #   user.assign_attributes(name: "Lindsay")
       #   user.changes # => { :name => ["Tobias", "Lindsay"] }
       def assign_attributes(new_attributes)
-        @attributes ||= attributes
+        @_her_attributes ||= attributes
         # Use setter methods first
         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)
+        associations = self.class.parse_associations(unset_attributes)
 
-        # Then merge the parsed_data into @attributes.
-        @attributes.merge!(parsed_attributes)
+        # Then merge the associations into @_her_attributes.
+        @_her_attributes.merge!(associations)
       end
       alias attributes= assign_attributes
 
       def attributes
-        @attributes ||= HashWithIndifferentAccess.new
+        # The natural choice of instance variable naming here would be
+        # `@attributes`. Unfortunately that causes a naming clash when
+        # used with `ActiveModel` version >= 5.2.0.
+        # As of v5.2.0 `ActiveModel` checks to see if `ActiveRecord`
+        # attributes exist, and assumes that if the instance variable
+        # `@attributes` exists on the instance, it is because they are
+        # `ActiveRecord` attributes.
+        @_her_attributes ||= HashWithIndifferentAccess.new
       end
 
       # Handles returning true for the accessible attributes
       #
       # @private
       def has_attribute?(attribute_name)
-        @attributes.include?(attribute_name)
+        @_her_attributes.include?(attribute_name)
       end
 
       # Handles returning data for a specific attribute
       #
       # @private
       def get_attribute(attribute_name)
-        @attributes[attribute_name]
+        @_her_attributes[attribute_name]
       end
       alias attribute get_attribute
 
       # Return the value of the model `primary_key` attribute
       def id
-        @attributes[self.class.primary_key]
+        @_her_attributes[self.class.primary_key]
       end
 
       # Return `true` if the other object is also a Her::Model and has matching
@@ -110,7 +117,7 @@ module Her
       #
       # @private
       def ==(other)
-        other.is_a?(Her::Model) && @attributes == other.attributes
+        other.is_a?(Her::Model) && @_her_attributes == other.attributes
       end
 
       # Delegate to the == method
@@ -120,27 +127,27 @@ module Her
         self == other
       end
 
-      # Delegate to @attributes, allowing models to act correctly in code like:
+      # Delegate to @_her_attributes, allowing models to act correctly in code like:
       #     [ Model.find(1), Model.find(1) ].uniq # => [ Model.find(1) ]
       # @private
       def hash
-        @attributes.hash
+        @_her_attributes.hash
       end
 
       # Assign attribute value (ActiveModel convention method).
       #
       # @private
       def attribute=(attribute, value)
-        @attributes[attribute] = nil unless @attributes.include?(attribute)
-        self.send(:"#{attribute}_will_change!") if @attributes[attribute] != value
-        @attributes[attribute] = value
+        @_her_attributes[attribute] = nil unless @_her_attributes.include?(attribute)
+        send("#{attribute}_will_change!") unless value == @_her_attributes[attribute]
+        @_her_attributes[attribute] = value
       end
 
       # Check attribute value to be present (ActiveModel convention method).
       #
       # @private
       def attribute?(attribute)
-        @attributes.include?(attribute) && @attributes[attribute].present?
+        @_her_attributes.include?(attribute) && @_her_attributes[attribute].present?
       end
 
       module ClassMethods
@@ -155,6 +162,7 @@ module Her
             attributes = klass.parse(record).merge(_metadata: parsed_data[:metadata],
                                                    _errors: parsed_data[:errors])
             klass.new(attributes).tap do |record|
+              record.instance_variable_set(:@changed_attributes, {})
               record.run_callbacks :find
             end
           end
@@ -164,10 +172,10 @@ module Her
         #
         # @private
         def instantiate_collection(klass, parsed_data = {})
-          items = klass.extract_array(parsed_data).map do |item|
-            instantiate_record(klass, data: item)
+          records = klass.extract_array(parsed_data).map do |record|
+            instantiate_record(klass, data: record)
           end
-          Her::Collection.new(items, parsed_data[:metadata], parsed_data[:errors])
+          Her::Collection.new(records, parsed_data[:metadata], parsed_data[:errors])
         end
 
         # Initialize a collection of resources with raw data from an HTTP request
@@ -196,9 +204,9 @@ module Her
 
           setter_method_names = model.class.setter_method_names
           params.each_with_object({}) do |(key, value), memo|
-            setter_method = key.to_s + '='
+            setter_method = "#{key}="
             if setter_method_names.include?(setter_method)
-              model.send(setter_method, value)
+              model.send setter_method, value
             else
               memo[key.to_sym] = value
             end

data/lib/her/model/introspection.rb

@@ -38,7 +38,7 @@ module Her
         #
         # @private
         def her_nearby_class(name)
-          her_sibling_class(name) || name.constantize rescue nil
+          her_sibling_class(name) || name.constantize
         end
 
         protected

data/lib/her/model/orm.rb

@@ -41,12 +41,8 @@ module Her
 
         run_callbacks :save do
           run_callbacks callback do
-            params = to_params
             self.class.request(to_params.merge(:_method => method, :_path => request_path)) do |parsed_data, response|
-              assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-              @metadata = parsed_data[:metadata]
-              @response_errors = parsed_data[:errors]
-
+              load_from_parsed_data(parsed_data)
               return false if !response.success? || @response_errors.any?
               if self.changed_attributes.present?
                 @previously_changed = self.changes.clone
@@ -77,53 +73,13 @@ module Her
         method = self.class.method_for(:destroy)
         run_callbacks :destroy do
           self.class.request(params.merge(:_method => method, :_path => request_path)) do |parsed_data, response|
-            assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-            @metadata = parsed_data[:metadata]
-            @response_errors = parsed_data[:errors]
+            load_from_parsed_data(parsed_data)
             @destroyed = response.success?
           end
         end
         self
       end
 
-      # Refetches the resource
-      #
-      # This method finds the resource by its primary key (which could be
-      # assigned manually) and modifies the object in-place.
-      #
-      # @example
-      #   user = User.find(1)
-      #   # => #<User(users/1) id=1 name="Tobias Fünke">
-      #   user.name = "Oops"
-      #   user.reload # Fetched again via GET "/users/1"
-      #   # => #<User(users/1) id=1 name="Tobias Fünke">
-      def reload(options = nil)
-        fresh_object = self.class.find(id)
-        assign_attributes(fresh_object.attributes)
-        self
-      end
-
-      # Assigns to +attribute+ the boolean opposite of <tt>attribute?</tt>. So
-      # if the predicate returns +true+ the attribute will become +false+. This
-      # method toggles directly the underlying value without calling any setter.
-      # Returns +self+.
-      #
-      # @example
-      #   user = User.first
-      #   user.admin? # => false
-      #   user.toggle(:admin)
-      #   user.admin? # => true
-      def toggle(attribute)
-        attributes[attribute] = !public_send("#{attribute}?")
-        self
-      end
-
-      # Wrapper around #toggle that saves the resource. Saving is subjected to
-      # validation checks. Returns +true+ if the record could be saved.
-      def toggle!(attribute)
-        toggle(attribute) && save
-      end
-
       # Initializes +attribute+ to zero if +nil+ and adds the value passed as
       # +by+ (default is 1). The increment is performed directly on the
       # underlying attribute, no setter is invoked. Only makes sense for
@@ -155,6 +111,54 @@ module Her
         increment!(attribute, -by)
       end
 
+      # Assigns to +attribute+ the boolean opposite of <tt>attribute?</tt>. So
+      # if the predicate returns +true+ the attribute will become +false+. This
+      # method toggles directly the underlying value without calling any setter.
+      # Returns +self+.
+      #
+      # @example
+      #   user = User.first
+      #   user.admin? # => false
+      #   user.toggle(:admin)
+      #   user.admin? # => true
+      def toggle(attribute)
+        attributes[attribute] = !public_send("#{attribute}?")
+        self
+      end
+
+      # Wrapper around #toggle that saves the resource. Saving is subjected to
+      # validation checks. Returns +true+ if the record could be saved.
+      def toggle!(attribute)
+        toggle(attribute) && save
+      end
+
+      # Refetches the resource
+      #
+      # This method finds the resource by its primary key (which could be
+      # assigned manually) and modifies the object in-place.
+      #
+      # @example
+      #   user = User.find(1)
+      #   # => #<User(users/1) id=1 name="Tobias Fünke">
+      #   user.name = "Oops"
+      #   user.reload # Fetched again via GET "/users/1"
+      #   # => #<User(users/1) id=1 name="Tobias Fünke">
+      def reload(options = nil)
+        fresh_object = self.class.find(id)
+        assign_attributes(fresh_object.attributes)
+        self
+      end
+
+      # Uses parsed response to assign attributes and metadata
+      #
+      # @private
+      def load_from_parsed_data(parsed_data)
+        data = parsed_data[:data]
+        assign_attributes(self.class.parse(data)) if data.any?
+        @metadata = parsed_data[:metadata]
+        @response_errors = parsed_data[:errors]
+      end
+
       module ClassMethods
         # Create a new chainable scope
         #
@@ -174,10 +178,8 @@ module Her
             instance_exec(*args, &code)
           end
 
-          # Add the scope method to the Relation class
-          Relation.instance_eval do
-            define_method(name) { |*args| instance_exec(*args, &code) }
-          end
+          # Add the scope method to the default/blank relation
+          scoped.define_singleton_method(name) { |*args| instance_exec(*args, &code) }
         end
 
         # @private
@@ -233,7 +235,9 @@ module Her
             data = parse(parsed_data[:data])
             metadata = parsed_data[:metadata]
             response_errors = parsed_data[:errors]
-            new(data.merge(:_destroyed => response.success?, :metadata => metadata, :response_errors => response_errors))
+            record = new(data.merge(:_destroyed => response.success?, :metadata => metadata))
+            record.response_errors = response_errors
+            record
           end
         end
 
@@ -269,9 +273,9 @@ module Her
           resource
         end
 
-        private
         # @private
         def blank_relation
+          @blank_relation ||= superclass.blank_relation.clone.tap { |r| r.parent = self } if superclass.respond_to?(:blank_relation)
           @blank_relation ||= Relation.new(self)
         end
       end

data/lib/her/model/parse.rb

@@ -32,8 +32,18 @@ module Her
 
         # @private
         def to_params(attributes, changes={})
-          filtered_attributes = attributes.dup.symbolize_keys
+          filtered_attributes = attributes.each_with_object({}) do |(key, value), memo|
+            case value
+            when Her::Model
+            when ActiveModel::Serialization
+              value = value.serializable_hash.symbolize_keys
+            end
+
+            memo[key.to_sym] = value
+          end
+
           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]
@@ -194,17 +204,20 @@ module Her
 
         # @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?)
+          return @_her_request_new_object_on_build unless @_her_request_new_object_on_build.nil?
+          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?)
+          return @_her_include_root_in_json unless @_her_include_root_in_json.nil?
+          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?)
+          return @_her_parse_root_in_json unless @_her_parse_root_in_json.nil?
+          superclass.respond_to?(:parse_root_in_json?) && superclass.parse_root_in_json?
         end
       end
     end

data/lib/her/model/relation.rb

@@ -3,6 +3,7 @@ module Her
     class Relation
       # @private
       attr_accessor :params
+      attr_writer :parent
 
       # @private
       def initialize(parent)
@@ -96,7 +97,6 @@ module Her
           @parent.request(request_params) do |parsed_data, response|
             if response.success?
               resource = @parent.new_from_parsed_data(parsed_data)
-              resource.instance_variable_set(:@changed_attributes, {})
               resource.run_callbacks :find
             else
               return nil