manageiq-api-common 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 505d9b26de12a65214f045cba58f0cd0d3f03f24b52e34c9f91c93438107593a
-  data.tar.gz: 93742f14fcc2493740e3b85b42cbcd8f3bc2e06b0b1e35ee3e306dc5eacb6564
+  metadata.gz: 46a97632c285025bf8e8f2d7204409a6afb43b29b2781a72dcceba180770622e
+  data.tar.gz: a9574eb959db384c326bcc9b591a3a462e7991f1be340d1d8747712b9e5eea2f
 SHA512:
-  metadata.gz: 46a55bf1c465a7de8ef16d7245f182dc60b1e14a6a650ac4f882f894889df8fe481e160c76a8701b3882c2abd72656f1bd38d0cdadf1467dff70d4f6e29e9206
-  data.tar.gz: 90ece62ebe786c71c3bc94d20d6bbbacced40abe5168ab9aabf93d628289ab5ef47fd6a982958dd228c7c72fd90dc9dff8fbba4ac8173767d15aa452fc38bbb8
+  metadata.gz: 835d73ceb6bdbec6e860eb5ff0853282e90927cebe254b0eedf0edae535ce40264367fd0130a172a7f3be0ff02cd5aa2f92a5451c193554f88961b1e693202a5
+  data.tar.gz: ca867c61681bd9566cb68dcc20763c9ce2df4977202b0b4637f56f85f61a17ce8d90dcffa4148d125e798cb510097a770357c6cd87575be224422cd2f0cc67d3

data/README.md

@@ -67,6 +67,28 @@ After implementing filtering in your application, this is the way to filter via
 |"?filter[id][]=5&filter[id][]=10&filter[id][]=15&filter[id][]=20"|`{:filter => { :id => ["5", "10", "15", "20"]}}` <br> **`filter: { id: ["5", "10", "15", "20"] }`**|
 |"?filter[id][eq][]=5&filter[id][eq][]=10&filter[id][eq][]=15&filter[id][eq][]=20"|`{:filter => { :id => { :eq => ["5", "10", "15", "20"]}}}` <br> **`filter: { id: { eq: ["5", "10", "15", "20"] }`**|
 
+#### Sorting Results
+
+Sorting query results is controlled via the _sort_by_ query parameter. The _sort_by_ parameter is available for both REST API and GraphQL requests.
+
+The syntax for the _sort_by_ parameter supports:
+
+- a single string representing the attribute name to sort by which may be followed by :asc or :desc
+  - **attribute**   (_default order is ascending_)
+  - **attribute:asc** (_ascending order_)
+  - **attribute:desc** (_descending order_)
+- an array of strings of the above syntax
+
+##### Sort_by Examples:
+
+- GET /api/v1.0/sources?sort_by=name
+- GET /api/v1.0/vms?sort_by[]=power_state\&sort_by[]=memory:desc
+
+| Query Parameter | Ruby Client Parameter | GraphQL Parameter |
+| --------------- | --------------------- | ----------------- |
+| "?sort_by=name" | { :sort_by => "name" } | sort_by: "name" |
+| "?sort_by[]=power_state\&sort_by[]=memory:desc" | { :sort_by => ["power_state", "memory:desc"] } |  sort_by: ["power_state, "memory:desc"] |
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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

@@ -17,12 +17,12 @@ module ManageIQ
           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 => {})
+            @safe_params_for_list ||= params.merge(params_for_polymorphic_subcollection).permit(*permitted_params, :filter => {}, :sort_by => [])
           end
 
           def permitted_params
             check_if_openapi_enabled
-            api_doc_definition.all_attributes + [:limit, :offset] + [subcollection_foreign_key]
+            api_doc_definition.all_attributes + [:limit, :offset, :sort_by] + [subcollection_foreign_key]
           end
 
           def subcollection_foreign_key
@@ -98,6 +98,10 @@ module ManageIQ
             safe_params_for_list[:offset]
           end
 
+          def query_sort_by
+            safe_params_for_list[:sort_by]
+          end
+
           def params_for_update
             check_if_openapi_enabled
             body_params.permit(*api_doc_definition.all_attributes - api_doc_definition.read_only_attributes)

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

@@ -0,0 +1,29 @@
+module ManageIQ
+  module API
+    module Common
+      module ApplicationControllerMixins
+        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
+    end
+  end
+end

data/lib/manageiq/api/common/graphql.rb

@@ -8,6 +8,7 @@ require "manageiq/api/common/graphql/generator"
 require "manageiq/api/common/graphql/types/big_int"
 require "manageiq/api/common/graphql/types/date_time"
 require "manageiq/api/common/graphql/types/query_filter"
+require "manageiq/api/common/graphql/types/query_sort_by"
 
 module ManageIQ
   module API

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

@@ -18,10 +18,12 @@ QueryType = ::GraphQL::ObjectType.define do
       description "List available #{collection}"
       type types[resource_type]
 
-      argument :id, types.ID
-      argument :offset, types.Int, "The number of #{collection} to skip before starting to collect the result set"
-      argument :limit,  types.Int, "The number of #{collection} to return"
-      argument :filter, ::ManageIQ::API::Common::GraphQL::Types::QueryFilter, "The Query Filter for querying the #{collection}"
+      argument :id,      types.ID
+      argument :offset,  types.Int, "The number of #{collection} to skip before starting to collect the result set"
+      argument :limit,   types.Int, "The number of #{collection} to return"
+      argument :filter,  ::ManageIQ::API::Common::GraphQL::Types::QueryFilter, "The Query Filter for querying the #{collection}"
+      argument :sort_by, ::ManageIQ::API::Common::GraphQL::Types::QuerySortBy, "The optional attributes to sort by. Provided as an array of attr[:asc] and attr:desc values"
+
       resolve lambda { |_obj, args, ctx|
         if base_query.present?
           scope = base_query.call(model_class, ctx)
@@ -39,7 +41,7 @@ QueryType = ::GraphQL::ObjectType.define do
         end
         scope = ::ManageIQ::API::Common::GraphQL.search_options(scope, args)
         ::ManageIQ::API::Common::PaginatedResponse.new(
-          base_query: scope, request: nil, limit: args[:limit], offset: args[:offset]
+          base_query: scope, request: nil, limit: args[:limit], offset: args[:offset], sort_by: args[:sort_by]
         ).records
       }
     end

data/lib/manageiq/api/common/graphql/types/query_sort_by.rb

@@ -0,0 +1,16 @@
+module ManageIQ
+  module API
+    module Common
+      module GraphQL
+        module Types
+          QuerySortBy = ::GraphQL::ScalarType.define do
+            name "QuerySortBy"
+            description "The Query SortBy"
+
+            coerce_input ->(value, _ctx) { JSON.parse(value.to_json) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/manageiq/api/common/open_api/docs/doc_v3.rb

@@ -34,6 +34,16 @@ module ManageIQ
               request_operation.validate_request_body(payload_content_type, payload)
             end
 
+            def validate_parameters!(http_method, request_path, api_version, params)
+              path = request_path.split(api_version)[1]
+              raise "API version not found in request_path" if path.nil?
+
+              request_operation = validator_doc.request_operation(http_method.to_s.downcase, path)
+              return unless request_operation
+
+              request_operation.validate_request_parameter(params, {})
+            end
+
             def version
               @version ||= Gem::Version.new(content.fetch_path("info", "version"))
             end

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

@@ -97,6 +97,11 @@ module ManageIQ
                 "pattern"     => "^\\d+$",
                 "readOnly"    => true,
               },
+              "SortByAttribute"    => {
+                "type"        => "string",
+                "description" => "Attribute with optional order to sort the result set by.",
+                "pattern"     => "^[a-z\\-_]+(:asc|:desc)?$"
+              }
             }
           end
 
@@ -169,6 +174,18 @@ module ManageIQ
                   "default" => 0
                 }
               },
+              "QuerySortBy" => {
+                "in"          => "query",
+                "name"        => "sort_by",
+                "description" => "The list of attribute and order to sort the result set by.",
+                "required"    => false,
+                "schema"      => {
+                  "oneOf" => [
+                    { "$ref" => "##{SCHEMAS_PATH}/SortByAttribute" },
+                    { "type" => "array", "items" => { "$ref" => "##{SCHEMAS_PATH}/SortByAttribute" } }
+                  ]
+                }
+              }
             }
           end
 
@@ -194,7 +211,8 @@ module ManageIQ
               "parameters"  => [
                 { "$ref" => "##{PARAMETERS_PATH}/QueryLimit"  },
                 { "$ref" => "##{PARAMETERS_PATH}/QueryOffset" },
-                { "$ref" => "##{PARAMETERS_PATH}/QueryFilter" }
+                { "$ref" => "##{PARAMETERS_PATH}/QueryFilter" },
+                { "$ref" => "##{PARAMETERS_PATH}/QuerySortBy" }
               ],
               "responses"   => {
                 "200" => {

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

@@ -2,17 +2,23 @@ module ManageIQ
   module API
     module Common
       class PaginatedResponse
-        attr_reader :limit, :offset
+        attr_reader :limit, :offset, :sort_by
 
-        def initialize(base_query:, request:, limit: nil, offset: nil)
+        def initialize(base_query:, request:, limit: nil, offset: nil, sort_by: nil)
           @base_query = base_query
           @request    = request
           @limit      = (limit || 100).to_i.clamp(1, 1000)
           @offset     = (offset || 0).to_i.clamp(0, Float::INFINITY)
+          @sort_by    = sort_by
         end
 
         def records
-          @records ||= @base_query.order(:id).limit(limit).offset(offset)
+          @records ||= begin
+            res = @base_query.order(:id).limit(limit).offset(offset)
+            order_options = sort_by_options(res.klass)
+            res = res.reorder(order_options) if order_options.present?
+            res
+          end
         end
 
         def response
@@ -83,6 +89,19 @@ module ManageIQ
         def count
           @count ||= @base_query.count
         end
+
+        def sort_by_options(model)
+          @sort_by_options ||= begin
+            Array(sort_by).collect do |selection|
+              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
+            end
+          end
+        end
       end
     end
   end

data/lib/manageiq/api/common/rbac/query_shared_resource.rb

@@ -13,7 +13,7 @@ module ManageIQ
             @resource_id = options[:resource_id]
             @resource_name = options[:resource_name]
             @share_info = []
-            @roles = RBAC::Roles.new("#{@app_name}-#{@resource_name}-#{@resource_id}")
+            @roles = RBAC::Roles.new("#{@app_name}-#{@resource_name}-#{@resource_id}", 'account')
           end
 
           def process

data/lib/manageiq/api/common/rbac/share_resource.rb

@@ -17,7 +17,7 @@ module ManageIQ
 
           def process
             validate_groups
-            @roles = RBAC::Roles.new("#{@app_name}-#{@resource_name}-")
+            @roles = RBAC::Roles.new("#{@app_name}-#{@resource_name}-", 'account')
             @group_uuids.each { |uuid| manage_roles_for_group(uuid) }
             self
           end

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

@@ -1,7 +1,7 @@
 module ManageIQ
   module API
     module Common
-      VERSION = "2.0.1".freeze
+      VERSION = "2.1.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-api-common
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_tenant
@@ -327,6 +327,7 @@ files:
 - lib/manageiq/api/common/application_controller_mixins/openapi_enabled.rb
 - lib/manageiq/api/common/application_controller_mixins/parameters.rb
 - lib/manageiq/api/common/application_controller_mixins/request_body_validation.rb
+- lib/manageiq/api/common/application_controller_mixins/request_parameter_validation.rb
 - lib/manageiq/api/common/application_controller_mixins/request_path.rb
 - lib/manageiq/api/common/engine.rb
 - lib/manageiq/api/common/entitlement.rb
@@ -342,6 +343,7 @@ files:
 - lib/manageiq/api/common/graphql/types/big_int.rb
 - lib/manageiq/api/common/graphql/types/date_time.rb
 - lib/manageiq/api/common/graphql/types/query_filter.rb
+- lib/manageiq/api/common/graphql/types/query_sort_by.rb
 - lib/manageiq/api/common/inflections.rb
 - lib/manageiq/api/common/logging.rb
 - lib/manageiq/api/common/metrics.rb