warrant 1.2.0 → 2.0.0.rc1

data/lib/warrant/models/role.rb

@@ -2,16 +2,20 @@
 
 module Warrant
     class Role
-        attr_reader :role_id
+        include Warrant::WarrantObject
+
+        attr_reader :role_id, :name, :description
 
         # @!visibility private
-        def initialize(role_id)
+        def initialize(role_id, name = nil, description = nil)
             @role_id = role_id
+            @name = name
+            @description = description
         end
 
         # Creates a role with the given parameters
         #
-        # @option params [String] :role_id A string identifier for this new role. The role_id can only be composed of lower-case alphanumeric chars and/or '-' and '_'. (optional)
+        # @option params [String] :role_id A string identifier for this new role. The role_id can only be composed of lower-case alphanumeric chars and/or '-' and '_'.
         #
         # @return [Role] created role
         #
@@ -20,19 +24,15 @@ module Warrant
         #
         # @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/roles"), Util.normalize_params(params))
 
             case res
             when Net::HTTPSuccess
                 res_json = JSON.parse(res.body)
-                Role.new(res_json['roleId'])
+                Role.new(res_json['roleId'], res_json['name'], res_json['description'])
             else
                 APIOperations.raise_error(res)
             end
@@ -40,7 +40,7 @@ module Warrant
 
         # Deletes a role with given role id
         #
-        # @param role_id [String] A string identifier for this new role. The role_id can only be composed of lower-case alphanumeric chars and/or '-' and '_'.
+        # @param role_id [String] The role_id of the role to delete.
         #
         # @return [nil] if delete was successful
         #
@@ -48,10 +48,9 @@ module Warrant
         #   Warrant::Role.delete("test-role")
         #
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.delete(role_id)
             res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/roles/#{role_id}"))
 
@@ -65,50 +64,121 @@ module Warrant
 
         # Lists all roles 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<Role>] all roles for your organization
         #
         # @example List all roles
         #   Warrant::Role.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/roles"))
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/roles"), Util.normalize_params(filters))
 
             case res
             when Net::HTTPSuccess
                 roles = JSON.parse(res.body)
-                roles.map{ |role| Role.new(role['roleId']) }
+                roles.map{ |role| Role.new(role['roleId'], role['name'], role['description']) }
             else
                 APIOperations.raise_error(res)
-            end   
+            end
         end
 
         # Get a role with the given role_id
         #
-        # @param role_id [String] A string identifier for this new role. The role_id can only be composed of lower-case alphanumeric chars and/or '-' and '_'.
+        # @param role_id [String] The role_id of the role to retrieve.
         #
         # @return [Role] retrieved role
         #
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidParameterError]
-        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.get(role_id)
             res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/roles/#{role_id}"))
 
             case res
             when Net::HTTPSuccess
                 role = JSON.parse(res.body)
-                Role.new(role['roleId'])
+                Role.new(role['roleId'], role['name'], role['description'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Updates a role with the given role_id and params
+        #
+        # @param role_id [String] The role_id of the role to be updated.
+        # @param [Hash] params attributes to update user with
+        # @option params [String] :name Name for the role. Designed to be used as a UI-friendly identifier. (optional)
+        # @option params [String] :description Description of the role. Designed to be used as a UI-friendly identifier. (optional)
+        #
+        # @return [Role] updated role
+        #
+        # @example Update role "test-role"'s name
+        #   Warrant::Role.update("test-role", { name: "Test Role" })
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.update(role_id, params = {})
+            res = APIOperations.put(URI.parse("#{::Warrant.config.api_base}/v1/roles/#{role_id}"), Util.normalize_params(params))
+
+            case res
+            when Net::HTTPSuccess
+                res_json = JSON.parse(res.body)
+                Role.new(res_json['roleId'], res_json['name'], res_json['description'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Updates a role with the given params
+        #
+        # @param [Hash] params attributes to update user with
+        # @option params [String] :name Name for the role. Designed to be used as a UI-friendly identifier. (optional)
+        # @option params [String] :description Description of the role. Designed to be used as a UI-friendly identifier. (optional)
+        #
+        # @return [Role] updated role
+        #
+        # @example Update role "test-role"'s name
+        #   Warrant::Role.update("test-role", { name: "Test Role" })
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        def update(params = {})
+            return Role.update(role_id, params)
+        end
+
+        # List roles for user
+        #
+        # @param user_id [String] The user_id of the user you want to retrieve roles 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<Role>] all assigned roles for the user
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::MissingRequiredParameterError]
+        # @raise [Warrant::UnauthorizedError]
+        def self.list_for_user(user_id, filters = {})
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/roles"), Util.normalize_params(filters))
+
+            case res
+            when Net::HTTPSuccess
+                roles = JSON.parse(res.body)
+                roles.map{ |role| Role.new(role['roleId'], role['name'], role['description']) }
             else
                 APIOperations.raise_error(res)
-            end  
+            end
         end
 
         # Assign a role to a user
@@ -116,35 +186,35 @@ module Warrant
         # @param user_id [String] The user_id of the user you want to assign a role to.
         # @param role_id [String] The role_id of the role you want to assign to a user.
         #
-        # @return [Permission] assigned role
+        # @return [Role] assigned role
         #
+        # @raise [Warrant::DuplicateRecordError]
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.assign_to_user(user_id, role_id)
             res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/roles/#{role_id}"))
 
             case res
             when Net::HTTPSuccess
                 role = JSON.parse(res.body)
-                Role.new(role['permissionId'])
+                Role.new(role['roleId'], role['name'], role['description'])
             else
                 APIOperations.raise_error(res)
-            end  
+            end
         end
 
         # Remove a role from a user
         #
-        # @param user_id [String] The user_id of the role you want to assign a role to.
-        # @param role_id [String] The role_id of the role you want to assign to a user.
+        # @param user_id [String] The user_id of the role you want to remove a role from.
+        # @param role_id [String] The role_id of the role you want to remove from a user.
         #
         # @return [nil] if remove was successful
         #
+        # @raise [Warrant::ForbiddenError]
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
@@ -157,33 +227,46 @@ module Warrant
                 return
             else
                 APIOperations.raise_error(res)
-            end  
+            end
+        end
+
+        # List assigned permissions for the role
+        #
+        # @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 [Permission] assigned permissions
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::MissingRequiredParameterError]
+        # @raise [Warrant::UnauthorizedError]
+        def list_permissions(filters = {})
+            return Permission.list_for_role(role_id, filters)
         end
 
         # Assign a permission to a role
         #
-        # @param permission_id [String] The permission_id of the permission you want to assign to a role.
+        # @param permission_id [String] The permission_id of the permission you want to assign to the role.
         #
         # @return [Permission] assigned permission
         #
+        # @raise [Warrant::DuplicateRecordError]
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def assign_permission(permission_id)
             return Permission.assign_to_role(role_id, permission_id)
         end
 
         # Remove a permission from a role
         #
-        # @param permission_id [String] The permission_id of the permission you want to assign to a role.
+        # @param permission_id [String] The permission_id of the permission you want to remove from the role.
         #
         # @return [nil] if remove was successful
         #
         # @raise [Warrant::InternalError]
-        # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
@@ -191,5 +274,13 @@ module Warrant
         def remove_permission(permission_id)
             return Permission.remove_from_role(role_id, permission_id)
         end
+
+        def warrant_object_type
+            "role"
+        end
+
+        def warrant_object_id
+            role_id
+        end
     end
 end

data/lib/warrant/models/session.rb

@@ -6,7 +6,7 @@ module Warrant
         #
         # @option params [String] :user_id Id of the user to create a session for.
         # @option params [Integer] :ttl Number of seconds a session should live for. By default session tokens live for 24 hours and self service tokens live for 30 minutes.
-        # 
+        #
         # @return [String] Session token
         #
         # @raise [Warrant::InternalError]
@@ -15,7 +15,6 @@ module Warrant
         # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.create_authorization_session(params = {})
             params = params.merge(type: "sess")
             res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/sessions"), Util.normalize_params(params))
@@ -36,15 +35,15 @@ module Warrant
         # @option params [String] :tenant_id Id of the tenant to create a session for
         # @option params [Integer] :ttl Number of seconds a session should live for. By default session tokens live for 24 hours and self service tokens live for 30 minutes.
         #
-        # @return [String] URL to the self service dashboard 
-        # 
+        # @return [String] URL to the self service dashboard
+        #
+        # @raise [Warrant::ForbiddenError]
         # @raise [Warrant::InternalError]
         # @raise [Warrant::InvalidParameterError]
         # @raise [Warrant::InvalidRequestError]
         # @raise [Warrant::MissingRequiredParameterError]
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
-        # @raise [Warrant::WarrantError]
         def self.create_self_service_session(redirect_url, params = {})
             params = params.merge(type: "ssdash")
             res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/sessions"), Util.normalize_params(params))