restful_resource 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 518adcf1420c8305d189766883817e8c71d8cd09ffe472270e2a2cfa0e6a1103
-  data.tar.gz: 82fdbfd0ace4c8c2e8aca022e60b6a55cf84177add1719fb9d5e55b504aacb84
+  metadata.gz: d1f405ccf5d3f49ac11166ce73e0268fc4203203a63b3e31999d9f2cfbc416bc
+  data.tar.gz: 6d07fc35aad7fcf4ee6d2a0236476bd30ac68bbea0cc252a85e5b6d79ad216b8
 SHA512:
-  metadata.gz: 9ae13ab26b3ce3d49061db7ca21f4ec1d41358120f54039e0b9f8a549aaf867a2e192b132173f52f7d38fb911c978fbffd0c74e8a574d4a64688d21a48b5b3f9
-  data.tar.gz: b5a9fe7a39f196739016b340c933d693126fceac8f93cc707bd8d1b69e13e7caf9c6a318a8e8bf36457ec0e2269c2038bf2389baf9abb4f08b90ca9828888398
+  metadata.gz: ff4a2dea42bcc6bdcd56f539757dad0b3c4ab185d4bf73be11d098176b7af030f4cce005addf6d5e9d6f907605de0406f81b53645110549ee67395b56bacc2f9
+  data.tar.gz: 75decbc1a7c0058bc7476efbf05981a6bee4771663e285734b3c587a41c4b61b26f87960717216d0a28ff5e1bcade60e7f025232dc577cb9a273d13844852d5e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+2.5.1
+---
+
+- Add support for `PATCH` in `RestfulResource::RailsValidation`
+- Improved specs for `PATCH` features
+
 2.5.0
 ---
 

data/lib/restful_resource/rails_validations.rb

@@ -1,18 +1,12 @@
 module RestfulResource
   module RailsValidations
     module ClassMethods
-      def put(id, data: {}, **)
-        super
-      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.merge(errors: errors)
-                 end
-        result = result.merge(id: id)
-        new(result)
+      def put(id, data: {}, **others)
+        with_validations(id, data: data) { super }
+      end
+
+      def patch(id, data: {}, **others)
+        with_validations(id, data: data) { super }
       end
 
       def post(data: {}, **)
@@ -25,7 +19,7 @@ module RestfulResource
 
       private
 
-      def with_validations(data: {})
+      def with_validations(id = nil, data: {})
         yield
       rescue HttpClient::UnprocessableEntity => e
         errors = parse_json(e.response.body)
@@ -35,6 +29,9 @@ module RestfulResource
                  else
                    data.merge(errors: errors)
                  end
+
+        result = result.merge(id: id) if id
+
         new(result)
       end
     end

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '2.5.0'.freeze
+  VERSION = '2.5.1'.freeze
 end

data/spec/restful_resource/base_spec.rb

@@ -204,6 +204,57 @@ RSpec.describe RestfulResource::Base do
     end
   end
 
+  describe '#patch' do
+    it 'patchs no data with no params' do
+      expected_response = RestfulResource::Response.new(body: { name: 'Audi' }.to_json, status: 200)
+      expect_patch('http://api.carwow.co.uk/makes/1', expected_response)
+
+      object = Make.patch(1)
+
+      expect(object.name).to eq 'Audi'
+    end
+
+    it 'patchs no data with no params passed' do
+      expected_response = RestfulResource::Response.new(body: { name: 'Audi' }.to_json, status: 200)
+      expect_patch('http://api.carwow.co.uk/makes/1?make_slug=Volkswagen', expected_response)
+
+      object = Make.patch(1, make_slug: 'Volkswagen')
+
+      expect(object.name).to eq 'Audi'
+    end
+
+    it 'patchs data with params passed' do
+      data = { make_slug: 'Audi' }
+
+      expected_response = RestfulResource::Response.new(body: { name: 'Audi' }.to_json, status: 200)
+      expect_patch('http://api.carwow.co.uk/makes/1', expected_response, data: data)
+
+      object = Make.patch(1, data: { make_slug: 'Audi' })
+
+      expect(object.name).to eq 'Audi'
+    end
+
+    it 'patchs data with params passed' do
+      data = { make_slug: 'Audi' }
+
+      expected_response = RestfulResource::Response.new(body: { name: 'Audi' }.to_json, status: 200)
+      expect_patch('http://api.carwow.co.uk/makes/1?make_slug=Volkswagen', expected_response, data: data)
+
+      object = Make.patch(1, data: data, make_slug: 'Volkswagen')
+
+      expect(object.name).to eq 'Audi'
+    end
+
+    it 'accepts custom headers' do
+      expect_patch('http://api.carwow.co.uk/makes/1',
+        RestfulResource::Response.new,
+        headers: { accept: 'application/json' }
+      )
+
+      Make.patch(1, data: {}, headers: { accept: 'application/json' })
+    end
+  end
+
   describe '#put' do
     it 'puts no data with no params' do
       expected_response = RestfulResource::Response.new(body: { name: 'Audi' }.to_json, status: 200)

data/spec/restful_resource/http_client_spec.rb

@@ -25,6 +25,16 @@ RSpec.describe RestfulResource::HttpClient do
       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
@@ -57,6 +67,22 @@ RSpec.describe RestfulResource::HttpClient do
       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
+
+      expect { http_client(connection).patch('http://httpbin.org/status/409') }.to raise_error(RestfulResource::HttpClient::Conflict)
+    end
+
+    it 'patch should raise error 422' do
+      connection = faraday_connection do |stubs|
+        stubs.patch('http://httpbin.org/status/422') { |_env| [422, {}, nil] }
+      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] }
@@ -89,6 +115,14 @@ RSpec.describe RestfulResource::HttpClient do
       expect { http_client(connection).post('http://httpbin.org/status/429') }.to raise_error(RestfulResource::HttpClient::TooManyRequests)
     end
 
+    it 'patch should raise error 502' do
+      connection = faraday_connection do |stubs|
+        stubs.patch('http://httpbin.org/status/502') { |_env| [502, {}, nil] }
+      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] }
@@ -105,6 +139,14 @@ RSpec.describe RestfulResource::HttpClient do
       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
+
+      expect { http_client(connection).patch('http://httpbin.org/status/503') }.to raise_error(RestfulResource::HttpClient::ServiceUnavailable)
+    end
+
     it 'put should raise error 503' do
       connection = faraday_connection do |stubs|
         stubs.put('http://httpbin.org/status/503') { |_env| [503, {}, nil] }
@@ -125,12 +167,14 @@ RSpec.describe RestfulResource::HttpClient 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] }
       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

data/spec/restful_resource/rails_validations_spec.rb

@@ -7,13 +7,78 @@ RSpec.describe RestfulResource::RailsValidations do
     allow(RestfulResource::Base).to receive(:http).and_return(@mock_http)
   end
 
-  context '#put without errors' do
+  context '#patch without errors' do
     before do
       data = { name: 'Barak' }
       expected_response = RestfulResource::Response.new(body: { name: 'Barak' }.to_json)
-      expect_put('http://api.carwow.co.uk/dealers/1', expected_response, data: data)
+      expect_patch('http://api.carwow.co.uk/dealers/1', expected_response, data: data)
 
-      @object = Dealer.put(1, data: data)
+      @object = Dealer.patch(1, data: data)
+    end
+
+    it 'returns object' do
+      expect(@object.name).to eq 'Barak'
+    end
+
+    it 'returns valid object' do
+      expect(@object).to be_valid
+    end
+  end
+
+  context '#patch with errors' do
+    before do
+      data = { name: 'Leonardo' }
+      @error = 'Cannot use Ninja Turtles names'
+      expected_response = RestfulResource::Response.new(body: { errors: [@error] }.to_json)
+      expect_patch_with_unprocessable_entity('http://api.carwow.co.uk/dealers/1', expected_response, data: data)
+
+      @object = Dealer.patch(1, data: data)
+    end
+
+    it 'has an error' do
+      expect(@object.errors.count).to eq 1
+    end
+
+    it 'has correct error' do
+      expect(@object.errors.first).to eq @error
+    end
+
+    it 'returns properly built object' do
+      expect(@object.name).to eq 'Leonardo'
+    end
+
+    it 'returns not valid object' do
+      expect(@object).not_to be_valid
+    end
+
+    it 'handles errors returned as root object' do
+      data = { name: 'Michelangelo' }
+      expected_response = RestfulResource::Response.new(body: @error.to_json)
+      expect_patch_with_unprocessable_entity('http://api.carwow.co.uk/dealers/1', expected_response, data: data)
+
+      @object = Dealer.patch(1, data: data)
+      expect(@object).not_to be_valid
+      expect(@object.errors).to eq @error
+    end
+
+    it 'returns the resource id as part of the response' do
+      data = { name: 'Michelangelo' }
+      expected_response = RestfulResource::Response.new(body: @error.to_json)
+      expect_patch_with_unprocessable_entity('http://api.carwow.co.uk/dealers/1', expected_response, data: data)
+
+      @object = Dealer.patch(1, data: data)
+      expect(@object).not_to be_valid
+      expect(@object.id).to be(1)
+    end
+  end
+
+  context '#patch 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)
+
+      @object = Dealer.patch(1, data: data)
     end
 
     it 'returns object' do

data/spec/spec_helper.rb

@@ -20,6 +20,12 @@ def expect_delete(url, response, headers: {}, open_timeout: nil, timeout: nil)
     .and_return(response)
 end
 
+def expect_patch(url, response, data: {}, headers: {}, open_timeout: nil, timeout: nil)
+  expect(@mock_http).to receive(:patch)
+    .with(url, data: data, headers: headers, open_timeout: open_timeout, timeout: timeout)
+    .and_return(response)
+end
+
 def expect_put(url, response, data: {}, headers: {}, open_timeout: nil, timeout: nil)
   expect(@mock_http).to receive(:put)
     .with(url, data: data, headers: headers, open_timeout: open_timeout, timeout: timeout)
@@ -39,6 +45,13 @@ def expect_get_with_unprocessable_entity(url, response)
   expect(@mock_http).to receive(:get).with(url, headers: {}, open_timeout: nil, timeout: nil).and_raise(exception)
 end
 
+def expect_patch_with_unprocessable_entity(url, response, data: {})
+  request = RestfulResource::Request.new(:patch, url, body: data)
+  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(:patch).with(url, data: data, headers: {}, open_timeout: nil, timeout: nil).and_raise(exception)
+end
+
 def expect_put_with_unprocessable_entity(url, response, data: {})
   request = RestfulResource::Request.new(:put, url, body: data)
   rest_client_response = OpenStruct.new(body: response.body, headers: response.headers, code: response.status)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - David Santoro