insights-api-common 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4403934725fa19d242e7ff6b13e2a527d3bd900b9313f78d1d796fff8e6505ba
-  data.tar.gz: 619b1d292841e9f43423acf51875c6ef44772966138bdf853a914738b9ddd2ad
+  metadata.gz: 81867b9d7ef11af5730e42563f88c156e7f51c2ef9e474990942f68535483fee
+  data.tar.gz: bba675752b9788c7fff6e4375b2301217a063f291713d32694a49227c8bed981
 SHA512:
-  metadata.gz: efd17459f9aa21d14764f007e1dd037f3fe3880ac26c27c0b57c9d78a366e17fef334f544e8620545417928e70e680a736af8e5811ea4151cc46210ace82805d
-  data.tar.gz: e152265a66258e585d625ea5cd32ff86b602af983dabaa44e0535ee9dbb55799b311ca6a3b43e605d32d5e9f9a6c9efd0e2157c514e94448c5e1d6a72c0eac46
+  metadata.gz: 40c3eab1a34663c42f8d85416d5b30d32d2066235dbe7bf86992860aa6a8ebd551b0c800ec80b0d8b82ef69e17707a79e2eeed4737205f678fe0c35fe41489ee
+  data.tar.gz: fc3a7e98ca9a116e94347ba8a09892628299c37571fa940063f5ddd95915ffc633b76170c4b738943c0ab3c4f4484f45f790e68a19494339b0876a3426232202

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

@@ -16,7 +16,10 @@ module Insights
           def safe_params_for_list
             check_if_openapi_enabled
             # :limit & :offset can be passed in for pagination purposes, but shouldn't show up as params for filtering purposes
-            @safe_params_for_list ||= params.merge(params_for_polymorphic_subcollection).permit(*permitted_params, :filter => {}, :sort_by => [])
+            @safe_params_for_list ||= begin
+              sort_by_default = (params[:sort_by].kind_of?(String) || params[:sort_by].kind_of?(Array)) ? [] : {}
+              params.merge(params_for_polymorphic_subcollection).permit(*permitted_params, :filter => {}, :sort_by => sort_by_default)
+            end
           end
 
           def permitted_params

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

@@ -5,22 +5,6 @@ module Insights
         module RequestParameterValidation
           def self.included(other)
             other.include(OpenapiEnabled)
-
-            other.before_action(:validate_request_parameters)
-          end
-
-          private
-
-          def validate_request_parameters
-            api_version = self.class.send(:api_version)[1..-1].sub(/x/, ".")
-
-            api_doc.try(
-              :validate_parameters!,
-              request.method,
-              request.path,
-              api_version,
-              params.slice(:sort_by)
-            )
           end
         end
       end

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

@@ -3,12 +3,13 @@ module Insights
     module Common
       module GraphQL
         class AssociationLoader < ::GraphQL::Batch::Loader
-          attr_reader :args, :association_name, :model
+          attr_reader :args, :association_name, :graphql_options, :model
 
-          def initialize(model, association_name, args = {})
+          def initialize(model, association_name, args = {}, graphql_options = {})
             @model            = model
             @association_name = association_name
             @args             = args
+            @graphql_options  = graphql_options
           end
 
           def cache_key(record)
@@ -24,9 +25,15 @@ module Insights
           def read_association(record)
             recs = GraphQL::AssociatedRecords.new(record.public_send(association_name))
             recs = GraphQL.search_options(recs, args)
-            PaginatedResponse.new(
-              :base_query => recs, :request => nil, :limit => args[:limit], :offset => args[:offset]
-            ).records
+            if graphql_options[:use_pagination_v2] == true
+              PaginatedResponseV2.new(
+                :base_query => recs, :request => nil, :limit => args[:limit], :offset => args[:offset]
+              ).records
+            else
+              PaginatedResponse.new(
+                :base_query => recs, :request => nil, :limit => args[:limit], :offset => args[:offset]
+              ).records
+            end
           end
         end
       end

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

@@ -79,6 +79,14 @@ module Insights
           end
 
           def self.init_schema(request, schema_overlay = {})
+            base_init_schema(request, { :use_pagination_v2 => false }, schema_overlay)
+          end
+
+          def self.init_schema_v2(request, schema_overlay = {})
+            base_init_schema(request, { :use_pagination_v2 => true }, schema_overlay)
+          end
+
+          def self.base_init_schema(request, graphql_options, schema_overlay = {})
             api_version       = ::Insights::API::Common::GraphQL.version(request)
             version_namespace = "V#{api_version.tr('.', 'x')}"
             openapi_doc       = ::Insights::API::Common::OpenApi::Docs.instance[api_version]

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

@@ -27,7 +27,7 @@
     preload :<%= associations %>
 
     resolve lambda { |obj, args, _ctx|
-      ::Insights::API::Common::GraphQL::AssociationLoader.new(<%= klass_name.constantize %>, "<%= associations %>", args).load(obj)
+      ::Insights::API::Common::GraphQL::AssociationLoader.new(<%= klass_name.constantize %>, "<%= associations %>", args, graphql_options).load(obj)
     }
   end
 <%   end %>

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

@@ -40,9 +40,15 @@ QueryType = ::GraphQL::ObjectType.define do
             openapi_doc.definitions[openapi_schema_name]).apply
         end
         scope = ::Insights::API::Common::GraphQL.search_options(scope, args)
-        ::Insights::API::Common::PaginatedResponse.new(
-          base_query: scope, request: nil, limit: args[:limit], offset: args[:offset], sort_by: args[:sort_by]
-        ).records
+        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]
+          ).records
+        else
+          ::Insights::API::Common::PaginatedResponse.new(
+            base_query: scope, request: nil, limit: args[:limit], offset: args[:offset], sort_by: args[:sort_by]
+          ).records
+        end
       }
     end
   end

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

@@ -10,6 +10,7 @@ module Insights
           @limit      = (limit || 100).to_i.clamp(1, 1000)
           @offset     = (offset || 0).to_i.clamp(0, Float::INFINITY)
           @sort_by    = sort_by
+          validate_sort_by
         end
 
         def records
@@ -96,12 +97,20 @@ module Insights
               sort_attr, sort_order = selection.split(':')
               sort_order ||= "asc"
               arel = model.arel_attribute(sort_attr)
-              arel = arel.asc  if sort_order == "asc"
-              arel = arel.desc if sort_order == "desc"
-              arel
+              (sort_order == "desc") ? arel.desc : arel.asc
             end
           end
         end
+
+        def validate_sort_by
+          return unless sort_by.present?
+          raise ArgumentError, "Invalid sort_by parameter specified \"#{sort_by}\"" unless sort_by.kind_of?(String) || sort_by.kind_of?(Array)
+          Array(sort_by).each { |key| validate_sort_by_directive(key) }
+        end
+
+        def validate_sort_by_directive(key)
+          raise ArgumentError, "Invalid sort_by directive specified \"#{key}\"" unless key.match?(/^[a-z\\-_]+(:asc|:desc)?$/)
+        end
       end
     end
   end

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

@@ -0,0 +1,38 @@
+module Insights
+  module API
+    module Common
+      class PaginatedResponseV2 < PaginatedResponse
+        attr_reader :limit, :offset, :sort_by
+
+        private
+
+        def sort_by_options(model)
+          @sort_by_options ||= begin
+            sort_options = []
+            return sort_options if sort_by.blank?
+
+            sort_by.each do |sort_attr, sort_order|
+              sort_order = "asc" if sort_order.blank?
+              arel = model.arel_attribute(sort_attr)
+              arel = (sort_order == "desc") ? arel.desc : arel.asc
+              sort_options << arel
+            end
+            sort_options
+          end
+        end
+
+        def validate_sort_by
+          return unless sort_by.present?
+          raise ArgumentError, "Invalid sort_by parameter specified \"#{sort_by}\"" unless sort_by.kind_of?(ActionController::Parameters) || sort_by.kind_of?(Hash)
+
+          sort_by.each { |sort_attr, sort_order| validate_sort_by_directive(sort_attr, sort_order) }
+        end
+
+        def validate_sort_by_directive(sort_attr, sort_order)
+          order = sort_order.blank? ? "asc" : sort_order
+          raise ArgumentError, "Invalid sort_by directive specified \"#{sort_attr}=#{sort_order}\"" unless sort_attr.match?(/^[a-z\\-_]+$/) && order.match?(/^(asc|desc)$/)
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Insights
   module API
     module Common
-      VERSION = "3.6.0".freeze
+      VERSION = "3.7.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.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Insights Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -359,12 +359,12 @@ files:
 - lib/insights/api/common/open_api/serializer.rb
 - lib/insights/api/common/option_redirect_enhancements.rb
 - lib/insights/api/common/paginated_response.rb
+- lib/insights/api/common/paginated_response_v2.rb
 - lib/insights/api/common/rbac/access.rb
 - lib/insights/api/common/rbac/policies.rb
 - lib/insights/api/common/rbac/roles.rb
 - lib/insights/api/common/rbac/seed.rb
 - lib/insights/api/common/rbac/service.rb
-- lib/insights/api/common/rbac/utilities.rb
 - lib/insights/api/common/rbac/validate_groups.rb
 - lib/insights/api/common/request.rb
 - lib/insights/api/common/routing.rb

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

@@ -1,30 +0,0 @@
-module Insights
-  module API
-    module Common
-      module RBAC
-        module Utilities
-          def validate_groups
-            Service.call(RBACApiClient::GroupApi) do |api|
-              uuids = SortedSet.new
-              Service.paginate(api, :list_groups, {}).each { |group| uuids << group.uuid }
-              missing = @group_uuids - uuids
-              raise Insights::API::Common::InvalidParameter, "The following group uuids are missing #{missing.to_a.join(",")}" unless missing.empty?
-            end
-          end
-
-          def unique_name(resource_id, group_id)
-            "#{@app_name}-#{@resource_name}-#{resource_id}-group-#{group_id}"
-          end
-
-          def parse_ids_from_name(name)
-            @regexp ||= Regexp.new("#{@app_name}-#{@resource_name}-(?<resource_id>.*)-group-(?<group_uuid>.*)")
-            result = @regexp.match(name)
-            if result
-              [result[:resource_id], result[:group_uuid]]
-            end
-          end
-        end
-      end
-    end
-  end
-end