restful_resource 2.5.3 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e46af8066f1ca4d4e59dae90cd6283676f65e146ed62ab56c506eeafb189b95
-  data.tar.gz: fdbb7277f080e8c00ff73e5b01f26954d67dd04189456a4500276b0a435b8a41
+  metadata.gz: 88ffc05f6fe383a8d7e885b26498b3d56b18f4ed3e3011b07e01638ebd0b09ba
+  data.tar.gz: 9e2e99681e0b464332ec34361c17903ff54ed368974cd52f401fe51ebe011aea
 SHA512:
-  metadata.gz: 2039984d78d5131c8a88cb45fd7cc65a2626b2d2bee7977642ce10d84fd19f8d158ef7a7202f07e36dbf5ba4404cbf772f2f56f0f92497d1571f60f052dcfc68
-  data.tar.gz: c382b0c2d0f1f4901a990ef771104d0350536e6bd773bed632dcfc74d4f090577044b255bf49544fc2939ff9848d60efdbd020d0f55d16f6bb1db5e70e06eb8a
+  metadata.gz: 8f1650c811c5ddb2c0d992449e47d2e7c804e3b142963d43a803a252b61884c8e2514aed11e3fcd1123f68cdff3cd7752773471ddd5b8b26a12b9a0dc95688d6
+  data.tar.gz: 300be14f9ac06b762c3302f4e71901c82ffc86dc5a74bb3daabe63eb032a72a9ac19cca82b1f337dd37cda31f69d006adfc2cc078fcc42687e850e08d316954f

data/.circleci/config.yml

@@ -7,7 +7,9 @@ jobs:
       - checkout
       - run:
           name: Bundle Install
-          command: bundle check || bundle install
+          command: |
+            gem install bundler && \
+            bundle check || bundle install
       - run:
           name: Run rspec in parallel
           command: |
@@ -18,3 +20,10 @@ jobs:
                               $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
       - store_test_results:
           path: test_results
+
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -18,3 +17,4 @@ tmp
 .idea
 *.swp
 *.swo
+/tags

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+2.10.0
+---
+
+- Support Faraday v1 (#85)
+
+2.9.0
+---
+
+- Add support for DELETE in RestfulResource::RailsValidations (#73)
+
+2.8.1
+---
+
+- Looser Faraday requirement >= 0.15, < 1.1
+
+2.8.0
+---
+
+- Make params hash in methods consistent, and always optional (#61)
+
+2.7.0
+---
+
+- Add `X-Client-Start` header on request containing milliseconds since unix epoch
+
+2.6.1
+---
+
+- Support only `faraday-0.15.x`
+    - `0.16.x` breaks `faraday-http-cache`
+
+2.6.0 (yanked)
+---
+
+- Upgrade to `faraday-0.16.x`
+- Add `X-Client-Timeout` header on requests if a client timeout is set
+
+2.5.3
+---
+
+- Raise `RestfulResource::HttpClient::GatewayTimeout` when response status is `504`
+
+
+2.5.2
+---
+
+- Add ability to set `timeout` and `open_timeout` options on connection
+
 2.5.1
 ---
 

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    restful_resource (2.10.0)
+      activesupport (~> 6.0)
+      faraday (~> 1.0)
+      faraday-cdn-metrics (~> 0.2)
+      faraday-encoding
+      faraday-http-cache (~> 2.2)
+      faraday_middleware (~> 1.0)
+      link_header
+      rack (~> 2.2)
+      typhoeus (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.0)
+    carwow_rubocop (3.3.0)
+      rubocop (>= 0.78)
+      rubocop-performance
+      rubocop-rspec
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-cdn-metrics (0.2.0)
+      faraday (~> 1)
+    faraday-encoding (0.0.5)
+      faraday
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    ffi (1.13.0)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    link_header (0.0.8)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  carwow_rubocop
+  pry
+  rake
+  restful_resource!
+  rspec
+  rspec-its
+  rspec_junit_formatter
+
+BUNDLED WITH
+   2.1.4

data/lib/restful_resource/base.rb

@@ -12,7 +12,7 @@ module RestfulResource
       timeout: nil,
       open_timeout: nil,
       faraday_config: nil,
-      faraday_options: nil)
+      faraday_options: {})
 
       @base_url = URI.parse(base_url)
 
@@ -33,14 +33,14 @@ module RestfulResource
       @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)
       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)
@@ -48,7 +48,7 @@ module RestfulResource
       paginate_response(response)
     end
 
-    def self.get(params = {})
+    def self.get(**params)
       params_without_options, options = format_params(params)
 
       response = http.get(collection_url(params_without_options), **options)
@@ -58,7 +58,7 @@ module RestfulResource
     def self.delete(id, **params)
       params_without_options, options = format_params(params)
       response = http.delete(member_url(id, params_without_options), **options)
-      RestfulResource::OpenObject.new(parse_json(response.body))
+      new(parse_json(response.body))
     end
 
     def self.patch(id, data: {}, headers: {}, **params)
@@ -92,7 +92,7 @@ module RestfulResource
       new(parse_json(response.body))
     end
 
-    def self.all(params = {})
+    def self.all(**params)
       where(params)
     end
 
@@ -133,14 +133,14 @@ module RestfulResource
       result
     end
 
-    def self.collection_url(params)
+    def self.collection_url(**params)
       url = merge_url_paths(base_url, @resource_path, @action_prefix)
       replace_parameters(url, params)
     end
 
     private
 
-    def self.format_params(params = {})
+    def self.format_params(**params)
       headers = params.delete(:headers) || {}
 
       headers[:cache_control] = 'no-cache' if params.delete(:no_cache)
@@ -154,7 +154,7 @@ module RestfulResource
       uri.merge(paths.compact.join('/')).to_s
     end
 
-    def self.member_url(id, params)
+    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)
@@ -173,7 +173,7 @@ module RestfulResource
       ActiveSupport::JSON.decode(json)
     end
 
-    def self.replace_parameters(url, params)
+    def self.replace_parameters(url, **params)
       missing_params = []
       params = params.with_indifferent_access
 

data/lib/restful_resource/http_client.rb

@@ -88,7 +88,7 @@ module RestfulResource
       timeout: nil,
       open_timeout: nil,
       faraday_config: nil,
-      faraday_options: nil)
+      faraday_options: {})
       api_name = instrumentation[:api_name]            ||= 'api'
       instrumentation[:request_instrument_name]        ||= "http.#{api_name}"
       instrumentation[:cache_instrument_name]          ||= "http_cache.#{api_name}"
@@ -202,7 +202,7 @@ module RestfulResource
       cache_instrument_name: nil,
       server_cache_instrument_name: nil,
       faraday_config: nil,
-      faraday_options: nil)
+      faraday_options: {})
 
       @connection = Faraday.new(nil, faraday_options) do |b|
         b.request :json
@@ -252,7 +252,8 @@ module RestfulResource
         req.body = request.body unless request.body.nil?
         req.url request.url
 
-        req.headers = req.headers.merge(request.headers)
+        req.headers = req.headers.merge(request.headers).merge(x_client_start: time_current_ms)
+        req.headers = req.headers.merge(x_client_timeout: req.options[:timeout]) if req.options[:timeout]
       end
 
       Response.new(body: response.body, headers: response.headers, status: response.status)
@@ -264,6 +265,15 @@ module RestfulResource
       response = e.response
       raise ClientError, request unless response
 
+      handle_error(request, response)
+    rescue Faraday::ServerError => e
+      response = e.response
+      raise ClientError, request unless response
+
+      handle_error(request, response)
+    end
+
+    def handle_error(request, response)
       case response[:status]
       when 404 then raise HttpClient::ResourceNotFound.new(request, response)
       when 409 then raise HttpClient::Conflict.new(request, response)
@@ -275,5 +285,9 @@ module RestfulResource
       else raise HttpClient::OtherHttpError.new(request, response)
       end
     end
+
+    def time_current_ms
+      (Time.current.to_f * 1_000.0).to_i
+    end
   end
 end

data/lib/restful_resource/rails_validations.rb

@@ -17,13 +17,16 @@ module RestfulResource
         with_validations { super }
       end
 
+      def delete(*)
+        with_validations { super }
+      end
+
       private
 
       def with_validations(id = nil, data: {})
         yield
       rescue HttpClient::UnprocessableEntity => e
         errors = parse_json(e.response.body)
-        result = nil
         result = if errors.is_a?(Hash) && errors.key?('errors')
                    data.merge(errors)
                  else

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '2.5.3'.freeze
+  VERSION = '2.10.0'.freeze
 end

data/restful_resource.gemspec

@@ -20,18 +20,19 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'carwow_rubocop'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rspec_junit_formatter'
 
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday-cdn-metrics'
+  spec.add_dependency 'activesupport', '~> 6.0'
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'faraday-cdn-metrics', '~> 0.2'
   spec.add_dependency 'faraday-encoding'
-  spec.add_dependency 'faraday-http-cache'
-  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'faraday-http-cache', '~> 2.2'
+  spec.add_dependency 'faraday_middleware', '~> 1.0'
   spec.add_dependency 'link_header'
-  spec.add_dependency 'rack'
-  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'rack', '~> 2.2'
+  spec.add_dependency 'typhoeus', '~> 1.4'
 end

data/spec/restful_resource/base_authorization_spec.rb

@@ -2,12 +2,8 @@ require_relative '../spec_helper'
 
 describe RestfulResource::Base, 'authorization' do
   before do
-    class FirstClient < RestfulResource::Base
-    end
-
-    class SecondClient < RestfulResource::Base
-    end
-
+    class FirstClient < RestfulResource::Base; end
+    class SecondClient < RestfulResource::Base; end
     class NotConfiguredClient < RestfulResource::Base; end
 
     class FirstTest < FirstClient

data/spec/restful_resource/base_spec.rb

@@ -3,8 +3,10 @@ require_relative '../spec_helper'
 RSpec.describe RestfulResource::Base do
   before do
     @mock_http = double('mock_http')
-    allow(described_class).to receive(:http).and_return(@mock_http)
-    described_class.configure(base_url: 'http://api.carwow.co.uk/')
+    allow(Make).to receive(:http).and_return(@mock_http)
+    Make.configure(base_url: 'http://api.carwow.co.uk/')
+    allow(Model).to receive(:http).and_return(@mock_http)
+    Model.configure(base_url: 'http://api.carwow.co.uk/')
   end
 
   it 'acts as an openobject' do
@@ -143,9 +145,14 @@ RSpec.describe RestfulResource::Base do
   end
 
   describe '#base_url' do
+    before do
+      @mock_http = double('mock_http')
+      allow(TestA).to receive(:http).and_return(@mock_http)
+      allow(TestB).to receive(:http).and_return(@mock_http)
+    end
+
     it 'is different for each subclass of Base' do
       BaseA.configure(base_url: 'http://a.carwow.co.uk')
-
       BaseB.configure(base_url: 'http://b.carwow.co.uk')
 
       expect_get('http://a.carwow.co.uk/testa/1', RestfulResource::Response.new)
@@ -385,6 +392,7 @@ RSpec.describe RestfulResource::Base do
     let(:faraday_options) { double }
 
     it 'passes arguments to HttpClient' do
+      client = Class.new(described_class)
       expect(RestfulResource::HttpClient).to receive(:new).with(username: username,
                                                                 password: password,
                                                                 auth_token: auth_token,
@@ -397,7 +405,7 @@ RSpec.describe RestfulResource::Base do
                                                                 faraday_options: faraday_options
                                                                )
 
-      described_class.configure(base_url: 'http://foo.bar',
+      client.configure(base_url: 'http://foo.bar',
                                 username: username,
                                 password: password,
                                 auth_token: auth_token,

data/spec/restful_resource/http_client_configuration_spec.rb

@@ -19,7 +19,7 @@ describe RestfulResource::HttpClient do
 
     describe 'Builder configuration' do
       it 'uses the typhoeus adapter' do
-        expect(middleware).to include Faraday::Adapter::Typhoeus
+        expect(connection.adapter).to eq Faraday::Adapter::Typhoeus
       end
 
       it 'url_encodes requests' do
@@ -81,13 +81,13 @@ describe RestfulResource::HttpClient do
             described_class.new(instrumentation: { app_name: 'rails', api_name: 'api', metric_class: FakeMetrics })
 
             expect(RestfulResource::Instrumentation).to have_received(:new)
-                                               .with(app_name: 'rails',
-                                                     api_name: 'api',
-                                                     request_instrument_name: 'http.api',
-                                                     cache_instrument_name: 'http_cache.api',
-                                                     server_cache_instrument_name: 'cdn_metrics.api',
-                                                     metric_class: FakeMetrics
-                                                    )
+              .with(app_name: 'rails',
+                    api_name: 'api',
+                    request_instrument_name: 'http.api',
+                    cache_instrument_name: 'http_cache.api',
+                    server_cache_instrument_name: 'cdn_metrics.api',
+                    metric_class: FakeMetrics
+                   )
           end
 
           it 'subscribes to the notifications' do

data/spec/restful_resource/http_client_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../spec_helper'
 
 RSpec.describe RestfulResource::HttpClient do
-  def faraday_connection
-    Faraday.new do |builder|
+  def faraday_connection(opts = {})
+    Faraday.new(opts) do |builder|
       builder.request :url_encoded
       builder.response :raise_error
       builder.adapter :test do |stubs|
@@ -16,175 +16,97 @@ RSpec.describe RestfulResource::HttpClient do
   end
 
   describe 'Basic HTTP' do
-    it 'executes get' do
-      connection = faraday_connection do |stubs|
-        stubs.get('http://httpbin.org/get') { |_env| [200, {}, nil] }
-      end
-
-      response = http_client(connection).get('http://httpbin.org/get')
-      expect(response.status).to eq 200
-    end
-
-    it 'executes patch' do
-      connection = faraday_connection do |stubs|
-        # Note: request body is serialized as url-encoded so the stub body must be in the same format to match
-        stubs.patch('http://httpbin.org/patch', 'name=Alfred') { |_env| [200, {}, nil] }
-      end
-
-      response = http_client(connection).patch('http://httpbin.org/patch', data: { name: 'Alfred' })
-      expect(response.status).to eq 200
-    end
-
-    it 'executes put' do
-      connection = faraday_connection do |stubs|
-        # Note: request body is serialized as url-encoded so the stub body must be in the same format to match
-        stubs.put('http://httpbin.org/put', 'name=Alfred') { |_env| [200, {}, nil] }
-      end
-
-      response = http_client(connection).put('http://httpbin.org/put', data: { name: 'Alfred' })
-      expect(response.status).to eq 200
-    end
-
-    it 'executes post' do
-      connection = faraday_connection do |stubs|
-        # Note: request body is serialized as url-encoded so the stub body must be in the same format to match
-        stubs.post('http://httpbin.org/post', 'name=Alfred') { |_env| [200, {}, %("name": "Alfred")] }
-      end
-
-      response = http_client(connection).post('http://httpbin.org/post', data: { name: 'Alfred' })
-
-      expect(response.body).to include 'name": "Alfred'
-      expect(response.status).to eq 200
-    end
-
-    it 'executes delete' do
-      connection = faraday_connection do |stubs|
-        stubs.delete('http://httpbin.org/delete') { |_env| [200, {}, nil] }
-      end
-
-      response = http_client(connection).delete('http://httpbin.org/delete')
-
-      expect(response.status).to eq 200
-    end
+    shared_examples 'error codes throw exception' do |verb, status, exception_class|
+      it "should raise an error #{status}" do
+        url = "http://httpbin.org/status/#{status}"
 
-    it 'patch should raise error 409' do
-      connection = faraday_connection do |stubs|
-        stubs.patch('http://httpbin.org/status/409') { |_env| [409, {}, nil] }
-      end
-
-      expect { http_client(connection).patch('http://httpbin.org/status/409') }.to raise_error(RestfulResource::HttpClient::Conflict)
-    end
+        connection = faraday_connection do |stubs|
+          stubs.send(verb, url) { [status, {}, nil] }
+        end
 
-    it 'patch should raise error 422' do
-      connection = faraday_connection do |stubs|
-        stubs.patch('http://httpbin.org/status/422') { |_env| [422, {}, nil] }
+        expect { http_client(connection).send(verb, url) }.to raise_error(exception_class)
       end
-
-      expect { http_client(connection).patch('http://httpbin.org/status/422') }.to raise_error(RestfulResource::HttpClient::UnprocessableEntity)
     end
 
-    it 'put should raise error 409' do
-      connection = faraday_connection do |stubs|
-        stubs.put('http://httpbin.org/status/409') { |_env| [409, {}, nil] }
-      end
+    shared_examples 'raise an exception on error responses' do |verb|
+      include_examples 'error codes throw exception', verb, 409, RestfulResource::HttpClient::Conflict
+      include_examples 'error codes throw exception', verb, 404, RestfulResource::HttpClient::ResourceNotFound
+      include_examples 'error codes throw exception', verb, 422, RestfulResource::HttpClient::UnprocessableEntity
+      include_examples 'error codes throw exception', verb, 429, RestfulResource::HttpClient::TooManyRequests
+      include_examples 'error codes throw exception', verb, 502, RestfulResource::HttpClient::BadGateway
+      include_examples 'error codes throw exception', verb, 503, RestfulResource::HttpClient::ServiceUnavailable
+      include_examples 'error codes throw exception', verb, 504, RestfulResource::HttpClient::GatewayTimeout
 
-      expect { http_client(connection).put('http://httpbin.org/status/409') }.to raise_error(RestfulResource::HttpClient::Conflict)
+      include_examples 'error codes throw exception', verb, 418, RestfulResource::HttpClient::OtherHttpError
     end
 
-    it 'put should raise error 422' do
-      connection = faraday_connection do |stubs|
-        stubs.put('http://httpbin.org/status/422') { |_env| [422, {}, nil] }
-      end
+    context 'GET' do
+      include_examples 'raise an exception on error responses', :get
 
-      expect { http_client(connection).put('http://httpbin.org/status/422') }.to raise_error(RestfulResource::HttpClient::UnprocessableEntity)
-    end
+      it 'executes get' do
+        connection = faraday_connection do |stubs|
+          stubs.get('http://httpbin.org/get') { |_env| [200, {}, nil] }
+        end
 
-    it 'post should raise error 422' do
-      connection = faraday_connection do |stubs|
-        stubs.post('http://httpbin.org/status/422') { |_env| [422, {}, nil] }
+        response = http_client(connection).get('http://httpbin.org/get')
+        expect(response.status).to eq 200
       end
-
-      expect { http_client(connection).post('http://httpbin.org/status/422') }.to raise_error(RestfulResource::HttpClient::UnprocessableEntity)
     end
 
-    it 'post should raise error 429' do
-      connection = faraday_connection do |stubs|
-        stubs.post('http://httpbin.org/status/429') { |_env| [429, {}, nil] }
-      end
+    context 'PATCH' do
+      include_examples 'raise an exception on error responses', :patch
 
-      expect { http_client(connection).post('http://httpbin.org/status/429') }.to raise_error(RestfulResource::HttpClient::TooManyRequests)
-    end
+      it 'executes patch' do
+        connection = faraday_connection do |stubs|
+          # Note: request body is serialized as url-encoded so the stub body must be in the same format to match
+          stubs.patch('http://httpbin.org/patch', 'name=Alfred') { |_env| [200, {}, nil] }
+        end
 
-    it 'patch should raise error 502' do
-      connection = faraday_connection do |stubs|
-        stubs.patch('http://httpbin.org/status/502') { |_env| [502, {}, nil] }
+        response = http_client(connection).patch('http://httpbin.org/patch', data: { name: 'Alfred' })
+        expect(response.status).to eq 200
       end
-
-      expect { http_client(connection).patch('http://httpbin.org/status/502') }.to raise_error(RestfulResource::HttpClient::BadGateway)
     end
 
-    it 'put should raise error 502' do
-      connection = faraday_connection do |stubs|
-        stubs.put('http://httpbin.org/status/502') { |_env| [502, {}, nil] }
-      end
-
-      expect { http_client(connection).put('http://httpbin.org/status/502') }.to raise_error(RestfulResource::HttpClient::BadGateway)
-    end
+    context 'PUT' do
+      include_examples 'raise an exception on error responses', :put
+      it 'executes put' do
+        connection = faraday_connection do |stubs|
+          # Note: request body is serialized as url-encoded so the stub body must be in the same format to match
+          stubs.put('http://httpbin.org/put', 'name=Alfred') { |_env| [200, {}, nil] }
+        end
 
-    it 'post should raise error 502' do
-      connection = faraday_connection do |stubs|
-        stubs.post('http://httpbin.org/status/502') { |_env| [502, {}, nil] }
+        response = http_client(connection).put('http://httpbin.org/put', data: { name: 'Alfred' })
+        expect(response.status).to eq 200
       end
-
-      expect { http_client(connection).post('http://httpbin.org/status/502') }.to raise_error(RestfulResource::HttpClient::BadGateway)
     end
 
-    it 'patch should raise error 503' do
-      connection = faraday_connection do |stubs|
-        stubs.patch('http://httpbin.org/status/503') { |_env| [503, {}, nil] }
-      end
+    context 'POST' do
+      include_examples 'raise an exception on error responses', :post
+      it 'executes post' do
+        connection = faraday_connection do |stubs|
+          # Note: request body is serialized as url-encoded so the stub body must be in the same format to match
+          stubs.post('http://httpbin.org/post', 'name=Alfred') { |_env| [200, {}, %("name": "Alfred")] }
+        end
 
-      expect { http_client(connection).patch('http://httpbin.org/status/503') }.to raise_error(RestfulResource::HttpClient::ServiceUnavailable)
-    end
+        response = http_client(connection).post('http://httpbin.org/post', data: { name: 'Alfred' })
 
-    it 'put should raise error 503' do
-      connection = faraday_connection do |stubs|
-        stubs.put('http://httpbin.org/status/503') { |_env| [503, {}, nil] }
+        expect(response.body).to include 'name": "Alfred'
+        expect(response.status).to eq 200
       end
-
-      expect { http_client(connection).put('http://httpbin.org/status/503') }.to raise_error(RestfulResource::HttpClient::ServiceUnavailable)
     end
 
-    it 'post should raise error 503' do
-      connection = faraday_connection do |stubs|
-        stubs.post('http://httpbin.org/status/503') { |_env| [503, {}, nil] }
-      end
-
-      expect { http_client(connection).post('http://httpbin.org/status/503') }.to raise_error(RestfulResource::HttpClient::ServiceUnavailable)
-    end
+    context 'DELETE' do
+      include_examples 'raise an exception on error responses', :delete
 
-    it 'post should raise error 504' do
-      connection = faraday_connection do |stubs|
-        stubs.post('http://httpbin.org/status/504') { |_env| [504, {}, nil] }
-      end
+      it 'executes delete' do
+        connection = faraday_connection do |stubs|
+          stubs.delete('http://httpbin.org/delete') { |_env| [200, {}, nil] }
+        end
 
-      expect { http_client(connection).post('http://httpbin.org/status/504') }.to raise_error(RestfulResource::HttpClient::GatewayTimeout)
-    end
+        response = http_client(connection).delete('http://httpbin.org/delete')
 
-    it 'raises error on 404' do
-      connection = faraday_connection do |stubs|
-        stubs.get('http://httpbin.org/status/404') { |_env| [404, {}, nil] }
-        stubs.post('http://httpbin.org/status/404') { |_env| [404, {}, nil] }
-        stubs.patch('http://httpbin.org/status/404') { |_env| [404, {}, nil] }
-        stubs.put('http://httpbin.org/status/404') { |_env| [404, {}, nil] }
-        stubs.delete('http://httpbin.org/status/404') { |_env| [404, {}, nil] }
+        expect(response.status).to eq 200
       end
-
-      expect { http_client(connection).get('http://httpbin.org/status/404') }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
-      expect { http_client(connection).delete('http://httpbin.org/status/404') }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
-      expect { http_client(connection).patch('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
-      expect { http_client(connection).put('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
-      expect { http_client(connection).post('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
     end
 
     it 'raises Faraday::ConnectionFailed errors' do
@@ -210,14 +132,6 @@ RSpec.describe RestfulResource::HttpClient do
 
       expect { http_client(connection).get('https://localhost:3005') }.to raise_error(RestfulResource::HttpClient::ClientError)
     end
-
-    it 'raises OtherHttpError for other status response codes' do
-      connection = faraday_connection do |stubs|
-        stubs.get('http://httpbin.org/status/418') { |_env| [418, {}, nil] }
-      end
-
-      expect { http_client(connection).get('http://httpbin.org/status/418') }.to raise_error(RestfulResource::HttpClient::OtherHttpError)
-    end
   end
 
   describe 'Authentication' do
@@ -292,4 +206,69 @@ RSpec.describe RestfulResource::HttpClient do
       expect(response.status).to eq 200
     end
   end
+
+  describe 'X-Client-Timeout' do
+    let(:http_client) { described_class.new(connection: connection, timeout: timeout) }
+    let(:connection) do
+      conn = faraday_connection do |stubs|
+        stubs.get('http://httpbin.org/get', required_headers) { |_env| [200, {}, nil] }
+      end
+
+      conn.options[:timeout] = timeout
+
+      conn
+    end
+
+
+    context 'when explicit timeout set on connection' do
+      let(:timeout) { 5 }
+      let(:required_headers) { { 'X-Client-Timeout' => 5 } }
+      it 'sets X-Client-Timeout correctly' do
+        response = http_client.get('http://httpbin.org/get')
+
+        expect(response.status).to eq 200
+      end
+    end
+
+    context 'when not explicit timeout set' do
+      let(:timeout) { nil }
+      let(:required_headers) { {} }
+
+      it 'sets X-Client-Timeout correctly' do
+        response = http_client.get('http://httpbin.org/get')
+
+        expect(response.status).to eq 200
+      end
+    end
+
+    context 'when set on request' do
+      let(:timeout) { nil }
+      let(:required_headers) { { 'X-Client-Timeout' => 1 } }
+
+      it 'sets X-Client-Timeout correctly' do
+        response = http_client.get('http://httpbin.org/get', timeout: 1)
+
+        expect(response.status).to eq 200
+      end
+    end
+  end
+
+  describe 'X-Client-Start' do
+    let(:now) { Time.current }
+    let(:required_headers) { { 'X-Client-Start' => (now.to_f * 1000.0).to_i } }
+    let(:http_client) { described_class.new(connection: connection) }
+    let(:connection) do
+      conn = faraday_connection do |stubs|
+        stubs.get('http://httpbin.org/get', required_headers) { |_env| [200, {}, nil] }
+      end
+    end
+
+    before { allow(Time).to receive(:current).and_return(now) }
+
+    it 'sets X-Client-Start correctly' do
+      response = http_client.get('http://httpbin.org/get')
+
+      expect(response.status).to eq 200
+    end
+  end
 end

data/spec/restful_resource/rails_validations_spec.rb

@@ -3,8 +3,8 @@ require_relative '../spec_helper'
 RSpec.describe RestfulResource::RailsValidations do
   before do
     @mock_http = double('mock_http')
-    RestfulResource::Base.configure(base_url: 'http://api.carwow.co.uk/')
-    allow(RestfulResource::Base).to receive(:http).and_return(@mock_http)
+    Dealer.configure(base_url: 'http://api.carwow.co.uk/')
+    allow(Dealer).to receive(:http).and_return(@mock_http)
   end
 
   context '#patch without errors' do
@@ -72,13 +72,13 @@ RSpec.describe RestfulResource::RailsValidations do
     end
   end
 
-  context '#patch without errors' do
+  context '#put without errors' do
     before do
       data = { name: 'Barak' }
       expected_response = RestfulResource::Response.new(body: { name: 'Barak' }.to_json)
-      expect_patch('http://api.carwow.co.uk/dealers/1', expected_response, data: data)
+      expect_put('http://api.carwow.co.uk/dealers/1', expected_response, data: data)
 
-      @object = Dealer.patch(1, data: data)
+      @object = Dealer.put(1, data: data)
     end
 
     it 'returns object' do
@@ -239,4 +239,53 @@ RSpec.describe RestfulResource::RailsValidations do
       expect(@object.errors).to eq @error
     end
   end
+
+  describe '#delete' do
+    subject { Dealer.delete(123) }
+
+    context 'without errors' do
+      before do
+        expected_response = RestfulResource::Response.new(body: { name: 'Barak' }.to_json)
+        expect_delete('http://api.carwow.co.uk/dealers/123', expected_response)
+      end
+
+      it 'returns object' do
+        expect(subject.name).to eq 'Barak'
+      end
+
+      it 'returns valid object' do
+        expect(subject).to be_valid
+      end
+    end
+
+    context 'with errors' do
+      let(:errors) { { errors: ['Cannot use Ninja Turtles names'] } }
+
+      before do
+        expected_response = RestfulResource::Response.new(body: errors.to_json)
+        expect_delete_with_unprocessable_entity('http://api.carwow.co.uk/dealers/123', expected_response)
+      end
+
+      it 'has an error' do
+        expect(subject.errors.count).to eq 1
+      end
+
+      it 'has correct error' do
+        expect(subject.errors.first).to eq 'Cannot use Ninja Turtles names'
+      end
+
+      it 'returns not valid object' do
+        expect(subject).not_to be_valid
+      end
+
+      context 'when there is a single error' do
+        let(:errors) { 'Cannot use Ninja Turtles names' }
+
+        it 'handles errors returned as root object' do
+          expect(subject).not_to be_valid
+          expect(subject.errors).to eq errors
+        end
+      end
+    end
+  end
 end

data/spec/restful_resource/redirections_spec.rb

@@ -3,8 +3,8 @@ require_relative '../spec_helper'
 RSpec.describe RestfulResource::Redirections do
   before do
     @mock_http = double('mock_http')
-    allow(RestfulResource::Base).to receive(:http).and_return(@mock_http)
-    RestfulResource::Base.configure(base_url: 'http://api.carwow.co.uk/')
+    allow(ModelWithRedirections).to receive(:http).and_return(@mock_http)
+    ModelWithRedirections.configure(base_url: 'http://api.carwow.co.uk/')
   end
 
   describe '#post' do

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'pry'
 require 'rspec'
 require 'rspec/its'
 require_relative '../lib/restful_resource'
@@ -65,3 +66,10 @@ def expect_post_with_unprocessable_entity(url, response, data: {})
   exception = RestfulResource::HttpClient::UnprocessableEntity.new(request, rest_client_response)
   expect(@mock_http).to receive(:post).with(url, data: data, headers: {}, open_timeout: nil, timeout: nil).and_raise(exception)
 end
+
+def expect_delete_with_unprocessable_entity(url, response)
+  request = RestfulResource::Request.new(:delete, url)
+  rest_client_response = OpenStruct.new(body: response.body, headers: response.headers, code: response.status)
+  exception = RestfulResource::HttpClient::UnprocessableEntity.new(request, rest_client_response)
+  expect(@mock_http).to receive(:delete).with(url, headers: {}, open_timeout: nil, timeout: nil).and_raise(exception)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.10.0
 platform: ruby
 authors:
 - David Santoro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,47 +96,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday-cdn-metrics
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: faraday-encoding
   requirement: !ruby/object:Gem::Requirement
@@ -155,30 +169,30 @@ dependencies:
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: link_header
   requirement: !ruby/object:Gem::Requirement
@@ -197,30 +211,30 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: A simple activerecord inspired rest resource base class implemented using
   rest-client
 email:
@@ -237,6 +251,7 @@ files:
 - ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -288,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A simple activerecord inspired rest resource base class implemented using