warrant 3.1.0 → 5.0.0

data/lib/warrant/models/tenant.rb

@@ -1,24 +1,22 @@
 # frozen_string_literal: true
 
 module Warrant
-    class Tenant
+    class Tenant < Warrant::Object
         OBJECT_TYPE = "tenant"
 
         include Warrant::WarrantObject
 
-        attr_reader :tenant_id, :name, :created_at
+        alias :tenant_id :object_id
 
         # @!visibility private
-        def initialize(tenant_id, name, created_at)
-            @tenant_id = tenant_id
-            @name = name
-            @created_at = created_at
+        def initialize(tenant_id, meta = {}, created_at = nil)
+            super(OBJECT_TYPE, tenant_id, meta, created_at)
         end
 
         # Creates a tenant with the given parameters
         #
         # @option params [String] :tenant_id User defined string identifier for this tenant. If not provided, Warrant will create an id for the tenant and return it. In this case, you should store the id in your system for future reference. Note that tenantIds in Warrant must be composed of alphanumeric chars and/or '-', '_', and '@'. (optional)
-        # @option params [String] :name A displayable name for this tenant. (optional)
+        # @option params [Hash] :meta A JSON object containing additional information about this tenant (e.g. name/description, etc.) to be persisted to Warrant. (optional)
         #
         # @return [Tenant] created tenant
         #
@@ -31,23 +29,16 @@ module Warrant
         # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def self.create(params = {})
-            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/tenants"), Util.normalize_params(params))
-
-            case res
-            when Net::HTTPSuccess
-                res_json = JSON.parse(res.body)
-                Tenant.new(res_json['tenantId'], res_json['name'], res_json['createdAt'])
-            else
-                APIOperations.raise_error(res)
-            end
+        def self.create(params = {}, options = {})
+            object = Object.create({ object_type: OBJECT_TYPE, object_id: params[:tenant_id], meta: params[:meta] }, options)
+            return Tenant.new(object.object_id, object.meta, object.created_at)
         end
 
         # Batch creates multiple tenants with given parameters
         #
-        # @param [Array] Array of tenants to create.
-        #   * tenant_id User defined string identifier for this tenant. If not provided, Warrant will create an id for the tenant and return it. In this case, you should store the id in your system for future reference. Note that tenantIds in Warrant must be composed of alphanumeric chars and/or '-', '_', and '@'. (optional)
-        #   * name A displayable name for this tenant. (optional)
+        # @param [Array<Hash>] tenants Array of tenants to create.
+        # @option tenants [String] :tenant_id User defined string identifier for this tenant. If not provided, Warrant will create an id for the tenant and return it. In this case, you should store the id in your system for future reference. Note that tenantIds in Warrant must be composed of alphanumeric chars and/or '-', '_', and '@'. (optional)
+        # @option tenants [Hash] :meta A JSON object containing additional information about the tenant (e.g. name/description, etc.) to be persisted to Warrant. (optional)
         #
         # @return [Array<Tenant>] all created tenants
         #
@@ -60,21 +51,14 @@ module Warrant
         # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def self.batch_create(tenants = [])
-            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/tenants"), Util.normalize_params(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
+        def self.batch_create(tenants, options = {})
+            res = Object.batch_create(tenants.map{ |tenant| { object_type: OBJECT_TYPE, object_id: tenant[:tenant_id], meta: tenant[:meta] }}, options)
+            return res.map{ |obj| Tenant.new(obj.object_id, obj.meta, obj.created_at)}
         end
 
         # Deletes a tenant with given tenant id
         #
-        # @param tenant_id [String] User defined string identifier for this tenant. If not provided, Warrant will create an id for the tenant and return it. In this case, you should store the id in your system for future reference. Note that tenantIds in Warrant must be composed of alphanumeric chars and/or '-', '_', and '@'.
+        # @param tenant_id [String] User defined string identifier for this tenant.
         #
         # @return [nil] if delete was successful
         #
@@ -84,21 +68,44 @@ module Warrant
         # @raise [Warrant::InternalError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def self.delete(tenant_id)
-            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}"))
+        def self.delete(tenant_id, options = {})
+            return Object.delete(OBJECT_TYPE, tenant_id, options)
+        end
 
-            case res
-            when Net::HTTPSuccess
-                return
-            else
-                APIOperations.raise_error(res)
-            end
+        # Batch deletes multiple tenants with given parameters
+        #
+        # @param [Array<Hash, Tenant>] tenants Array of tenants to delete.
+        # @option tenants [String] :tenant_id Customer defined string identifier for this tenant.
+        #
+        # @return [nil] if delete was successful
+        #
+        # @example Delete two tenants with ids "test-tenant-1" and "test-tenant-2"
+        #   Warrant::Tenant.batch_delete([{ tenant_id: "test-tenant-1" }, { tenant_id: "test-tenant-2" }])
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.batch_delete(tenants, options = {})
+            return Object.batch_delete(tenants.map{ |tenant|
+                if tenant.instance_of? Tenant
+                    { object_type: OBJECT_TYPE, object_id: tenant.object_id }
+                else
+                    { object_type: OBJECT_TYPE, object_id: tenant[:tenant_id] }
+                end
+            }, options)
         end
 
         # Lists all tenants for your organization
         #
-        # @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)
+        # @param [Hash] filters Filters to apply to result set
+        # @param [Hash] options Options to apply on a per-request basis
+        # @option filters [Integer] :limit A positive integer representing the maximum number of items to return in the response. Must be less than or equal to 1000. Defaults to 25. (optional)
+        # @option filters [String] :prev_cursor A cursor representing your place in a list of results. Requests containing prev_cursor will return the results immediately preceding the cursor. (optional)
+        # @option filters [String] :next_cursor A cursor representing your place in a list of results. Requests containing next_cursor will return the results immediately following the cursor. (optional)
+        # @option filters [String] :sort_by The column to sort the result by. Unless otherwise specified, all list endpoints are sorted by their unique identifier by default. Supported values for objects are +object_type+, +object_id+, and +created_at+ (optional)
+        # @option filters [String] :sort_order The order in which to sort the result by. Valid values are +ASC+ and +DESC+. Defaults to +ASC+. (optional)
+        # @option options [String] :warrant_token A valid warrant token from a previous write operation or latest. Used to specify desired consistency for this read operation. (optional)
         #
         # @return [Array<Tenant>] all tenants for your organization
         #
@@ -108,16 +115,11 @@ module Warrant
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::UnauthorizedError]
-        def self.list(filters = {})
-            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/tenants"), Util.normalize_params(filters))
-
-            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
+        def self.list(filters = {}, options = {})
+            filters.merge({ object_type: "tenant" })
+            list_response = Object.list(filters, options)
+            tenants = list_response.results.map{ |object| Tenant.new(object.object_id, object.meta, object.created_at)}
+            return ListResponse.new(tenants, list_response.prev_cursor, list_response.next_cursor)
         end
 
         # Get a tenant with the given tenant_id
@@ -130,67 +132,53 @@ module Warrant
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def self.get(tenant_id)
-            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}"))
-
-            case res
-            when Net::HTTPSuccess
-                tenant = JSON.parse(res.body)
-                Tenant.new(tenant['tenantId'], tenant['name'], tenant['createdAt'])
-            else
-                APIOperations.raise_error(res)
-            end
+        def self.get(tenant_id, options = {})
+            object = Object.get(OBJECT_TYPE, tenant_id, options)
+            return Tenant.new(object.object_id, object.meta, object.created_at)
         end
 
-        # Updates a tenant with the given tenant_id and params
+        # Updates a tenant with the given tenant_id
         #
-        # @param tenant_id [String] User defined string identifier for this tenant. If not provided, Warrant will create an id for the tenant and return it. In this case, you should store the id in your system for future reference. Note that tenantIds in Warrant must be composed of alphanumeric chars and/or '-', '_', and '@'.
-        # @param [Hash] params attributes to update tenant with
-        # @option params [String] :name A displayable name for this tenant. (optional)
+        # @param tenant_id [String] User defined string identifier for this tenant.
+        # @param meta [Hash] A JSON object containing additional information about this tenant (e.g. name/description, etc.) to be persisted to Warrant.
         #
         # @return [Tenant] updated tenant
         #
-        # @example Update tenant "test-tenant"'s name
-        #   Warrant::Tenant.update("test-tenant", { name: "my-new-name@example.com" })
+        # @example Update tenant "test-tenant"'s email
+        #   Warrant::Tenant.update("test-tenant", { email: "my-new-email@example.com" })
         #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def self.update(tenant_id, params = {})
-            res = APIOperations.put(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}"), Util.normalize_params(params))
-
-            case res
-            when Net::HTTPSuccess
-                res_json = JSON.parse(res.body)
-                Tenant.new(res_json['tenantId'], res_json['name'], res_json['createdAt'])
-            else
-                APIOperations.raise_error(res)
-            end
+        def self.update(tenant_id, meta, options = {})
+            object = Object.update(OBJECT_TYPE, tenant_id, meta, options)
+            return Tenant.new(object.object_id, object.meta, object.created_at)
         end
 
         # Updates the tenant with the given params
         #
-        # @option params [String] :name A displayable name for this tenant. (optional)
+        # @param meta [Hash] A JSON object containing additional information about this tenant (e.g. name/description, etc.) to be persisted to Warrant.
         #
         # @return [Tenant] updated tenant
         #
         # @example Update tenant "test-tenant"'s name
         #   tenant = Warrant::Tenant.get("test-tenant")
-        #   tenant.update(name: "my-new-name@example.com")
+        #   tenant.update({ name: "my-new-name@example.com" })
         #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def update(params = {})
-            return Tenant.update(tenant_id, params)
+        def update(meta, options = {})
+            return Tenant.update(tenant_id, meta, options)
         end
 
         # Add a user to a tenant
         #
         # @param user_id [String] The user_id of the user you want to add to the tenant.
+        # @param relation [String] The relation for this tenant to user association. The relation must be valid as per the +tenant+ object type definition.
         #
         # @return [Warrant] warrant assigning user to the tenant
         #
@@ -199,13 +187,14 @@ module Warrant
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def assign_user(user_id)
-            return User.assign_to_tenant(tenant_id, user_id)
+        def assign_user(user_id, relation: "member", options: {})
+            return User.assign_to_tenant(tenant_id, user_id, relation: relation, options: options)
         end
 
         # Remove a user from a tenant
         #
         # @param user_id [String] The user_id of the user you want to remove from the tenant.
+        # @param relation [String] The relation for this tenant to user association. The relation must be valid as per the +tenant+ object type definition.
         #
         # @return [nil] if remove was successful
         #
@@ -213,31 +202,32 @@ module Warrant
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
         # @raise [Warrant::WarrantError]
-        def remove_user(user_id)
-            return User.remove_from_tenant(tenant_id, user_id)
+        def remove_user(user_id, relation: "member", options: {})
+            return User.remove_from_tenant(tenant_id, user_id, relation: relation, options: options)
         end
 
         # List all tenants for a user
         #
         # @param user_id [String] The user_id of the user from which to fetch tenants
-        # @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)
+        # @param [Hash] filters Filters to apply to result set
+        # @param [Hash] options Options to apply on a per-request basis
+        # @option filters [String] :object_type Only return objects with an `objectType` matching this value
+        # @option filters [Integer] :limit A positive integer representing the maximum number of items to return in the response. Must be less than or equal to 1000. Defaults to 25. (optional)
+        # @option filters [String] :prev_cursor A cursor representing your place in a list of results. Requests containing prev_cursor will return the results immediately preceding the cursor. (optional)
+        # @option filters [String] :next_cursor A cursor representing your place in a list of results. Requests containing next_cursor will return the results immediately following the cursor. (optional)
+        # @option filters [String] :sort_by The column to sort the result by. Unless otherwise specified, all list endpoints are sorted by their unique identifier by default. Supported values for objects are +object_type+, +object_id+, and +created_at+ (optional)
+        # @option filters [String] :sort_order The order in which to sort the result by. Valid values are +ASC+ and +DESC+. Defaults to +ASC+. (optional)
+        # @option options [String] :warrant_token A valid warrant token from a previous write operation or latest. Used to specify desired consistency for this read operation. (optional)
         #
         # @return [Array<Tenant>] all tenants for the user
         #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::UnauthorizedError]
-        def self.list_for_user(user_id, filters = {})
-            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/tenants"), Util.normalize_params(filters))
-
-            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
+        def self.list_for_user(user_id, filters = {}, options = {})
+            query_response = Warrant.query("select tenant where user:#{user_id} is *", filters: filters, options: options)
+            tenants = query_response.results.map{ |result| Tenant.new(result.object_id, result.meta) }
+            return ListResponse.new(tenants, query_response.prev_cursor, query_response.next_cursor)
         end
 
         # List all users for a tenant
@@ -248,27 +238,35 @@ module Warrant
         # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::UnauthorizedError]
         # @raise [Warrant::WarrantError]
-        def list_users
-            return User.list_for_tenant(tenant_id)
+        def list_users(filters = {}, options = {})
+            return User.list_for_tenant(tenant_id, filters, options)
         end
 
         # List pricing tiers for a tenant
         #
-        # @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)
+        # @param [Hash] filters Filters to apply to result set
+        # @param [Hash] options Options to apply on a per-request basis
+        # @option filters [String] :object_type Only return objects with an `objectType` matching this value
+        # @option filters [Integer] :limit A positive integer representing the maximum number of items to return in the response. Must be less than or equal to 1000. Defaults to 25. (optional)
+        # @option filters [String] :prev_cursor A cursor representing your place in a list of results. Requests containing prev_cursor will return the results immediately preceding the cursor. (optional)
+        # @option filters [String] :next_cursor A cursor representing your place in a list of results. Requests containing next_cursor will return the results immediately following the cursor. (optional)
+        # @option filters [String] :sort_by The column to sort the result by. Unless otherwise specified, all list endpoints are sorted by their unique identifier by default. Supported values for objects are +object_type+, +object_id+, and +created_at+ (optional)
+        # @option filters [String] :sort_order The order in which to sort the result by. Valid values are +ASC+ and +DESC+. Defaults to +ASC+. (optional)
+        # @option options [String] :warrant_token A valid warrant token from a previous write operation or latest. Used to specify desired consistency for this read operation. (optional)
         #
         # @return [Array<Feature>] assigned pricing tiers for the tenant
         #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::UnauthorizedError]
-        def list_pricing_tiers(filters = {})
-            return PricingTier.list_for_tenant(tenant_id, filters)
+        def list_pricing_tiers(filters = {}, options = {})
+            return PricingTier.list_for_tenant(tenant_id, filters, options)
         end
 
         # Assign a pricing tier to a tenant
         #
         # @param pricing_tier_id [String] The pricing_tier_id of the pricing tier you want to assign to the tenant.
+        # @param relation [String] The relation for this pricing tier to tenant association. The relation must be valid as per the +pricing tier+ object type definition.
         #
         # @return [PricingTier] assigned pricing tier
         #
@@ -277,13 +275,14 @@ module Warrant
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def assign_pricing_tier(pricing_tier_id)
-            return PricingTier.assign_to_tenant(tenant_id, pricing_tier_id)
+        def assign_pricing_tier(pricing_tier_id, relation: "member", options: {})
+            return PricingTier.assign_to_tenant(tenant_id, pricing_tier_id, relation: relation, options: options)
         end
 
         # Remove a pricing_tier from a tenant
         #
         # @param pricing_tier_id [String] The pricing_tier_id of the pricing_tier you want to remove from the tenant.
+        # @param relation [String] The relation for this pricing tier to tenant association. The relation must be valid as per the +pricing tier+ object type definition.
         #
         # @return [nil] if remove was successful
         #
@@ -292,27 +291,35 @@ module Warrant
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
         # @raise [Warrant::WarrantError]
-        def remove_pricing_tier(pricing_tier_id)
-            return PricingTier.remove_from_tenant(tenant_id, pricing_tier_id)
+        def remove_pricing_tier(pricing_tier_id, relation: "member", options: {})
+            return PricingTier.remove_from_tenant(tenant_id, pricing_tier_id, relation: relation, options: options)
         end
 
         # List features for a tenant
         #
-        # @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)
+        # @param [Hash] filters Filters to apply to result set
+        # @param [Hash] options Options to apply on a per-request basis
+        # @option filters [String] :object_type Only return objects with an `objectType` matching this value
+        # @option filters [Integer] :limit A positive integer representing the maximum number of items to return in the response. Must be less than or equal to 1000. Defaults to 25. (optional)
+        # @option filters [String] :prev_cursor A cursor representing your place in a list of results. Requests containing prev_cursor will return the results immediately preceding the cursor. (optional)
+        # @option filters [String] :next_cursor A cursor representing your place in a list of results. Requests containing next_cursor will return the results immediately following the cursor. (optional)
+        # @option filters [String] :sort_by The column to sort the result by. Unless otherwise specified, all list endpoints are sorted by their unique identifier by default. Supported values for objects are +object_type+, +object_id+, and +created_at+ (optional)
+        # @option filters [String] :sort_order The order in which to sort the result by. Valid values are +ASC+ and +DESC+. Defaults to +ASC+. (optional)
+        # @option options [String] :warrant_token A valid warrant token from a previous write operation or latest. Used to specify desired consistency for this read operation. (optional)
         #
         # @return [Array<Feature>] assigned features for the tenant
         #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::UnauthorizedError]
-        def list_features(filters = {})
-            return Feature.list_for_tenant(tenant_id, filters)
+        def list_features(filters = {}, options = {})
+            return Feature.list_for_tenant(tenant_id, filters, options)
         end
 
         # Assign a feature to a tenant
         #
         # @param feature_id [String] The feature_id of the feature you want to assign to the tenant.
+        # @param relation [String] The relation for this feature to tenant association. The relation must be valid as per the +feature+ object type definition.
         #
         # @return [Feature] assigned feature
         #
@@ -321,13 +328,14 @@ module Warrant
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def assign_feature(feature_id)
-            return Feature.assign_to_tenant(tenant_id, feature_id)
+        def assign_feature(feature_id, relation: "member", options: {})
+            return Feature.assign_to_tenant(tenant_id, feature_id, relation: relation, options: options)
         end
 
         # Remove a feature from a tenant
         #
         # @param feature_id [String] The feature_id of the feature you want to remove from the tenant.
+        # @param relation [String] The relation for this feature to tenant association. The relation must be valid as per the +feature+ object type definition.
         #
         # @return [nil] if remove was successful
         #
@@ -336,34 +344,34 @@ module Warrant
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
         # @raise [Warrant::WarrantError]
-        def remove_feature(feature_id)
-            return Feature.remove_from_tenant(tenant_id, feature_id)
+        def remove_feature(feature_id, relation: "member", options: {})
+            return Feature.remove_from_tenant(tenant_id, feature_id, relation: relation, options: options)
         end
 
         # Check whether a tenant has a given feature
         #
         # @param feature_id [String] The feature_id of the feature to check whether the tenant has access to.
+        # @param relation [String] The relation for this feature to tenant association. The relation must be valid as per the +feature+ object type definition.
         # @option options [Hash] :context Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @option options [Boolean] :consistent_read Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
         # @option options [Boolean] :debug Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
-        # @ return [Boolean] whether or not the tenant has the given feature
+        # @return [Boolean] whether or not the tenant has the given feature
         #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        def has_feature?(feature_id, opts = {})
-            return Warrant.has_feature?(
+        def has_feature?(feature_id, relation: "member", options: {})
+            return Warrant.has_feature?({
                 feature_id: feature_id,
+                relation: relation,
                 subject: {
                     object_type: "tenant",
                     object_id: tenant_id
                 },
-                context: opts[:context],
-                consistent_read: opts[:consistent_read],
-                debug: opts[:debug]
-            )
+                context: options[:context],
+                debug: options[:debug]
+            }, options)
         end
 
         def warrant_object_type