insights-api-common 4.1.5 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23ebe490e2b124e093a772ba711f5f93942725df5da610609aacb0619f57194
-  data.tar.gz: bf033da653e5130461d092a06fc5a9b26c9e451e7e900e33a34efaf8338d07e6
+  metadata.gz: 27c2d8f13f5a3be044e999f5eede282412bdd00e258b21760f34c154609fa622
+  data.tar.gz: 46afb339ae074b46703fb268b1bbd8b76f1375ba80196632c8a803f408fcd73e
 SHA512:
-  metadata.gz: 1abf3875849663909685e77d9d9a2b212bf52a02cf8772e6f30530c96e7b814e28ff167565dfd07908ccbb5bddb50264b6ba6f9b21dce60119ce4ae5291f84a2
-  data.tar.gz: dab5a4c9ee7a93f7f0eaec01befe41367f3799fc1f87bd0a83855f2f12148e7070de15d4d0736969f3201f76c44ff54da711cc959b0d670695c65c41b9ca6a1a
+  metadata.gz: 3449d374a193f78d3d314156042ef4956a76aebd82ad9fed5481f8932bb103faf19f1f67d9bac0adf61fd4a3570f743f1625a3f37bc095cd6f31499e30117f96
+  data.tar.gz: 562dc832ad9d50ca6e9f3790ed989cc0a2953e0450eaa11587012e9a96383df4b29491c7cab9b2f650ced30a71ef274d4a46f34e641ac7baf8f0bce7eeb74235

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/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/error_document.rb

@@ -4,7 +4,8 @@ module Insights
       class ErrorDocument
         def add(status = 400, message)
           @status = status
-          errors << {"status" => status, "detail" => message}
+          safe_message = message.to_s.encode('UTF-8', :invalid => :replace, :undef => :replace)
+          errors << {"status" => status, "detail" => safe_message}
           self
         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/version.rb

@@ -1,7 +1,7 @@
 module Insights
   module API
     module Common
-      VERSION = "4.1.5".freeze
+      VERSION = "5.0.4".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.5
+  version: 5.0.4
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-05-26 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