json_api_toolbox 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf01239707604258774757a852af9f3abcb8016a
-  data.tar.gz: 384bf04edfce2f0433704f59e7e93610d65a7d46
+  metadata.gz: 7038c336858ee4ac23c97beaab29792b1ded14e7
+  data.tar.gz: 94f61f5dee12030051d01bf760aed3e8976fa78b
 SHA512:
-  metadata.gz: 13bd778d079b84c75676ea9eedadbcfe605c1051f5114588133072dfa038e6258f8e22643b340f888decbf117ef308135898e33b2c6304f0c8963a2a10762748
-  data.tar.gz: 9176fb7de866f06e100bbec0b510fa9afdc27cae6baba03ca23f3290004383d0c80502a3c441c4d69457fb5efdcd4813d4f16020f29482a1a7463f7c165912f8
+  metadata.gz: 51f83d87385cce4c0830c6dbede7e304f5ffe47e32de626e5aed3915a54d9eb3962eb8146218bf5689aa0a90c14a27ffc3d57ff0fe7c66710279508b86f80d10
+  data.tar.gz: 4056d9c5a4fe7a1457b8a5afb76d98302beac94a0faf5b5afcd02f88aba23403ea133b9f0f0486ac3ddd032d0a4192e61b273f5b425e79c859c8a711ae78a743

data/CHANGELOG.md

@@ -4,7 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Added
+
 ## [Released]
+## [1.2.0] - 2020-01-16
+### Added
+- Added param `headers` to `#get`, `#post`, `#patch`, `#put`, to send extra headers
+- Added new shared example `a failed attempt to retrieve a resource`
 
 ## [1.1.0] - 2019-05-28
 ### Added

data/README.md

@@ -120,6 +120,9 @@ it_behaves_like 'a get with jsonapi with default value of', SomeModel
 it_behaves_like 'a json api response with all relations of', SomeModel
   validate if all relations are included on your data
 
+it_behaves_like 'a failed attempt to retrieve a resource'
+  check if the api response will include an error when `find` raise a exception retrieving a resource.
+
 ## Example Tests
 
 
@@ -158,6 +161,12 @@ RSpec.describe ManagersController, type: :controller do
       it_behaves_like 'a json api response with included node'
       it_behaves_like 'a json api response with all relations of', Manager
       it_behaves_like 'a get with jsonapi with default value of', Manager
+
+      context 'When the manager does not exist' do
+        before { get :show, params: { id: 300 } }
+
+        it_behaves_like 'a failed attempt to retrieve a resource'
+      end
     end
   end
 
@@ -202,6 +211,12 @@ RSpec.describe ManagersController, type: :controller do
       it 'validates if values were updated' do
         expect(data['attributes']['name']).to eq(new_name)
       end
+
+      context 'When the manager does not exist' do
+        before { get :show, params: { id: 300 } }
+
+        it_behaves_like 'a failed attempt to retrieve a resource'
+      end
     end
   end
 end

data/lib/json_api_toolbox/spec_support/shared_examples_for_controllers.rb

@@ -72,6 +72,14 @@ module JsonApiToolbox
         it { expect(data).to have_key('id') }
         it { expect(data).to have_key('attributes') }
       end
+
+      RSpec.shared_examples 'a failed attempt to retrieve a resource' do
+        let(:errors) { JSON.parse(response.body)['errors'] }
+
+        it 'returns response with error\'s title including RecordNotFound' do
+          expect(errors.first['title']).to eq('ActiveRecord::RecordNotFound')
+        end
+      end
     end
   end
 end

data/lib/json_api_toolbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonApiToolbox
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/service.rb

@@ -6,12 +6,13 @@ require 'json-api-vanilla'
 
 module JsonApiToolbox
   class Service
-    attr_reader :http_method, :url, :body
+    attr_reader :http_method, :url, :body, :extra_headers
 
-    def initialize(http_method, url, body)
+    def initialize(http_method, url, body, extra_headers = {})
       @http_method = http_method
       @url = url
       @body = body
+      @extra_headers = extra_headers
     end
 
     def execute
@@ -38,7 +39,7 @@ module JsonApiToolbox
         'Content-Type' => 'application/json'
       }
       headers[:params] = body if http_method == :get
-      headers
+      headers.merge(extra_headers)
     end
 
     def build_body
@@ -48,21 +49,21 @@ module JsonApiToolbox
     end
 
     class << self
-      def get(url: nil, includes: nil, query_string: nil)
+      def get(url: nil, includes: nil, query_string: nil, headers: {})
         body = build_query_string(includes, query_string)
-        new(:get, url, body).execute
+        new(:get, url, body, headers).execute
       end
 
-      def post(url: nil, body: nil)
-        new(:post, url, body).execute
+      def post(url: nil, body: nil, headers: {})
+        new(:post, url, body, headers).execute
       end
 
-      def patch(url: nil, body: nil)
-        new(:patch, url, body).execute
+      def patch(url: nil, body: nil, headers: {})
+        new(:patch, url, body, headers).execute
       end
 
-      def put(url: nil, body: nil)
-        new(:put, url, body).execute
+      def put(url: nil, body: nil, headers: {})
+        new(:put, url, body, headers).execute
       end
 
       def parse_response(response)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_toolbox
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Adriano Bacha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2020-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack