insights-api-common 4.1.3 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cf965cd6b7745959546ab9b9479cee4912c35fe1782150a6550accea5a97377
-  data.tar.gz: 0c01ee3607a0526678e5413a1a6f192f5c425848f455d6e6987d422cd0e342ad
+  metadata.gz: 2aa2430e936c484f6b54cbcc8587462ab0ace760f6a2ab7a295e02258953a932
+  data.tar.gz: a41b5a30792c05b38b48df621f60ced0aa098b49fc6c1dbf3282d36bfbb5830c
 SHA512:
-  metadata.gz: a66ce559fc33707f407c861913d26128b8650141831a9e36aec0aaeadab949b396bc5df4565557d4c9cfce9f52da7eca6b3902741016c8bf42816cd564c0f2ec
-  data.tar.gz: 9607fdd7fae77684fa135029cbd7d318db22b853d8d4933ce6fe548b3c68e1720bca2ca3c2d7e381b474c63fe813ca4dfc4b3cbfeacc71b7ba5c8fb10a445a74
+  metadata.gz: 48d2cff3476fa94a453cdb247c2a452a6197729f531361ac093e76c03530777f22a097487b1a0f4bcc6e733cad32f7425764d976ddc2a72d2edb1efe84e15eb8
+  data.tar.gz: da7a2598ce95a1769f028a26461436a5962aa2455605dbf4ac7fd23a5c86d7ca0aaaa2eb68e20e423286a5d2e8cc812892cf94fc26b6200acac2d1cd94e636c3

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

@@ -8,7 +8,7 @@ module Insights
           @route_mapper = route_mapper
         end
 
-        def redirect_major_version(version, prefix, via: [:delete, :get, :options, :patch, :post])
+        def redirect_major_version(version, prefix, via: [:delete, :get, :options])
           route_mapper.match(
             "/#{version.split('.').first}/*path(.:format)",
             :format => false,

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

@@ -1,7 +1,7 @@
 module Insights
   module API
     module Common
-      VERSION = "4.1.3".freeze
+      VERSION = "5.0.2".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.3
+  version: 5.0.2
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2021-04-09 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