warrant 1.2.0 → 2.0.0.rc3

data/lib/warrant/models/tenant.rb

@@ -2,8 +2,10 @@
 
 module Warrant
     class Tenant
+        include Warrant::WarrantObject
+
         attr_reader :tenant_id, :name, :created_at
-        
+
         # @!visibility private
         def initialize(tenant_id, name, created_at)
             @tenant_id = tenant_id
@@ -20,15 +22,13 @@ module Warrant
         #
         # @example Create a new Tenant with the tenant id "test-customer"
         #   Warrant::Tenant.create(tenant_id: "test-customer")
-        # 
+        #
         # @raise [Warrant::DuplicateRecordError]
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::InvalidRequestError]
-        # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.create(params = {})
             res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/tenants"), Util.normalize_params(params))
 
@@ -41,6 +41,35 @@ module Warrant
             end
         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)
+        #
+        # @return [Array<Tenant>] all created tenants
+        #
+        # @example Create two new tenants with tenant ids "test-tenant-1" and "test-tenant-2"
+        #   Warrant::Tenant.batch_create([{ tenant_id: "test-tenant-1" }, { tenant_id: "test-tenant-2" }])
+        #
+        # @raise [Warrant::DuplicateRecordError]
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @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
+        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 '@'.
@@ -51,10 +80,8 @@ module Warrant
         #   Warrant::Tenant.delete("test-customer")
         #
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.delete(tenant_id)
             res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}"))
 
@@ -68,18 +95,19 @@ module Warrant
 
         # 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)
+        #
         # @return [Array<Tenant>] all tenants for your organization
         #
         # @example List all tenants
         #   Warrant::Tenant.list()
         #
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidRequestError]
-        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.list(filters = {})
-            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/tenants"))
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/tenants"), Util.normalize_params(filters))
 
             case res
             when Net::HTTPSuccess
@@ -87,7 +115,7 @@ module Warrant
                 tenants.map{ |tenant| Tenant.new(tenant['tenantId'], tenant['name'], tenant['createdAt']) }
             else
                 APIOperations.raise_error(res)
-            end   
+            end
         end
 
         # Get a tenant with the given tenant_id
@@ -95,13 +123,11 @@ module Warrant
         # @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 '@'.
         #
         # @return [Tenant] retrieved tenant
-        # 
+        #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
-        # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.get(tenant_id)
             res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}"))
 
@@ -111,7 +137,7 @@ module Warrant
                 Tenant.new(tenant['tenantId'], tenant['name'], tenant['createdAt'])
             else
                 APIOperations.raise_error(res)
-            end  
+            end
         end
 
         # Updates a tenant with the given tenant_id and params
@@ -124,14 +150,12 @@ module Warrant
         #
         # @example Update tenant "test-tenant"'s name
         #   Warrant::Tenant.update("test-tenant", { name: "my-new-name@example.com" })
-        # 
-        # @raise [Warrant::DuplicateRecordError]
+        #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.update(tenant_id, params = {})
             res = APIOperations.put(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}"), Util.normalize_params(params))
 
@@ -153,14 +177,11 @@ module Warrant
         # @example Update tenant "test-tenant"'s name
         #   tenant = Warrant::Tenant.get("test-tenant")
         #   tenant.update(name: "my-new-name@example.com")
-        # 
-        # @raise [Warrant::DuplicateRecordError]
+        #
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
-        # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def update(params = {})
             return Tenant.update(tenant_id, params)
         end
@@ -171,14 +192,13 @@ module Warrant
         #
         # @return [Warrant] warrant assigning user to the tenant
         #
+        # @raise [Warrant::DuplicateRecordError]
         # @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)
+        def assign_user(user_id)
+            return User.assign_to_tenant(tenant_id, user_id)
         end
 
         # Remove a user from a tenant
@@ -188,8 +208,6 @@ module Warrant
         # @return [nil] if remove was successful
         #
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidParameterError]
-        # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
         # @raise [Warrant::WarrantError]
@@ -197,18 +215,19 @@ module Warrant
             return User.remove_from_tenant(tenant_id, user_id)
         end
 
-        # List all tenants for a user 
+        # 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)
         #
         # @return [Array<Tenant>] all tenants for the user
         #
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::InvalidParameterError]
         # @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"))
+        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
@@ -216,10 +235,10 @@ module Warrant
                 tenants.map{ |tenant| Tenant.new(tenant['tenantId'], tenant['name'], tenant['createdAt']) }
             else
                 APIOperations.raise_error(res)
-            end   
+            end
         end
 
-        # List all users for a tenant 
+        # List all users for a tenant
         #
         # @return [Array<User>] all users for the tenant
         #
@@ -230,5 +249,127 @@ module Warrant
         def list_users
             return User.list_for_tenant(tenant_id)
         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)
+        #
+        # @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)
+        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.
+        #
+        # @return [PricingTier] assigned pricing tier
+        #
+        # @raise [Warrant::DuplicateRecordError]
+        # @raise [Warrant::InternalError]
+        # @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)
+        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.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @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)
+        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)
+        #
+        # @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)
+        end
+
+        # Assign a feature to a tenant
+        #
+        # @param feature_id [String] The feature_id of the feature you want to assign to the tenant.
+        #
+        # @return [Feature] assigned feature
+        #
+        # @raise [Warrant::DuplicateRecordError]
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def assign_feature(feature_id)
+            return Feature.assign_to_tenant(tenant_id, feature_id)
+        end
+
+        # Remove a feature from a tenant
+        #
+        # @param feature_id [String] The feature_id of the feature you want to remove from the tenant.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def remove_feature(feature_id)
+            return Feature.remove_from_tenant(tenant_id, feature_id)
+        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.
+        # @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
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def has_feature?(feature_id, opts = {})
+            return Warrant.has_feature?(
+                feature_id: feature_id,
+                subject: {
+                    object_type: "tenant",
+                    object_id: tenant_id
+                },
+                context: opts[:context],
+                consistent_read: opts[:consistent_read],
+                debug: opts[:debug]
+            )
+        end
+
+        def warrant_object_type
+            "tenant"
+        end
+
+        def warrant_object_id
+            tenant_id
+        end
     end
 end