fetcheable_on_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e306962ed07df291f4da84e7a48ea260f4da40dd
+  data.tar.gz: 9feabe197b5dada9b5f6d6da92f4a1689c069667
+SHA512:
+  metadata.gz: ec029100a872fd1b7b271f462511a155d6c78995ee9a7c07758f92bbc9ba45cdb716fe99060897ecca10c5aa4d8cb690cdded97a2599d6ff031e890e80377ea0
+  data.tar.gz: 86e4291e7a000d6116bc9f9d520860ed1fb9e725310c4f8faed50f2abb7a1ca944288955e949d93377499c19ec0ac1c058f7815c37bc325b219a4f1f49ae0632

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fabien@tymate.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fetcheable_on_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    fetcheable_on_api (0.1.0)
+      activesupport (>= 4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fetcheable_on_api!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.59.2)
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Fabien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,336 @@
+
+# FetcheableOnApi
+
+FetcheableOnApi allows you to quickly and easily set up a filter system based on the JSONAPI specification for ActiveRecord objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fetcheable_on_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fetcheable_on_api
+
+## Usage
+
+Imagine the following models called question and answer:
+
+```ruby
+class Question < ApplicationRecord
+  #
+  # Validations
+  #
+  validates :content,
+            presence: true
+
+  #
+  # Associations
+  #
+  has_one :answer,
+          class_name: 'Answer',
+          foreign_key: 'question_id',
+          dependent: :destroy,
+          inverse_of: :question
+end
+
+# == Schema Information
+#
+# Table name: questions
+#
+#  id         :bigint(8)        not null, primary key
+#  content    :text             not null
+#  position   :integer
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+```
+
+```ruby
+class Answer < ApplicationRecord
+  #
+  # Validations
+  #
+  validates :content,
+            presence: true
+
+  #
+  # Associations
+  #
+  belongs_to :question,
+             class_name: 'Question',
+             foreign_key: 'question_id',
+             inverse_of: :answer
+end
+
+# == Schema Information
+#
+# Table name: answers
+#
+#  id          :bigint(8)        not null, primary key
+#  content     :text             not null
+#  question_id :bigint(8)
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#
+```
+And controller:
+
+```ruby
+class QuestionsController < ActionController::Base
+  # GET /questions
+  def index
+    questions = Question.joins(:answer).includes(:answer).all
+    render json: questions
+  end
+end
+```
+
+### Sorting
+
+You can now define the allowed attribute(s) in the sorting of the collection like this:
+
+```ruby
+class QuestionsController < ActionController::Base
+  #
+  # FetcheableOnApi
+  #
+  sort_by :position
+
+  # GET /questions
+  def index
+    questions = apply_fetcheable(Question.joins(:answer).includes(:answer).all)
+    render json: questions
+  end
+end
+```
+This allows you to pass a new parameter in the query:
+
+```bash
+$ curl -X GET \
+  'http://localhost:3000/questions?sort=position'
+
+[
+    {
+        "id": 3,
+        "position": 1,
+        "content": "How to simply sort a collection with this gem ?",
+        "answer": "Just add sort_by in your controller and call the apply_fetcheable method"
+    },
+    {
+        "id": 4,
+        "position": 2,
+        "content": "Is it so simple?",
+        "answer": "Yes"
+    },
+    {
+        "id": 5,
+        "position": 3,
+        "content": "Is this real life?",
+        "answer": "Yes this is real life"
+    }
+]
+```
+
+FetcheableOnApi support multiple sort fields by allowing comma-separated (U+002C COMMA, “,”) sort fields:
+```ruby
+class QuestionsController < ActionController::Base
+  #
+  # FetcheableOnApi
+  #
+  sort_by :position, :id
+
+  # GET /questions
+  def index
+    questions = apply_fetcheable(Question.joins(:answer).includes(:answer).all)
+    render json: questions
+  end
+end
+```
+
+```bash
+$ curl -X GET \
+  'http://localhost:3000/questions?sort=position,id'
+
+[
+    {
+        "id": 3,
+        "position": 1,
+        "content": "How to simply sort a collection with this gem ?",
+        "answer": "Just add sort_by in your controller and call the apply_fetcheable method"
+    },
+    {
+        "id": 4,
+        "position": 2,
+        "content": "Is it so simple?",
+        "answer": "Yes"
+    },
+    {
+        "id": 5,
+        "position": 3,
+        "content": "Is this real life?",
+        "answer": "Yes this is real life"
+    }
+]
+```
+
+The default sort order for each sort field is ascending unless it is prefixed with a minus (U+002D HYPHEN-MINUS, “-“), in which case it is descending:
+
+```bash
+$ curl -X GET \
+  'http://localhost:3000/questions?sort=-position'
+
+[
+    {
+        "id": 5,
+        "position": 3,
+        "content": "Is this real life?",
+        "answer": "Yes this is real life"
+    },
+    {
+        "id": 4,
+        "position": 2,
+        "content": "Is it so simple?",
+        "answer": "Yes"
+    },
+    {
+        "id": 3,
+        "position": 1,
+        "content": "How to simply sort a collection with this gem ?",
+        "answer": "Just add sort_by in your controller and call the apply_fetcheable method"
+    }
+]
+```
+
+### Pagination
+
+Pagination is automatically set on the controller and allows the use of a new parameter `page`.
+The pagination is page-based strategy, it can use query parameters such as `page[number]` and `page[size]`
+
+```bash
+$ curl -X GET \
+  'http://localhost:3000/questions?page[number]=1&page[size]=2'
+
+[
+    {
+        "id": 3,
+        "position": 1,
+        "content": "How to simply sort a collection with this gem ?",
+        "answer": "Just add sort_by in your controller and call the apply_fetcheable method"
+    },
+    {
+        "id": 4,
+        "position": 2,
+        "content": "Is it so simple?",
+        "answer": "Yes"
+    }
+]
+
+$ curl -X GET \
+  'http://localhost:3000/questions?page[number]=2&page[size]=2'
+
+[
+    {
+        "id": 5,
+        "position": 3,
+        "content": "Is this real life?",
+        "answer": "Yes this is real life"
+    }
+]
+```
+
+### Filtering
+
+The `filter` query parameter is reserved for filtering data and the controller must set the attributes allowed to be filtered.
+
+```ruby
+class QuestionsController < ActionController::Base
+  #
+  # FetcheableOnApi
+  #
+  sort_by :position, :id
+  filter_by :content
+
+  # GET /questions
+  def index
+    questions = apply_fetcheable(Question.joins(:answer).includes(:answer).all)
+    render json: questions
+  end
+end
+```
+
+```bash
+$ curl -X GET \
+  'http://localhost:3000/questions?filter[content]=gem'
+
+[
+    {
+        "id": 3,
+        "position": 1,
+        "content": "How to simply sort a collection with this gem ?",
+        "answer": "Just add sort_by in your controller and call the apply_fetcheable method"
+    }
+]
+```
+
+You can also define a filter through an association like this:
+
+```ruby
+class QuestionsController < ActionController::Base
+  #
+  # FetcheableOnApi
+  #
+  sort_by :position, :id
+  filter_by :content
+  filter_by :answer,
+            class_name: Answer,
+            as: 'content'
+
+  # GET /questions
+  def index
+    questions = apply_fetcheable(Question.joins(:answer).includes(:answer).all)
+    render json: questions
+  end
+end
+```
+
+```bash
+$ curl -X GET \
+  'http://localhost:3000/questions?filter[answer]=apply_fetcheable'
+
+[
+    {
+        "id": 3,
+        "position": 1,
+        "content": "How to simply sort a collection with this gem ?",
+        "answer": "Just add sort_by in your controller and call the apply_fetcheable method"
+    }
+]
+```
+
+And that's all !
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fetcheable_on_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FetcheableOnApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fetcheable_on_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fetcheable_on_api'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fetcheable_on_api.gemspec

@@ -0,0 +1,47 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fetcheable_on_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fetcheable_on_api'
+  spec.version       = FetcheableOnApi::VERSION
+  spec.authors       = ['Fabien']
+  spec.email         = ['fab.piette@gmail.com']
+
+  spec.summary       = 'A controller filters engine gem'\
+                       ' based on jsonapi spec.'
+  spec.description   = 'A controller filters engine gem'\
+                       ' based on jsonapi spec.'
+  spec.homepage      = 'https://github.com/FabienPiette/fetcheable_on_api.git'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org.
+  # To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete
+  # this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to
+  # the gem when it is released.
+  # The `git ls-files -z` loads the files in
+  # the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+                     .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.59.2'
+end

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 4.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_head.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activesupport', github: 'rails/rails'
+
+gemspec path: "../"

data/lib/fetcheable_on_api.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'fetcheable_on_api/filtreable'
+require 'fetcheable_on_api/pagineable'
+require 'fetcheable_on_api/sortable'
+require 'fetcheable_on_api/version'
+require 'active_support'
+
+module FetcheableOnApi
+  #
+  # Supports
+  #
+
+  #
+  # Public class methods
+  #
+  def self.included(klass)
+    klass.class_eval do
+      include Filtreable
+      include Sortable
+      include Pagineable
+    end
+  end
+
+  #
+  # Public instance methods
+  #
+
+  #
+  # Protected instance methods
+  #
+  protected
+
+  def apply_fetcheable(collection)
+    collection = apply_sort(collection)
+    collection = apply_pagination(collection)
+    apply_filters(collection)
+  end
+end
+
+ActiveSupport.on_load :action_controller do
+  include Fetcheable
+end

data/lib/fetcheable_on_api/filtreable.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module FetcheableOnApi
+  module Filtreable
+    #
+    # Supports
+    #
+
+    #
+    # Public class methods
+    #
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        class_attribute :filters_configuration, :instance_writer => false
+        self.filters_configuration = {}
+      end
+    end
+
+    module ClassMethods
+      def filter_by(*attrs)
+        options = attrs.extract_options!
+        options.symbolize_keys!
+        options.assert_valid_keys(:as, :class_name)
+
+        self.filters_configuration = filters_configuration.dup
+
+        attrs.each do |attr|
+          filters_configuration[attr] ||= {
+            as: options[:as] || attr
+          }
+
+          filters_configuration[attr] = filters_configuration[attr].merge(options)
+        end
+      end
+    end
+
+    #
+    # Public instance methods
+    #
+
+    #
+    # Protected instance methods
+    #
+    protected
+
+    def apply_filters(collection)
+      return collection if params[:filter].blank?
+
+      filter_params = params.require(:filter)
+                            .permit(filters_configuration.keys)
+                            .to_hash
+
+      filtering = filter_params.map do |column, value|
+        column_name = filters_configuration[column.to_sym].fetch(:as, column)
+        klass       = filters_configuration[column.to_sym].fetch(:class_name, collection.klass)
+
+        klass.arel_table[column_name].matches("%#{value}%")
+      end
+
+      collection.where(filtering.inject(:and))
+    end
+  end
+end

data/lib/fetcheable_on_api/pagineable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FetcheableOnApi
+  module Pagineable
+    #
+    # Supports
+    #
+
+    #
+    # Public class methods
+    #
+
+    #
+    # Public instance methods
+    #
+
+    #
+    # Protected instance methods
+    #
+    protected
+
+    def apply_pagination(collection)
+      return collection if params[:page].blank?
+
+      limit  = params[:page].fetch(:size, 25).to_i
+      offset = (params[:page].fetch(:number, 1).to_i - 1) * limit
+
+      collection.limit(limit).offset(offset)
+    end
+  end
+end

data/lib/fetcheable_on_api/sortable.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module FetcheableOnApi
+  module Sortable
+    #
+    # Supports
+    #
+    SORT_ORDER = {
+      '+' => :asc,
+      '-' => :desc
+    }
+
+    #
+    # Public class methods
+    #
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        class_attribute :sorts_configuration, :instance_writer => false
+        self.sorts_configuration = {}
+      end
+    end
+
+    module ClassMethods
+      def sort_by(*attrs)
+        options = attrs.extract_options!
+        options.symbolize_keys!
+
+        self.sorts_configuration = sorts_configuration.dup
+
+        attrs.each do |attr|
+          sorts_configuration[attr] ||= {
+            as: attr
+          }
+
+          sorts_configuration[attr] = self.sorts_configuration[attr].merge(options)
+        end
+      end
+    end
+
+    #
+    # Public instance methods
+    #
+
+    #
+    # Protected instance methods
+    #
+    protected
+
+    def apply_sort(collection)
+      return collection if params[:sort].blank?
+
+      ordering      = {}
+      sorted_params = params[:sort].split(',')
+
+      sorted_params.each do |attr|
+        sort_sign = (attr =~ /\A[+-]/) ? attr.slice!(0) : '+'
+        klass     = collection.klass
+
+        if klass.attribute_names.include?(attr)
+          ordering[attr] = SORT_ORDER[sort_sign]
+        end
+      end
+
+      ordering.select! do |attr|
+        sorts_configuration.key?(attr.to_sym)
+      end
+
+      collection.order(ordering)
+    end
+  end
+end

data/lib/fetcheable_on_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FetcheableOnApi
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: fetcheable_on_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabien
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+description: A controller filters engine gem based on jsonapi spec.
+email:
+- fab.piette@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fetcheable_on_api.gemspec
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_head.gemfile
+- lib/fetcheable_on_api.rb
+- lib/fetcheable_on_api/filtreable.rb
+- lib/fetcheable_on_api/pagineable.rb
+- lib/fetcheable_on_api/sortable.rb
+- lib/fetcheable_on_api/version.rb
+homepage: https://github.com/FabienPiette/fetcheable_on_api.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A controller filters engine gem based on jsonapi spec.
+test_files: []