warrant 0.1.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a67a5a1dd2b6e9b95b675395d1337acd9509f166f5e22d224987260191b5090d
-  data.tar.gz: '08013f834166288f8a0ba21753d7a11d0a89e1aa8b7189894e0d80146f47081e'
+  metadata.gz: 6fc7f30432a9ab516978da52e77811011ee0625a819124ad8dcb5b20d8610a34
+  data.tar.gz: 54dc068a58982fc5f8fdcc2d781ce5b6b5ec320c3f7a5dfdbd8338eaa20fac93
 SHA512:
-  metadata.gz: 8fd775c0e3bf27a5e2eebfa06992c2b09e6dc8d1337740ddbab46e328ea9ccc16b48f1da20e0214ba450d2428d0ac43370ae58ab7f698de7a3ed4b00abab646d
-  data.tar.gz: 04d89c962874fbd667d3f695f2913552e4dd855fa436737b387e05498736f4557549cd64958ab6dbce92d37f9ffd114549f498140cce5f7823e3f93e0e39c4c9
+  metadata.gz: 4e892e951b8107a9d6bdeb621a1ee2fb1674c8a9195eb7271e127f77961d5cfa8fe673e93cfd6bb2784452630ade845b65aa3455379c169580ea8b32fb9dad2f
+  data.tar.gz: b7e7c396ff14cbc500b9bf1e1882db09b84002e78fc2ffa11a019de0cc3da25d60766f78b6650075baa648125c87ed9ed48e8cf250cc2a41818fef5b3d2b9209

data/README.md

@@ -3,9 +3,10 @@
 Use [Warrant](https://warrant.dev/) in ruby projects.
 
 [![Gem Version](https://badge.fury.io/rb/warrant.svg)](https://badge.fury.io/rb/warrant)
-[![Discord](https://img.shields.io/discord/865661082203193365?label=discord)](https://discord.gg/QNCMKWzqET)
+[![Slack](https://img.shields.io/badge/slack-join-brightgreen)](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w)
 
 ## Installation
+---
 
 Add this line to your application's Gemfile:
 
@@ -17,99 +18,39 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install warrant
 
-## Usage
+You can also build the gem from source:
 
-```ruby
-require 'warrant'
-Warrant.api_key = 'api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E='
-```
+    $ gem build warrant.gemspec
 
-### `create_user(email, user_id = '')`
-
-This method creates a user entity in Warrant with the specified `user_d`. Provide an optional `username` to make it easier to identify users in the Warrant dashboard.
-
-```ruby
-# Create user with user email and id
-Warrant::WarrantClient.create_user(user.email, user.id)
-
-# Create user with generated id
-Warrant::WarrantClient.create_user()
-```
-
-### `create_warrant(object_type, object_id, relation, user)`
-
-#### **User parameters**
-Can provide either a user id, or a combination of object type, object id, and relation
+## Documentation
 ---
-#### **user_id**
-Creates a warrant for the user specified by user_id
-
-#### **object_type**
-#### **object_id**
-#### **relation**
-Creates a warrant for the given userset specified by object type, object id, and relation
-
-
-This method creates a warrant which specifies that the provided `user` (or userset) has `relation` on the object of type `objectType` with id `objectId`.
-
-```ruby
-# Create a warrant allowing user.id to "view" the store with id store.id
-Warrant::WarrantClient.create_warrant('store', store.id, 'view', { user_id: user.id })
-
-# Create a warrant specifying all members of the manager role to "view" store of id store.id
-Warrant::WarrantClient.create_warrant('store', store.id, 'view', { object_type: 'role', object_id: 'manager', relation: 'member' })
-```
-
-### `create_session(userId)`
 
-This method creates a session in Warrant for the user with the specified `userId` and returns a session token which can be used to make authorized requests to the Warrant API only for the specified user. This session token can safely be used to make requests to the Warrant API's authorization endpoint to determine user access in web and mobile client applications.
-
-```ruby
-# Create session token for user
-Warrant::WarrantClient.create_session(user.id)
-```
-
-### `is_authorized(object_type, object_id, relation, user_id)`
-
-This method returns `true` if the user with the specified `user_id` has the specified `relation` to the object of type `object_type` with id `objectId` and `false` otherwise.
-
-```ruby
-# Example: user 123 can only view store 824
-Warrant::WarrantClient.is_authorized('store', '824', 'view', '123') # true
-Warrant::WarrantClient.is_authorized('store', '824', 'edit', '123') # false
-```
-
-### `list_warrants(filters = {})`
-This method returns all warrants that match the filters provided, or all warrants for your organization if none are provided. 
+- [Ruby API Docs](https://rubydoc.info/gems/warrant)
+- [Warrant Docs](https://docs.warrant.dev/)
 
-#### **Filter Parameters** 
+## Requirements
 ---
-#### **object_type**
-Only return warrants with the given object type.
-
-#### **object_id**
-Only return warrants with the given object id.
 
-#### **relation**
-Only return warrants with the given relation.
-
-#### **user_id**
-Only return warrants with the given user id
+- Ruby 2.3+.
 
+## Usage
+---
 
 ```ruby
-# List all warrants for an organization
-Warrant::WarrantClient.list_warrants
+require 'warrant'
+Warrant.api_key = 'api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E='
 
-# List all warrants with object type of store
-Warrant::WarrantClient.list_warrants(object_type: 'store')
+# create a user
+Warrant::User.create(user_id: "user123")
+
+# check whether user slp951 has view access to report 7asm24
+Warrant::Warrant.is_authorized?(object_type: "report", object_id: "7asm24", relation: "viewer", subject: { object_id: "user", object_id: "slp951" })
 ```
 
----
 
 We’ve used a random API key in these code examples. Replace it with your [actual publishable API keys](https://app.warrant.dev) to
 test this code through your own Warrant account.
@@ -117,7 +58,3 @@ test this code through your own Warrant account.
 For more information on how to use the Warrant API, please refer to the [Warrant API reference](https://docs.warrant.dev).
 
 Note that we may release new [minor and patch](https://semver.org/) versions of this library with small but backwards-incompatible fixes to the type declarations. These changes will not affect Warrant itself.
-
-## Warrant Documentation
-
-- [Warrant Docs](https://docs.warrant.dev/)

data/lib/warrant/api_operations.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Warrant
+    # @!visibility private
+    class APIOperations
+        class << self
+            def post(uri, params = {}, use_ssl = true)
+                http = Net::HTTP.new(uri.host, uri.port)
+                http.use_ssl = use_ssl
+                headers = {
+                    "Authorization": "ApiKey #{::Warrant.config.api_key}"
+                }
+                http.post(uri.path, params.to_json, headers)
+            end
+
+            def delete(uri, params = {})
+                http = Net::HTTP.new(uri.host, uri.port)
+                http.use_ssl = true
+                request = Net::HTTP::Delete.new(uri.path)
+                request["Authorization"] = "ApiKey #{::Warrant.config.api_key}"
+
+                http.request(request, params.to_json)
+            end
+
+            def get(uri, params = {})
+                http = Net::HTTP.new(uri.host, uri.port)
+                http.use_ssl = true
+                headers = {
+                    "Authorization": "ApiKey #{::Warrant.config.api_key}"
+                }
+
+                unless params.empty?
+                    normalized_params = Util.normalize_params(params.compact)
+                    uri.query = URI.encode_www_form(normalized_params)
+                end
+
+                http.get(uri, headers)
+            end
+
+            def put(uri, params = {})
+                http = Net::HTTP.new(uri.host, uri.port)
+                http.use_ssl = true
+                headers = {
+                    "Authorization": "ApiKey #{::Warrant.config.api_key}"
+                }
+                http.put(uri.path, params.to_json, headers)
+            end
+
+            def raise_error(response)
+                error_code = JSON.parse(response.body)['code']
+
+                case error_code
+                when Error::DUPLICATE_RECORD_ERROR
+                    raise DuplicateRecordError.initialize_error_from_response(response)
+                when Error::INTERNAL_ERROR
+                    raise InternalError.initialize_error_from_response(response)
+                when Error::INVALID_REQUEST_ERROR
+                    raise InvalidRequestError.initialize_error_from_response(response)
+                when Error::INVALID_PARAMETER_ERROR
+                    raise InvalidParameterError.initialize_error_from_response(response)
+                when Error::MISSING_REQUIRED_PARAMETER_ERROR
+                    raise MissingRequiredParameterError.initialize_error_from_response(response)
+                when Error::NOT_FOUND_ERROR
+                    raise NotFoundError.initialize_error_from_response(response)
+                when Error::UNAUTHORIZED_ERROR
+                    raise UnauthorizedError.initialize_error_from_response(response)
+                when Error::UNKNOWN_ORIGIN_ERROR
+                    raise UnknownOriginError.initialize_error_from_response(response)
+                else
+                    raise WarrantError.initialize_error_from_response(response)
+                end
+            end
+        end
+    end
+end

data/lib/warrant/errors.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Warrant
+    class Error
+        DUPLICATE_RECORD_ERROR = "duplicate_record"
+        INTERNAL_ERROR = "internal_error"
+        INVALID_REQUEST_ERROR = "invalid_request"
+        INVALID_PARAMETER_ERROR = "invalid_parameter"
+        MISSING_REQUIRED_PARAMETER_ERROR = "missing_required_parameter"
+        NOT_FOUND_ERROR = "not_found"
+        UNAUTHORIZED_ERROR = "unauthorized"
+    end
+
+    class WarrantError < StandardError
+        attr_reader :code, :headers, :message, :http_status, :http_headers, :http_body, :json_body
+
+        def initialize(code = nil, message = nil, http_status = nil, http_headers = nil, http_body = nil, json_body = nil)
+            @code = code
+            @headers = headers
+            @message = message
+            @http_status = http_status
+            @http_headers = http_headers
+            @http_body = http_body
+            @json_body = json_body
+        end
+
+        def self.initialize_error_from_response(response)
+            response_json = JSON.parse(response.body)
+            self.new(
+                response_json['code'],
+                Util.snake_case(response_json['message']),
+                response.code,
+                response.to_hash,
+                response.body,
+                response_json
+            )
+        end
+    end
+
+    class DuplicateRecordError < WarrantError; end
+    class InternalError < WarrantError; end
+    class InvalidRequestError < WarrantError; end
+    class InvalidParameterError < WarrantError; end
+    class MissingRequiredParameterError < WarrantError; end
+    class NotFoundError < WarrantError; end
+    class UnauthorizedError < WarrantError; end
+end

data/lib/warrant/models/permission.rb

@@ -3,9 +3,210 @@
 module Warrant
     class Permission
         attr_reader :permission_id
-
+        
+        # @!visibility private
         def initialize(permission_id)
             @permission_id = permission_id
         end
+
+        # Creates a permission with the given parameters
+        #
+        # @option params [String] :permission_id A string identifier for this new permission. The permission_id can only be composed of lower-case alphanumeric chars and/or '-' and '_'. (optional)
+        #
+        # @return [Permission] created permission
+        #
+        # @example Create a new Permission with the permission id "test-permission"
+        #   Warrant::Permission.create(permission_id: "test-permission")
+        #
+        # @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/permissions"), Util.normalize_params(params))
+
+            case res
+            when Net::HTTPSuccess
+                res_json = JSON.parse(res.body)
+                Permission.new(res_json['permissionId'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Deletes a permission with given permission id
+        #
+        # @param permission_id [String] A string identifier for this new permission. The permission_id can only be composed of lower-case alphanumeric chars and/or '-' and '_'.
+        #
+        # @return [nil] if delete was successful
+        #
+        # @example Delete a Permission with the permission id "test-permission"
+        #   Warrant::Permission.delete("test-permission")
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.delete(permission_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/permissions/#{permission_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Lists all permissions for your organization
+        #
+        # @return [Array<Permission>] all permissions for organization
+        #
+        # @example List all permissions
+        #   Warrant::Permission.list()
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.list(filters = {})
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/permissions"))
+
+            case res
+            when Net::HTTPSuccess
+                permissions = JSON.parse(res.body)
+                permissions.map{ |permission| Permission.new(permission['permissionId']) }
+            else
+                APIOperations.raise_error(res)
+            end   
+        end
+
+        # Get a permission with the given permission_id
+        #
+        # @param permission_id [String] A string identifier for this new permission. The permission_id can only be composed of lower-case alphanumeric chars and/or '-' and '_'.
+        #
+        # @return [Permission] retrieved permission
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.get(permission_id)
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/permissions/#{permission_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                permission = JSON.parse(res.body)
+                Permission.new(permission['permissionId'])
+            else
+                APIOperations.raise_error(res)
+            end  
+        end
+
+        # Assign a permission to a role
+        #
+        # @param role_id [String] The role_id of the role you want to assign a permission to.
+        # @param permission_id [String] The permission_id of the permission you want to assign to a role.
+        #
+        # @return [Permission] assigned permission
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::MissingRequiredParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.assign_to_role(role_id, permission_id)
+            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/roles/#{role_id}/permissions/#{permission_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                permission = JSON.parse(res.body)
+                Permission.new(permission['permissionId'])
+            else
+                APIOperations.raise_error(res)
+            end  
+        end
+
+        # Remove a permission from a role
+        #
+        # @param role_id [String] The role_id of the role you want to assign a permission to.
+        # @param permission_id [String] The permission_id of the permission you want to assign to a role.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::MissingRequiredParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.remove_from_role(role_id, permission_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/roles/#{role_id}/permissions/#{permission_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            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
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::MissingRequiredParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.assign_to_user(user_id, permission_id)
+            res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/permissions/#{permission_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                permission = JSON.parse(res.body)
+                Permission.new(permission['permissionId'])
+            else
+                APIOperations.raise_error(res)
+            end  
+        end
+
+        # 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
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::MissingRequiredParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.remove_from_user(user_id, permission_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/permissions/#{permission_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end  
+        end
     end
 end

data/lib/warrant/models/role.rb

@@ -4,8 +4,192 @@ module Warrant
     class Role
         attr_reader :role_id
 
+        # @!visibility private
         def initialize(role_id)
             @role_id = role_id
         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)
+        #
+        # @return [Role] created role
+        #
+        # @example Create a new Role with the role id "test-role"
+        #   Warrant::Role.create(role_id: "test-role")
+        #
+        # @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'])
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # 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 '_'.
+        #
+        # @return [nil] if delete was successful
+        #
+        # @example Delete a Role with the role id "test-role"
+        #   Warrant::Role.delete("test-role")
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @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}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end
+        end
+
+        # Lists all roles for your organization
+        #
+        # @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::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.list(filters = {})
+            res = APIOperations.get(URI.parse("#{::Warrant.config.api_base}/v1/roles"))
+
+            case res
+            when Net::HTTPSuccess
+                roles = JSON.parse(res.body)
+                roles.map{ |role| Role.new(role['roleId']) }
+            else
+                APIOperations.raise_error(res)
+            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 '_'.
+        #
+        # @return [Role] retrieved role
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidParameterError]
+        # @raise [Warrant::InvalidRequestError]
+        # @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'])
+            else
+                APIOperations.raise_error(res)
+            end  
+        end
+
+        # Assign a role to a user
+        #
+        # @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
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @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'])
+            else
+                APIOperations.raise_error(res)
+            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.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::MissingRequiredParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def self.remove_from_user(user_id, role_id)
+            res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/roles/#{role_id}"))
+
+            case res
+            when Net::HTTPSuccess
+                return
+            else
+                APIOperations.raise_error(res)
+            end  
+        end
+
+        # Assign a permission to a role
+        #
+        # @param permission_id [String] The permission_id of the permission you want to assign to a role.
+        #
+        # @return [Permission] assigned permission
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @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.
+        #
+        # @return [nil] if remove was successful
+        #
+        # @raise [Warrant::InternalError]
+        # @raise [Warrant::InvalidRequestError]
+        # @raise [Warrant::MissingRequiredParameterError]
+        # @raise [Warrant::NotFoundError]
+        # @raise [Warrant::UnauthorizedError]
+        # @raise [Warrant::WarrantError]
+        def remove_permission(permission_id)
+            return Permission.remove_from_role(role_id, permission_id)
+        end
     end
 end