fetcheable_on_api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe1436fc856be39403a098964fd749c327d478b1cd4caa23776b030fa44dbb05
-  data.tar.gz: 382385b75448f082476ec23adfd4d360b5aa53b8a8cdfb072de4f1dcecf94d63
+  metadata.gz: '03812339432d5b98fc4b5c21a591fa89f6d4682e04ffbafca240e24c45bfa9fe'
+  data.tar.gz: 4156ce0dd1ab15dfc3c84b28b3caeb6bc45c8aec203ffd9d35b2995a16d78512
 SHA512:
-  metadata.gz: 913c31f970e2a6592a0aeab78f4f2e64d37074c120782fff145a7766e1e62a1d6469cf3dc36ec20ff09ff06a98d9978ba035e6a63cebc8beccb71eb96e398e69
-  data.tar.gz: 9ea51948fc95741f8e751a1371de3f7cdee1ea725751cc814df1b5916ab7c9e09adbc096f84e23ef70e1a20ca3590ec3fa0f75b428a60704ef934ae3d14304b5
+  metadata.gz: 4b1e81ab96273f468b159de0fb3bcf366762c63e5743dcb6098b127ed7daa5e63a548f943a1de461022a757a930517f0cacd7dc88bd03e83e90f837393ceb6d5
+  data.tar.gz: c41a76a9bd81d7450e3b8c236b375aaa78359474d435f927de89a3a2109723e4570b1d212285a29e06f7f22528cb3eed78b93b99c5ad2ac74c50189dcd8c1d68

data/README.md

@@ -46,17 +46,23 @@ class Question < ApplicationRecord
           foreign_key: 'question_id',
           dependent: :destroy,
           inverse_of: :question
+
+  belongs_to :category,
+             class_name: 'Category',
+             inverse_of: :questions,
+             optional: true
 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
+#  id          :bigint(8)        not null, primary key
+#  content     :text             not null
+#  position    :integer
+#  category_id :bigint(8)
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
 #
 ```
 
@@ -88,6 +94,34 @@ end
 #  updated_at  :datetime         not null
 #
 ```
+
+```ruby
+class Category < ApplicationRecord
+  #
+  # Validations
+  #
+  validates :name,
+            presence: true
+
+  #
+  # Associations
+  #
+  has_many :questions,
+           class_name: 'Question',
+           inverse_of: :category
+end
+
+# == Schema Information
+#
+# Table name: categories
+#
+#  id          :bigint(8)        not null, primary key
+#  name        :text             not null
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#
+```
+
 And controller:
 
 ```ruby
@@ -128,18 +162,21 @@ $ curl -X GET \
     {
         "id": 3,
         "position": 1,
+        "category_id": 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,
+        "category_id": 2,
         "content": "Is it so simple?",
         "answer": "Yes"
     },
     {
         "id": 5,
         "position": 3,
+        "category_id": 2,
         "content": "Is this real life?",
         "answer": "Yes this is real life"
     }
@@ -170,18 +207,21 @@ $ curl -X GET \
     {
         "id": 3,
         "position": 1,
+        "category_id": 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,
+        "category_id": 2,
         "content": "Is it so simple?",
         "answer": "Yes"
     },
     {
         "id": 5,
         "position": 3,
+        "category_id": 2,
         "content": "Is this real life?",
         "answer": "Yes this is real life"
     }
@@ -198,18 +238,21 @@ $ curl -X GET \
     {
         "id": 5,
         "position": 3,
+        "category_id": 2,
         "content": "Is this real life?",
         "answer": "Yes this is real life"
     },
     {
         "id": 4,
         "position": 2,
+        "category_id": 2,
         "content": "Is it so simple?",
         "answer": "Yes"
     },
     {
         "id": 3,
         "position": 1,
+        "category_id": 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"
     }
@@ -229,12 +272,14 @@ $ curl -X GET \
     {
         "id": 3,
         "position": 1,
+        "category_id": 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,
+        "category_id": 2,
         "content": "Is it so simple?",
         "answer": "Yes"
     }
@@ -247,6 +292,7 @@ $ curl -X GET \
     {
         "id": 5,
         "position": 3,
+        "category_id": 2,
         "content": "Is this real life?",
         "answer": "Yes this is real life"
     }
@@ -288,6 +334,7 @@ $ curl -X GET \
     {
         "id": 3,
         "position": 1,
+        "category_id": 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"
     }
@@ -304,12 +351,14 @@ $ curl -X GET \
     {
         "id": 4,
         "position": 2,
+        "category_id": 2,
         "content": "Is it so simple?",
         "answer": "Yes"
     },
     {
         "id": 5,
         "position": 3,
+        "category_id": 2,
         "content": "Is this real life?",
         "answer": "Yes this is real life"
     }
@@ -345,12 +394,50 @@ $ curl -X GET \
     {
         "id": 3,
         "position": 1,
+        "category_id": 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"
     }
 ]
 ```
 
+Furthermore you can specify one of the supported `Arel` predicate.
+
+```ruby
+class QuestionsController < ActionController::Base
+  #
+  # FetcheableOnApi
+  #
+  filter_by :category_id, with: :eq
+
+  # GET /questions
+  def index
+    questions = apply_fetcheable(Question.includes(:answer).all)
+    render json: questions
+  end
+end
+```
+
+```bash
+$ curl -X GET \
+  'http://localhost:3000/questions?filter[category_id]=1'
+
+[
+    {
+        "id": 3,
+        "position": 1,
+        "category_id": 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"
+    }
+]
+```
+
+Currently two kind of predicates are supported:
+
++ `:ilike` which is the default behaviour and will match the parameter with the SQL fragment `ILIKE '%foo%'`.
++ `:eq` which matches the parameter with the SQL fragment `= 'foo'`.
+
 And that's all !
 
 ## Development

data/lib/fetcheable_on_api/filtreable.rb

@@ -21,7 +21,7 @@ module FetcheableOnApi
       def filter_by(*attrs)
         options = attrs.extract_options!
         options.symbolize_keys!
-        options.assert_valid_keys(:as, :class_name)
+        options.assert_valid_keys(:as, :class_name, :with)
 
         self.filters_configuration = filters_configuration.dup
 
@@ -45,10 +45,8 @@ module FetcheableOnApi
     protected
 
     def apply_filters(collection)
-      return collection unless valid_parameters?(params)
-      return collection unless valid_parameters?(params[:filter])
-
       return collection if params[:filter].blank?
+      valid_parameters!(:filter)
 
       filter_params = params.require(:filter)
                             .permit(filters_configuration.keys)
@@ -58,8 +56,16 @@ module FetcheableOnApi
         values.split(',').map do |value|
           column_name = filters_configuration[column.to_sym].fetch(:as, column)
           klass       = filters_configuration[column.to_sym].fetch(:class_name, collection.klass)
+          predicate   = filters_configuration[column.to_sym].fetch(:with, :ilike)
 
-          klass.arel_table[column_name].matches("%#{value}%")
+          case predicate
+          when :ilike
+            klass.arel_table[column_name].matches("%#{value}%")
+          when :eq
+            klass.arel_table[column_name].eq(value)
+          else
+            raise ArgumentError, "unsupported predicate `#{predicate}`"
+          end
         end.inject(:or)
       end
 

data/lib/fetcheable_on_api/pagineable.rb

@@ -20,9 +20,8 @@ module FetcheableOnApi
     protected
 
     def apply_pagination(collection)
-      return collection unless valid_parameters?(params)
-      return collection unless valid_parameters?(params[:page])
-      return collection unless params[:page].present?
+      return collection if params[:page].blank?
+      valid_parameters!(:page)
 
       limit = params[:page].fetch(
         :size,

data/lib/fetcheable_on_api/sortable.rb

@@ -48,10 +48,8 @@ module FetcheableOnApi
     protected
 
     def apply_sort(collection)
-      return collection unless valid_parameters?(params)
-      return collection unless valid_parameters?(params[:sort])
-
       return collection if params[:sort].blank?
+      valid_parameters!(:sort, permitted_types: [String])
 
       ordering      = {}
       sorted_params = params[:sort].split(',')

data/lib/fetcheable_on_api/version.rb

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

data/lib/fetcheable_on_api.rb

@@ -54,9 +54,24 @@ module FetcheableOnApi
     apply_pagination(collection)
   end
 
-  def valid_parameters?(parameters)
-    parameters.is_a?(ActionController::Parameters) ||
-      parameters.is_a?(Hash)
+  def valid_parameters!(*keys, permitted_types: default_permitted_types)
+    raise ArgumentError.new(
+      "Incorrect type #{params.dig(*keys).class} for params #{keys}"
+    ) unless valid_params_types(*keys, permitted_types: permitted_types)
+  end
+
+  def valid_params_types(*keys, permitted_types: default_permitted_types)
+    permitted_types.inject(false) do |res, type|
+      res || valid_params_type(params.dig(*keys), type)
+    end
+  end
+
+  def valid_params_type(value, type)
+    value.is_a?(type)
+  end
+
+  def default_permitted_types
+    [ActionController::Parameters, Hash]
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fetcheable_on_api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Fabien
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport