her 0.8.2 → 0.10.4

data/.travis.yml

@@ -3,7 +3,9 @@ language: ruby
 sudo: false
 
 rvm:
-  - 2.2.2
+  - 2.4.2
+  - 2.3.5
+  - 2.2.8
   - 2.1.6
   - 2.0.0
   - 1.9.3
@@ -14,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

@@ -1,8 +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">
@@ -15,6 +10,7 @@ If you need Rails 5 support, version 0.8.2 is for you!
   <a href="https://codeclimate.com/github/remiprev/her"><img src="http://img.shields.io/codeclimate/github/remiprev/her.svg" /></a>
   <a href='https://gemnasium.com/remiprev/her'><img src="http://img.shields.io/gemnasium/remiprev/her.svg" /></a>
   <a href="https://travis-ci.org/remiprev/her"><img src="http://img.shields.io/travis/remiprev/her/master.svg" /></a>
+  <a href="https://gitter.im/her-orm/Lobby"><img src="https://badges.gitter.im/her-orm/Lobby.png" alt="Gitter chat" title="" data-pin-nopin="true"></a>
 </p>
 
 ---
@@ -173,6 +169,24 @@ end
 
 Now, each HTTP request made by Her will have the `X-API-Token` header.
 
+### Basic Http Authentication
+Her can use basic http auth by adding a line to your initializer
+
+```ruby
+# config/initializers/her.rb
+Her::API.setup url: "https://api.example.com" do |c|
+  # Request
+  c.use Faraday::Request::BasicAuthentication, 'myusername', 'mypassword'
+  c.use Faraday::Request::UrlEncoded
+
+  # Response
+  c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
+  c.use Faraday::Adapter::NetHttp
+end
+```
+
 ### OAuth
 
 Using the `faraday_middleware` and `simple_oauth` gems, it’s fairly easy to use OAuth authentication with Her.
@@ -214,7 +228,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
 
@@ -228,7 +242,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:
 
@@ -397,8 +411,8 @@ You can use the association methods to build new objects and save them.
 @user.comments.build(body: "Just a draft")
 # => [#<Comment body="Just a draft" user_id=1>]
 
-@user.comments.create(body: "Hello world.")
-# POST "/users/1/comments" with `body=Hello+world.`
+@user.comments.create(body: "Hello world.", user_id: 1)
+# POST "/comments" with `body=Hello+world.&user_id=1`
 # => [#<Comment id=3 body="Hello world." user_id=1>]
 ```
 
@@ -432,7 +446,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 `{ … }`.
@@ -593,7 +607,7 @@ users = Users.all
 #### JSON API support
 
 To consume a JSON API 1.0 compliant service, it must return data in accordance with the [JSON API spec](http://jsonapi.org/). The general format
-of the data is as follows: 
+of the data is as follows:
 
 ```json
 { "data": {
@@ -976,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)
@@ -987,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

@@ -18,13 +18,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rspec", "~> 2.13"
-  s.add_development_dependency "rspec-its", "~> 1.0"
-  s.add_development_dependency "fivemat", "~> 1.2"
+  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/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/middleware/json_api_parser.rb

@@ -25,7 +25,7 @@ module Her
       # @private
       def on_complete(env)
         env[:body] = case env[:status]
-        when 204
+        when 204, 304
           parse('{}')
         else
           parse(env[:body])

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
@@ -49,6 +45,7 @@ module Her
 
           return @cached_result unless @params.any? || @cached_result.nil?
           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]}" }
           @klass.get(path, @params).tap do |result|
@@ -65,6 +62,13 @@ module Her
           end
         end
 
+        # @private
+        def reset
+          @params = {}
+          @cached_result = nil
+          @parent.attributes.delete(@name)
+        end
+
         # Add query parameters to the HTTP request performed to fetch the data
         #
         # @example
@@ -97,6 +101,29 @@ module Her
           @klass.get_resource(path, @params)
         end
 
+        # Refetches the association and puts the proxy back in its initial state,
+        # which is unloaded. Cached associations are cleared.
+        #
+        # @example
+        #   class User
+        #     include Her::Model
+        #     has_many :comments
+        #   end
+        #
+        #   class Comment
+        #     include Her::Model
+        #   end
+        #
+        #   user = User.find(1)
+        #   user.comments = [#<Comment(comments/2) id=2 body="Hello!">]
+        #   user.comments.first.id = "Oops"
+        #   user.comments.reload # => [#<Comment(comments/2) id=2 body="Hello!">]
+        #   # Fetched again via GET "/users/1/comments"
+        def reload
+          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
+          :build, :create, :where, :find, :all, :assign_nested_attributes, :reload
 
         # @private
         def initialize(association)

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

@@ -80,7 +80,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/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
@@ -85,14 +85,14 @@ 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
 
         # @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,53 +31,15 @@ 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
       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(/[?=]$/, '')
 
@@ -87,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 =~ /[?=]$/ || @_her_attributes.include?(method) || super
       end
 
       # Assign new attributes to a resource
@@ -101,47 +69,55 @@ 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 = 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)
+        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 data
+      # Return `true` if the other object is also a Her::Model and has matching
+      # data
       #
       # @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
@@ -151,47 +127,94 @@ 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
+
+        # 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.instance_variable_set(:@changed_attributes, {})
+              record.run_callbacks :find
+            end
+          end
+        end
+
+        # Initialize a collection of resources
+        #
+        # @private
+        def instantiate_collection(klass, parsed_data = {})
+          records = klass.extract_array(parsed_data).map do |record|
+            instantiate_record(klass, data: record)
+          end
+          Her::Collection.new(records, 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}="
+            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
@@ -199,18 +222,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
@@ -224,7 +251,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
         #
@@ -237,7 +265,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
         #
@@ -252,9 +281,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/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