json_api_toolbox 1.3.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af58f7d3d2dc113db2fd9a34cad4e6861aee871f
-  data.tar.gz: 93a83be02bb1c09da703f1aa274a9005761f8b6f
+SHA256:
+  metadata.gz: 07cee6578d3ec72b85799bb88a7b8f0fee45c63950516209dca50d65ee0d4bcb
+  data.tar.gz: 9e6171341031bba7809a8337256d882e05ee5b11095bedd58e2f7ff2f62000d3
 SHA512:
-  metadata.gz: 90a1513719aa4bfe47a83dd800c1e23d0a12bb9856ca1b490d90a564b2d3d3928052fb4ca85ab6cbd9585349481c5de14a95b2f0a2e86fa5284de7eaa635983f
-  data.tar.gz: 4365c231d6a15e8f55509270011d09203cb0e3b47c9bb5024caeee7795a3d0b7f5a9d400166ed1c568f63e852204623556991606ecd562061106b58015158dc7
+  metadata.gz: 24ab8d780ec3b8a21ace2100b29c8f60593bc01cef3f23dbe81a6d3993687aa7c3a93a22dd6e04c9647de17b62f693452c8e7b1a40941d191459879f89342c35
+  data.tar.gz: 5aa57f37c3c11b462755ab90a3d85986ade02bdbb9d1d5a78a3f6ac5df025f5ee73eeb23ba9011277ace4a3a3742626a516ef8d62573976156d30cdc50bec496

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -10,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.rubocop.base.yml

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from:
+  - '.rubocop.base.yml'
+
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false

data/.version

@@ -0,0 +1 @@
+2.0.1

data/CHANGELOG.md

@@ -5,9 +5,45 @@ 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]
+
+## [2.0.1] - 2021-08-13
+### Fixed
+- Fixed a constant loading problem on rails
+
+## [2.0.0] - 2021-06-23
 ### Added
+- New README file describing the gem and it's uses
+- Added support for default rubocop config
+- New setup script
+- Added docker to run rubocop and rspec 
+
+### Changed
+- New 2.0 branch! With better support for semver and ruby updates
+- Moved the rspec examples file for easier manual import
+- Updated all dependencies
+- Moved some dependencies into development dependencies
+
+### Removed
+- Removed support for ruby 2.5 series
+- Removed unneeded files (old CI files, ruby version lock, etc…)
+- Removed auto import for rspec examples. It now need to be added manually on `rails_helper.rb`
 
 ## [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

data/Dockerfile

@@ -0,0 +1,18 @@
+FROM ruby:2.6-alpine
+
+RUN apk update \
+    && apk upgrade \
+    && apk add --update \
+    git \
+    openssh \
+    build-base \
+    && rm -rf /var/cache/apk/*
+
+RUN gem update --system
+
+WORKDIR /gem
+COPY . .
+
+ENTRYPOINT ["sh", "docker-entrypoint.sh"]
+
+CMD ["rake", "lint-and-test"]

data/Gemfile.lock

@@ -0,0 +1,239 @@
+PATH
+  remote: .
+  specs:
+    json_api_toolbox (2.0.1)
+      activerecord (>= 5.1.0)
+      activesupport (>= 5.1.0)
+      json-api-vanilla
+      jsonapi-serializable
+      log_toolbox
+      request_store
+      rest-client
+      will_paginate
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4)
+      actionpack (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activesupport (= 6.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4)
+      actionpack (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4)
+      activesupport (= 6.1.4)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activestorage (6.1.4)
+      actionpack (= 6.1.4)
+      activejob (= 6.1.4)
+      activerecord (= 6.1.4)
+      activesupport (= 6.1.4)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.10.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json-api-vanilla (1.0.2)
+    jsonapi-renderer (0.2.2)
+    jsonapi-serializable (0.3.1)
+      jsonapi-renderer (~> 0.2.0)
+    log_toolbox (1.3.11)
+      lograge (>= 0.11.1)
+      logstash-event (>= 1.2.02)
+      logstash-logger (>= 0.26.1)
+      rails (>= 5.0)
+    lograge (0.11.2)
+      actionpack (>= 4)
+      activesupport (>= 4)
+      railties (>= 4)
+      request_store (~> 1.0)
+    logstash-event (1.2.02)
+    logstash-logger (0.26.1)
+      logstash-event (~> 1.2)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
+    mini_mime (1.1.0)
+    minitest (5.14.4)
+    netrc (0.11.0)
+    nio4r (2.5.8)
+    nokogiri (1.12.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.12.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4)
+      actioncable (= 6.1.4)
+      actionmailbox (= 6.1.4)
+      actionmailer (= 6.1.4)
+      actionpack (= 6.1.4)
+      actiontext (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activemodel (= 6.1.4)
+      activerecord (= 6.1.4)
+      activestorage (= 6.1.4)
+      activesupport (= 6.1.4)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    request_store (1.5.0)
+      rack (>= 1.4)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.19.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    shoulda-matchers (5.0.0)
+      activesupport (>= 5.2.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    will_paginate (3.3.1)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  json_api_toolbox!
+  pry-byebug
+  rake
+  rspec
+  rubocop
+  shoulda-matchers
+
+BUNDLED WITH
+   2.2.25

data/README.md

@@ -1,42 +1,32 @@
 # JsonApiToolbox
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_api_toolbox`. To experiment with that code, run `bin/console` for an interactive prompt.
+This toolbox serve as a JSON API helper within Guide TI specs
 
-TODO: Delete this and the text above, and describe your gem
+The current features are:
+- Integrates the gems `jsonapi-serializable`, `json-api-vanilla` and `log_toolbox`
+- Rspec support through a series of shares examples
+- Suport for JSON API services
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line in your `Gemfile`:
 
-```ruby
-gem 'json_api_toolbox'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install json_api_toolbox
+    gem 'json_api_toolbox'
 
-## Usage
+then execute:
 
-TODO: Write usage instructions here
+    $ bundle install
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+For rspec support, add this line on your `rails_helper.rb`:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    require 'json_api_toolbox/rspec'
 
-## Contributing
+## Usage Examples
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/abacha/json_api_toolbox.
+You can check some gem uses within the examples below:
 
-## Examples
+### Service
 
-#Service
 ```ruby
 class MyService < JsonApiToolbox::Service
   BASE_URL = 'http://localhost:3000/my_model'
@@ -61,9 +51,10 @@ class MyService < JsonApiToolbox::Service
 end
 ```
 
-#Renderizable
+### Renderizable
+
+A simple render:
 
-Render common
 ```ruby
 render_object(Quota.all)
 ```
@@ -76,7 +67,7 @@ new Hash, the key must be 'Hash' and the value must be your Serializable.
 render_object(QuotaGap.all, class: { Hash: SerializableQuotaGap })
 ```
 
-#Paginable
+### Paginable
 
 To render a collection with a json api pagination, you will need to send a Hash
 that contains two keys called 'links' and 'meta', and its values must be Hashs.
@@ -96,35 +87,33 @@ class MyController
 end
 ```
 
-##ShareExamplesForControllers
+### Rspec Shared Examples
 
-it_behaves_like 'a http method'
-  validate if your response have http status 200
+`it_behaves_like 'a http method'`
+- validate if your response have http status 200
 
-it_behaves_like 'a get method'
-  validate if your response have http status 200
-  validate if your response responde to body method
+`it_behaves_like 'a get method'`
+- validate if your response have http status 200
+- validate if your response responde to body method
 
-it_behaves_like 'a json api response with included node'
-  validate if yor response.body has included node
+`it_behaves_like 'a json api response with included node'`
+- validate if yor response.body has included node
 
-it_behaves_like 'a get with jsonapi with default value of', SomeModel
-  validate if all attributes are present on your data
-  obs:
-    1 - for enums who have '_cd' in the end of attribute name, '_cd' is removed.
-      ex: enum_cd => enum
-    2 - id attributes are removed from validation
-    3 - for attributes who have _id in the end of attribute name, they are
-    removed from validation
+`it_behaves_like 'a get with jsonapi with default value of', SomeModel`
+- validate if all attributes are present on your data based on the current criteria:
+  1. for enums who have `_cd` in the end of attribute name, `_cd` is removed.
 
-it_behaves_like 'a json api response with all relations of', SomeModel
-  validate if all relations are included on your data
+      ex: `enum_cd` => `enum`
+  1. id attributes are removed from validation
+  1. for attributes who have `_id` in the end of attribute name, they are removed from validation
 
-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.
+`it_behaves_like 'a json api response with all relations of', SomeModel`
+- validate if all relations are included on your data
 
-## Example Tests
+`it_behaves_like 'a failed attempt to retrieve a resource'`
+- checks if the api response will include an error when `find` raise a exception retrieving a resource.
 
+## Test example
 
 ```ruby
 # frozen_string_literal: true
@@ -221,3 +210,26 @@ RSpec.describe ManagersController, type: :controller do
   end
 end
 ```
+
+## Development
+
+To change the gem is simple, just clone this repository and run the `bin/setup` script
+
+Then you can make your changes and check them with `rspec` or `rubocop .`.
+
+
+### On docker
+
+#### Building
+```bash
+  docker build . -t json-api-toolbox-dev
+```
+
+#### Running tests
+```bash
+  docker run --rm -it -v "$(echo $HOME)/.ssh:/root/.ssh" -v "$(pwd):/gem" json-api-toolbox-dev
+```
+
+## Contributing
+
+> To be written

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
 
-task :default => :spec
+task default: :spec
+
+desc 'Execute both RuboCop and RSpec'
+task "lint-and-test" => [:lint, :spec]

data/bin/docker

@@ -0,0 +1,61 @@
+#! /usr/bin/env sh
+
+NAMETAG="json-api-toolbox:dev"
+COMMAND=${1:-help}
+shift
+
+command_help() {
+    echo "
+Usage:  docker COMMAND [code]
+
+A simple script to control the project container
+
+Commands:
+  run                      Run [code] on a new container
+  exec                     Run [code] on the current active container
+  build                    Build the project image
+  help                     Show this help message
+"
+}
+
+command_build() {
+    docker build -t $NAMETAG --ssh=default . 
+}
+
+config_ssh_agent() {
+  if [ uname == "Darwin" ]; then
+    AUTH_PATH="/run/host-services/ssh-auth.sock"
+  else 
+    AUTH_PATH=$(echo $SSH_AUTH_SOCK)
+  fi
+
+  echo "-v $(echo $HOME)/.ssh:/root/.ssh \
+        -v $(echo $AUTH_PATH):/ssh-agent \
+        -e SSH_AUTH_SOCK=/ssh-agent \
+  "
+}
+
+command_run() {
+    [[ $1 == "--build" ]] && { command_build; shift; }
+
+    docker volume create bundler_cache > /dev/null
+    docker run -it \
+               -v bundler_cache:/usr/local/bundle \
+               -v $(pwd):/gem \
+               $(config_ssh_agent) \
+               $NAMETAG
+               $@
+}
+
+command_exec() {
+    [[ $1 == "--build" ]] && { command_build; shift; }
+
+    docker exec $NAMETAG $@
+}
+
+case $COMMAND in
+  build) command_build "$@" ;;
+  exec)  command_exec  "$@" ;;
+  run)   command_run   "$@" ;;
+  *)     command_help  "$@" ;;
+esac

data/bin/setup.sh

@@ -0,0 +1,57 @@
+#! /bin/sh
+
+DEFAULT_REPO=git@bitbucket.org:guideinvestimentos/rails_defaults.git
+STRICT=${1:-no}
+ONE_WEEK_AGO=$(( $(date +%s) - 604800 ))
+
+if [ -f .rubocop.base.yml ]; then
+  FILE_TIME=$(date -r .rubocop.base.yml +%s)
+fi
+
+info(){
+  printf "\033[34;1m$1\033[0m\n"
+}
+
+step(){
+  printf " - $1: \0337\n"
+}
+
+success(){
+  printf "\0338\033[1A\033[32;1mOK!\033[0m\n\033[2K"
+}
+
+skipped(){
+  printf "\0338\033[1A\033[33;1mSKIPPED ($1)\033[0m\n\033[2K"
+}
+
+error() {
+  printf "\0338\033[1A\033[31;1mERRO!\033[0m\n\033[2K"
+  printf "\033[31m  $1\033[0m\n"
+  [ $STRICT -eq "--strict" ] && exit $2
+}
+
+info "Configurando o projeto\n"
+
+step "Atualizando configuração base do Rubocop"
+
+if [ ${FILE_TIME:-0} -lt $ONE_WEEK_AGO ]; then
+  RUBOCOP_FILE=$(git archive --remote=$DEFAULT_REPO HEAD .rubocop.yml 2> /dev/null  | tar xO 2> /dev/null)
+
+  if [ -z "$RUBOCOP_FILE" ]; then
+    error "Não foi possível baixar o arquivo de configuração" 1
+  else
+    echo "$RUBOCOP_FILE" > .rubocop.base.yml
+    success
+  fi
+else
+  skipped "Arquivo recente"
+fi
+
+step "Instalando dependências"
+
+bundle check 2>&1 > /dev/null && skipped "up-to date" || {
+  RESULT=$(bundle install 2>&1 > /dev/null)
+  [ $? -eq "0" ] && success || error "$RESULT" 2
+}
+
+info "\nConfiguração executada com sucesso"

data/bitbucket-pipelines.yml

@@ -1,20 +1,56 @@
-image: ruby:2.4.1
+image: ruby:2.6
 
-pipelines:
-  default:
-    - step:
+definitions:
+  caches:
+    bundler-26: vendor/bundle
+    bundler-27: vendor/bundle
+    bundler-30: vendor/bundle
+
+  steps:
+    - step: &test
+        name: Testing
+        script: 
+          - apt-get install git
+          - gem update --system
+          - bundle config set --local path "vendor/bundle"
+          - bin/setup.sh --strict
+          - bundle exec rake lint-and-test
+    - step: &release
+        name: Release gem
         script:
-          - git archive --remote=git@bitbucket.org:guideinvestimentos/rails_defaults.git HEAD .rubocop.yml | tar -x
+          - apt-get install git
+          - gem update --system
+          - bundle config set --local path "vendor/bundle"
           - bundle install
-          - gem install rubocop
-          - rspec -fdoc
-          - rubocop .
+          - mkdir -p ~/.gem/
+          - curl -sSL -u $RUBYGEMS_USERNAME:$RUBYGEMS_PASSWORD https://rubygems.org/api/v1/api_key.yaml -o ~/.gem/credentials
+          - chmod 0600 ~/.gem/credentials
+          - bundle exec rake release --trace
 
+pipelines:
+  pull-requests:
+    '**':
+      - parallel:
+        - step:
+            <<: *test
+            name: Ruby 2.6
+            image: ruby:2.6
+            caches:
+              - bundler-26
+        - step:
+            <<: *test
+            name: Ruby 2.7
+            image: ruby:2.7
+            caches:
+              - bundler-27
+        - step:
+            <<: *test
+            name: Ruby 3.0
+            image: ruby:3.0
+            caches:
+              - bundler-30
   branches:
     master:
-      - step:
-          script:
-            - gem build json_api_toolbox.gemspec
-            - curl -u $RUBYGEMS_USERNAME:$RUBYGEMS_PASSWORD https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials
-            - chmod 0600 ~/.gem/credentials
-            - gem push $(ls *.gem)
+      - step: *release
+    'branch-1.x':
+      - step: *release

data/docker-entrypoint.sh

@@ -0,0 +1,3 @@
+#! /bin/sh
+
+. bin/setup.sh && bundle exec "$@"

data/json_api_toolbox.gemspec

@@ -1,41 +1,38 @@
 # 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'
 
 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.6.0'
+  spec.name                   = 'json_api_toolbox'
+  spec.version                = JsonApiToolbox::VERSION
 
-  spec.summary       = 'Json API usefull tools'
-  spec.homepage      = 'http://bitbucket.org/guideinvestimentos/json_api_toolbox'
+  spec.authors                = ['Adriano Bacha']
+  spec.email                  = ['abacha@gmail.com']
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  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|
     f.match(%r{^(test|spec|features)/})
   end
   spec.require_paths = ['lib']
 
-  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 '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'
-  spec.add_dependency 'will_paginate',        '>= 3.1.0'
+  spec.add_dependency 'activerecord',  '>= 5.1.0'
+  spec.add_dependency 'activesupport', '>= 5.1.0'
+  spec.add_dependency 'jsonapi-serializable'
+  spec.add_dependency 'json-api-vanilla'
+  spec.add_dependency 'log_toolbox'
+  spec.add_dependency 'request_store'
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'will_paginate'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'json'
-  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
+  spec.add_development_dependency 'shoulda-matchers'
 end
-# rubocop:enable Metrics/BlockLength

data/lib/json_api_toolbox.rb

@@ -8,8 +8,9 @@ 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'
 require_relative 'json_api_toolbox/serializables/serializable_job'
 require_relative 'json_api_toolbox/serializables/serializable_version'

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/rspec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module JsonApiToolbox
+  module Rspec
+    RSpec.shared_examples 'a http method' do
+      it 'returns http success' do
+        expect(response).to have_http_status(:success)
+      end
+    end
+
+    RSpec.shared_examples 'a post with status 422 Unprocessable Entity' do
+      it 'returns http code 422 Unprocessable Entity' do
+        expect(response).to have_http_status(422)
+      end
+    end
+
+    RSpec.shared_examples 'a get method' do
+      it_behaves_like 'a http method'
+
+      it 'response with JSON body' do
+        expect { response.body }.not_to raise_exception
+      end
+    end
+
+    RSpec.shared_examples 'a json api response with included node' do
+      it 'returns with included node' do
+        expect(JSON.parse(response.body)['included'].count).not_to eql(0)
+      end
+    end
+
+    RSpec.shared_examples 'a get with jsonapi with default value of' do |model|
+      let(:attributes) { data['attributes'].keys }
+      let(:model_keys) do
+        enums = []
+        model.new.attributes.keys.map do |attr|
+          case attr
+          when /_cd$/
+            enums << attr
+            attr.gsub(/_cd/, '')
+          when /_id$|^id$/
+            nil
+          else
+            attr
+          end
+        end.compact + enums
+      end
+
+      it 'returns response with default values' do
+        expect((model_keys & attributes).size).to eq(model_keys.size)
+      end
+    end
+
+    RSpec.shared_examples 'a json api response with all relations of' do |model|
+      let(:attributes) { data['relationships'].keys }
+      let(:relation_keys) { model.reflections.keys }
+
+      it 'returns response with default relationships' do
+        expect(attributes).to match_array(relation_keys)
+      end
+    end
+
+    RSpec.shared_examples 'a json api response' do
+      let(:body) { JSON.parse(response.body) }
+      let(:data) { body['data'].first }
+
+      it { expect(body).to have_key('data') }
+      it { expect(data).to have_key('type') }
+      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

data/lib/json_api_toolbox/version.rb

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

data/lib/postable.rb

@@ -7,11 +7,11 @@ module JsonApiToolbox
         associations = model.reflect_on_all_associations.map(&:name)
         normalized_hash = hash.map do |key, value|
           child_model = association_class(model, key) if value.is_a? Hash
-          key = associations.include?(key.to_sym) ? "#{key}_attributes" : key
+          key = "#{key}_attributes" if associations.include?(key.to_sym)
           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

metadata

@@ -1,155 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: json_api_toolbox
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Adriano Bacha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: jsonapi-serializable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json-api-vanilla
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-- !ruby/object:Gem::Dependency
-  name: jsonapi-serializable
   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: log_toolbox
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: request_store
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-- !ruby/object:Gem::Dependency
-  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -221,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -234,20 +206,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
 description: 
 email:
 - abacha@gmail.com
@@ -257,22 +215,27 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".version"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
+- bin/docker
+- bin/setup.sh
 - bitbucket-pipelines.yml
+- docker-entrypoint.sh
 - json_api_toolbox.gemspec
 - lib/enums.rb
 - lib/json_api_toolbox.rb
 - lib/json_api_toolbox/paginable.rb
+- lib/json_api_toolbox/rspec.rb
 - lib/json_api_toolbox/serializables/serializable_enum_option.rb
 - lib/json_api_toolbox/serializables/serializable_exception.rb
 - lib/json_api_toolbox/serializables/serializable_job.rb
 - lib/json_api_toolbox/serializables/serializable_version.rb
-- lib/json_api_toolbox/spec_support/shared_examples_for_controllers.rb
 - lib/json_api_toolbox/version.rb
 - lib/postable.rb
 - lib/renderizable.rb
@@ -289,15 +252,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.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.2.25
 signing_key: 
 specification_version: 4
 summary: Json API usefull tools

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.5.0

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.5
-before_install: gem install bundler -v 1.15.1

data/lib/json_api_toolbox/spec_support/shared_examples_for_controllers.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require 'rspec'
-
-module JsonApiToolbox
-  module SpecSupport
-    module SharedExamplesForControllers
-      RSpec.shared_examples 'a http method' do
-        it 'returns http success' do
-          expect(response).to have_http_status(:success)
-        end
-      end
-
-      RSpec.shared_examples 'a post with status 422 Unprocessable Entity' do
-        it 'returns http code 422 Unprocessable Entity' do
-          expect(response).to have_http_status(422)
-        end
-      end
-
-      RSpec.shared_examples 'a get method' do
-        it_behaves_like 'a http method'
-
-        it 'response with JSON body' do
-          expect { response.body }.not_to raise_exception
-        end
-      end
-
-      RSpec.shared_examples 'a json api response with included node' do
-        it 'returns with included node' do
-          expect(JSON.parse(response.body)['included'].count).not_to eql(0)
-        end
-      end
-
-      RSpec.
-        shared_examples 'a get with jsonapi with default value of' do |model|
-        let(:attributes) { data['attributes'].keys }
-        let(:model_keys) do
-          enums = []
-          model.new.attributes.keys.map do |attr|
-            if attr.match?(/_cd$/)
-              enums << attr
-              attr.gsub(/_cd/, '')
-            elsif attr.match?(/_id$|^id$/)
-              nil
-            else
-              attr
-            end
-          end.compact + enums
-        end
-
-        it 'returns response with default values' do
-          expect((model_keys & attributes).size).to eq(model_keys.size)
-        end
-      end
-
-      RSpec.
-        shared_examples 'a json api response with all relations of' do |model|
-        let(:attributes) { data['relationships'].keys }
-        let(:relation_keys) { model.reflections.keys }
-
-        it 'returns response with default relationships' do
-          expect(attributes).to match_array(relation_keys)
-        end
-      end
-
-      RSpec.shared_examples 'a json api response' do
-        let(:body) { JSON.parse(response.body) }
-        let(:data) { body['data'].first }
-
-        it { expect(body).to have_key('data') }
-        it { expect(data).to have_key('type') }
-        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