istox 0.1.97 → 0.1.98

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c5a7f018f60f1cb67728d6cdba0f6a10b5941cd7a9ac00e2957e2fe1041a174
-  data.tar.gz: 053d1b2aece848ad1f662268a55bb6bf1dddb09ea9d6a0548b76576aa8b0df24
+  metadata.gz: b20425ff9b96da28ae9fdf1c6b47c7159df66d16b67d8e2fff99d8ed1d750312
+  data.tar.gz: a04b8779b0fa907bb8c58fcba28d26089836c1bfd6b055570d9222e57ebd530c
 SHA512:
-  metadata.gz: 112f72f52eb1fd0781c821df36f509ebc6985b115eb6a9e86de2f37166f47ebf143a66af88f43e8615d2af34f8d16bd353fda9815ff78da15bf602c624b90f40
-  data.tar.gz: 34b293dfe5bc081c1905b32a5856e937869ffaab0845614af000d1acfc2beb9cbf6a0efd51e31331cc496c270b94d567f67f37f728b7b5b6b00359a59fc70666
+  metadata.gz: f44c23b065a529e8403bae9317316e34d2c41b91a33356b60cc816c5b25ce04b7096a3c1bbffae58097b4995541622011014f826c5c6c1a2515cf774b4613347
+  data.tar.gz: 8838d137671e85a48f18cd4b1d919bdd391f177e66ffcc64f97108dd014134a6d006e74bae944e1f2450b063225c7e71c2e66f5615741aa344d7ec6d705e2c73

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    istox (0.1.91)
+    istox (0.1.97)
       binding_of_caller
       bunny (>= 2.12.0)
       graphlient

data/lib/istox.rb

@@ -26,7 +26,8 @@ module Istox
   require 'istox/helpers/f_math'
   require 'istox/helpers/my_open_struct'
   require 'istox/helpers/common_helper'
-  require 'istox/helpers/filter'
+  require 'istox/helpers/regex_helper'
+  require 'istox/helpers/result_handler'
   require 'istox/models/blockchain_receipt'
   require 'istox/models/concerns/blockchain_receipt_query'
   require 'istox/consumers/blockchain_status_handler'

data/lib/istox/helpers/common_helper.rb

@@ -1,5 +1,18 @@
 module Istox
   module CommonHelper
+    def self.to_datetime(input)
+      return nil if input.blank?
+
+      begin
+        is_numeric = true if Integer input
+      rescue StandardError
+        false
+      end
+
+      # is unix timestamp
+      is_numeric ? Time.at(input.to_i).to_datetime : Time.parse(input)
+    end
+
     def self.to_open_struct(model)
       return nil if model.blank?
 

data/lib/istox/helpers/regex_helper.rb

@@ -0,0 +1,11 @@
+module Istox
+  module RegexHelper
+    def self.alphabet_only(input)
+      !input.match(/\A[a-zA-Z]*\z/).nil?
+    end
+
+    def self.symbol_only(input)
+      !input.match(/\A[^\w\s*]+\z/).nil?
+    end
+  end
+end

data/lib/istox/helpers/result_handler.rb

@@ -0,0 +1,131 @@
+module Istox
+  module ResultHandler
+    ##### main method to be called, suggested to always use this method and not individual method below
+    def self.process(query:, meta:, exclude_filter: false, exclude_order: false, exclude_paginate: false)
+      query = filter(query: query, meta: meta) unless exclude_filter
+      query = order(query: query, meta: meta) unless exclude_order
+
+      return paginate(query: query, meta: meta) unless exclude_paginate
+
+      query
+    end
+
+    def self.filter(query:, meta:)
+      return query if meta.blank? || meta.filters.blank?
+
+      meta.filters.each do |filter|
+        # chain the query with AND conditions
+        if filter.field.present?
+          validate_filter(filter)
+          query = query.where("#{filter.field} #{transform_compare(filter.type, filter.compare)} ?",
+                              transform_value(filter.type, filter.value))
+        end
+
+        next if filter.filters.blank?
+
+        # contains inner filters, chain the query with OR conditions
+        columns = []
+        values = []
+        filter.filters.each do |inner_filter|
+          validate_filter(filter)
+          columns.push("#{inner_filter.field} #{transform_compare(inner_filter.type, inner_filter.compare)} ?")
+          values.push(transform_value(inner_filter.type, inner_filter.value))
+        end
+
+        query = query.where(columns.join(' OR '), *values) unless columns.empty?
+      end
+
+      query
+    end
+
+    def self.order(query:, meta:)
+      return query if meta.blank? || meta.sorts.blank?
+
+      meta.sorts.each do |sort|
+        # to prevent sql injection
+        # sort.field should contains only alphabet and nothing else
+        raise StandardError, 'POSSIBLE_SQL_INJECTION' unless validate_column_name(sort.field)
+        # sort.order can only be asc or desc
+        raise StandardError, 'POSSIBLE_SQL_INJECTION' unless %w[asc desc].include?(sort.order.downcase)
+
+        query = query.order("#{sort.field.downcase} #{sort.order.upcase}")
+      end
+      query
+    end
+
+    def self.paginate(query:, meta:)
+      current_page = meta.page
+      offset = (current_page - 1) * meta.limit
+      total = query.count
+      data = query.limit(meta.limit).offset(offset)
+
+      page_count = (total + meta.limit - 1) / meta.limit
+
+      OpenStruct.new(
+        data: data,
+        pagination: OpenStruct.new(
+          page: current_page,
+          limit: meta.limit,
+          previous_page: current_page - 1,
+          current_page: current_page,
+          next_page: current_page < page_count ? current_page + 1 : 0,
+          page_count: page_count,
+          total_count: total
+        )
+      )
+    end
+
+    #######################################
+    ######
+    ###### private methods
+    ######
+    ######
+    ######
+    ##########################################
+
+    def self.validate_column_name(column)
+      # allow underscore
+      column = column.gsub('_', '')
+
+      Istox::RegexHelper.alphabet_only(column)
+    end
+
+    def self.validate_filter(filter)
+      # filter.field/column should contains only alphabet and nothing else
+      raise StandardError, 'POSSIBLE_SQL_INJECTION' unless validate_column_name(filter.field)
+
+      # filter.compare should only contains alphabets (eg. IN) or symbols only (eg. >=, =, <=, <>)
+      raise StandardError, 'POSSIBLE_SQL_INJECTION' unless validate_compare(filter.compare)
+    end
+
+    def self.transform_compare(type, compare)
+      return compare if type.blank?
+
+      return 'IS' if type.downcase == 'nullable' && ['=', 'is', '=='].include?(compare.downcase)
+
+      return 'IS NOT' if type.downcase == 'nullable' && ['<>', 'is not', '!='].include?(compare.downcase)
+
+      compare
+    end
+
+    def self.transform_value(type, value)
+      return value if value.blank? || type.blank? || type.downcase == 'string'
+
+      return 'NULL' if type.downcase == 'nullable' && %w[null true yes].include?(type.downcase)
+
+      return 'NOT NULL' if type.downcase == 'nullable' && %w[not_null false no].include?(type.downcase)
+
+      return value.to_i if type.downcase == 'integer'
+
+      return value.to_f if type.downcase == 'float'
+
+      return ::Istox::CommonHelper.to_datetime(value) if type.downcase == 'date' || type.downcase == 'datetime'
+    end
+
+    def self.validate_compare(compare)
+      Istox::RegexHelper.alphabet_only(compare) || Istox::RegexHelper.symbol_only(compare)
+    end
+
+    private_class_method :validate_compare, :validate_filter, :transform_value, :transform_compare, :validate_column_name
+  end
+end

data/lib/istox/version.rb

@@ -1,3 +1,3 @@
 module Istox
-  VERSION = '0.1.97'.freeze
+  VERSION = '0.1.98'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: istox
 version: !ruby/object:Gem::Version
-  version: 0.1.97
+  version: 0.1.98
 platform: ruby
 authors:
 - Siong Leng
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2019-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -294,7 +294,6 @@ files:
 - lib/istox/helpers/bunny_boot.rb
 - lib/istox/helpers/common_helper.rb
 - lib/istox/helpers/f_math.rb
-- lib/istox/helpers/filter.rb
 - lib/istox/helpers/graphql_client.rb
 - lib/istox/helpers/grpc_client.rb
 - lib/istox/helpers/gruf_listener_hook.rb
@@ -303,6 +302,8 @@ files:
 - lib/istox/helpers/order_book_price_time.rb
 - lib/istox/helpers/order_book_prorate.rb
 - lib/istox/helpers/publisher.rb
+- lib/istox/helpers/regex_helper.rb
+- lib/istox/helpers/result_handler.rb
 - lib/istox/helpers/vault.rb
 - lib/istox/interfaces/chainhub/transaction.rb
 - lib/istox/models/blockchain_receipt.rb

data/lib/istox/helpers/filter.rb

@@ -1,37 +0,0 @@
-module Istox
-  module Filter
-    def self.order(query:, filters:)
-      filters&.sort&.each do |x|
-        query = query.order("#{x.field.downcase} #{x.order.upcase}")
-      end
-      query
-    end
-
-    def self.paginate(query:, filters:)
-      current_page = filters.page
-      offset = (current_page - 1) * filters.limit
-      total = query.count
-      data = query.limit(filters.limit).offset(offset)
-
-      page_count = (total + filters.limit - 1) / filters.limit
-
-      {
-        data: data,
-        pagination: {
-          page: current_page,
-          limit: filters.limit,
-          previousPage: current_page - 1,
-          currentPage: current_page,
-          nextPage: current_page < page_count ? current_page + 1 : 0,
-          pageCount: page_count,
-          totalCount: total
-        }
-      }
-    end
-
-    def self.order_and_paginate(query:, filters:)
-      query = order(query: query, filters: filters)
-      paginate(query: query, filters: filters)
-    end
-  end
-end