procore-sift 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f18552ca0480672282156cc7664312b98dbad772
-  data.tar.gz: 81612b0c72fa8827496fe23af9e804993d4d1484
+SHA256:
+  metadata.gz: 3faa95a328bd7cb7f4252ed830e08bb0032a367526b223f3b24857b955912c2d
+  data.tar.gz: ef52247a7f9fd757d18fa662f7b7d7e4f9ab49e45b80de9ae68e18690fba80d8
 SHA512:
-  metadata.gz: 0dc882e598295f080ead00b2b791ecbd5a86722ac7108ce37d00835b7c47790d4dc90d70140cc0bfd8d0b9f66b8b0861072b24e7c84f5ac69170365aedf82572
-  data.tar.gz: 753c9f44ea32b532bc1fb99d5d1b840255c3132eaf5bcfab5842eec2778439b2069e0c631d4a17aba4b41dec583b17f243e341c9f7557ea4aae1ae30ab785403
+  metadata.gz: aa7c02c0b73fcefc709b7030b636611ec6a821f14df32080fb21c4e4ddf0a50288ad298775bd8919196b47e30652e4d02a1303d1189d9e7703aadc435d7be54e
+  data.tar.gz: 4d1dfefa31e8b1537d9605d8724fa2fceb16739ed62300da2e38ec8a8ba4f567a47712b8b7fd82f52dc229495a14524896d7eab9dbbcfcde665fc9113dfe3ea6

data/README.md

@@ -46,6 +46,7 @@ Every filter must have a type, so that Sift knows what to do with it. The curren
 * time - Filter on a time column
 * datetime - Filter on a datetime column
 * scope - Filter on an ActiveRecord scope
+* jsonb - Filter on a jsonb column (supported only in PostgreSQL)
 
 ### Filter on Scopes
 Just as your filter values are used to scope queries on a column, values you
@@ -122,6 +123,36 @@ The following types support ranges
 * time
 * datetime
 
+### Filter on jsonb column
+
+Usually JSONB columns stores values as an Array or an Object (key-value), in both cases the parameter needs to be sent in a JSON format
+
+**Array**
+
+It should be sent an array in the URL Query parameters
+ * `?filters[metadata]=[1,2]`
+
+**key-value**
+
+It can be passed one or more Key values:
+ * `?filters[metadata]={"data_1":"test"}`
+ * `?filters[metadata]={"data_1":"test","data_2":"[1,2]"}`
+
+When the value is an array, it will filter records with those values or more, for example:
+
+* `?filters[metadata]={"data_2":"[1,2]"}`
+
+Will return records with next values stored in the JSONB column `metadata`:
+```ruby
+{ data_2: 1 }
+{ data_2: 2 }
+{ data_2: [1] }
+{ data_2: [2] }
+{ data_2: [1,2] }
+{ data_2: [1,2,3] }
+```
+
+
 ### Filter on JSON Array
 `int` type filters support sending the values as an array in the URL Query parameters. For example `?filters[id]=[1,2]`. This is a way to keep payloads smaller for GET requests. When URI encoded this will become `filters%5Bid%5D=%5B1,2%5D` which is much smaller the standard format of `filters%5Bid%5D%5B%5D=1&&filters%5Bid%5D%5B%5D=2`.
 

data/lib/procore-sift.rb

@@ -10,6 +10,7 @@ require "sift/scope_handler"
 require "sift/where_handler"
 require "sift/validators/valid_int_validator"
 require "sift/validators/valid_date_range_validator"
+require "sift/validators/valid_json_validator"
 
 module Sift
   extend ActiveSupport::Concern

data/lib/sift/parameter.rb

@@ -13,7 +13,8 @@ module Sift
       {
         supports_boolean: supports_boolean?,
         supports_ranges: supports_ranges?,
-        supports_json: supports_json?
+        supports_json: supports_json?,
+        supports_json_object: supports_json_object?
       }
     end
 
@@ -32,7 +33,11 @@ module Sift
     end
 
     def supports_json?
-      type == :int
+      [:int, :jsonb].include?(type)
+    end
+
+    def supports_json_object?
+      type == :jsonb
     end
 
     def supports_boolean?

data/lib/sift/type_validator.rb

@@ -4,6 +4,7 @@ module Sift
     DATETIME_RANGE_PATTERN = { format: { with: /\A.+(?:[^.]\.\.\.[^.]).+\z/, message: "must be a range" }, valid_date_range: true }.freeze
     DECIMAL_PATTERN = { numericality: true, allow_nil: true }.freeze
     BOOLEAN_PATTERN = { inclusion: { in: [true, false] }, allow_nil: true }.freeze
+    JSON_PATTERN = { valid_json: true }.freeze
 
     WHITELIST_TYPES = [:int,
                        :decimal,
@@ -13,7 +14,8 @@ module Sift
                        :date,
                        :time,
                        :datetime,
-                       :scope].freeze
+                       :scope,
+                       :jsonb].freeze
 
     def initialize(param, type)
       @param = param
@@ -32,6 +34,8 @@ module Sift
         DECIMAL_PATTERN
       when :boolean
         BOOLEAN_PATTERN
+      when :jsonb
+        JSON_PATTERN
       end
     end
 

data/lib/sift/validators/valid_json_validator.rb

@@ -0,0 +1,14 @@
+class ValidJsonValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    record.errors.add attribute, "must be a valid JSON" unless valid_json?(value)
+  end
+
+  private
+
+  def valid_json?(value)
+    value = value.strip if value.is_a?(String)
+    JSON.parse(value)
+  rescue JSON::ParserError
+    false
+  end
+end

data/lib/sift/value_parser.rb

@@ -5,6 +5,7 @@ module Sift
       @supports_boolean = options.fetch(:supports_boolean, false)
       @supports_ranges = options.fetch(:supports_ranges, false)
       @supports_json = options.fetch(:supports_json, false)
+      @supports_json_object = options.fetch(:supports_json_object, false)
       @value = normalized_value(value, type)
     end
 
@@ -15,26 +16,39 @@ module Sift
         elsif parse_as_boolean?
           boolean_value
         elsif parse_as_json?
-          array_from_json
+          supports_json_object ? parse_json_and_values : array_from_json
         else
           value
         end
     end
 
+    def parse_json(string)
+      JSON.parse(string)
+    rescue JSON::ParserError
+      string
+    end
+
+    def parse_json_and_values
+      parsed_jsonb = parse_json(value)
+      return parsed_jsonb if parsed_jsonb.is_a?(Array) || parsed_jsonb.is_a?(String)
+
+      parsed_jsonb.each_with_object({}) do |key_value, hash|
+        hash[key_value.first] = parse_json(key_value.last.to_s)
+      end
+    end
+
     def array_from_json
-      result = JSON.parse(value)
+      result = parse_json(value)
       if result.is_a?(Array)
         result
       else
         value
       end
-    rescue JSON::ParserError
-      value
     end
 
     private
 
-    attr_reader :value, :type, :supports_boolean, :supports_json, :supports_ranges
+    attr_reader :value, :type, :supports_boolean, :supports_json, :supports_json_object, :supports_ranges
 
     def parse_as_range?(raw_value=value)
       supports_ranges && raw_value.to_s.include?("...")

data/lib/sift/version.rb

@@ -1,3 +1,3 @@
 module Sift
-  VERSION = "0.13.0".freeze
+  VERSION = "0.14.0".freeze
 end

data/lib/sift/where_handler.rb

@@ -5,7 +5,28 @@ module Sift
     end
 
     def call(collection, value, _params, _scope_params)
-      collection.where(@param.internal_name => value)
+      if @param.type == :jsonb
+        apply_jsonb_conditions(collection, value)
+      else
+        collection.where(@param.internal_name => value)
+      end
+    end
+
+    private
+
+    def apply_jsonb_conditions(collection, value)
+      return collection.where("#{@param.internal_name} @> ?", val.to_s) if value.is_a?(Array)
+
+      value.each do |key, val|
+        condition = if val.is_a?(Array)
+          "('{' || TRANSLATE(#{@param.internal_name}->>'#{key}', '[]','') || '}')::int[] && ARRAY[?]"
+        else # Single Value
+          val = val.to_s
+          "#{@param.internal_name}->>'#{key}' = ?"
+        end
+        collection = collection.where(condition, val)
+      end
+      collection
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procore-sift
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Procore Technologies
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -115,6 +115,7 @@ files:
 - lib/sift/type_validator.rb
 - lib/sift/validators/valid_date_range_validator.rb
 - lib/sift/validators/valid_int_validator.rb
+- lib/sift/validators/valid_json_validator.rb
 - lib/sift/value_parser.rb
 - lib/sift/version.rb
 - lib/sift/where_handler.rb
@@ -138,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Summary of Sift.