insights-api-common 4.0.1 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da2ebb5e76ab8009c3a4afda352c91ebcaee7eaa293b1fcc7c55bcd7711f2e6b
-  data.tar.gz: 2a772f8bc79d01d48f2ca637ba9adcf0a1fa67c1aefda8bb414d45f5111b4558
+  metadata.gz: 3b5d5b1fb4fcee54a7ebe9cb45e950c8360c6b53652a90d6aa2d7e0884fdf079
+  data.tar.gz: 83b4b1b28772acd3ccd73ea21380314e4aabfa8417e6bc34509d385c6941a337
 SHA512:
-  metadata.gz: d174ee5da9f78f4c7312ef570c0e3563d059c7332a1e43ad58ac17d7ec9051a4a8ebda04f7f1afa9b4f0179c0c4751204f25dae81d21eded96186336c6ed61a3
-  data.tar.gz: e46f808117d0c742c89cc0b477308b8ddfff3e68f72ee36dbd57cc886df1fec97f8070836609c80164457fe98f2982f0a1f25919eee1ffe3aae08400a40696f4
+  metadata.gz: 43f6f59fd6787c5ac69c746fc89b4f0ab2e8122d13a3e4c0151c2b9fdbd8d4dd5ccc4a9a8068b5da7c466e870299bee88e58994e5169b74571b00b466d2b61f5
+  data.tar.gz: ec3589a7a4327583e3bdbb604862a72f3e421305f566336adb64d1ac5ba9d353da5333865fabb3cf145f3ffef44f29ee67ce5a4519ec252db3b25a138096ffc1

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,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|
-                  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)
+            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)
@@ -31,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])
@@ -45,7 +62,7 @@ module Insights
           end
 
           def api_client_errors(exc, error_document)
-            body = JSON.parse(exc.response_body)
+            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')
@@ -56,6 +73,12 @@ module Insights
               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.to_s.delete_suffix('?')} this #{exception.record.model_name.human.downcase}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,10 +2,14 @@ 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'
 
+          setup_custom_metrics(args[:custom_metrics])
+
+          return if metrics_port == 0
+
           ensure_exporter_server
           enable_in_process_metrics
           enable_web_server_metrics(prefix)
@@ -13,10 +17,10 @@ module Insights
 
         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 +37,31 @@ 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|
+            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.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"  },
@@ -440,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
@@ -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.1".freeze
+      VERSION = "4.1.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.0.1
+  version: 4.1.2
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-08-05 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
@@ -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