restful_resource 2.3.0 → 2.4.0

data/lib/restful_resource/http_client.rb

@@ -1,5 +1,5 @@
 # Use the Faraday-Typhoeus adapter provided by Typhoeus, not Faraday
-require "typhoeus/adapters/faraday"
+require 'typhoeus/adapters/faraday'
 
 module RestfulResource
   class HttpClient
@@ -7,15 +7,16 @@ module RestfulResource
       attr_reader :request, :response
 
       def initialize(request, response = nil)
-        @request, @response = request, assign_response(response)
+        @request = request
+        @response = assign_response(response)
       end
 
       def assign_response(response = nil)
-        if response
-          @response = Response.new(body: response[:body], headers: response[:headers], status: response[:status])
-        else
-          @response = Response.new
-        end
+        @response = if response
+                      Response.new(body: response[:body], headers: response[:headers], status: response[:status])
+                    else
+                      Response.new
+                    end
       end
     end
 
@@ -24,7 +25,7 @@ module RestfulResource
 
     class ResourceNotFound < HttpError
       def message
-        "HTTP 404: Resource Not Found"
+        'HTTP 404: Resource Not Found'
       end
     end
 
@@ -40,44 +41,45 @@ module RestfulResource
 
     class BadGateway < RetryableError
       def message
-        "HTTP 502: Bad gateway"
+        'HTTP 502: Bad gateway'
       end
     end
 
     class ServiceUnavailable < RetryableError
       def message
-        "HTTP 503: Service unavailable"
+        'HTTP 503: Service unavailable'
       end
     end
 
     class Timeout < RetryableError
       def message
-        "Timeout: Service not responding"
+        'Timeout: Service not responding'
       end
     end
 
     class TooManyRequests < RetryableError
       def message
-        "HTTP 429: Too Many Requests"
+        'HTTP 429: Too Many Requests'
       end
     end
 
     class ClientError < RetryableError
       def message
-        "There was some client error"
+        'There was some client error'
       end
     end
 
     def initialize(username: nil,
-                   password: nil,
-                   auth_token: nil,
-                   logger: nil,
-                   cache_store: nil,
-                   connection: nil,
-                   instrumentation: {},
-                   open_timeout: 2,
-                   timeout: 10,
-                   faraday_config: nil)
+      password: nil,
+      auth_token: nil,
+      logger: nil,
+      cache_store: nil,
+      connection: nil,
+      instrumentation: {},
+      open_timeout: 2,
+      timeout: 10,
+      faraday_config: nil,
+      faraday_options: nil)
       api_name = instrumentation[:api_name]            ||= 'api'
       instrumentation[:request_instrument_name]        ||= "http.#{api_name}"
       instrumentation[:cache_instrument_name]          ||= "http_cache.#{api_name}"
@@ -85,11 +87,13 @@ module RestfulResource
 
       if instrumentation[:metric_class]
         @metrics = Instrumentation.new(instrumentation.slice(:app_name,
-                                                             :api_name,
-                                                             :request_instrument_name,
-                                                             :cache_instrument_name,
-                                                             :server_cache_instrument_name,
-                                                             :metric_class))
+          :api_name,
+          :request_instrument_name,
+          :cache_instrument_name,
+          :server_cache_instrument_name,
+          :metric_class
+        )
+                                      )
         @metrics.subscribe_to_notifications
       end
 
@@ -100,7 +104,9 @@ module RestfulResource
                                                         request_instrument_name: instrumentation.fetch(:request_instrument_name, nil),
                                                         cache_instrument_name: instrumentation.fetch(:cache_instrument_name, nil),
                                                         server_cache_instrument_name: instrumentation.fetch(:server_cache_instrument_name, nil),
-                                                        faraday_config: faraday_config)
+                                                        faraday_config: faraday_config,
+                                                        faraday_options: faraday_options
+                                                       )
 
       if auth_token
         @connection.headers[:authorization] = "Bearer #{auth_token}"
@@ -168,20 +174,19 @@ module RestfulResource
     attr_reader :default_open_timeout, :default_timeout
 
     def initialize_connection(logger: nil,
-                              cache_store: nil,
-                              instrumenter: nil,
-                              request_instrument_name: nil,
-                              cache_instrument_name: nil,
-                              server_cache_instrument_name: nil,
-                              faraday_config: nil)
-
-      @connection = Faraday.new do |b|
+      cache_store: nil,
+      instrumenter: nil,
+      request_instrument_name: nil,
+      cache_instrument_name: nil,
+      server_cache_instrument_name: nil,
+      faraday_config: nil,
+      faraday_options: nil)
+
+      @connection = Faraday.new(nil, faraday_options) do |b|
         b.request :json
         b.response :raise_error
 
-        if logger
-          b.response :logger, logger
-        end
+        b.response :logger, logger if logger
 
         if server_cache_instrument_name
           b.use :cdn_metrics, instrumenter: instrumenter,
@@ -195,13 +200,9 @@ module RestfulResource
                              instrument_name: cache_instrument_name
         end
 
-        if instrumenter && request_instrument_name
-          b.use :instrumentation, name: request_instrument_name
-        end
+        b.use :instrumentation, name: request_instrument_name if instrumenter && request_instrument_name
 
-        if faraday_config
-          faraday_config.call(b)
-        end
+        faraday_config&.call(b)
 
         b.response :encoding
         b.use :gzip
@@ -211,7 +212,7 @@ module RestfulResource
     end
 
     def build_user_agent(app_name)
-      parts = ["carwow/internal"]
+      parts = ['carwow/internal']
       parts << "RestfulResource/#{VERSION}"
       parts << "(#{app_name})" if app_name
       parts << "Faraday/#{Faraday::VERSION}"
@@ -232,10 +233,11 @@ module RestfulResource
     rescue Faraday::ConnectionFailed
       raise
     rescue Faraday::TimeoutError
-      raise HttpClient::Timeout.new(request)
+      raise HttpClient::Timeout, request
     rescue Faraday::ClientError => e
       response = e.response
-      raise ClientError.new(request) unless response
+      raise ClientError, request unless response
+
       case response[:status]
       when 404 then raise HttpClient::ResourceNotFound.new(request, response)
       when 409 then raise HttpClient::Conflict.new(request, response)

data/lib/restful_resource/instrumentation.rb

@@ -2,7 +2,6 @@ require 'active_support/notifications'
 
 module RestfulResource
   class Instrumentation
-
     def initialize(app_name:, api_name:, request_instrument_name:, cache_instrument_name:, server_cache_instrument_name:, metric_class:)
       @app_name = app_name
       @api_name = api_name
@@ -50,18 +49,18 @@ module RestfulResource
         # count#quotes_site.research_site_api.cache_hit=1
         # count#quotes_site.research_site_api.api_v2_cap_derivatives.cache_hit=1
         case cache_status
-          when :fresh, :valid
-            metric_class.count cache_notifier_namespace(metric: 'cache_hit'), 1
-            metric_class.count cache_notifier_namespace(metric: 'cache_hit', event: event), 1
-          when :invalid, :miss
-            metric_class.count cache_notifier_namespace(metric: 'cache_miss'), 1
-            metric_class.count cache_notifier_namespace(metric: 'cache_miss', event: event), 1
-          when :unacceptable
-            metric_class.count cache_notifier_namespace(metric: 'cache_not_cacheable'), 1
-            metric_class.count cache_notifier_namespace(metric: 'cache_not_cacheable', event: event), 1
-          when :bypass
-            metric_class.count cache_notifier_namespace(metric: 'cache_bypass'), 1
-            metric_class.count cache_notifier_namespace(metric: 'cache_bypass', event: event), 1
+        when :fresh, :valid
+          metric_class.count cache_notifier_namespace(metric: 'cache_hit'), 1
+          metric_class.count cache_notifier_namespace(metric: 'cache_hit', event: event), 1
+        when :invalid, :miss
+          metric_class.count cache_notifier_namespace(metric: 'cache_miss'), 1
+          metric_class.count cache_notifier_namespace(metric: 'cache_miss', event: event), 1
+        when :unacceptable
+          metric_class.count cache_notifier_namespace(metric: 'cache_not_cacheable'), 1
+          metric_class.count cache_notifier_namespace(metric: 'cache_not_cacheable', event: event), 1
+        when :bypass
+          metric_class.count cache_notifier_namespace(metric: 'cache_bypass'), 1
+          metric_class.count cache_notifier_namespace(metric: 'cache_bypass', event: event), 1
         end
       end
 
@@ -71,7 +70,7 @@ module RestfulResource
         client_cache_status = event.payload.fetch(:client_cache_status, nil)
         server_cache_status = event.payload.fetch(:server_cache_status, nil)
 
-        if client_cache_status.nil? || !client_cache_status.in?([:fresh, :valid])
+        if client_cache_status.nil? || !client_cache_status.in?(%i[fresh valid])
           # Outputs log lines like:
           # count#quotes_site.research_site_api.server_cache_hit=1
           # count#quotes_site.research_site_api.api_v2_cap_derivatives.server_cache_hit=1
@@ -100,19 +99,17 @@ module RestfulResource
     end
 
     def validate_metric_class!
-      metric_methods = %i(count sample measure)
-      if metric_methods.any? {|m| !metric_class.respond_to?(m) }
-        raise ArgumentError.new "Metric class '#{metric_class}' does not respond to #{metric_methods.join ','}"
-      end
+      metric_methods = %i[count sample measure]
+      raise ArgumentError, "Metric class '#{metric_class}' does not respond to #{metric_methods.join ','}" if metric_methods.any? { |m| !metric_class.respond_to?(m) }
     end
 
     def cache_notifier_namespace(metric:, event: nil)
       [app_name, api_name, base_request_path(event), metric].compact.join('.')
     end
 
-    # Converts a path like "/api/v2/cap_derivatives/75423/with_colours" to "api_v2_cap_derivatives_with_colours"
+    #  Converts a path like "/api/v2/cap_derivatives/75423/with_colours" to "api_v2_cap_derivatives_with_colours"
     def base_request_path(event)
-      path_from_event(event).split('/').drop(1).select {|a| a.match(/\d+/).nil? }.join('_') if event
+      path_from_event(event).split('/').drop(1).select { |a| a.match(/\d+/).nil? }.join('_') if event
     end
 
     def path_from_event(event)

data/lib/restful_resource/null_logger.rb

@@ -1,6 +1,5 @@
 module RestfulResource
   class NullLogger
-    def <<(*args)
-    end
+    def <<(*args); end
   end
 end

data/lib/restful_resource/open_object.rb

@@ -1,6 +1,6 @@
 module RestfulResource
   class OpenObject
-    def initialize(attributes = {}, hack_for_activeresource = false)
+    def initialize(attributes = {}, _hack_for_activeresource = false)
       @inner_object = OpenStruct.new(attributes)
     end
 
@@ -16,7 +16,7 @@ module RestfulResource
       super || @inner_object.respond_to?(method, include_private)
     end
 
-    def as_json(options=nil)
+    def as_json(options = nil)
       @inner_object.send(:table).as_json(options)
     end
 

data/lib/restful_resource/paginated_array.rb

@@ -1,6 +1,6 @@
 module RestfulResource
   class PaginatedArray < Array
-    def initialize(original_array, previous_page_url:, next_page_url:, total_count: )
+    def initialize(original_array, previous_page_url:, next_page_url:, total_count:)
       super(original_array)
 
       @previous_page_url = previous_page_url
@@ -21,8 +21,10 @@ module RestfulResource
     end
 
     private
+
     def get_page_from_url(url)
       return nil unless url
+
       params = Rack::Utils.parse_query URI(url).query
       params['page'].to_i
     end

data/lib/restful_resource/rails_validations.rb

@@ -6,13 +6,13 @@ module RestfulResource
       rescue HttpClient::UnprocessableEntity => e
         errors = parse_json(e.response.body)
         result = nil
-        if errors.is_a?(Hash) && errors.has_key?('errors')
-          result = data.merge(errors)
-        else
-          result = data.merge(errors: errors)
-        end
+        result = if errors.is_a?(Hash) && errors.key?('errors')
+                   data.merge(errors)
+                 else
+                   data.merge(errors: errors)
+                 end
         result = result.merge(id: id)
-        self.new(result)
+        new(result)
       end
 
       def post(data: {}, **)
@@ -30,12 +30,12 @@ module RestfulResource
       rescue HttpClient::UnprocessableEntity => e
         errors = parse_json(e.response.body)
         result = nil
-        if errors.is_a?(Hash) && errors.has_key?('errors')
-          result = data.merge(errors)
-        else
-          result = data.merge(errors: errors)
-        end
-        self.new(result)
+        result = if errors.is_a?(Hash) && errors.key?('errors')
+                   data.merge(errors)
+                 else
+                   data.merge(errors: errors)
+                 end
+        new(result)
       end
     end
 

data/lib/restful_resource/redirections.rb

@@ -1,7 +1,7 @@
 module RestfulResource
   class MaximumAttemptsReached < StandardError
     def message
-      "The maximum attempts limit was reached before the resource was ready"
+      'The maximum attempts limit was reached before the resource was ready'
     end
   end
 
@@ -11,12 +11,13 @@ module RestfulResource
         def post(data: {}, delay: 1.0, max_attempts: 10, headers: {}, open_timeout: nil, timeout: nil, **params)
           url = collection_url(params)
 
-          response = self.accept_redirected_result(response: http.post(url, data: data, headers: headers, open_timeout: nil, timeout: nil), delay: delay, max_attempts: max_attempts)
+          response = accept_redirected_result(response: http.post(url, data: data, headers: headers, open_timeout: nil, timeout: nil), delay: delay, max_attempts: max_attempts)
 
-          self.new(parse_json(response.body))
+          new(parse_json(response.body))
         end
 
         private
+
         def self.accept_redirected_result(response:, delay:, max_attempts:)
           new_response = response
           if response.status == 303
@@ -32,9 +33,7 @@ module RestfulResource
               new_response = http.get(resource_location, headers: {}, open_timeout: nil, timeout: nil)
             end
 
-            if attempts == max_attempts
-              raise RestfulResource::MaximumAttemptsReached
-            end
+            raise RestfulResource::MaximumAttemptsReached if attempts == max_attempts
           end
           response = new_response
         end

data/lib/restful_resource/request.rb

@@ -33,4 +33,3 @@ module RestfulResource
     end
   end
 end
-

data/lib/restful_resource/resource_id_missing_error.rb

@@ -1,7 +1,7 @@
 module RestfulResource
   class ResourceIdMissingError < StandardError
     def message
-      "You must pass the resource ID"
+      'You must pass the resource ID'
     end
   end
 end

data/lib/restful_resource/response.rb

@@ -2,8 +2,10 @@ module RestfulResource
   class Response
     attr_reader :body, :headers, :status
 
-    def initialize(body: "{}", headers: {}, status: nil)
-      @body, @headers, @status = body, headers, status
+    def initialize(body: '{}', headers: {}, status: nil)
+      @body = body
+      @headers = headers
+      @status = status
     end
   end
 end

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'.freeze
 end

data/restful_resource.gemspec

@@ -1,36 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'restful_resource/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "restful_resource"
+  spec.name          = 'restful_resource'
   spec.version       = RestfulResource::VERSION
-  spec.authors       = ["David Santoro", "Federico Rebora"]
-  spec.email         = ["developers@carwow.co.uk"]
-  spec.description   = %q{A simple activerecord inspired rest resource base class implemented using rest-client}
-  spec.summary       = %q{A simple activerecord inspired rest resource base class implemented using rest-client}
-  spec.homepage      = "http://www.github.com/carwow/restful_resource"
-  spec.license       = "MIT"
+  spec.authors       = ['David Santoro', 'Federico Rebora']
+  spec.email         = ['developers@carwow.co.uk']
+  spec.description   = 'A simple activerecord inspired rest resource base class implemented using rest-client'
+  spec.summary       = 'A simple activerecord inspired rest resource base class implemented using rest-client'
+  spec.homepage      = 'http://www.github.com/carwow/restful_resource'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 2.1'
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.4'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'carwow_rubocop', '~> 2.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rspec-its'
 
-  spec.add_dependency "faraday"
-  spec.add_dependency "faraday_middleware"
-  spec.add_dependency "faraday-http-cache"
-  spec.add_dependency "faraday-encoding"
-  spec.add_dependency "link_header"
-  spec.add_dependency "activesupport"
-  spec.add_dependency "rack"
-  spec.add_dependency "typhoeus"
-  spec.add_dependency "faraday-cdn-metrics"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday-cdn-metrics'
+  spec.add_dependency 'faraday-encoding'
+  spec.add_dependency 'faraday-http-cache'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'link_header'
+  spec.add_dependency 'rack'
+  spec.add_dependency 'typhoeus'
 end

data/spec/fixtures.rb

@@ -1,17 +1,17 @@
 class Make < RestfulResource::Base
-  resource_path "makes"
+  resource_path 'makes'
   has_many :models
 end
 
 class Model < RestfulResource::Base
   has_one :make
-  resource_path "groups/:group_id/makes/:make_slug/models"
+  resource_path 'groups/:group_id/makes/:make_slug/models'
 end
 
 class Dealer < RestfulResource::Base
   include RestfulResource::RailsValidations
 
-  resource_path "dealers"
+  resource_path 'dealers'
 end
 
 class BaseA < RestfulResource::Base
@@ -21,11 +21,11 @@ class BaseB < RestfulResource::Base
 end
 
 class TestA < BaseA
-  self.resource_path "testa"
+  resource_path 'testa'
 end
 
 class TestB < BaseB
-  self.resource_path "testb"
+  resource_path 'testb'
 end
 
 class ModelWithRedirections < RestfulResource::Base
@@ -36,7 +36,7 @@ end
 
 module ComplicatedModule
   class Parent < BaseA
-    resource_path "parent"
+    resource_path 'parent'
     has_many :children
     has_many :other_things
     has_many :missing
@@ -51,7 +51,7 @@ module ComplicatedModule
     has_one :parent
 
     def full_name
-      "#{self.first_name} #{self.second_name}"
+      "#{first_name} #{second_name}"
     end
   end
 end

data/spec/restful_resource/associations_spec.rb

@@ -1,53 +1,55 @@
 require_relative '../spec_helper'
 
 describe RestfulResource::Associations do
-  describe "#has_many" do
-    before :each do
-      @parent = ComplicatedModule::Parent.new({
+  describe '#has_many' do
+    before do
+      @parent = ComplicatedModule::Parent.new(
         name: 'John Doe',
-        other_things: [{stuff: 'aaa'}, {stuff: 'bbb'}],
+        other_things: [{ stuff: 'aaa' }, { stuff: 'bbb' }],
         children:
           [
-            {first_name: 'David', second_name: 'Doe'},
-            {first_name: 'Mary', second_name: 'Doe'}
+            { first_name: 'David', second_name: 'Doe' },
+            { first_name: 'Mary', second_name: 'Doe' }
           ]
-      })
+
+      )
     end
 
-    it "should add a method to access nested resource" do
+    it 'adds a method to access nested resource' do
       expect(@parent.children.first.first_name).to eq 'David'
       expect(@parent.children.last.first_name).to eq 'Mary'
-      expect(@parent.children.first.to_json).to eq({first_name: 'David', second_name: 'Doe'}.to_json)
+      expect(@parent.children.first.to_json).to eq({ first_name: 'David', second_name: 'Doe' }.to_json)
     end
 
-    it "should pick the right class for the instantiation of chilren" do
+    it 'picks the right class for the instantiation of chilren' do
       expect(@parent.children.first.full_name).to eq 'David Doe'
     end
 
-    it "should use open object when can't infer class name of association" do
+    it "uses open object when can't infer class name of association" do
       expect(@parent.other_things.first.stuff).to eq 'aaa'
     end
 
-    it "should return nil for missing associations" do
+    it 'returns nil for missing associations' do
       expect(@parent.missing).to be_nil
     end
   end
 
-  describe "#has_one" do
-    before :each do
-      @child = ComplicatedModule::Child.new({
+  describe '#has_one' do
+    before do
+      @child = ComplicatedModule::Child.new(
         first_name: 'David', second_name: 'Smith',
-        parent: {name: 'John Smith'}
-      })
+        parent: { name: 'John Smith' }
+
+      )
     end
 
-    it "should add a method to access nested resource" do
+    it 'adds a method to access nested resource' do
       expect(@child.parent.name).to eq 'John Smith'
-      expect(@child.parent.to_json).to eq({name: 'John Smith'}.to_json)
+      expect(@child.parent.to_json).to eq({ name: 'John Smith' }.to_json)
     end
 
-    it "should pick the right class for the instantiation of chilren" do
-      expect(@child.parent.is_parent?).to be_truthy
+    it 'picks the right class for the instantiation of chilren' do
+      expect(@child.parent).to be_is_parent
     end
   end
 end

data/spec/restful_resource/base_authorization_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../spec_helper'
 
 describe RestfulResource::Base, 'authorization' do
-  before :each do
+  before do
     class FirstClient < RestfulResource::Base
     end
 
@@ -21,20 +21,19 @@ describe RestfulResource::Base, 'authorization' do
     FirstClient.configure(base_url: 'http://api.carwow.co.uk/api/first')
     SecondClient.configure(base_url: 'http://api.carwow.co.uk/api/second',
                            username: 'test_user',
-                           password: 'test_pass')
+                           password: 'test_pass'
+                          )
   end
 
-  it "should use two different http instances" do
+  it 'uses two different http instances' do
     expect(FirstTest.send(:http)).not_to equal(SecondTest.send(:http))
   end
 
-  it 'should have same http auth on superclass' do
+  it 'has same http auth on superclass' do
     expect(SecondTest.send(:http)).to equal(SecondClient.send(:http))
   end
 
-  it 'should raise exception if base_url is not set' do
+  it 'raises exception if base_url is not set' do
     expect { NotConfiguredClient.send(:base_url) }.to raise_error 'Base url missing'
   end
-
 end
-