warrant 1.2.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3ba7f4c3cde89c03aa17c15bfe00fa553172b27365b2e25548e7f349f38d799
-  data.tar.gz: 0fbc797a1768ca2aa47a08a7b2864a4398c25ed3deb2ff26f45e113855961c8c
+  metadata.gz: e4b223824bcd7432223d20591698f3160529fbe71d846fc608e389d6733b4ef2
+  data.tar.gz: 59ac3e03836bc44313afa2377875313573b2d4fe15627ab1bde09de1f74381ee
 SHA512:
-  metadata.gz: 9240a10a74f6cf277e2a94d392181dbb66f89b5a970b6d4688c3fd6582ecde03fdfdf9dca63294be48f9de48d03d5c2bf0f5b1d5fc9bc689d87876365fde0192
-  data.tar.gz: 5950abb71082b36b859c8679952a1055b6726588353db03df292e036ee11e239c41cdf0abf76995bb1a2c82d34aa21e3bf6643832ba9315e7810a6261c2938c3
+  metadata.gz: 2c3ac854c8720abdbc663df3e943299b262602d8d14296ff9595845b01961c8ead99f77c07c538f6b29319916007e6aba0ed859b95ac38b2912099e067ef521f
+  data.tar.gz: ae74c5ffce7718d20c758f922d2ab384cde9b050d71bafc08a0a37452f39ebf482bb45d533dc7598396e32f76fc0d5c890002f3c5d49947b05bc4701c79242d7

data/Gemfile

@@ -8,3 +8,7 @@ gemspec
 gem "rake"
 gem "minitest", "~> 5.0"
 gem "rubocop", "~> 1.21"
+
+group :test do
+    gem "webmock"
+end

data/lib/warrant/api_operations.rb

@@ -8,7 +8,8 @@ module Warrant
                 http = Net::HTTP.new(uri.host, uri.port)
                 http.use_ssl = use_ssl
                 headers = {
-                    "Authorization": "ApiKey #{::Warrant.config.api_key}"
+                    "Authorization": "ApiKey #{::Warrant.config.api_key}",
+                    "User-Agent": "warrant-ruby/#{VERSION}"
                 }
                 http.post(uri.path, params.to_json, headers)
             end
@@ -18,6 +19,7 @@ module Warrant
                 http.use_ssl = true
                 request = Net::HTTP::Delete.new(uri.path)
                 request["Authorization"] = "ApiKey #{::Warrant.config.api_key}"
+                request["User-Agent"] = "warrant-ruby/#{VERSION}"
 
                 http.request(request, params.to_json)
             end
@@ -26,7 +28,8 @@ module Warrant
                 http = Net::HTTP.new(uri.host, uri.port)
                 http.use_ssl = true
                 headers = {
-                    "Authorization": "ApiKey #{::Warrant.config.api_key}"
+                    "Authorization": "ApiKey #{::Warrant.config.api_key}",
+                    "User-Agent": "warrant-ruby/#{VERSION}"
                 }
 
                 unless params.empty?
@@ -41,7 +44,8 @@ module Warrant
                 http = Net::HTTP.new(uri.host, uri.port)
                 http.use_ssl = true
                 headers = {
-                    "Authorization": "ApiKey #{::Warrant.config.api_key}"
+                    "Authorization": "ApiKey #{::Warrant.config.api_key}",
+                    "User-Agent": "warrant-ruby/#{VERSION}"
                 }
                 http.put(uri.path, params.to_json, headers)
             end
@@ -52,6 +56,8 @@ module Warrant
                 case error_code
                 when Error::DUPLICATE_RECORD_ERROR
                     raise DuplicateRecordError.initialize_error_from_response(response)
+                when Error::FORBIDDEN_ERROR
+                    raise ForbiddenError.initialize_error_from_response(response)
                 when Error::INTERNAL_ERROR
                     raise InternalError.initialize_error_from_response(response)
                 when Error::INVALID_REQUEST_ERROR

data/lib/warrant/errors.rb

@@ -3,6 +3,7 @@
 module Warrant
     class Error
         DUPLICATE_RECORD_ERROR = "duplicate_record"
+        FORBIDDEN_ERROR = "forbidden"
         INTERNAL_ERROR = "internal_error"
         INVALID_REQUEST_ERROR = "invalid_request"
         INVALID_PARAMETER_ERROR = "invalid_parameter"
@@ -38,6 +39,7 @@ module Warrant
     end
 
     class DuplicateRecordError < WarrantError; end
+    class ForbiddenError < WarrantError; end
     class InternalError < WarrantError; end
     class InvalidRequestError < WarrantError; end
     class InvalidParameterError < WarrantError; end

data/lib/warrant/models/feature.rb

@@ -0,0 +1,327 @@
+# frozen_string_literal: true
+
+module Warrant
+    class Feature
+        include Warrant::WarrantObject
+
+        attr_reader :feature_id
+
+        # @!visibility private
+        def initialize(feature_id)
+            @feature_id = feature_id
+        end
+
+        # Creates a feature with the given parameters
+        #
+        # @option params [String] :feature_id A string identifier for this new feature. The feature_id can only be composed of lower-case alphanumeric chars and/or '-' and '_'.
+        #
+        # @return [Feature] created feature
+        #
+        # @example Create a new Feature with the feature id "test-feature"
+        #   Warrant::Feature.create(feature_id: "test-feature")
+        #
+        # @raise [Warrant::DuplicateRecordError]
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.create(params = {})
+            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/features"), Util.normalize_params(params))
+
+            case res
+            when Net::HTTPSuccess
+                res_json = JSON.parse(res.body)
+                Feature.new(res_json['featureId'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Deletes a feature with given feature id
+        #
+        # @param feature_id [String] The feature_id of the feature to delete.
+        #
+        # @return [nil] if delete was successful
+        #
+        # @example Delete a Feature with the feature id "test-feature"
+        #   Warrant::Feature.delete("test-feature")
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.delete(feature_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/features/#{feature_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Lists all features 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<Feature>] all features for your organization
+        #
+        # @example List all features
+        #   Warrant::Feature.list()
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.list(filters = {})
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/features"), Util.normalize_params(filters))
+
+            case res
+            when Net::HTTPSuccess
+                features = JSON.parse(res.body)
+                features.map{ |feature| Feature.new(feature['featureId']) }
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Get a feature with the given feature_id
+        #
+        # @param feature_id [String] The feature_id of the feature to retrieve.
+        #
+        # @return [Feature] retrieved feature
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.get(feature_id)
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/features/#{feature_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                feature = JSON.parse(res.body)
+                Feature.new(feature['featureId'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # List features for tenant
+        #
+        # @param tenant_id [String] The tenant_id of the tenant to list features for.
+        # @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 self.list_for_tenant(tenant_id, filters = {})
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}/features"), Util.normalize_params(filters))
+
+            case res
+            when Net::HTTPSuccess
+                features = JSON.parse(res.body)
+                features.map{ |feature| Feature.new(feature['featureId']) }
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Assign a feature to a tenant
+        #
+        # @param tenant_id [String] The tenant_id of the tenant you want to assign a feature to.
+        # @param feature_id [String] The feature_id of the feature you want to assign to a tenant.
+        #
+        # @return [Feature] assigned feature
+        #
+        # @raise [Warrant::DuplicateRecordError]
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.assign_to_tenant(tenant_id, feature_id)
+            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}/features/#{feature_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                feature = JSON.parse(res.body)
+                Feature.new(feature['featureId'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Remove a feature from a tenant
+        #
+        # @param tenant_id [String] The tenant_id of the tenant you want to remove a feature from.
+        # @param feature_id [String] The feature_id of the feature you want to remove from a tenant.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.remove_from_tenant(tenant_id, feature_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/tenants/#{tenant_id}/features/#{feature_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # List features for user
+        #
+        # @param user_id [String] The user_id of the user to list features for.
+        # @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 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}/features"), Util.normalize_params(filters))
+
+            case res
+            when Net::HTTPSuccess
+                features = JSON.parse(res.body)
+                features.map{ |feature| Feature.new(feature['featureId']) }
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Assign a feature to a user
+        #
+        # @param user_id [String] The user_id of the user you want to assign a feature to.
+        # @param feature_id [String] The feature_id of the feature you want to assign to a user.
+        #
+        # @return [Feature] assigned feature
+        #
+        # @raise [Warrant::DuplicateRecordError]
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.assign_to_user(user_id, feature_id)
+            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/features/#{feature_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                feature = JSON.parse(res.body)
+                Feature.new(feature['featureId'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Remove a feature from a user
+        #
+        # @param user_id [String] The user_id of the user you want to remove a feature from.
+        # @param feature_id [String] The feature_id of the feature you want to remove from a user.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.remove_from_user(user_id, feature_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/features/#{feature_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # List features for pricing tier
+        #
+        # @param pricing_tier_id [String] The pricing_tier_id of the pricing tier to list features for.
+        # @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 pricing tier
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.list_for_pricing_tier(pricing_tier_id, filters = {})
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/pricing-tiers/#{pricing_tier_id}/features"), Util.normalize_params(filters))
+
+            case res
+            when Net::HTTPSuccess
+                features = JSON.parse(res.body)
+                features.map{ |feature| Feature.new(feature['featureId']) }
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Assign a feature to a pricing tier
+        #
+        # @param pricing_tier_id [String] The pricing_tier_id of the pricing tier you want to assign a feature to.
+        # @param feature_id [String] The feature_id of the feature you want to assign to a pricing tier.
+        #
+        # @return [Feature] assigned pricing tier
+        #
+        # @raise [Warrant::DuplicateRecordError]
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.assign_to_pricing_tier(pricing_tier_id, feature_id)
+            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/pricing-tiers/#{pricing_tier_id}/features/#{feature_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                feature = JSON.parse(res.body)
+                Feature.new(feature['featureId'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Remove a feature from a pricing tier
+        #
+        # @param pricing_tier_id [String] The pricing_tier_id of the pricing tier you want to remove a feature from.
+        # @param feature_id [String] The feature_id of the feature you want to remove from a pricing tier.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.remove_from_pricing_tier(pricing_tier_id, feature_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/pricing-tiers/#{pricing_tier_id}/features/#{feature_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        def warrant_object_type
+            "feature"
+        end
+
+        def warrant_object_id
+            feature_id
+        end
+    end
+end