insights-api-common 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38345e2eca706bb365900e3e3eb7ea2488d38587b654536cfe60bc04367a9e8c
-  data.tar.gz: 101d18e408627530170f6b62013ed494970939fa40e46fecb8e38e7cf4493685
+  metadata.gz: 2d9fb8764a0f41c1080473eddd2d98dee2df8170f88da25fa2b033470957cf4f
+  data.tar.gz: eb025888657a1ad4c68054aba85aa099ae4455e0ec028d1208ca7468f1a7a04d
 SHA512:
-  metadata.gz: fcf19c204af28d1a540408f86967e96e25e7345ffe0cdd1cfd9fc07b697cdbfba2abfee9fb9dca9f042c34988826dd3f2e000e57239fd3d1f5a19b1fd72309f8
-  data.tar.gz: a0bb8e4e1499fcdca95a925565fe601db6cc1a410c2c2d0c36b47ec3d766e248477bb67ecb842d4c79540a4cb3b49df332faa87c9913bb3e2851fe60a8e2a514
+  metadata.gz: 9faab22d7dc2bd6f140fbf0db52c1f546101fff8c08039d3acef806495a5381baa5969e63eb345b769869fe321534cbc0fe26601eff88ce327aec22a6cf1a3ea
+  data.tar.gz: 928591637a490109a8a3d38841c4b5b79e13205f565a9f14d145270257952885f40cc4cf84574bc70fdb2bc2b4338f17cc55274636261e5de630b7ae558c7e01

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

@@ -6,12 +6,13 @@ module Insights
           require 'prometheus_exporter'
           require 'prometheus_exporter/client'
 
+          setup_custom_metrics(args[:custom_metrics])
+
           return if metrics_port == 0
 
           ensure_exporter_server
           enable_in_process_metrics
           enable_web_server_metrics(prefix)
-          setup_custom_metrics(args[:custom_metrics])
         end
 
         private_class_method def self.ensure_exporter_server
@@ -41,14 +42,18 @@ module Insights
           return if custom_metrics.nil?
 
           custom_metrics.each do |metric|
-            instance_variable_set("@#{metric[:name]}_#{metric[:type]}", PrometheusExporter::Client.default.register(metric[:type], metric[:name], metric[:description]))
-
-            define_singleton_method(metric[:name]) do
-              case metric[:type]
-              when :counter
-                instance_variable_get("@#{metric[:name]}_#{metric[:type]}")&.observe(1)
-              else
-                "Metric of type #{metric[:type]} unsupported, implement it in Insights::API::Common::Metrics#L45"
+            if metrics_port == 0
+              define_singleton_method(metric[:name]) {}
+            else
+              instance_variable_set("@#{metric[:name]}_#{metric[:type]}", PrometheusExporter::Client.default.register(metric[:type], metric[:name], metric[:description]))
+
+              define_singleton_method(metric[:name]) do
+                case metric[:type]
+                when :counter
+                  instance_variable_get("@#{metric[:name]}_#{metric[:type]}")&.observe(1)
+                else
+                  "Metric of type #{metric[:type]} unsupported, implement it in Insights::API::Common::Metrics#L45"
+                end
               end
             end
           end

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

@@ -441,7 +441,7 @@ module Insights
               end
 
               # Take existing attrs, that we won't generate
-              ['example', 'format', 'readOnly', 'title', 'description'].each do |property_key|
+              ['example', 'format', 'nullable', 'readOnly', 'title', 'description'].each do |property_key|
                 property_value                 = openapi_contents.dig(*path_parts(SCHEMAS_PATH), klass_name, "properties", key, property_key)
                 properties_value[property_key] = property_value if property_value
               end

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.1".freeze
+      VERSION = "5.0.0".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.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: prometheus_exporter
   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