warrant 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78f048c8c4f4611aafd280b84cce9cd09d8d664b6892030ec564bf34b80215ea
-  data.tar.gz: bba96bc3e9c504487af9b5ebad98b673b3592eb9b72fecba81ebf33e52ae54de
+  metadata.gz: b2de57e7f6362b34f03718a734f921659060d75eb720068cb4b891dfd0b54040
+  data.tar.gz: d410a14ae055941fd09cfc8476d6faf9d228f39596e5b6414b58a38520cf50ac
 SHA512:
-  metadata.gz: 0e4a8f1e22266df4957bbd40f45c0d42a336a13091d33cccb40482d632f98b494f05218de73c61a5bb85216116595751f5fc331f626afc3b6d7ea5ae017cf581
-  data.tar.gz: b4f41491a47957d3bfb888231e2b110d70d0fad7e24ff82a4f64a51460dd4a78fd8ab8a86d26b20433ff8ff403ca3f5b9051d976f1b0adb6869e98f92a08cecc
+  metadata.gz: ebd8297df53e8f8e2baa67bd602587344ef8ad2ffcc1db03a8e247a3a4cf2e41f55dd90916dd93196398a21a39a726ec8d4871cb3cd7f3f3c14ba9e6dd27ca14
+  data.tar.gz: 3e6b64ac8e89d4282f235190d9873045d608ce2a1eea4f4adbf0bf95924fbe2046321340d05b73c65eeffbfcd5c9d702ebdfed238af56cceb11aaa943b463ec3

data/lib/warrant/models/warrant.rb

@@ -88,29 +88,67 @@ module Warrant
             end
         end
 
-        # Query to find all warrants for a given subject.
+        # Query to find all warrants for a given object or subject.
         #
-        # @option params [String] :select Specifies the type of results to be returned by the query. Optionally, the `explicit` keyword can be provided (i.e. `explicit warrants`) to specify that only explicit results be returned. By default, both implicit and explicit results are returned.
-        # @option params [String] :for A list of conditions specifying which resources to query results for (i.e. "get all warrants **for role:admin**"). Only those warrants matching **all** of the conditions in the `for` clause are selected. If the `explicit` keyword is not specified in the `select` param, the resulting warrants are then expanded to determine if they imply other warrants (i.e. "the owner of a report is also an editor of that report"). Must be zero or more comma separated values in the format `object|relation|subject|context = val`. For object and subject filters, you can filter on all object ids by using the `*` character (i.e. `role:*`). (optional)
-        # @option params [String] :where A list of conditions to be applied to the result set before it is returned. If a where clause is provided, the query will only return results matching **all** conditions. Must be zero or more comma separated values in the format `object|relation|subject|context = val``. For object and subject filters, you can filter on all object ids by using the `*` character, i.e. `role:*`. (optional)
+        # @param warrant_query [WarrantQuery] Query to run for a set of warrants.
+        # @option filters [Integer] :page A positive integer (starting with 1) representing the page of items to return in response. Used in conjunction with the limit param. (optional)
+        # @option filters [Integer] :limit A positive integer representing the max number of items to return in response. (optional)
         #
-        # @return [Array<Warrant>] list of all warrants with provided params
+        # @return [Hash] Query result with `result` listing warrants returned and `meta` with metadata for the selected object types.
         #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::UnauthorizedError]
         # @raise [Warrant::WarrantError]
-        def self.query(params = {})
-            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/query"), params)
+        def self.query(warrant_query = WarrantQuery.new, filters = {})
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/query"), { "q": warrant_query.to_query_param, **filters })
 
             case res
             when Net::HTTPSuccess
-                warrants = JSON.parse(res.body)
-                warrants.map{ |warrant|
+                query_result = JSON.parse(res.body)
+                query_result['result'] = query_result['result'].map{ |warrant|
                     subject = Subject.new(warrant['subject']['objectType'], warrant['subject']['objectId'], warrant['subject']['relation'])
                     Warrant.new(warrant['objectType'], warrant['objectId'], warrant['relation'], subject, warrant['context'], warrant['isImplicit'])
                 }
+
+                if query_result['meta']['feature']
+                    query_result['meta']['feature'].each{ |featureId, feature|
+                        query_result['meta']['feature'][featureId] = Feature.new(feature['featureId'])
+                    }
+                end
+
+                if query_result['meta']['pricing-tier']
+                    query_result['meta']['pricing-tier'].each{ |pricingTierId, pricingTier|
+                        query_result['meta']['pricing-tier'][pricingTierId] = PricingTier.new(pricingTier['pricingTierId'])
+                    }
+                end
+
+                if query_result['meta']['permission']
+                    query_result['meta']['permission'].each{ |permissionId, permission|
+                        query_result['meta']['permission'][permissionId] = Permission.new(permission['permissionId'], permission['name'], permission['description'])
+                    }
+                end
+
+                if query_result['meta']['role']
+                    query_result['meta']['role'].each{ |roleId, role|
+                        query_result['meta']['role'][roleId] = Role.new(role['roleId'], role['name'], role['description'])
+                    }
+                end
+
+                if query_result['meta']['user']
+                    query_result['meta']['user'].each{ |userId, user|
+                        query_result['meta']['user'][userId] = User.new(user['userId'], user['email'], user['createdAt'])
+                    }
+                end
+
+                if query_result['meta']['tenant']
+                    query_result['meta']['tenant'].each{ |tenantId, tenant|
+                        query_result['meta']['tenant'][tenantId] = Tenant.new(tenant['tenantId'], tenant['name'], tenant['createdAt'])
+                    }
+                end
+
+                query_result
             else
                 APIOperations.raise_error(res)
             end

data/lib/warrant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Warrant
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/lib/warrant/warrant_query.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Warrant
+    class WarrantQuery
+        attr_accessor :select_clause, :for_clause, :where_clause
+
+        def initialize
+            @select_clause = []
+            @for_clause = {}
+            @where_clause = {}
+        end
+
+        def select(*object_types)
+            @select_clause = object_types
+            self
+        end
+
+        def select_explicit(*object_types)
+            @select_clause = "explicit #{object_types}"
+            self
+        end
+
+        def for(for_filters)
+            @for_clause = @for_clause.merge(for_filters)
+            self
+        end
+
+        def where(where_filters)
+            @where_clause = @where_clause.merge(where_filters)
+            self
+        end
+
+        def to_query_param
+            if @select_clause.length == 0 || @for_clause.empty?
+                raise "Must have a select and for clause"
+            end
+
+            query = "SELECT #{@select_clause.join(",")} FOR #{filters_hash_to_string(@for_clause)}"
+            query += " WHERE #{filters_hash_to_string(@where_clause)}" unless @where_clause.empty?
+
+            query
+        end
+
+        private
+
+        def filters_hash_to_string(filters)
+            filter_string = ""
+
+            if filters[:object]
+                filter_string += "object=#{filters[:object]}"
+            elsif filters[:subject]
+                filter_string += "subject=#{filters[:subject]}"
+            end
+
+            if filters[:context]
+                context_values = []
+                filters[:context].each{ |k, v|
+                    context_values.push("#{k}=#{v}")
+                }
+
+                filter_string += " AND context=[#{context_values.join(" ")}]"
+            end
+
+            filter_string
+        end
+    end
+end

data/lib/warrant.rb

@@ -7,6 +7,7 @@ require "json"
 require "forwardable"
 
 require "warrant/warrant_object"
+require "warrant/warrant_query"
 
 require "warrant/api_operations"
 require "warrant/errors"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warrant
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Warrant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies: []
 description: Ruby library for the Warrant API at https://warrant.dev.
 email: hello@warrant.dev
@@ -41,6 +41,7 @@ files:
 - lib/warrant/version.rb
 - lib/warrant/warrant_configuration.rb
 - lib/warrant/warrant_object.rb
+- lib/warrant/warrant_query.rb
 homepage: https://github.com/warrant-dev/warrant-ruby
 licenses:
 - MIT