insights-api-common 4.1.4 → 5.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce10f1b7fbf9b54ce62a4df70d74d36576b5aaf27edc46e7876ab9b8dc3b858d
-  data.tar.gz: 8d8396b33c3a823d38afce61af976daa07806c4c71373f03f21b738541dd611c
+  metadata.gz: 69996ff970a292cd520ac12cda29ef17bb8d80b06c103df7eb9989ae75fdb868
+  data.tar.gz: aa44e58806adfb3b2be0d57709558bb67a73898f4d76a98850ede77f00dfb460
 SHA512:
-  metadata.gz: cd95076ae1ad48ccf33eb2fa9fcedc044c70c1f2ad995fbbc29d3a98cc3fd680620a1828d69a9b0dad213cc91f1c58ecc80c2a066d1018f35d24ec9719b3aad3
-  data.tar.gz: 196b69377f50c94460c5a2a564cf6786352e3962a5cac8d5cf6b69656415bc06420af8f78552758ddb9b3b1dbde3badbd02613e0ade3ae0e8d3264b5e52e46c6
+  metadata.gz: 575068b4b0214c56bd537ebbd3ac0d11724fef6bfae4b231bb045bf04559b829744a722adaf9a7676773e7a4488c86dfc27769065d7bb2896fba3717093192dd
+  data.tar.gz: ee3131ab6fc83044a334fe8e5fa4a381aa92a87a7d5c9a46523cd683cf2e6f546f2d8ee40b1a5b837907062a4e7479ecaf94f96369ab3d5ab7b07c1200d65fa1

data/README.md

@@ -30,6 +30,7 @@ Or install it yourself as:
 | Supported Comparators     | Comparator    |
 | ---------------------     | ----------    |
 | Integer                   | eq            |
+|                           | not_eq        |
 |                           | gt            |
 |                           | gte           |
 |                           | lt            |
@@ -37,12 +38,14 @@ Or install it yourself as:
 |                           | nil           |
 |                           | not_nil       |
 | String                    | eq            |
+|                           | not_eq        |
 |                           | contains      |
 |                           | starts_with   |
 |                           | ends_with     |
 |                           | nil           |
 |                           | not_nil       |
 | String (case insensitive) | eq_i          |
+|                           | not_eq_i      |
 |                           | contains_i    |
 |                           | starts_with_i |
 |                           | ends_with_i   |
@@ -53,6 +56,7 @@ After implementing filtering in your application, this is the way to filter via
 | --------------- | --------------------- | ----------------- |
 | "?filter[name]=reviews" | { :filter => { :name => "reviews" } } | filter: { name: "reviews" } |
 | "?filter[name][eq]=reviews" | { :filter => { :name => { :eq => "reviews" } } } | filter: { name: { eq: "reviews" } } |
+| "?filter[name][not_eq]=reviews" | { :filter => { :name => { :not_eq => "reviews" } } } | filter: { name: { not_eq: "reviews" } } |
 | "?filter[name][starts_with]=a" | { :filter => { :name => { :starts_with => "a" } } } | filter: { name: { starts_with: "a" } } |
 | "?filter[name][ends_with]=manager" | { :filter => { :name => { :ends_with => "manager" } } } | filter: { name: { ends_with: "manager" } } |
 | "?filter[name][contains]=openshift" | { :filter => { :name => { :contains => "openshift" } } } | filter: { name: { contains: "openshift" } } |

data/lib/insights/api/common/application_controller_mixins/exception_handling.rb

@@ -14,7 +14,6 @@ module Insights
           end
 
           def rescue_from_handler(exception)
-            logger.error("#{exception.class.name}: #{exception.message}\n#{exception.backtrace.join("\n")}")
             errors = Insights::API::Common::ErrorDocument.new.tap do |error_document|
               exception_list_from(exception).each do |exc|
                 if api_client_exception?(exc)

data/lib/insights/api/common/application_controller_mixins/parameters.rb

@@ -123,7 +123,8 @@ module Insights
 
           def sanctified_permit_param(api_doc_definition, attributes)
             api_doc_definition['properties'].each_with_object([]) do |(k, v), memo|
-              next unless attributes.each { |attr| attr.include?(k) }
+              # only add to the permit hash if we're actually trying to update it.
+              next unless attributes.any? { |attr| attr.include?(k) }
 
               memo << if v['type'] == 'array'
                         { k => [] }

data/lib/insights/api/common/application_controller_mixins/request_path.rb

@@ -44,10 +44,14 @@ module Insights
             private
 
             def id_regexp(primary_collection_name)
-              @id_regexp ||= begin
+              @id_regexp_table ||= {}
+
+              if @id_regexp_table.empty? || @id_regexp_table[primary_collection_name].nil?
                 id_parameter = id_parameter_from_api_doc(primary_collection_name)
-                id_parameter ? id_parameter.fetch_path("schema", "pattern") : /^\d+$/
+                @id_regexp_table[primary_collection_name] = id_parameter ? id_parameter.fetch_path("schema", "pattern") : /^\d+$/
               end
+
+              @id_regexp_table[primary_collection_name]
             end
 
             def id_parameter_from_api_doc(primary_collection_name)

data/lib/insights/api/common/custom_exceptions.rb

@@ -7,7 +7,8 @@ module Insights
         def self.custom_message(exception)
           case exception.class.to_s
           when "Pundit::NotAuthorizedError"
-            "You are not authorized to #{exception.query.to_s.delete_suffix('?')} this #{exception.record.model_name.human.downcase}"
+            exception.policy.try(:error_message) ||
+              "You are not authorized to perform the #{exception.query.to_s.delete_suffix('?')} action for this #{exception.record.model_name.human.downcase}"
           end
         end
       end

data/lib/insights/api/common/filter.rb

@@ -2,8 +2,8 @@ module Insights
   module API
     module Common
       class Filter
-        INTEGER_COMPARISON_KEYWORDS = ["eq", "gt", "gte", "lt", "lte", "nil", "not_nil"].freeze
-        STRING_COMPARISON_KEYWORDS  = ["contains", "contains_i", "eq", "eq_i", "starts_with", "starts_with_i", "ends_with", "ends_with_i", "nil", "not_nil"].freeze
+        INTEGER_COMPARISON_KEYWORDS = ["eq", "not_eq", "gt", "gte", "lt", "lte", "nil", "not_nil"].freeze
+        STRING_COMPARISON_KEYWORDS  = ["contains", "contains_i", "eq", "not_eq", "eq_i", "not_eq_i", "starts_with", "starts_with_i", "ends_with", "ends_with_i", "nil", "not_nil"].freeze
         ALL_COMPARISON_KEYWORDS     = (INTEGER_COMPARISON_KEYWORDS + STRING_COMPARISON_KEYWORDS).uniq.freeze
 
         attr_reader :apply, :arel_table, :api_doc_definition, :extra_filterable_attributes, :model
@@ -242,6 +242,16 @@ module Insights
           self.query = query.where(model_arel_attribute(key).eq_any(Array(value)))
         end
 
+        def comparator_not_eq(key, value)
+          self.query = query.where.not(model_arel_attribute(key).eq_any(Array(value)))
+        end
+
+        def comparator_not_eq_i(key, value)
+          values = Array(value).map { |v| query.sanitize_sql_like(v.downcase) }
+
+          self.query = query.where.not(model_arel_table(key).grouping(arel_lower(key).matches_any(values)))
+        end
+
         def comparator_eq_i(key, value)
           values = Array(value).map { |v| query.sanitize_sql_like(v.downcase) }
 

data/lib/insights/api/common/graphql/generator.rb

@@ -20,8 +20,32 @@ module Insights
             openapi_path.split("/")[1..-1]
           end
 
+          def self.template_file_by(type, root_dir = __dir__)
+            Pathname.new(root_dir).join(File.expand_path("templates", root_dir), "#{type}.erb")
+          end
+
+          def self.root_dir
+            Rails.root
+          end
+
+          def self.app_name
+            Rails.application.class.parent.name.underscore
+          end
+
+          def self.pluggable_template_file_by(type)
+            templates_relative_path = "lib/#{app_name}/api/graphql/templates"
+            template_path = File.expand_path(templates_relative_path, root_dir)
+            Pathname.new(root_dir).join(template_path, "#{type}.erb")
+          end
+
+          def self.template_path_by(type)
+            template_path_pluggable = pluggable_template_file_by(type)
+            template_path_default   = template_file_by(type)
+            template_path_pluggable.exist? ? template_path_pluggable : template_path_default
+          end
+
           def self.template(type)
-            File.read(Pathname.new(__dir__).join(File.expand_path("templates", __dir__), "#{type}.erb").to_s)
+            File.read(template_path_by(type))
           end
 
           def self.graphql_type(property_name, property_format, property_type)

data/lib/insights/api/common/metrics.rb

@@ -17,7 +17,7 @@ module Insights
 
         private_class_method def self.ensure_exporter_server
           require 'socket'
-          TCPSocket.open("localhost", metrics_port) {}
+          TCPSocket.open("127.0.0.1", metrics_port) {}
         rescue Errno::ECONNREFUSED
           require 'prometheus_exporter/server'
           server = PrometheusExporter::Server::WebServer.new(port: metrics_port)

data/lib/insights/api/common/request.rb

@@ -57,6 +57,9 @@ module Insights
           self.current = request
           self.current_request_id = current&.request_id
           yield current
+        rescue => exception
+          Rails.logger.error("#{exception.class.name}: #{exception.message}\n#{exception.backtrace.join("\n")}")
+          raise
         ensure
           self.current = saved
           self.current_request_id = saved_request_id

data/lib/insights/api/common/version.rb

@@ -1,7 +1,7 @@
 module Insights
   module API
     module Common
-      VERSION = "4.1.4".freeze
+      VERSION = "5.0.3".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insights-api-common
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 5.0.3
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -160,16 +160,16 @@ dependencies:
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.11.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.11.7
 - !ruby/object:Gem::Dependency
   name: graphql-batch
   requirement: !ruby/object:Gem::Requirement
@@ -246,6 +246,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -415,7 +457,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: Common Utilites for Insights microservices