insights-api-common 3.10.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5622d9061e04f7bde11f766efbdefc38e514ffd02e0c17dc633383a55f743cec
-  data.tar.gz: d38c11d43f867259c661127ca53e0e7de1c014385953a516583d9f94b9aee454
+  metadata.gz: e43686bd25c46149f1fd5886e5c60452fd04a06c183042ea4f678f227a6b1ca6
+  data.tar.gz: 882ea648b87f2ee1d7c6c8fa171e85f828c1c46ad818799f3e0d638b4e7b9384
 SHA512:
-  metadata.gz: 868598aa6f827b0f6fb5d62df159024464f94f8523b78430d8dae0483e6544c10decd602b34e7c32976165c5cd6e1b140d7c3ee0e08a9b0fa39463f020c8b000
-  data.tar.gz: 0d40859189e2a9417658e8d123a1925faea88674c796637b6e781ab56129548f92bcf243ead0e32141bd32e1db5d1271fb7e5e52ec865acbbc6765b4fa594348
+  metadata.gz: cc9dd41c400b94bf67648ac2ddf0f6b5d30ec44ed17cc5f3294155e518908911e261cd5b304518ed9f730840695c06a2b5ecbbc05a6149f38571d95c1d4d8748
+  data.tar.gz: 92e36a165e0b440a279951f6d5a0e8ddd516eb439b9b31768be0ef880350eacf52b8ec2286552f112553eec01cf72e2ba3d2bb635d6791cdab3ea6e134c267d6

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

@@ -10,8 +10,11 @@ module Insights
               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}")
+                  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
               end
 
@@ -35,6 +38,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/graphql/templates/query_type.erb

@@ -26,7 +26,7 @@ QueryType = ::GraphQL::ObjectType.define do
 
       resolve lambda { |_obj, args, ctx|
         if base_query.present?
-          scope = base_query.call(model_class, ctx)
+          scope = base_query.call(model_class, args, ctx)
         else
           scope = model_class
         end

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

@@ -2,13 +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'
 
           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
@@ -33,6 +34,23 @@ 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
       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 = "3.10.0".freeze
+      VERSION = "4.1.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insights-api-common
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -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
@@ -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
@@ -357,6 +371,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