insights-api-common 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f6030728902f58dcb0ce11d0de032c9c3ab442877686e097a83a7c6a7da2cfe
-  data.tar.gz: ef7838a59298b7ef0a5c0b4aa6681331f4757fc073cebbdc791f154c28c05fe9
+  metadata.gz: 38345e2eca706bb365900e3e3eb7ea2488d38587b654536cfe60bc04367a9e8c
+  data.tar.gz: 101d18e408627530170f6b62013ed494970939fa40e46fecb8e38e7cf4493685
 SHA512:
-  metadata.gz: bd8564c491431e177fa89daa27330dcbfe02ddfdeaa915eb6207a32fe659257cda7684ef39d0c05e8732c404a3bf3c54617b3f563c4054b170f06ac9901230e4
-  data.tar.gz: 90c76dc626605e9d9c890203832213751938ae6a45dedeeac4b5d30ce3e76804a166b894be4281549a5169495920d8e6de17446aaf2645ef706b4b19fc7e4697
+  metadata.gz: fcf19c204af28d1a540408f86967e96e25e7345ffe0cdd1cfd9fc07b697cdbfba2abfee9fb9dca9f042c34988826dd3f2e000e57239fd3d1f5a19b1fd72309f8
+  data.tar.gz: a0bb8e4e1499fcdca95a925565fe601db6cc1a410c2c2d0c36b47ec3d766e248477bb67ecb842d4c79540a4cb3b49df332faa87c9913bb3e2851fe60a8e2a514

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,16 +7,28 @@ 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|
-                  code = exc.respond_to?(:code) ? exc.code : error_code_from_class(exc)
-                  error_document.add(code.to_s, "#{exc.class}: #{exc.message}")
-                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)
+            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)
+                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)
@@ -28,6 +40,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])
@@ -35,6 +55,30 @@ module Insights
               DEFAULT_ERROR_CODE
             end
           end
+
+          def api_client_exception?(exc)
+            exc.respond_to?(:code) && exc.respond_to?(:response_body) && exc.respond_to?(:response_headers) &&
+              !exc.response_body.nil?
+          end
+
+          def api_client_errors(exc, error_document)
+            body = json_parsed_body(exc)
+            if body.is_a?(Hash) && body.key?('errors') && body['errors'].is_a?(Array)
+              body['errors'].each do |error|
+                next unless error.key?('status') && error.key?('detail')
+
+                error_document.add(error['status'], error['detail'])
+              end
+            else
+              error_document.add(exc.code.to_s, exc.message )
+            end
+          end
+
+          def json_parsed_body(exc)
+            JSON.parse(exc.response_body)
+          rescue StandardError
+            nil
+          end
         end
       end
     end

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.delete_suffix('?')} this #{exception.record.model_name.human.downcase}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,21 +2,24 @@ module Insights
   module API
     module Common
       class Metrics
-        def self.activate(config, prefix)
+        def self.activate(config, prefix, args = {})
           require 'prometheus_exporter'
           require 'prometheus_exporter/client'
 
+          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)
@@ -33,6 +36,27 @@ module Insights
           require "insights/api/common/middleware/web_server_metrics"
           Rails.application.middleware.unshift(Insights::API::Common::Middleware::WebServerMetrics, :metrics_prefix => prefix)
         end
+
+        private_class_method def self.setup_custom_metrics(custom_metrics)
+          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"
+              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.rb

@@ -1,2 +1,3 @@
 require "insights/api/common/open_api/docs"
+require "insights/api/common/open_api/version_from_prefix"
 require "insights/api/common/open_api/serializer"

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

@@ -48,6 +48,7 @@ module Insights
             ENV['APP_NAME'] = app_name
             ENV['PATH_PREFIX'] = app_prefix
             Rails.application.reload_routes!
+            @operation_id_hash = {}
           end
 
           def server_base_path
@@ -117,8 +118,8 @@ module Insights
                     "type"        => "object",
                     "properties"  => {
                       "status"    => {
-                        "type"    => "integer",
-                        "example" => 404
+                        "type"    => "string",
+                        "example" => "404"
                       },
                       "detail"    => {
                         "type"    => "string",
@@ -200,7 +201,7 @@ module Insights
             sub_collection = (primary_collection != klass_name)
             {
               "summary"     => "List #{klass_name.pluralize}#{" for #{primary_collection}" if sub_collection}",
-              "operationId" => "list#{primary_collection if sub_collection}#{klass_name.pluralize}",
+              "operationId" => operation_id(klass_name, primary_collection, sub_collection),
               "description" => "Returns an array of #{klass_name} objects",
               "parameters"  => [
                 { "$ref" => "##{PARAMETERS_PATH}/QueryLimit"  },
@@ -562,6 +563,24 @@ module Insights
           def schema_overrides
             {}
           end
+
+          def validate_operation_id(name, klass_name)
+            if @operation_id_hash.key?(name)
+              raise ArgumentError, "operation id cannot be duplicates, #{name} in class #{klass_name} has already been used in class #{@operation_id_hash[name]}"
+            end
+            @operation_id_hash[name] = klass_name
+          end
+
+          def operation_id(klass_name, primary_collection, sub_collection)
+            klass = klass_name.constantize
+            name = if klass.respond_to?(:list_operation_id)
+                     klass.send(:list_operation_id)
+                   else
+                     "list#{primary_collection if sub_collection}#{klass_name.pluralize}"
+                   end
+            validate_operation_id(name, klass_name)
+            name
+          end
         end
       end
     end

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

@@ -3,27 +3,40 @@ module Insights
     module Common
       module OpenApi
         module Serializer
+          include VersionFromPrefix
+
           def as_json(arg = {})
-            previous = super
+            previous = super(:except => _excluded_attributes(arg))
+
             encrypted_columns_set = (self.class.try(:encrypted_columns) || []).to_set
             encryption_filtered = previous.except(*encrypted_columns_set)
             return encryption_filtered unless arg.key?(:prefixes)
-            version = api_version_from_prefix(arg[:prefixes].first)
-            presentation_name = self.class.try(:presentation_name) || self.class.name
-            schema  = ::Insights::API::Common::OpenApi::Docs.instance[version].definitions[presentation_name]
-            attrs   = encryption_filtered.slice(*schema["properties"].keys)
-            schema["properties"].keys.each do |name|
+
+            attrs = encryption_filtered.slice(*_schema_properties(arg).keys)
+            _schema_properties(arg).keys.each do |name|
               next if attrs[name].nil?
               attrs[name] = attrs[name].iso8601 if attrs[name].kind_of?(Time)
               attrs[name] = attrs[name].to_s if name.ends_with?("_id") || name == "id"
-              attrs[name] = self.public_send(name) if !attrs.key?(name) && !encrypted_columns_set.include?(name)
             end
             attrs.compact
           end
 
-          def api_version_from_prefix(prefix)
-            /\/?\w+\/v(?<major>\d+)[x\.]?(?<minor>\d+)?\// =~ prefix
-            [major, minor].compact.join(".")
+          private
+
+          def _excluded_attributes(arg)
+            return [] unless arg.key?(:prefixes)
+
+            self.attributes.keys - _schema_properties(arg).keys
+          end
+
+          def _schema_properties(arg)
+            @schema_properties ||= _schema(arg)["properties"]
+          end
+
+          def _schema(arg)
+            version = api_version_from_prefix(arg[:prefixes].first)
+            presentation_name = self.class.try(:presentation_name) || self.class.name
+            ::Insights::API::Common::OpenApi::Docs.instance[version].definitions[presentation_name]
           end
         end
       end

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

@@ -0,0 +1,14 @@
+module Insights
+  module API
+    module Common
+      module OpenApi
+        module VersionFromPrefix
+          def api_version_from_prefix(prefix)
+            /\/?\w+\/v(?<major>\d+)[x\.]?(?<minor>\d+)?\// =~ prefix
+            [major, minor].compact.join(".")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/insights/api/common/rbac/seed.rb

@@ -2,7 +2,7 @@ module Insights
   module API
     module Common
       module RBAC
-        require 'rbac-api-client'
+        require 'insights-rbac-api-client'
 
         class Seed
           def initialize(seed_file, user_file = nil)

data/lib/insights/api/common/rbac/service.rb

@@ -2,7 +2,7 @@ module Insights
   module API
     module Common
       module RBAC
-        require 'rbac-api-client'
+        require 'insights-rbac-api-client'
 
         class NetworkError  < StandardError; end
         class TimedOutError < StandardError; end

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

@@ -25,6 +25,14 @@ module Insights
           Thread.current[:current_request]
         end
 
+        def self.current_request_id
+          Thread.current[:request_id]
+        end
+
+        def self.current_request_id=(id)
+          Thread.current[:request_id] = id
+        end
+
         def self.current!
           current || raise(RequestNotSet)
         end
@@ -45,10 +53,13 @@ module Insights
 
         def self.with_request(request)
           saved = current
+          saved_request_id = current&.request_id
           self.current = request
+          self.current_request_id = current&.request_id
           yield current
         ensure
           self.current = saved
+          self.current_request_id = saved_request_id
         end
 
         def self.current_forwardable

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insights-api-common
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -56,22 +56,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.1.1
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.1.1
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
 - !ruby/object:Gem::Dependency
   name: manageiq-loggers
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: insights-rbac-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -222,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
@@ -278,16 +292,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -331,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
@@ -357,6 +372,7 @@ files:
 - lib/insights/api/common/open_api/docs/object_definition.rb
 - lib/insights/api/common/open_api/generator.rb
 - lib/insights/api/common/open_api/serializer.rb
+- lib/insights/api/common/open_api/version_from_prefix.rb
 - lib/insights/api/common/option_redirect_enhancements.rb
 - lib/insights/api/common/paginated_response.rb
 - lib/insights/api/common/paginated_response_v2.rb
@@ -399,7 +415,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Common Utilites for Insights microservices