warrant 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c44e60e9d2c5fef31622621a356033848368ba16854759d81ec6797ba3a0dbe
-  data.tar.gz: 146f08b5bac7ed1db618f39ef8e6c7f0a2884b8167e65c3812d2ee0d41fcf2c6
+  metadata.gz: d3ba7f4c3cde89c03aa17c15bfe00fa553172b27365b2e25548e7f349f38d799
+  data.tar.gz: 0fbc797a1768ca2aa47a08a7b2864a4398c25ed3deb2ff26f45e113855961c8c
 SHA512:
-  metadata.gz: 27f2a30747e35747387f294a05d221571488fc60f4c4522257770352eeea31ad1785c77b5579c2de031265c07ade7f9fe49b7cb91962282a662e53e3945ba758
-  data.tar.gz: 59c909e93d57c04301bcf13600573e073ebe61c83493ceed1c280c9629745cfe1cc40e089d71a804608bd768d39039563cfae2cde9410c30d19a9d007f29a35a
+  metadata.gz: 9240a10a74f6cf277e2a94d392181dbb66f89b5a970b6d4688c3fd6582ecde03fdfdf9dca63294be48f9de48d03d5c2bf0f5b1d5fc9bc689d87876365fde0192
+  data.tar.gz: 5950abb71082b36b859c8679952a1055b6726588353db03df292e036ee11e239c41cdf0abf76995bb1a2c82d34aa21e3bf6643832ba9315e7810a6261c2938c3

data/lib/warrant/models/subject.rb

@@ -9,5 +9,13 @@ module Warrant
             @object_id = object_id
             @relation = relation
         end
+
+        def self.new_from_hash(attributes)
+            object_type = attributes.fetch(:object_type)
+            object_id = attributes.fetch(:object_id)
+            relation = attributes.fetch(:relation, nil)
+
+            self.new(object_type, object_id, relation)
+        end
     end
 end

data/lib/warrant/models/tenant.rb

@@ -164,5 +164,71 @@ module Warrant
         def update(params = {})
             return Tenant.update(tenant_id, params)
         end
+
+        # Add a user to a tenant
+        #
+        # @param user_id [String] The user_id of the user you want to add to the tenant.
+        #
+        # @return [Warrant] warrant assigning user to the tenant
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def add_user(user_id)
+            return User.add_to_tenant(tenant_id, user_id)
+        end
+
+        # Remove a user from a tenant
+        #
+        # @param user_id [String] The user_id of the user you want to remove from the tenant.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def remove_user(user_id)
+            return User.remove_from_tenant(tenant_id, user_id)
+        end
+
+        # List all tenants for a user 
+        #
+        # @param user_id [String] The user_id of the user from which to fetch tenants
+        #
+        # @return [Array<Tenant>] all tenants for the user
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.list_for_user(user_id)
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/tenants"))
+
+            case res
+            when Net::HTTPSuccess
+                tenants = JSON.parse(res.body)
+                tenants.map{ |tenant| Tenant.new(tenant['tenantId'], tenant['name'], tenant['createdAt']) }
+            else
+                APIOperations.raise_error(res)
+            end   
+        end
+
+        # List all users for a tenant 
+        #
+        # @return [Array<User>] all users for the tenant
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def list_users
+            return User.list_for_tenant(tenant_id)
+        end
     end
 end

data/lib/warrant/models/user.rb

@@ -87,7 +87,7 @@ module Warrant
                 users.map{ |user| User.new(user['userId'], user['email'], user['createdAt']) }
             else
                 APIOperations.raise_error(res)
-            end   
+            end
         end
 
         # Get a user with the given user_id
@@ -111,7 +111,7 @@ module Warrant
                 User.new(user['userId'], user['email'], user['createdAt'])
             else
                 APIOperations.raise_error(res)
-            end  
+            end
         end
 
         # Updates a user with the given user_id and params
@@ -182,7 +182,7 @@ module Warrant
                 roles.map{ |role| Role.new(role['roleId']) }
             else
                 APIOperations.raise_error(res)
-            end 
+            end
         end
 
         # Assign a role to a user
@@ -227,7 +227,7 @@ module Warrant
             return Role.remove_from_user(user_id, role_id)
         end
 
-        # List all permissions for a user 
+        # List all permissions for a user
         #
         # @return [Array<Permission>] all permissions for the user
         #
@@ -244,12 +244,11 @@ module Warrant
                 permissions.map{ |permission| Permission.new(permission['permissionId']) }
             else
                 APIOperations.raise_error(res)
-            end 
+            end
         end
 
         # Assign a permission to a user
         #
-        # @param user_id [String] The user_id of the user you want to assign a permission to.
         # @param permission_id [String] The permission_id of the permission you want to assign to a user.
         #
         # @return [Permission] assigned permission
@@ -270,7 +269,6 @@ module Warrant
 
         # Remove a permission from a user
         #
-        # @param user_id [String] The user_id of the user you want to assign a permission to.
         # @param permission_id [String] The permission_id of the permission you want to assign to a user.
         #
         # @return [nil] if remove was successful
@@ -319,5 +317,89 @@ module Warrant
                 }]
             )
         end
+
+        # Add a user to a tenant
+        #
+        # @param tenant_id [String] The tenant_id of the tenant you want to assign a user to.
+        # @param user_id [String] The user_id of the user you want to add to the tenant.
+        #
+        # @return [Warrant] warrant assigning user to the tenant
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.add_to_tenant(tenant_id, user_id)
+            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}/users/#{user_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                res_json = JSON.parse(res.body)
+                subject = Subject.new(res_json['subject']['objectType'], res_json['subject']['objectId'], res_json['subject']['relation'])
+                Warrant.new(res_json['objectType'], res_json['objectId'], res_json['relation'], subject)
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Remove a user from a tenant
+        #
+        # @param tenant_id [String] The tenant_id of the tenant you want to remove the user from.
+        # @param user_id [String] The user_id of the user you want to remove from the tenant.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.remove_from_tenant(tenant_id, user_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}/users/#{user_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # List all users for a tenant
+        #
+        # @param tenant_id [String] The tenant_id of the tenant from which to fetch users
+        #
+        # @return [Array<User>] all users for the tenant
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.list_for_tenant(tenant_id)
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}/users"))
+
+            case res
+            when Net::HTTPSuccess
+                users = JSON.parse(res.body)
+                users.map{ |user| User.new(user['userId'], user['email'], user['createdAt']) }
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # List all tenants for a user
+        #
+        # @return [Array<Tenant>] all tenants for the user
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def list_tenants
+            return Tenant.list_for_user(user_id)
+        end
     end
 end

data/lib/warrant/models/warrant.rb

@@ -2,14 +2,15 @@
 
 module Warrant
     class Warrant
-        attr_reader :id, :object_type, :object_id, :relation, :subject
+        attr_reader :id, :object_type, :object_id, :relation, :subject, :is_direct_match
 
         # @!visibility private
-        def initialize(object_type, object_id, relation, subject)
+        def initialize(object_type, object_id, relation, subject, is_direct_match = nil)
             @object_type = object_type
             @object_id = object_id
             @relation = relation
             @subject = subject
+            @is_direct_match = is_direct_match
         end
 
         # Create a new warrant that associates an object (object_type and object_id) to a subject via a relation.
@@ -38,7 +39,7 @@ module Warrant
 
             case res
             when Net::HTTPSuccess
-                subject = Subject.new(res_json['subject']['objectType'], res_json['subject']['objectId'])
+                subject = Subject.new(res_json['subject']['objectType'], res_json['subject']['objectId'], res_json['subject']['relation'])
                 Warrant.new(res_json['objectType'], res_json['objectId'], res_json['relation'], subject)
             else
                 APIOperations.raise_error(res)
@@ -95,7 +96,7 @@ module Warrant
             when Net::HTTPSuccess
                 warrants = JSON.parse(res.body)
                 warrants.map{ |warrant|
-                    subject = Subject.new(warrant['subject']['objectType'], warrant['subject']['objectId'])
+                    subject = Subject.new(warrant['subject']['objectType'], warrant['subject']['objectId'], warrant['subject']['relation'])
                     Warrant.new(warrant['objectType'], warrant['objectId'], warrant['relation'], subject)
                 }
             else
@@ -103,6 +104,38 @@ module Warrant
             end
         end
 
+        # Query to find all warrants for a given subject.
+        #
+        # @option params [String] :object_type The type of object. Must be one of your system's existing object types. (optional)
+        # @option params [String] :relation The relation for this object to subject association. The relation must be valid as per the object type definition. (optional)
+        # @option params [String] :subject The subject to query warrants for. This should be in the format `OBJECT_TYPE:OBJECT_ID`, i.e. `user:8`
+        #   * subject (Hash) - The specific subject for which warrants will be queried for.
+        #       * object_type (String) - The type of object. Must be one of your system's existing object types.
+        #       * object_id (String) - The id of the specific object.
+        #
+        # @return [Array<Warrant>] list of all warrants with provided params
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.query(params = {})
+            params[:subject] = Subject.new_from_hash(params[:subject])
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/query"), params)
+
+            case res
+            when Net::HTTPSuccess
+                warrants = JSON.parse(res.body)
+                warrants.map{ |warrant|
+                    subject = Subject.new(warrant['subject']['objectType'], warrant['subject']['objectId'], warrant['subject']['relation'])
+                    Warrant.new(warrant['objectType'], warrant['objectId'], warrant['relation'], subject, warrant['isDirectMatch'])
+                }
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
         # Checks whether a specified access check is authorized or not.
         # If you would like to check only one warrant, then you can exclude the op param and provide an array with one warrant.
         #

data/lib/warrant/util.rb

@@ -32,6 +32,8 @@ module Warrant
                         new_opts[new_key] = normalize_params(v)
                     when Array
                         new_opts[new_key] = v.map { |i| normalize_params(i) }
+                    when Subject
+                        new_opts[new_key] = "#{v.object_type}:#{v.object_id}"
                     else
                         new_opts[new_key] = v
                     end

data/lib/warrant/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warrant
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Warrant
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies: []
 description: Ruby library for the Warrant API at https://warrant.dev.
 email: hello@warrant.dev
@@ -46,7 +46,7 @@ metadata:
   source_code_uri: https://github.com/warrant-dev/warrant-ruby
   changelog_uri: https://github.com/warrant-dev/warrant-ruby/CHANGELOG.md
   documentation_uri: https://docs.warrant.dev/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Warrant Ruby Library
 test_files: []