insights-api-common 4.1.0 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43686bd25c46149f1fd5886e5c60452fd04a06c183042ea4f678f227a6b1ca6
-  data.tar.gz: 882ea648b87f2ee1d7c6c8fa171e85f828c1c46ad818799f3e0d638b4e7b9384
+  metadata.gz: f23ebe490e2b124e093a772ba711f5f93942725df5da610609aacb0619f57194
+  data.tar.gz: bf033da653e5130461d092a06fc5a9b26c9e451e7e900e33a34efaf8338d07e6
 SHA512:
-  metadata.gz: cc9dd41c400b94bf67648ac2ddf0f6b5d30ec44ed17cc5f3294155e518908911e261cd5b304518ed9f730840695c06a2b5ecbbc05a6149f38571d95c1d4d8748
-  data.tar.gz: 92e36a165e0b440a279951f6d5a0e8ddd516eb439b9b31768be0ef880350eacf52b8ec2286552f112553eec01cf72e2ba3d2bb635d6791cdab3ea6e134c267d6
+  metadata.gz: 1abf3875849663909685e77d9d9a2b212bf52a02cf8772e6f30530c96e7b814e28ff167565dfd07908ccbb5bddb50264b6ba6f9b21dce60119ce4ae5291f84a2
+  data.tar.gz: dab5a4c9ee7a93f7f0eaec01befe41367f3799fc1f87bd0a83855f2f12148e7070de15d4d0736969f3201f76c44ff54da711cc959b0d670695c65c41b9ca6a1a

data/README.md

@@ -1,8 +1,8 @@
 # Insights::API::Common
 
 [![Build Status](https://travis-ci.org/RedHatInsights/insights-api-common-rails.svg)](https://travis-ci.org/RedHatInsights/insights-api-common-rails)
-[![Maintainability](https://api.codeclimate.com/v1/badges/790ea6c77d82da6be68a/maintainability)](https://codeclimate.com/github/RedHatInsights/insights-api-common-rails/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/790ea6c77d82da6be68a/test_coverage)](https://codeclimate.com/github/RedHatInsights/insights-api-common-rails/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8ec8a19165383fdaed47/maintainability)](https://codeclimate.com/github/RedHatInsights/insights-api-common-rails/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8ec8a19165383fdaed47/test_coverage)](https://codeclimate.com/github/RedHatInsights/insights-api-common-rails/test_coverage)
 [![Security](https://hakiri.io/github/RedHatInsights/insights-api-common-rails/master.svg)](https://hakiri.io/github/RedHatInsights/insights-api-common-rails/master)
 
 Header, Encryption, RBAC, Serialization, Pagination and other common behavior for Insights microservices built with Rails

data/lib/insights/api/common.rb

@@ -1,3 +1,4 @@
+require "insights/api/common/custom_exceptions"
 require "insights/api/common/engine"
 require "insights/api/common/entitlement"
 require "insights/api/common/error_document"

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

@@ -7,19 +7,27 @@ module Insights
 
           def self.included(other)
             other.rescue_from(StandardError, RuntimeError) do |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)
-                    api_client_errors(exc, error_document)
-                  else
-                    error_document.add(error_code_from_class(exc).to_s, "#{exc.class}: #{exc.message}")
-                  end
-                end
+              rescue_from_handler(exception) do |error_document, exc|
+                error_document.add(error_code_from_class(exc).to_s, "#{exc.class}: #{exc.message}")
               end
+            end
+          end
 
-              render :json => errors.to_h, :status => error_code_from_class(exception)
+          def rescue_from_handler(exception)
+            errors = Insights::API::Common::ErrorDocument.new.tap do |error_document|
+              exception_list_from(exception).each do |exc|
+                if api_client_exception?(exc)
+                  api_client_errors(exc, error_document)
+                elsif custom_exception?(exc)
+                  message = fetch_custom_message(exc)
+                  error_document.add(error_code_from_class(exc).to_s, message)
+                else
+                  yield error_document, exc
+                end
+              end
             end
+
+            render :json => errors.to_h, :status => error_code_from_class(exception)
           end
 
           def exception_list_from(exception)
@@ -31,6 +39,14 @@ module Insights
             end
           end
 
+          def custom_exception?(exception)
+            Insights::API::Common::CustomExceptions::CUSTOM_EXCEPTION_LIST.include?(exception.class.to_s)
+          end
+
+          def fetch_custom_message(exception)
+            Insights::API::Common::CustomExceptions.custom_message(exception)
+          end
+
           def error_code_from_class(exception)
             if ActionDispatch::ExceptionWrapper.rescue_responses.key?(exception.class.to_s)
               Rack::Utils.status_code(ActionDispatch::ExceptionWrapper.rescue_responses[exception.class.to_s])

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

@@ -0,0 +1,16 @@
+module Insights
+  module API
+    module Common
+      class CustomExceptions
+        CUSTOM_EXCEPTION_LIST = %w[Pundit::NotAuthorizedError].freeze
+
+        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}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,18 +6,21 @@ 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
           require 'socket'
-          TCPSocket.open("localhost", 9394) {}
+          TCPSocket.open("localhost", metrics_port) {}
         rescue Errno::ECONNREFUSED
           require 'prometheus_exporter/server'
-          server = PrometheusExporter::Server::WebServer.new(port: 9394)
+          server = PrometheusExporter::Server::WebServer.new(port: metrics_port)
           server.start
 
           PrometheusExporter::Client.default = PrometheusExporter::LocalClient.new(collector: server.collector)
@@ -39,18 +42,26 @@ 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
         end
+
+        private_class_method def self.metrics_port
+          @metrics_port ||= (ENV['METRICS_PORT']&.to_i || 9394)
+        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.0".freeze
+      VERSION = "4.1.5".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.0
+  version: 4.1.5
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -58,20 +58,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 5.2.2
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1.1
+        version: 5.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 5.2.2
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1.1
+        version: 5.2.2.1
 - !ruby/object:Gem::Dependency
   name: manageiq-loggers
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -236,16 +236,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -345,6 +345,7 @@ files:
 - lib/insights/api/common/application_controller_mixins/request_body_validation.rb
 - lib/insights/api/common/application_controller_mixins/request_parameter_validation.rb
 - lib/insights/api/common/application_controller_mixins/request_path.rb
+- lib/insights/api/common/custom_exceptions.rb
 - lib/insights/api/common/engine.rb
 - lib/insights/api/common/entitlement.rb
 - lib/insights/api/common/error_document.rb