restful_resource 2.8.0 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c511ad574a9784552504e068391cf15f73bdbbf4f89c42d725ecfd64221e772f
-  data.tar.gz: 84ac5026baabbe9433a51f4cac7e01e79c8ce28fb9a2175d98277024de0d76b6
+  metadata.gz: f91745b5168b3296b8088ea1c102145b894680ae31fa008527f301324ae37730
+  data.tar.gz: f431b9d44f4d187ac6ef6fb11cd1ada2cb2a3b8fde7778a89f99b195cb4028d4
 SHA512:
-  metadata.gz: ab6abfd19fa1cc2466d44583741f806616d338d865139860b8d088b7a9dd2a021d70966d59d2bb10839e13cc26d8c0f715c5d87c7061c9b9c9dcbad75df28c49
-  data.tar.gz: d2b5848f1554b203817b026141db8853b774a655d50e1a8766ab19bb2c09e735c07825a7ced98274dadb9834c9209da029eb4e0a8d6dff72b9befe074bb92765
+  metadata.gz: f385b176d47a81a6f72a5181aa57a96942e50df3441b29aa41609a1dbb530baea1c8e16e7669a295e8cb5d6a9bf190bb12ffed2805ee97be58e4649f27721af7
+  data.tar.gz: 618550d814e19931476b14a8c645f3583432618152ca8d17c15ecd83dff192c23a62e3e7848d3ac4efb1a38c9a854131578ec2da0c656e93a402c699b4c9349d

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    restful_resource (2.8.0)
+    restful_resource (2.9.1)
       activesupport
-      faraday (~> 0.15.0)
+      faraday (>= 0.15, < 1.1)
       faraday-cdn-metrics
       faraday-encoding
       faraday-http-cache
@@ -15,15 +15,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.1)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2)
     ast (2.4.0)
-    carwow_rubocop (3.0.4)
-      rubocop (>= 0.68)
+    carwow_rubocop (3.2.1)
+      rubocop (>= 0.78)
       rubocop-performance
       rubocop-rspec
     coderay (1.1.2)
@@ -31,7 +31,7 @@ GEM
     diff-lcs (1.3)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    faraday (0.15.4)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
     faraday-cdn-metrics (0.1.0)
       faraday (~> 0.11)
@@ -39,25 +39,25 @@ GEM
       faraday
     faraday-http-cache (2.0.0)
       faraday (~> 0.8)
-    faraday_middleware (0.13.1)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.11.2)
-    i18n (1.7.0)
+    ffi (1.12.1)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
+    jaro_winkler (1.5.4)
     link_header (0.0.8)
     method_source (0.9.2)
-    minitest (5.13.0)
+    minitest (5.14.0)
     multipart-post (2.1.1)
-    parallel (1.18.0)
-    parser (2.6.5.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.7)
+    rack (2.1.2)
     rainbow (3.0.0)
-    rake (13.0.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -76,25 +76,25 @@ GEM
     rspec-support (3.9.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.75.1)
+    rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.0)
+    rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.36.0)
+    rubocop-rspec (1.37.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     thread_safe (0.3.6)
     typhoeus (1.3.1)
       ethon (>= 0.9.0)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
-    zeitwerk (2.2.1)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
@@ -110,4 +110,4 @@ DEPENDENCIES
   rspec_junit_formatter
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/lib/restful_resource/base.rb

@@ -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)

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.8.0'.freeze
+  VERSION = '2.9.1'.freeze
 end

data/restful_resource.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-its'
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'faraday', '~> 0.15.0'
+  spec.add_dependency 'faraday', '>= 0.15', '< 1.1'
   spec.add_dependency 'faraday-cdn-metrics'
   spec.add_dependency 'faraday-encoding'
   spec.add_dependency 'faraday-http-cache'

data/spec/restful_resource/http_client_spec.rb

@@ -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
-
-    it 'patch should raise error 409' do
-      connection = faraday_connection do |stubs|
-        stubs.patch('http://httpbin.org/status/409') { |_env| [409, {}, nil] }
-      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}"
 
-      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

data/spec/restful_resource/rails_validations_spec.rb

@@ -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/spec_helper.rb

@@ -65,3 +65,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.8.0
+  version: 2.9.1
 platform: ruby
 authors:
 - David Santoro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,16 +113,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: faraday-cdn-metrics
   requirement: !ruby/object:Gem::Requirement