insights-api-common 5.0.0 → 5.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d9fb8764a0f41c1080473eddd2d98dee2df8170f88da25fa2b033470957cf4f
-  data.tar.gz: eb025888657a1ad4c68054aba85aa099ae4455e0ec028d1208ca7468f1a7a04d
+  metadata.gz: b8a770535b65f1da98fa3196078052c5048bd13dcd4253145aa04afa5d6c1bf9
+  data.tar.gz: 13f54d55fe5343eaec0116095014e3782232e836e8e1d610a1e1120ea59b68b8
 SHA512:
-  metadata.gz: 9faab22d7dc2bd6f140fbf0db52c1f546101fff8c08039d3acef806495a5381baa5969e63eb345b769869fe321534cbc0fe26601eff88ce327aec22a6cf1a3ea
-  data.tar.gz: 928591637a490109a8a3d38841c4b5b79e13205f565a9f14d145270257952885f40cc4cf84574bc70fdb2bc2b4338f17cc55274636261e5de630b7ae558c7e01
+  metadata.gz: d329437271a364dc4d03b31b484400c2ab496b91a17f2e39c80fd57c249a992b7e6764b69724677120fe1de219c315472835809df5001a348fd264bb66a8961c
+  data.tar.gz: 93510825434809fde1d60e46b73a8f80f61535d41d77f8ebe2df716e26212d1903a0f9d9911f328bf4e6607c6aaa5a64aea46617ad39a763819f6325cab851d7

data/README.md

@@ -30,6 +30,7 @@ Or install it yourself as:
 | Supported Comparators     | Comparator    |
 | ---------------------     | ----------    |
 | Integer                   | eq            |
+|                           | not_eq        |
 |                           | gt            |
 |                           | gte           |
 |                           | lt            |
@@ -37,12 +38,14 @@ Or install it yourself as:
 |                           | nil           |
 |                           | not_nil       |
 | String                    | eq            |
+|                           | not_eq        |
 |                           | contains      |
 |                           | starts_with   |
 |                           | ends_with     |
 |                           | nil           |
 |                           | not_nil       |
 | String (case insensitive) | eq_i          |
+|                           | not_eq_i      |
 |                           | contains_i    |
 |                           | starts_with_i |
 |                           | ends_with_i   |
@@ -53,6 +56,7 @@ After implementing filtering in your application, this is the way to filter via
 | --------------- | --------------------- | ----------------- |
 | "?filter[name]=reviews" | { :filter => { :name => "reviews" } } | filter: { name: "reviews" } |
 | "?filter[name][eq]=reviews" | { :filter => { :name => { :eq => "reviews" } } } | filter: { name: { eq: "reviews" } } |
+| "?filter[name][not_eq]=reviews" | { :filter => { :name => { :not_eq => "reviews" } } } | filter: { name: { not_eq: "reviews" } } |
 | "?filter[name][starts_with]=a" | { :filter => { :name => { :starts_with => "a" } } } | filter: { name: { starts_with: "a" } } |
 | "?filter[name][ends_with]=manager" | { :filter => { :name => { :ends_with => "manager" } } } | filter: { name: { ends_with: "manager" } } |
 | "?filter[name][contains]=openshift" | { :filter => { :name => { :contains => "openshift" } } } | filter: { name: { contains: "openshift" } } |

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

@@ -44,10 +44,14 @@ module Insights
             private
 
             def id_regexp(primary_collection_name)
-              @id_regexp ||= begin
+              @id_regexp_table ||= {}
+
+              if @id_regexp_table.empty? || @id_regexp_table[primary_collection_name].nil?
                 id_parameter = id_parameter_from_api_doc(primary_collection_name)
-                id_parameter ? id_parameter.fetch_path("schema", "pattern") : /^\d+$/
+                @id_regexp_table[primary_collection_name] = id_parameter ? id_parameter.fetch_path("schema", "pattern") : /^\d+$/
               end
+
+              @id_regexp_table[primary_collection_name]
             end
 
             def id_parameter_from_api_doc(primary_collection_name)

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

@@ -4,7 +4,8 @@ module Insights
       class ErrorDocument
         def add(status = 400, message)
           @status = status
-          errors << {"status" => status, "detail" => message}
+          safe_message = message.to_s.encode('UTF-8', :invalid => :replace, :undef => :replace)
+          errors << {"status" => status, "detail" => safe_message}
           self
         end
 

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

@@ -2,8 +2,8 @@ module Insights
   module API
     module Common
       class Filter
-        INTEGER_COMPARISON_KEYWORDS = ["eq", "gt", "gte", "lt", "lte", "nil", "not_nil"].freeze
-        STRING_COMPARISON_KEYWORDS  = ["contains", "contains_i", "eq", "eq_i", "starts_with", "starts_with_i", "ends_with", "ends_with_i", "nil", "not_nil"].freeze
+        INTEGER_COMPARISON_KEYWORDS = ["eq", "not_eq", "gt", "gte", "lt", "lte", "nil", "not_nil"].freeze
+        STRING_COMPARISON_KEYWORDS  = ["contains", "contains_i", "eq", "not_eq", "eq_i", "not_eq_i", "starts_with", "starts_with_i", "ends_with", "ends_with_i", "nil", "not_nil"].freeze
         ALL_COMPARISON_KEYWORDS     = (INTEGER_COMPARISON_KEYWORDS + STRING_COMPARISON_KEYWORDS).uniq.freeze
 
         attr_reader :apply, :arel_table, :api_doc_definition, :extra_filterable_attributes, :model
@@ -177,6 +177,20 @@ module Insights
           end
         end
 
+        def self.build_filtered_scope(scope, api_version, klass_name, filter)
+          return scope unless filter
+
+          openapi_doc = ::Insights::API::Common::OpenApi::Docs.instance[api_version]
+          openapi_schema_name, = ::Insights::API::Common::GraphQL::Generator.openapi_schema(openapi_doc, klass_name)
+
+          action_parameters = ActionController::Parameters.new(filter)
+          definitions = openapi_doc.definitions
+
+          association_attribute_properties = association_attribute_properties(definitions, action_parameters)
+
+          new(scope, action_parameters, definitions[openapi_schema_name], association_attribute_properties).apply
+        end
+
         def timestamp(k, val)
           if val.kind_of?(Hash)
             val.each do |comparator, value|
@@ -242,6 +256,16 @@ module Insights
           self.query = query.where(model_arel_attribute(key).eq_any(Array(value)))
         end
 
+        def comparator_not_eq(key, value)
+          self.query = query.where.not(model_arel_attribute(key).eq_any(Array(value)))
+        end
+
+        def comparator_not_eq_i(key, value)
+          values = Array(value).map { |v| query.sanitize_sql_like(v.downcase) }
+
+          self.query = query.where.not(model_arel_table(key).grouping(arel_lower(key).matches_any(values)))
+        end
+
         def comparator_eq_i(key, value)
           values = Array(value).map { |v| query.sanitize_sql_like(v.downcase) }
 

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

@@ -20,8 +20,32 @@ module Insights
             openapi_path.split("/")[1..-1]
           end
 
+          def self.template_file_by(type, root_dir = __dir__)
+            Pathname.new(root_dir).join(File.expand_path("templates", root_dir), "#{type}.erb")
+          end
+
+          def self.root_dir
+            Rails.root
+          end
+
+          def self.app_name
+            Rails.application.class.parent.name.underscore
+          end
+
+          def self.pluggable_template_file_by(type)
+            templates_relative_path = "lib/#{app_name}/api/graphql/templates"
+            template_path = File.expand_path(templates_relative_path, root_dir)
+            Pathname.new(root_dir).join(template_path, "#{type}.erb")
+          end
+
+          def self.template_path_by(type)
+            template_path_pluggable = pluggable_template_file_by(type)
+            template_path_default   = template_file_by(type)
+            template_path_pluggable.exist? ? template_path_pluggable : template_path_default
+          end
+
           def self.template(type)
-            File.read(Pathname.new(__dir__).join(File.expand_path("templates", __dir__), "#{type}.erb").to_s)
+            File.read(template_path_by(type))
           end
 
           def self.graphql_type(property_name, property_format, property_type)
@@ -140,8 +164,16 @@ module Insights
 
               graphql_model_type_template = ERB.new(template("model_type"), nil, '<>').result(binding)
               graphql_namespace.module_eval(graphql_model_type_template)
+
+              unless graphql_namespace.const_defined?("#{klass_name}AggregateType", false)
+                graphql_aggregate_model_type_template = ERB.new(template("aggregate_model_type"), nil, '<>').result(binding)
+                graphql_namespace.module_eval(graphql_aggregate_model_type_template)
+              end
             end
 
+            graphql_aggregate_type_template = ERB.new(template("aggregate_type"), nil, '<>').result(binding)
+            graphql_namespace.module_eval(graphql_aggregate_type_template)
+
             graphql_query_type_template = ERB.new(template("query_type"), nil, '<>').result(binding)
             graphql_namespace.module_eval(graphql_query_type_template)
 

data/lib/insights/api/common/graphql/templates/aggregate_model_type.erb

@@ -0,0 +1,8 @@
+<%= klass_name %>AggregateType = ::GraphQL::ObjectType.define do
+  name "<%= klass_name %>AggregateType"
+  description "A <%= klass_name %>AggregateType to wrap metrics aggregation"
+
+  field :aggregate, AggregateType do
+    resolve ->(object, _args, _ctx) { object }
+  end
+end

data/lib/insights/api/common/graphql/templates/aggregate_type.erb

@@ -0,0 +1,14 @@
+AggregateType = ::GraphQL::ObjectType.define do
+  name "AggregateType"
+  description "A AggregateType type for aggregation metrics"
+
+  field :total_count, !types.Int do
+    resolve ->(object, _args, _ctx) {
+      if object.kind_of?(QueryRelation) # from nested aggregation
+        object.count # count is array operation
+      else
+        object
+      end
+    }
+  end
+end

data/lib/insights/api/common/graphql/templates/model_type.erb

@@ -30,6 +30,19 @@
       ::Insights::API::Common::GraphQL::AssociationLoader.new(<%= klass_name.constantize %>, "<%= associations %>", args, graphql_options).load(obj)
     }
   end
+
+  field :<%= associations %>_aggregate do
+    description "Aggregation of <%= associations %> associated with <%= klass_name %> model."
+    type <%= "#{association_class_name}AggregateType" %>
+
+    associations_name = "<%= associations %>"
+    preload :<%= associations %>
+
+    resolve lambda { |obj, args, _ctx|
+      ::Insights::API::Common::GraphQL::AssociationLoader.new(<%= klass_name.constantize %>, "<%= associations %>", args, graphql_options).load(obj)
+    }
+  end
+
 <%   end %>
 <% end %>
 end

data/lib/insights/api/common/graphql/templates/query_type.erb

@@ -31,18 +31,9 @@ QueryType = ::GraphQL::ObjectType.define do
           scope = model_class
         end
 
-        if args[:filter]
-          openapi_doc = ::Insights::API::Common::OpenApi::Docs.instance["<%= api_version %>"]
-          openapi_schema_name, _schema = ::Insights::API::Common::GraphQL::Generator.openapi_schema(openapi_doc, klass_name)
-          association_attribute_properties =
-            Insights::API::Common::Filter.association_attribute_properties(openapi_doc.definitions, ActionController::Parameters.new(args[:filter]))
-          scope = ::Insights::API::Common::Filter.new(
-            scope,
-            ActionController::Parameters.new(args[:filter]),
-            openapi_doc.definitions[openapi_schema_name],
-            association_attribute_properties).apply
-        end
+        scope = ::Insights::API::Common::Filter.build_filtered_scope(scope, "<%= api_version %>", klass_name, args[:filter])
         scope = ::Insights::API::Common::GraphQL.search_options(scope, args)
+
         if <%= graphql_options[:use_pagination_v2] %> == true
           ::Insights::API::Common::PaginatedResponseV2.new(
             base_query: scope, request: nil, limit: args[:limit], offset: args[:offset], sort_by: args[:sort_by]
@@ -54,5 +45,24 @@ QueryType = ::GraphQL::ObjectType.define do
         end
       }
     end
+
+    field_aggregate = "#{collection}_aggregate"
+    field field_aggregate do
+      description "The #{collection} aggregation associated with this #{klass_name}"
+      klass_name_type = "::Insights::API::Common::GraphQL::Api::#{version_namespace}::#{klass_name}AggregateType".constantize
+      argument :filter, ::Insights::API::Common::GraphQL::Types::QueryFilter, "The Query Filter for querying the #{collection}"
+
+      type klass_name_type
+
+      resolve lambda { |_obj, args, _ctx|
+        if base_query.present?
+          scope = base_query.call(model_class, args, ctx)
+        else
+          scope = model_class
+        end
+
+        ::Insights::API::Common::Filter.build_filtered_scope(scope, "<%= api_version %>", klass_name, args[:filter]).count
+      }
+    end
   end
 end

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

@@ -17,7 +17,7 @@ module Insights
 
         private_class_method def self.ensure_exporter_server
           require 'socket'
-          TCPSocket.open("localhost", metrics_port) {}
+          TCPSocket.open("127.0.0.1", metrics_port) {}
         rescue Errno::ECONNREFUSED
           require 'prometheus_exporter/server'
           server = PrometheusExporter::Server::WebServer.new(port: metrics_port)

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: insights-api-common
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.5
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -160,16 +160,16 @@ dependencies:
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.11.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.11.7
 - !ruby/object:Gem::Dependency
   name: graphql-batch
   requirement: !ruby/object:Gem::Requirement
@@ -396,6 +396,8 @@ files:
 - lib/insights/api/common/graphql/associated_records.rb
 - lib/insights/api/common/graphql/association_loader.rb
 - lib/insights/api/common/graphql/generator.rb
+- lib/insights/api/common/graphql/templates/aggregate_model_type.erb
+- lib/insights/api/common/graphql/templates/aggregate_type.erb
 - lib/insights/api/common/graphql/templates/model_type.erb
 - lib/insights/api/common/graphql/templates/query_type.erb
 - lib/insights/api/common/graphql/templates/schema.erb
@@ -457,7 +459,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Common Utilites for Insights microservices