json_api_toolbox 1.0.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d86adcef9e00a063dd8fbc2f4931f97617944048
-  data.tar.gz: 21c6fffd1922e785c24c2c9c5c5ebd9de8f2a85c
+SHA256:
+  metadata.gz: 2bd96792ca86fca2089b5b5f5e837b0d5555e9d8ad549d17f4d2697034288c8c
+  data.tar.gz: be654d88ed537bae350035da7ef869a50dbde04271e491b693815398e3fdfb3a
 SHA512:
-  metadata.gz: 4405d86a77ddd9e18efb4168f8b93eef4a920119782700cc14c2e2d9bd501861f5339176b261afd0dc389f2b9abe947b21aeef79403dc6b1719e563878128ff4
-  data.tar.gz: e82e752c41c23a8fb914f2eae069e145fb84f522968e290ad5abb029f9839ecb5ffc3d51ef6fa2c2f372c1771a118899b22404b753df92a92ea83f34bc73b8a9
+  metadata.gz: 2a6b0f774066482fe66821665f9a39cdb55e7f345b765fe1ad7c131994595a2c98fdc8853b0b3314f0e317a450babb944cc1052c92caaaa6405e8710eb86c86e
+  data.tar.gz: 4ab8137ebee0a96c5ee2680b1725a206632d31b69281e0d86be0f4fea7596331a60ef3ea243d7e536781ed1088bb5c489735deef75871c67846f02c87cf88d7b

data/CHANGELOG.md

@@ -4,8 +4,38 @@ 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.5.1] - 2021-05-26
+### Fixed
+- Fixed a pagination bug that happened when building the resource_path from the controller name
+
+## [1.5.0] - 2021-02-04
+### Added
+- Require `will_paginate`
+- Remove limit of version to `log_toolbox` dependence
+- Update ruby of 2.4.x to 2.5.x
+
+## [1.4.0] - 2020‑11‑16
+### Added
+- Adding per_page limit
+
+## [1.3.0] - 2020-02-19
+### Added
+- Remove gem rescue responsibility
+
+## [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

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/bitbucket-pipelines.yml

@@ -1,4 +1,4 @@
-image: ruby:2.4.1
+image: ruby:2.5.8
 
 pipelines:
   default:
@@ -15,6 +15,7 @@ pipelines:
       - step:
           script:
             - gem build json_api_toolbox.gemspec
+            - mkdir /root/.gem
             - curl -u $RUBYGEMS_USERNAME:$RUBYGEMS_PASSWORD https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials
             - chmod 0600 ~/.gem/credentials
             - gem push $(ls *.gem)

data/json_api_toolbox.gemspec

@@ -6,15 +6,16 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'json_api_toolbox/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'json_api_toolbox'
-  spec.version       = JsonApiToolbox::VERSION
-  spec.authors       = ['Adriano Bacha']
-  spec.email         = ['abacha@gmail.com']
+  spec.required_ruby_version  = '~> 2.5.0'
+  spec.name                   = 'json_api_toolbox'
+  spec.version                = JsonApiToolbox::VERSION
+  spec.authors                = ['Adriano Bacha']
+  spec.email                  = ['abacha@gmail.com']
 
-  spec.summary       = 'Json API usefull tools'
-  spec.homepage      = 'http://bitbucket.org/guideinvestimentos/json_api_toolbox'
+  spec.summary                = 'Json API usefull tools'
+  spec.homepage               = 'http://bitbucket.org/guideinvestimentos/json_api_toolbox'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files                  = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.require_paths = ['lib']
@@ -22,8 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'actionpack',           '>= 4.0.0'
   spec.add_dependency 'activerecord',         '>= 4.0.0'
   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 'json-api-vanilla',     '~> 1.0.1'
+  spec.add_dependency 'log_toolbox'
   spec.add_dependency 'request_store',        '~> 1.3.2'
   spec.add_dependency 'rest-client',          '>= 2.0.1'
   spec.add_dependency 'rspec',                '>= 3.0.0'

data/lib/json_api_toolbox.rb

@@ -8,6 +8,8 @@ require 'postable'
 require 'service'
 require 'jsonapi/serializable'
 require 'json_api_toolbox/paginable'
+require 'will_paginate'
+require 'will_paginate/active_record'
 
 require_relative 'json_api_toolbox/spec_support/shared_examples_for_controllers'
 require_relative 'json_api_toolbox/serializables/serializable_enum_option'

data/lib/json_api_toolbox/paginable.rb

@@ -2,6 +2,9 @@
 
 module JsonApiToolbox
   module Paginable
+    DEFAULT_PER_PAGE = 20
+    MAX_PER_PAGE = 100
+
     def pagination_meta(collection_resource)
       {
         'current-page': collection_resource.current_page,
@@ -30,14 +33,23 @@ module JsonApiToolbox
       end
     end
 
+    def per_page
+      return DEFAULT_PER_PAGE if params[:per_page].nil?
+
+      per_page_limit = (ENV['MAX_PER_PAGE'] || MAX_PER_PAGE).to_i
+
+      [per_page_limit, params[:per_page].to_i].min
+    end
+
+    private
+
     def create_page_link(link, page)
-      link_path = collection_resource_path(page: page,
-                                           per_page: params[:per_page])
+      link_path = collection_resource_path(page: page, per_page: per_page)
       { link => link_path }
     end
 
     def collection_resource_path(options)
-      path_method = "#{controller_name.pluralize.underscore}_path"
+      path_method = "#{controller_path.parameterize.pluralize.underscore}_path"
       public_send(path_method, options)
     end
   end

data/lib/json_api_toolbox/spec_support/shared_examples_for_controllers.rb

@@ -37,10 +37,11 @@ module JsonApiToolbox
         let(:model_keys) do
           enums = []
           model.new.attributes.keys.map do |attr|
-            if attr.match?(/_cd$/)
+            case attr
+            when /_cd$/
               enums << attr
               attr.gsub(/_cd/, '')
-            elsif attr.match?(/_id$|^id$/)
+            when /_id$|^id$/
               nil
             else
               attr
@@ -72,6 +73,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.0.0'
+  VERSION = '1.5.1'
 end

data/lib/postable.rb

@@ -11,7 +11,7 @@ module JsonApiToolbox
           hash_value = check_child_association(value, key, model, child_model)
           [key, hash_value]
         end
-        Hash[normalized_hash]
+        normalized_hash.to_h
       end
 
       private

data/lib/renderizable.rb

@@ -20,9 +20,9 @@ module JsonApiToolbox
     def fields
       return {} unless fields?
 
-      params[:fields].permit!.to_h.map do |field, attributes|
-        [field, attributes.split(',')]
-      end.to_h
+      params[:fields].permit!.to_h.transform_values do |attributes|
+        attributes.split(',')
+      end
     end
 
     def permitted_params
@@ -82,9 +82,8 @@ module JsonApiToolbox
     end
 
     def build_error_options(object, options)
-      if options[:status].blank?
-        options = options.merge(status: :unprocessable_entity)
-      end
+      options = options.merge(status: :unprocessable_entity) if options[:status].blank?
+
       { jsonapi_errors: object.errors }.merge(options)
     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

data/lib/service.rb

@@ -6,19 +6,17 @@ 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)
+      Service.parse_response(request)
     end
 
     def request
@@ -28,8 +26,6 @@ module JsonApiToolbox
         payload: build_body,
         headers: build_header
       )
-    rescue RestClient::ExceptionWithResponse => e
-      e.response
     end
 
     def build_header
@@ -38,7 +34,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 +44,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.0.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Adriano Bacha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: json-api-vanilla
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: jsonapi-serializable
+  name: log_toolbox
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -273,17 +287,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Json API usefull tools