Warrant Ruby Library
Use Warrant in ruby projects.
Installation
Add this line to your application's Gemfile:
gem 'warrant'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install warrant
Usage
require 'warrant'
Warrant.api_key = 'api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E='
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.
# 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
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.
# 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.
# 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.
# 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.
Filter Parameters
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
# List all warrants for an organization
Warrant::WarrantClient.list_warrants
# List all warrants with object type of store
Warrant::WarrantClient.list_warrants(object_type: 'store')
We’ve used a random API key in these code examples. Replace it with your actual publishable API keys to 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.
Note that we may release new minor and patch versions of this library with small but backwards-incompatible fixes to the type declarations. These changes will not affect Warrant itself.