her 1.0.1 → 1.0.2

data/.rubocop_todo.yml

@@ -0,0 +1,232 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-05-16 14:33:11 -0300 using RuboCop version 0.54.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: Include.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 1
+Lint/EmptyWhen:
+  Exclude:
+    - 'lib/her/model/parse.rb'
+
+# Offense count: 1
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/her/api.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/her/api.rb'
+    - 'lib/her/model/associations/association.rb'
+    - 'lib/her/model/attributes.rb'
+    - 'lib/her/model/orm.rb'
+    - 'spec/model/attributes_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/her/api.rb'
+
+# Offense count: 10
+Metrics/AbcSize:
+  Max: 38
+
+# Offense count: 91
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 694
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+# Offense count: 10
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 28
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 106
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 4
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/her/model/associations.rb'
+    - 'lib/her/model/attributes.rb'
+    - 'lib/her/model/relation.rb'
+
+# Offense count: 7
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/her/model/associations.rb'
+    - 'lib/her/model/attributes.rb'
+    - 'lib/her/model/base.rb'
+    - 'lib/her/model/deprecated_methods.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/RegexpMatch:
+  Exclude:
+    - 'spec/support/macros/model_macros.rb'
+
+# Offense count: 23
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 21
+# Cop supports --auto-correct.
+Style/Encoding:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'her.gemspec'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 59
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: when_needed, always, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 89
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 6
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/her/json_api/model.rb'
+    - 'lib/her/model/associations/association_proxy.rb'
+    - 'lib/her/model/nested_attributes.rb'
+    - 'lib/her/model/orm.rb'
+    - 'lib/her/model/parse.rb'
+
+# Offense count: 2
+Style/MethodMissing:
+  Exclude:
+    - 'lib/her/model/associations/association_proxy.rb'
+    - 'lib/her/model/relation.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/her/model/http.rb'
+    - 'lib/her/version.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'lib/her/model/paths.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/her/model/paths.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, Whitelist.
+# Whitelist: present?, blank?, presence, try
+Style/SafeNavigation:
+  Exclude:
+    - 'spec/model/orm_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'her.gemspec'
+
+# Offense count: 1613
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiteralsInInterpolation:
+  Exclude:
+    - 'lib/her/model/introspection.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoredMethods.
+# IgnoredMethods: respond_to, define_method
+Style/SymbolProc:
+  Exclude:
+    - 'lib/her/model/parse.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
+# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
+Style/TernaryParentheses:
+  Exclude:
+    - 'lib/her/model/http.rb'
+    - 'lib/her/model/orm.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'lib/her/middleware/json_api_parser.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  Exclude:
+    - 'spec/model/orm_spec.rb'
+
+# Offense count: 409
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 377

data/README.md

@@ -452,6 +452,22 @@ Her expects all `User` resources to have an `:organization_id` (or `:_organizati
 Her::Errors::PathError: Missing :_organization_id parameter to build the request path. Path is `organizations/:organization_id/users`. Parameters are `{ … }`.
 ```
 
+#### Associations with custom attributes
+
+Associations can also be made using custom attributes:
+
+```ruby
+class User
+  include Her::Model
+  belongs_to :owns, class_name: "Organization"
+end
+
+class Organization
+  include Her::Model
+  has_many :owners, class_name: "User"
+end
+```
+
 ### Validations
 
 Her includes `ActiveModel::Validations` so you can declare validations the same way you do in Rails.

data/her.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 $:.push File.expand_path("../lib", __FILE__)
 require "her/version"
 
@@ -14,12 +15,12 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "json", "~> 1.8"
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 3.5"
-  s.add_development_dependency "json", "~> 1.8"
 
   s.add_runtime_dependency "activemodel", ">= 4.2.1"
   s.add_runtime_dependency "faraday", ">= 0.8", "< 1.0"

data/lib/her/api.rb

@@ -2,6 +2,7 @@ module Her
   # This class is where all HTTP requests are made. Before using Her, you must configure it
   # so it knows where to make those requests. In Rails, this is usually done in `config/initializers/her.rb`:
   class API
+
     # @private
     attr_reader :connection, :options
 
@@ -9,7 +10,7 @@ module Her
     FARADAY_OPTIONS = [:request, :proxy, :ssl, :builder, :url, :parallel_manager, :params, :headers, :builder_class].freeze
 
     # Setup a default API connection. Accepted arguments and options are the same as {API#setup}.
-    def self.setup(opts={}, &block)
+    def self.setup(opts = {}, &block)
       @default_api = new(opts, &block)
     end
 
@@ -68,11 +69,11 @@ module Her
     #     connection.use MyCustomParser
     #     connection.use Faraday::Adapter::NetHttp
     #   end
-    def setup(opts={}, &blk)
+    def setup(opts = {}, &blk)
       opts[:url] = opts.delete(:base_uri) if opts.include?(:base_uri) # Support legacy :base_uri option
       @options = opts
 
-      faraday_options = @options.reject { |key, value| !FARADAY_OPTIONS.include?(key.to_sym) }
+      faraday_options = @options.select { |key, _| FARADAY_OPTIONS.include?(key.to_sym) }
       @connection = Faraday.new(faraday_options) do |connection|
         yield connection if block_given?
       end
@@ -84,11 +85,11 @@ module Her
     # and a metadata Hash.
     #
     # @private
-    def request(opts={})
+    def request(opts = {})
       method = opts.delete(:_method)
       path = opts.delete(:_path)
       headers = opts.delete(:_headers)
-      opts.delete_if { |key, value| key.to_s =~ /^_/ } # Remove all internal parameters
+      opts.delete_if { |key, _| key.to_s =~ /^_/ } # Remove all internal parameters
       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.
@@ -108,12 +109,12 @@ module Her
         end
       end
       { :parsed_data => response.env[:body], :response => response }
-
     end
 
     private
+
     # @private
-    def self.default_api(opts={})
+    def self.default_api(opts = {})
       defined?(@default_api) ? @default_api : nil
     end
   end

data/lib/her/collection.rb

@@ -1,9 +1,10 @@
 module Her
   class Collection < ::Array
+
     attr_reader :metadata, :errors
 
     # @private
-    def initialize(items=[], metadata={}, errors={})
+    def initialize(items = [], metadata = {}, errors = {})
       super(items)
       @metadata = metadata
       @errors = errors

data/lib/her/errors.rb

@@ -1,9 +1,10 @@
 module Her
   module Errors
     class PathError < StandardError
+
       attr_reader :missing_parameter
 
-      def initialize(message, missing_parameter=nil)
+      def initialize(message, missing_parameter = nil)
         super(message)
         @missing_parameter = missing_parameter
       end
@@ -16,6 +17,7 @@ module Her
     end
 
     class ResourceInvalid < StandardError
+
       attr_reader :resource
       def initialize(resource)
         @resource = resource

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