restful_resource 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eecf67a6ba417dae5f868966a577a527eaf35560ddf9ec17af5aa7070e9935bb
-  data.tar.gz: 4ddd23ce149cd8f4f9db30af2cdef923654771608108ed44ff8891199bb1643c
+  metadata.gz: 1f5f98400c48167cdb639a07e34ec5556d6d3ee4120686e1c97b1a21f46c1288
+  data.tar.gz: bf34cb96327e7420f7efd0c08bac8ffee01efea9ae104eef4bb24c03da0265a9
 SHA512:
-  metadata.gz: 6893e6298085c0e14e28f5d08ca7ab9144eafea210d18eabeb865df3dfa9b670af1a9f0052db5a0c2ad84ed6f6b9061cb0e101b7724514385e9b14509ab138e4
-  data.tar.gz: 0f2c0c895a4ae9a77d17b6816a15cbd0cd17f0bdbb6e46417aebfd471f1c2e33e0f3c8c997016e7bb2213d25058c6b9525106bd870145a5e8efee0da15325d9a
+  metadata.gz: '04010962bd8ad44f0ed445641997bf8604fad6b0b694f181040e552856730cbdf26b4e30b3cd62bd90b4e4ec152dd1811d67fad63b8efe4bfb5c6687e27e0b55'
+  data.tar.gz: cc0f65d304132e7eb25d601e19e491c12e584ef896681862ca4a3bda1e97e2500efb80afa5e783ab55a09d468ce87baeec1880280dd1ece333a61efc7503df8b

data/.circleci/config.yml

@@ -0,0 +1,20 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.4.4
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - run:
+          name: Run rspec in parallel
+          command: |
+            bundle exec rspec --profile 10 \
+                              --format RspecJunitFormatter \
+                              --out test_results/rspec.xml \
+                              --format progress \
+                              $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+      - store_test_results:
+          path: test_results

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+plugins:
+  fixme:
+    enabled: true

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  carwow_rubocop:
+    - default.yml
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,203 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-09-11 09:24:50 +0000 using RuboCop version 0.59.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
+# Cop supports --auto-correct.
+Layout/RescueEnsureAlignment:
+  Exclude:
+    - 'lib/restful_resource/associations.rb'
+
+# Offense count: 10
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/restful_resource/base.rb'
+
+# Offense count: 1
+Lint/Loop:
+  Exclude:
+    - 'lib/restful_resource/base.rb'
+
+# Offense count: 2
+Lint/ParenthesesAsGroupedExpression:
+  Exclude:
+    - 'spec/restful_resource/base_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/restful_resource/redirections.rb'
+
+# Offense count: 3
+# Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/restful_resource/base.rb'
+    - 'lib/restful_resource/redirections.rb'
+
+# Offense count: 5
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/restful_resource/rails_validations.rb'
+    - 'lib/restful_resource/redirections.rb'
+    - 'spec/restful_resource/base_spec.rb'
+    - 'spec/restful_resource/redirections_spec.rb'
+
+# Offense count: 8
+Metrics/AbcSize:
+  Max: 101
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 27
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 162
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 42
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 201
+
+# Offense count: 10
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 56
+
+# Offense count: 8
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 2
+# 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/restful_resource/associations.rb'
+
+# Offense count: 14
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/restful_resource/http_client_configuration_spec.rb'
+    - 'spec/restful_resource/rails_validations_spec.rb'
+    - 'spec/restful_resource/request_spec.rb'
+
+# Offense count: 1
+RSpec/DescribeMethod:
+  Exclude:
+    - 'spec/restful_resource/base_authorization_spec.rb'
+
+# Offense count: 19
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/restful_resource/base_spec.rb'
+    - 'spec/restful_resource/http_client_configuration_spec.rb'
+    - 'spec/restful_resource/http_client_spec.rb'
+    - 'spec/restful_resource/open_object_spec.rb'
+    - 'spec/restful_resource/rails_validations_spec.rb'
+    - 'spec/restful_resource/redirections_spec.rb'
+
+# Offense count: 53
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/restful_resource/associations_spec.rb'
+    - 'spec/restful_resource/base_spec.rb'
+    - 'spec/restful_resource/http_client_configuration_spec.rb'
+    - 'spec/restful_resource/rails_validations_spec.rb'
+    - 'spec/restful_resource/redirections_spec.rb'
+
+# Offense count: 14
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  Exclude:
+    - 'spec/restful_resource/base_spec.rb'
+    - 'spec/restful_resource/redirections_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 22
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 7
+
+# Offense count: 6
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/restful_resource/redirections_spec.rb'
+
+# Offense count: 10
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 2
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/restful_resource/base_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/restful_resource/base_spec.rb'
+    - 'spec/restful_resource/rails_validations_spec.rb'
+    - 'spec/restful_resource/redirections_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedChars.
+Style/AsciiComments:
+  Exclude:
+    - 'lib/restful_resource/instrumentation.rb'
+
+# Offense count: 1
+Style/MethodMissingSuper:
+  Exclude:
+    - 'lib/restful_resource/open_object.rb'
+
+# Offense count: 1
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/restful_resource/open_object.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/restful_resource/base.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
+# Whitelist: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym
+Style/TrivialAccessors:
+  Exclude:
+    - 'lib/restful_resource/base.rb'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+v2.4.0
+---
+
+- Add `faraday_options` to `Base.configure`
+
 v2.1.0
 ---
 

data/README.md

@@ -1,4 +1,4 @@
-# RestfulResource ![build status](https://circleci.com/gh/carwow/restful_resource.svg?style=shield&circle-token=0558310359000e8786d1fe42774b0e30b2b0e12c)
+# RestfulResource ![build status](https://circleci.com/gh/carwow/restful_resource.svg?style=shield&circle-token=0558310359000e8786d1fe42774b0e30b2b0e12c) [![Maintainability](https://api.codeclimate.com/v1/badges/61c85db718d559aa97c5/maintainability)](https://codeclimate.com/github/carwow/restful_resource/maintainability)
 
 Provides an ActiveResource like interface to JSON API's
 

data/Rakefile

@@ -9,12 +9,12 @@ desc "Upload to rubygems"
 task :upload => :build do
   # Check if tag with v#{ResearchSiteApiClient::VERSION} version exists, if so, return with error
 
-  # if tag_exists?(current_tag_name)
-  #   puts "Tag exists, did you run rake increase_revision_number after merging with master?"
-  #   exit 1
-  # end
+  if tag_exists?(current_tag_name)
+    puts "Tag exists, did you run rake increase_revision_number after merging with master?"
+    exit 1
+  end
 
-  # create_tag(current_tag_name)
+  create_tag(current_tag_name)
   Rake::Task[:release].invoke
 end
 

data/lib/restful_resource/associations.rb

@@ -1,37 +1,39 @@
 module RestfulResource
   module Associations
     def has_many(nested_resource_type)
-      namespace = self.to_s.deconstantize
-      klass_name = "#{nested_resource_type.to_s.singularize.camelize.to_s}"
+      namespace = to_s.deconstantize
+      klass_name = nested_resource_type.to_s.singularize.camelize.to_s
       klass_name = "#{namespace}::#{klass_name}" if namespace.present?
 
-      self.send(:define_method, nested_resource_type) do
+      send(:define_method, nested_resource_type) do
         klass = begin
           klass_name.safe_constantize
         rescue NameError
           nil
         end
-        klass = RestfulResource::OpenObject if (klass.nil? || !(klass < RestfulResource::OpenObject))
+        klass = RestfulResource::OpenObject if klass.nil? || !(klass < RestfulResource::OpenObject)
         nested_resource = @inner_object.send(nested_resource_type)
         return nil if nested_resource.nil?
+
         nested_resource.map { |obj| klass.new(obj) }
       end
     end
 
     def has_one(nested_resource_type)
-      namespace = self.to_s.deconstantize
-      klass_name = "#{nested_resource_type.to_s.camelize.to_s}"
+      namespace = to_s.deconstantize
+      klass_name = nested_resource_type.to_s.camelize.to_s
       klass_name = "#{namespace}::#{klass_name}" if namespace.present?
 
-      self.send(:define_method, nested_resource_type) do
+      send(:define_method, nested_resource_type) do
         klass = begin
           klass_name.safe_constantize
         rescue NameError
           nil
         end
-        klass = RestfulResource::OpenObject if (klass.nil? || !(klass < RestfulResource::OpenObject))
+        klass = RestfulResource::OpenObject if klass.nil? || !(klass < RestfulResource::OpenObject)
         nested_resource = @inner_object.send(nested_resource_type)
         return nil if nested_resource.nil?
+
         klass.new(@inner_object.send(nested_resource_type))
       end
     end

data/lib/restful_resource/base.rb

@@ -3,13 +3,14 @@ module RestfulResource
     extend RestfulResource::Associations
 
     def self.configure(base_url: nil,
-                       username: nil,
-                       password: nil,
-                       auth_token: nil,
-                       logger: nil,
-                       cache_store: nil,
-                       instrumentation: {},
-                       faraday_config: nil)
+      username: nil,
+      password: nil,
+      auth_token: nil,
+      logger: nil,
+      cache_store: nil,
+      instrumentation: {},
+      faraday_config: nil,
+      faraday_options: nil)
 
       @base_url = URI.parse(base_url)
 
@@ -19,33 +20,35 @@ module RestfulResource
                                               logger: logger,
                                               cache_store: cache_store,
                                               instrumentation: instrumentation,
-                                              faraday_config: faraday_config)
+                                              faraday_config: faraday_config,
+                                              faraday_options: faraday_options
+                                             )
     end
 
     def self.resource_path(url)
       @resource_path = url
     end
 
-    def self.find(id, params={})
+    def self.find(id, params = {})
       params_without_options, options = format_params(params)
 
       response = http.get(member_url(id, params_without_options), **options)
-      self.new(parse_json(response.body))
+      new(parse_json(response.body))
     end
 
-    def self.where(params={})
+    def self.where(params = {})
       params_without_options, options = format_params(params)
 
       url = collection_url(params_without_options)
       response = http.get(url, **options)
-      self.paginate_response(response)
+      paginate_response(response)
     end
 
     def self.get(params = {})
       params_without_options, options = format_params(params)
 
       response = http.get(collection_url(params_without_options), **options)
-      self.new(parse_json(response.body))
+      new(parse_json(response.body))
     end
 
     def self.delete(id, **params)
@@ -61,7 +64,7 @@ module RestfulResource
       url = member_url(id, params_without_options)
 
       response = http.put(url, data: data, headers: headers, **options)
-      self.new(parse_json(response.body))
+      new(parse_json(response.body))
     end
 
     def self.post(data: {}, headers: {}, **params)
@@ -72,11 +75,11 @@ module RestfulResource
 
       response = http.post(url, data: data, headers: headers, **options)
 
-      self.new(parse_json(response.body))
+      new(parse_json(response.body))
     end
 
     def self.all(params = {})
-      self.where(params)
+      where(params)
     end
 
     def self.action(action_name)
@@ -89,30 +92,30 @@ module RestfulResource
       @action_prefix = action_prefix.to_s
     end
 
-    def self.fetch_all!(conditions={})
+    def self.fetch_all!(conditions = {})
       Enumerator.new do |y|
         next_page = 1
         begin
-          resources = self.where(conditions.merge(page: next_page))
+          resources = where(conditions.merge(page: next_page))
           resources.each do |resource|
             y << resource
           end
           next_page = resources.next_page
-        end while(!next_page.nil?)
+        end while !next_page.nil?
       end
     end
 
     protected
+
     def self.http
       @http || superclass.http
     end
 
     def self.base_url
       result = @base_url
-      if result.nil? && superclass.respond_to?(:base_url)
-        result = superclass.base_url
-      end
-      raise "Base url missing" if result.nil?
+      result = superclass.base_url if result.nil? && superclass.respond_to?(:base_url)
+      raise 'Base url missing' if result.nil?
+
       result
     end
 
@@ -126,7 +129,7 @@ module RestfulResource
     def self.format_params(params = {})
       headers = params.delete(:headers) || {}
 
-      headers.merge!(cache_control: 'no-cache') if params.delete(:no_cache)
+      headers[:cache_control] = 'no-cache' if params.delete(:no_cache)
       open_timeout = params.delete(:open_timeout)
       timeout = params.delete(:timeout)
 
@@ -139,18 +142,20 @@ module RestfulResource
 
     def self.member_url(id, params)
       raise ResourceIdMissingError if id.blank?
+
       url = merge_url_paths(base_url, @resource_path, CGI.escape(id.to_s), @action_prefix)
       replace_parameters(url, params)
     end
 
     def self.new_collection(json)
       json.map do |element|
-        self.new(element)
+        new(element)
       end
     end
 
     def self.parse_json(json)
       return nil if json.strip.empty?
+
       ActiveSupport::JSON.decode(json)
     end
 
@@ -164,15 +169,13 @@ module RestfulResource
         if value.nil?
           missing_params << key
         else
-          url = url.gsub(':'+key, CGI.escape(value.to_s))
+          url = url.gsub(':' + key, CGI.escape(value.to_s))
         end
       end
 
-      if missing_params.any?
-        raise ParameterMissingError.new(missing_params)
-      end
+      raise ParameterMissingError, missing_params if missing_params.any?
 
-      url = url + "?#{params.to_query}" unless params.empty?
+      url += "?#{params.to_query}" unless params.empty?
       url
     end
 
@@ -180,10 +183,10 @@ module RestfulResource
       links_header =  response.headers[:links]
       links = LinkHeader.parse(links_header)
 
-      prev_url = links.find_link(['rel', 'prev']).try(:href)
-      next_url = links.find_link(['rel', 'next']).try(:href)
+      prev_url = links.find_link(%w[rel prev]).try(:href)
+      next_url = links.find_link(%w[rel next]).try(:href)
 
-      array = parse_json(response.body).map { |attributes| self.new(attributes) }
+      array = parse_json(response.body).map { |attributes| new(attributes) }
       PaginatedArray.new(array, previous_page_url: prev_url, next_page_url: next_url, total_count: response.headers[:x_total_count])
     end
   end