warrant 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a62cf14af95db8e5b31f60059a2a826a67c067239edb5f6c63cf02426df3ae21
-  data.tar.gz: bdc8aa083993566c57760d484e043ad3ed64abe2bf1945ebad2428c2eb497551
+  metadata.gz: a67a5a1dd2b6e9b95b675395d1337acd9509f166f5e22d224987260191b5090d
+  data.tar.gz: '08013f834166288f8a0ba21753d7a11d0a89e1aa8b7189894e0d80146f47081e'
 SHA512:
-  metadata.gz: 36cf1f6120b776293513e49d5554aa70a8ff22e671105072e2f04115d1e00bc852fd4cc5326672ae9ad246f35f069718272f2abf957ff9abe27ebeed0b564efc
-  data.tar.gz: 4377ab4955b67e922622ef8c10c50c17d3281d097ec62df85ce31779df3554d8326121622024ffde252abf1a3c13655d0e3f6251d898fc78f722a1578b091daa
+  metadata.gz: 8fd775c0e3bf27a5e2eebfa06992c2b09e6dc8d1337740ddbab46e328ea9ccc16b48f1da20e0214ba450d2428d0ac43370ae58ab7f698de7a3ed4b00abab646d
+  data.tar.gz: 04d89c962874fbd667d3f695f2913552e4dd855fa436737b387e05498736f4557549cd64958ab6dbce92d37f9ffd114549f498140cce5f7823e3f93e0e39c4c9

data/README.md

@@ -28,9 +28,9 @@ require 'warrant'
 Warrant.api_key = 'api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E='
 ```
 
-### `create_user(email, user_id = '', tenant_id = '')`
+### `create_user(email, user_id = '')`
 
-This method creates a user entity in Warrant with the specified `userId`. Provide an optional `username` to make it easier to identify users in the Warrant dashboard.
+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
@@ -40,13 +40,28 @@ Warrant::WarrantClient.create_user(user.email, user.id)
 Warrant::WarrantClient.create_user()
 ```
 
-### `create_warrant(objectType, objectId, relation, 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`.
 
 ```ruby
 # Create a warrant allowing user.id to "view" the store with id store.id
-Warrant::WarrantClient.create_warrant('store', store.id, 'view', { userId: user.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)`
@@ -58,9 +73,9 @@ This method creates a session in Warrant for the user with the specified `userId
 Warrant::WarrantClient.create_session(user.id)
 ```
 
-### `is_authorized(objectType, objectId, relation, userId)`
+### `is_authorized(object_type, object_id, relation, user_id)`
 
-This method returns `true` if the user with the specified `userId` has the specified `relation` to the object of type `objectType` with id `objectId` and `false` otherwise.
+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
@@ -73,16 +88,16 @@ This method returns all warrants that match the filters provided, or all warrant
 
 #### **Filter Parameters** 
 ---
-#### **objectType**
+#### **object_type**
 Only return warrants with the given object type.
 
-#### **objectId**
+#### **object_id**
 Only return warrants with the given object id.
 
 #### **relation**
 Only return warrants with the given relation.
 
-#### **userId**
+#### **user_id**
 Only return warrants with the given user id
 
 

data/lib/warrant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Warrant
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/warrant/warrant_client.rb

@@ -19,10 +19,9 @@ module Warrant
                 end
             end
 
-            def create_user(email, user_id = '', tenant_id = '')
+            def create_user(email, user_id = '')
                 uri = URI.parse("#{::Warrant.config.api_base}/v1/users")
                 params = {
-                    tenantId: tenant_id,
                     userId: user_id,
                     email: email
                 }
@@ -99,7 +98,7 @@ module Warrant
                     objectType: object_type,
                     objectId: object_id,
                     relation: relation,
-                    user: user
+                    user: Util.normalize_options(user)
                 }
                 res = post(uri, params)
                 res_json = JSON.parse(res.body)
@@ -113,7 +112,7 @@ module Warrant
             end
 
             def delete_warrant(warrant_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/warrants/#{warrant_id}")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/warrants/#{warrant_id}")
                 res = delete(uri)
 
                 case res

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warrant
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Warrant
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies: []
 description: Ruby library for the Warrant API at https://warrant.dev.
 email: hello@warrant.dev