json_api_toolbox 0.16.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84d7e3e998fe1b7dd81c3c14ecca011b1865402b
-  data.tar.gz: afd1306f2819f14a7cdbd3a7efd0c5ad36ff562f
+  metadata.gz: 7038c336858ee4ac23c97beaab29792b1ded14e7
+  data.tar.gz: 94f61f5dee12030051d01bf760aed3e8976fa78b
 SHA512:
-  metadata.gz: 76b1f72a931e1544401e9e8e70457ea0a4ad30850d9a1d321de7f225b80d859ee9d2ddc6d41e3e86c3f6f53810d8ba2ba7282be5c1abc9aae8f117c433395fb9
-  data.tar.gz: 1200fe389638afd9d8e829c7cf1bf4be284238bbb413d299238bde81ee1cb5d48ec0c3218cba96f28e1528dc9f43671aa31bb88b32b6ec7625d4d958e369464e
+  metadata.gz: 51f83d87385cce4c0830c6dbede7e304f5ffe47e32de626e5aed3915a54d9eb3962eb8146218bf5689aa0a90c14a27ffc3d57ff0fe7c66710279508b86f80d10
+  data.tar.gz: 4056d9c5a4fe7a1457b8a5afb76d98302beac94a0faf5b5afcd02f88aba23403ea133b9f0f0486ac3ddd032d0a4192e61b273f5b425e79c859c8a711ae78a743

data/CHANGELOG.md

@@ -5,6 +5,31 @@ 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
+- Added log with log_toolbox
+
+## [1.0.0] - 2019-05-13
+### Added
+- Added status internal_server_error on exception renderizable
+- Added status unprocessable_entity on renderizable when object have errors
+
+## [0.17.0] - 2018-08-14
+### Added
+- Added support for `fields` parameter to renderizable according to jsonapi spec
+
+## [0.16.2] - 2018-08-14
+### Fixed
+- Fixed broken JsonApiToolbox::Service
+
 ## [0.16.1] - 2018-08-14
 ### Fixed
 - Fixed warning when payload body is a hash at JsonApiToolbox::Service

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/json_api_toolbox.gemspec

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/BlockLength
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'json_api_toolbox/version'
@@ -23,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport',        '>= 4.0.0'
   spec.add_dependency 'json-api-vanilla',     '~> 1.0.1'
   spec.add_dependency 'jsonapi-serializable', '>= 0.3.0'
+  spec.add_dependency 'log_toolbox',          '>= 1.0.0'
   spec.add_dependency 'request_store',        '~> 1.3.2'
   spec.add_dependency 'rest-client',          '>= 2.0.1'
   spec.add_dependency 'rspec',                '>= 3.0.0'
@@ -33,5 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/json_api_toolbox/paginable.rb

@@ -15,7 +15,7 @@ module JsonApiToolbox
     def pagination(collection_resource)
       {
         first: 1,
-        last:  collection_resource.total_pages,
+        last: collection_resource.total_pages,
         prev: collection_resource.previous_page,
         next: collection_resource.next_page
       }.reduce({}, &method(:page_links))

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 = '0.16.1'
+  VERSION = '1.2.0'
 end

data/lib/postable.rb

@@ -21,6 +21,7 @@ module JsonApiToolbox
           association_i.name.to_s == key.to_s
         end
         return false unless association
+
         class_name = (association.options.symbolize_keys[:class_name] || key)
         ActiveSupport::Inflector.singularize(class_name).camelize.constantize
       end

data/lib/renderizable.rb

@@ -4,10 +4,11 @@ module JsonApiToolbox
   module Renderizable
     def render_object(object, options = {})
       if object.respond_to?(:errors) && object.errors.any?
-        render({ jsonapi_errors: object.errors }.merge(options))
+        render(build_error_options(object, options))
       else
-        renderization =
-          { jsonapi: object, include: includes_params }.merge(options)
+        renderization = { jsonapi: object,
+                          include: includes_params,
+                          fields: fields }.merge(options)
         render(build_meta_data(object).merge(renderization))
       end
     end
@@ -16,6 +17,14 @@ module JsonApiToolbox
       params.fetch(:includes, {})
     end
 
+    def fields
+      return {} unless fields?
+
+      params[:fields].permit!.to_h.map do |field, attributes|
+        [field, attributes.split(',')]
+      end.to_h
+    end
+
     def permitted_params
       model = controller_name.singularize
       parsed_params = params.require(model).permit(permitted_attributes).to_h
@@ -46,6 +55,12 @@ module JsonApiToolbox
 
     private
 
+    def fields?
+      params[:fields].present? &&
+        params[:fields].respond_to?(:permit!) &&
+        params[:fields].permit!.to_h.respond_to?(:map)
+    end
+
     def model_name
       controller_name.singularize.camelize.constantize
     end
@@ -65,5 +80,12 @@ module JsonApiToolbox
         {}
       end
     end
+
+    def build_error_options(object, options)
+      if options[:status].blank?
+        options = options.merge(status: :unprocessable_entity)
+      end
+      { jsonapi_errors: object.errors }.merge(options)
+    end
   end
 end

data/lib/renderizable_exceptions.rb

@@ -11,7 +11,11 @@ module JsonApiToolbox
     end
 
     def render_any_exception(exception)
-      puts_build_log_error(exception)
+      if Gem.loaded_specs.key?('log_toolbox')
+        log_critical(exception)
+      else
+        puts_build_log_error(exception)
+      end
 
       render build_jsonapi(exception)
     end
@@ -25,7 +29,7 @@ module JsonApiToolbox
           source: {} },
         jsonapi_class: {
           class: { Hash: JsonApiToolbox::Serializables::SerializableException }
-        } }
+        }, status: :internal_server_error }
     end
 
     def puts_build_log_error(error)

data/lib/service.rb

@@ -6,23 +6,25 @@ 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
       response = request
       return if response.code == 404
+
       Service.parse_response(response)
     end
 
     def request
       RestClient::Request.execute(
-        http_method: http_method,
+        method: http_method,
         url: url,
         payload: build_body,
         headers: build_header
@@ -37,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
@@ -47,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: 0.16.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Adriano Bacha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2020-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: log_toolbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement