json_api_filter 0.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0e5c959706685cf6cc047d4824c7ed0e0c35778b6b952aa3b305e5e0eb40f13
-  data.tar.gz: 3a87503e2341ae745d0ec6b5154049c95b0a28b527aeb8903ed000e53685bf3b
+  metadata.gz: 5471c30a61e8ea40ce7e68b4ce5782c7a690bb9ec05db87b4945e43d1c0e1e0a
+  data.tar.gz: 8aea59cea05e034f6f33e8405fe1faa939fbf558887f704d296c7c6033b993b0
 SHA512:
-  metadata.gz: fee62197e5d3814185e35f7935b76daba4c96dcabd2e655e250512f3267e8295512fffe16301df3b18b089c4eb5b5cbed1a120793dd60518929aa666ba16b5e2
-  data.tar.gz: c183c0a031bac479dfa66baf3cb90a9ef6735719c7dc61a12fcbda50412a0239e5dcd6ca4ebd3ddffae23588f9cd90793123a79cd2a44107723a9f869b5d4b2f
+  metadata.gz: c4ef69f9954823df0f90f60f092c1bc948960096a7a61ddd16c8bc6d17f29eacf40a050ba9f203790ac5063a5868ce2f60a88fb2ed758117e0a000e74abe6ebd
+  data.tar.gz: 35d7ffff9ff7e409633e81701ead53db2ee8267fb54e768b4698c697a75c1ea5ff6afb4d66709713ea6765969b0eac35d88c70bd5f3279812d3f53ab8b11be93

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_api_filter (0.2)
+    json_api_filter (0.3.2)
       activesupport (>= 3.0.0)
 
 GEM
@@ -84,11 +84,11 @@ GEM
     marcel (1.0.1)
     method_source (1.0.0)
     mini_mime (1.0.3)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
     nio4r (2.5.7)
-    nokogiri (1.11.2)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
     racc (1.5.2)
     rack (2.2.3)

data/README.md

@@ -2,9 +2,9 @@
 
 Filter for rails controller based on JsonAPI spec: `/books?filter[library_id]=1,2&filter[author_id][eq]=12&filter[created_at][gt]=2021-02-02`
 
-[![Maintainability](https://api.codeclimate.com/v1/badges/f620f88131ea9d8ff650/maintainability)](https://codeclimate.com/github/Blaked84/json_api_filter/maintainability)
+[![Maintainability](https://api.codeclimate.com/v1/badges/92a4a44d4af2bfa3b27d/maintainability)](https://codeclimate.com/github/evalmee/json_api_filter/maintainability)
 [![Gem Version](https://badge.fury.io/rb/json_api_filter.svg)](https://badge.fury.io/rb/json_api_filter)
-[![Build Status](https://travis-ci.com/Blaked84/json_api_filter.svg?branch=master)](https://travis-ci.com/Blaked84/json_api_filter)
+[![Build Status](https://travis-ci.com/evalmee/json_api_filter.svg?branch=master)](https://travis-ci.com/evalmee/json_api_filter)
 
 ## Installation
 
@@ -28,7 +28,7 @@ $ gem install json_api_filter
 
 ### Quick start
 
-To filter this request `/books?filter[library_id]=1,2&filter[author_id]=12&search=Lord of the ring`
+To filter this request `/books?filter[library_id]=1,2&filter[author_id]=12&search=Lord of the ring&include=users,users.posts`
 
 ```ruby
 class Book < ApplicationController
@@ -36,19 +36,80 @@ class Book < ApplicationController
   include JsonApiFilter
   permitted_filters  %i[library_id author_id]
   permitted_searches :user_search
-  
+  permitted_inclusions %i[users users.posts]
+
   def index
     @books = json_api_filter(Book, params)
+    inclusions = json_api_inclusions(params) # returns [:users, :'users.posts']
+
+    # then use `inclusions` in the serialiser
+    BookSerializer.new(@books, include: inclusions).serializable_hash.to_json
   end
-    
 end
 
 ```
 
 - `permitted_filters` let you define allowed attributes to filter on (mandatory)
 - `permitted_searches` let you define the allowed search method defined in you model what will be called if you pass `search` params in your request (can be a pg_search scope)
+- `permitted_inclusions` let you define the allowed inclusions
 - `json_api_filter(scope, params)` return an active record relation (`Book::` in this example)
+
+# Use inclusions in serializers
+
+# Handling errors
+
+If an endpoint does not support the include parameter, it MUST respond with 400 Bad Request to any requests that include it.
+
+```ruby
+class Book < ApplicationController
+
+  include JsonApiFilter
+  permitted_filters  %i[library_id author_id]
+  permitted_searches :user_search
+  
+  rescue_from JsonApiFilter::MissingPermittedInclusionError, with: :render_400
+
+  def index
+    @books = json_api_filter(Book, params)
+    inclusions = json_api_inclusions(params) # raises JsonApiFilter::MissingPermittedInclusionError
+  end
+  
+  private
   
+  def render_400(exception)
+    render json: exception, status: 400
+  end
+end
+```
+
+If a server is unable to identify a relationship path or does not support inclusion of resources from a path, it MUST respond with 400 Bad Request.
+This request should return a 400 status:
+
+ `/books?filter[library_id]=1,2&filter[author_id]=12&search=Lord of the ring&include=users,users.posts, users.addresses`
+
+```ruby
+class Book < ApplicationController
+
+  include JsonApiFilter
+  permitted_filters  %i[library_id author_id]
+  permitted_searches :user_search
+  permitted_inclusions %i[users users.posts]
+
+  rescue_from JsonApiFilter::UnknownInclusionsError, with: :render_400
+
+  def index
+    @books = json_api_filter(Book, params)
+    inclusions = json_api_inclusions(params) # raises JsonApiFilter::UnknownInclusionsError
+  end
+
+  private
+
+  def render_400(exception)
+    render json: exception, status: 400
+  end
+end
+```
+
 ## Migration from 0.1
 0.2.x version is not compatible with 0.1
 In your controller, you will have to replace all occurrences of `attr_filter` as bellow :

data/lib/json_api_filter/version.rb

@@ -1,3 +1,3 @@
 module JsonApiFilter
-  VERSION = "0.2"
+  VERSION = "0.3.2"
 end

data/lib/json_api_filter.rb

@@ -19,6 +19,24 @@ module JsonApiFilter
     end
   end
 
+  class MissingPermittedInclusionError < ::StandardError
+    def message
+      "PERMITTED_INCLUSIONS are required"
+    end
+  end
+
+  class UnknownInclusionsError < ::StandardError
+    attr_reader :item
+    def initialize(item)
+      super(message)
+      @item = item
+    end
+
+    def message
+      "Unable to identify #{item} as a relationship path or inclusion"
+    end
+  end
+
   extend ::ActiveSupport::Concern
   included do
   
@@ -36,6 +54,17 @@ module JsonApiFilter
       ).process
     end
 
+    def json_api_inclusions(params)
+      inclusions_params = params.fetch(:include, "").split(",").map(&:to_sym).uniq
+      unknown_inclusion = inclusions_params.find { |resource| json_api_permitted_inclusions.exclude?(resource) }
+
+      # If a server is unable to identify a relationship path or does not support inclusion of resources from a path,
+      # it MUST respond with 400 Bad Request.
+      raise UnknownInclusionsError, unknown_inclusion if unknown_inclusion.present?
+
+      inclusions_params
+    end
+
     def self.permitted_filters(val)
       define_singleton_method(:json_api_permitted_filters) do
         val
@@ -55,5 +84,21 @@ module JsonApiFilter
     def self.json_api_permitted_searches
       {}
     end
+
+    def self.permitted_inclusions(inclusions)
+      define_singleton_method(:json_api_permitted_inclusions) do
+        inclusions
+      end
+    end
+
+    # If an endpoint does not support the include parameter,
+    # it MUST respond with 400 Bad Request to any requests that include it.
+    def self.json_api_permitted_inclusions
+      raise MissingPermittedInclusionError
+    end
+
+    def json_api_permitted_inclusions
+      self.class.json_api_permitted_inclusions
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_filter
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.3.2
 platform: ruby
 authors:
 - Blaked
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -175,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Provide a filter for jsonAPI Controller in Rails