warrant 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5243205fa7c1a3a21d681d66ab0071c2b71c95fb018a9812b7844919611c8b31
-  data.tar.gz: f36c01ea86c7cb028b142fc30eae84824e6ef861915d3f71038052b704cedb8e
+  metadata.gz: a67a5a1dd2b6e9b95b675395d1337acd9509f166f5e22d224987260191b5090d
+  data.tar.gz: '08013f834166288f8a0ba21753d7a11d0a89e1aa8b7189894e0d80146f47081e'
 SHA512:
-  metadata.gz: 4675af03e0ca8a149e5b01c0a58a6e7f72064597c167a4a6ddef76e98975d321dcb0efe1feafe85df558207f070cbae2969dd3c84bafeaad35a99ad97aa9c31c
-  data.tar.gz: 188ddcc865f033900b0f1b11e4ba49d11ce5a6ff01a0cc67387a07e0600e048ccbbbe75c0f6297a9b4eeefb9e759f71c3104d4fe5a8d2221610b649b56fad630
+  metadata.gz: 8fd775c0e3bf27a5e2eebfa06992c2b09e6dc8d1337740ddbab46e328ea9ccc16b48f1da20e0214ba450d2428d0ac43370ae58ab7f698de7a3ed4b00abab646d
+  data.tar.gz: 04d89c962874fbd667d3f695f2913552e4dd855fa436737b387e05498736f4557549cd64958ab6dbce92d37f9ffd114549f498140cce5f7823e3f93e0e39c4c9

data/README.md

@@ -28,28 +28,43 @@ require 'warrant'
 Warrant.api_key = 'api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E='
 ```
 
-### `createUser(user_id, username)`
+### `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.id` as the user_id and `user.email` as the username
-Warrant::WarrantClient.create_user(user.id, user.email)
+# Create user with user email and id
+Warrant::WarrantClient.create_user(user.email, user.id)
 
 # Create user with generated id
 Warrant::WarrantClient.create_user()
 ```
 
-### `createWarrant(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' })
 ```
 
-### `createSession(userId)`
+### `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.
 
@@ -58,9 +73,9 @@ This method creates a session in Warrant for the user with the specified `userId
 Warrant::WarrantClient.create_session(user.id)
 ```
 
-### `isAuthorized(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
@@ -68,6 +83,34 @@ 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
+
+
+```ruby
+# 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](https://app.warrant.dev) to
 test this code through your own Warrant account.
 

data/lib/warrant/models/{userset_warrant.rb → warrant.rb}

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module Warrant
-    class UsersetWarrant
-        attr_reader :object_type, :object_id, :relation, :user
+    class Warrant
+        attr_reader :id, :object_type, :object_id, :relation, :user
 
-        def initialize(object_type, object_id, relation, user)
+        def initialize(id, object_type, object_id, relation, user)
+            @id = id
             @object_type = object_type
             @object_id = object_id
             @relation = relation

data/lib/warrant/util.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Warrant
+    class Util
+        class << self
+            def camelcase(str)
+                str = str.split('_').collect(&:capitalize).join
+                str.sub(str[0], str[0].downcase)
+            end
+
+            def normalize_options(opts)
+                new_opts = opts.each_with_object({}) do |(k, v), new_opts|
+                    new_key = Util.camelcase(k.to_s)
+
+                    new_opts[new_key] = v
+                end
+            end
+        end
+    end
+end

data/lib/warrant/version.rb

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

data/lib/warrant/warrant_client.rb

@@ -4,7 +4,7 @@ module Warrant
     class WarrantClient
         class << self
             def create_tenant(tenant_id = '')
-                uri = URI.parse("#{Warrant.config.api_base}/v1/tenants")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/tenants")
                 params = {
                     tenantId: tenant_id
                 }
@@ -19,10 +19,9 @@ module Warrant
                 end
             end
 
-            def create_user(email, user_id = '', tenant_id = '')
-                uri = URI.parse("#{Warrant.config.api_base}/v1/users")
+            def create_user(email, user_id = '')
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/users")
                 params = {
-                    tenantId: tenant_id,
                     userId: user_id,
                     email: email
                 }
@@ -38,7 +37,7 @@ module Warrant
             end
 
             def create_role(role_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/roles")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/roles")
                 params = {
                     roleId: role_id
                 }
@@ -54,7 +53,7 @@ module Warrant
             end
 
             def delete_role(role_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/roles/#{role_id}")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/roles/#{role_id}")
                 res = delete(uri)
 
                 case res
@@ -66,7 +65,7 @@ module Warrant
             end
 
             def create_permission(permission_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/permissions")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/permissions")
                 params = {
                     permissionId: permission_id
                 }
@@ -82,7 +81,7 @@ module Warrant
             end
 
             def delete_permission(permission_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/permissions/#{permission_id}")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/permissions/#{permission_id}")
                 res = delete(uri)
 
                 case res
@@ -94,22 +93,53 @@ module Warrant
             end
 
             def create_warrant(object_type, object_id, relation, user)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/warrants")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/warrants")
                 params = {
                     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)
 
                 case res
                 when Net::HTTPSuccess
-                    if res_json['user']['userId']
-                        UserWarrant.new(res_json['objectType'], res_json['objectId'], res_json['relation'], res_json['user']['userId'])
-                    elsif res_json['user']['objectType']
-                        UsersetWarrant.new(res_json['objectType'], res_json['objectId'], res_json['relation'], res_json['user'])
+                    Warrant.new(res_json['id'], res_json['objectType'], res_json['objectId'], res_json['relation'], res_json['user'])
+                else
+                    res_json
+                end
+            end
+
+            def delete_warrant(warrant_id)
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/warrants/#{warrant_id}")
+                res = delete(uri)
+
+                case res
+                when Net::HTTPSuccess
+                    return
+                else
+                    res_json
+                end
+            end
+
+            def list_warrants(filters = {})
+                query_string = ""
+                unless filters.empty?
+                    new_filters = Util.normalize_options(filters.compact)
+
+                    query_string = URI.encode_www_form(new_filters) 
+                end
+
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/warrants?#{query_string}")
+
+                res = get(uri)
+                res_json = JSON.parse(res.body)
+
+                case res
+                when Net::HTTPSuccess
+                    res_json.map do |warrant|
+                        Warrant.new(warrant['id'], warrant['objectType'], warrant['objectId'], warrant['relation'], warrant['user'])
                     end
                 else
                     res_json
@@ -117,7 +147,7 @@ module Warrant
             end
 
             def assign_role_to_user(user_id, role_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/users/#{user_id}/roles/#{role_id}")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/roles/#{role_id}")
                 res = post(uri)
                 res_json = JSON.parse(res.body)
 
@@ -130,7 +160,7 @@ module Warrant
             end
 
             def remove_role_from_user(user_id, role_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/users/#{user_id}/roles/#{role_id}")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/roles/#{role_id}")
                 res = delete(uri)
 
                 case res
@@ -142,7 +172,7 @@ module Warrant
             end
 
             def assign_permission_to_user(user_id, permission_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/users/#{user_id}/permissions/#{permission_id}")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/permissions/#{permission_id}")
                 res = post(uri)
                 res_json = JSON.parse(res.body)
 
@@ -155,7 +185,7 @@ module Warrant
             end
 
             def remove_permission_from_user(user_id, permission_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/users/#{user_id}/permissions/#{permission_id}")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/permissions/#{permission_id}")
                 res = delete(uri)
 
                 case res
@@ -167,7 +197,7 @@ module Warrant
             end
 
             def create_session(user_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/users/#{user_id}/sessions")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/users/#{user_id}/sessions")
                 res = post(uri)
                 res_json = JSON.parse(res.body)
 
@@ -180,7 +210,7 @@ module Warrant
             end
 
             def create_self_service_session(user_id, redirect_url)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/sessions")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/sessions")
                 params = {
                     type: "ssdash",
                     userId: user_id,
@@ -198,7 +228,7 @@ module Warrant
             end
 
             def is_authorized(object_type, object_id, relation, user_id)
-                uri = URI.parse("#{Warrant.config.api_base}/v1/authorize")
+                uri = URI.parse("#{::Warrant.config.api_base}/v1/authorize")
                 params = {
                     objectType: object_type,
                     objectId: object_id,
@@ -227,7 +257,7 @@ 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}"
                 }
                 http.post(uri.path, params.to_json, headers)
             end
@@ -236,10 +266,19 @@ 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}"
                 }
                 http.delete(uri.path, headers)
             end
+
+            def get(uri, params = {})
+                http = Net::HTTP.new(uri.host, uri.port)
+                http.use_ssl = true
+                headers = {
+                    "Authorization": "ApiKey #{::Warrant.config.api_key}"
+                }
+                http.get(uri, headers)
+            end
         end
     end
 end

data/lib/warrant.rb

@@ -11,13 +11,13 @@ require "warrant/models/role"
 require "warrant/models/tenant"
 require "warrant/models/user"
 require "warrant/models/userset"
-require "warrant/models/user_warrant"
-require "warrant/models/userset_warrant"
+require "warrant/models/warrant"
+require "warrant/util"
 require "warrant/warrant_configuration"
 require "warrant/warrant_client"
 
 module Warrant
-    @config = Warrant::WarrantConfiguration.new
+    @config = ::Warrant::WarrantConfiguration.new
 
     class << self
         extend Forwardable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warrant
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Warrant
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-26 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
@@ -30,9 +30,9 @@ files:
 - lib/warrant/models/role.rb
 - lib/warrant/models/tenant.rb
 - lib/warrant/models/user.rb
-- lib/warrant/models/user_warrant.rb
 - lib/warrant/models/userset.rb
-- lib/warrant/models/userset_warrant.rb
+- lib/warrant/models/warrant.rb
+- lib/warrant/util.rb
 - lib/warrant/version.rb
 - lib/warrant/warrant_client.rb
 - lib/warrant/warrant_configuration.rb
@@ -44,7 +44,7 @@ metadata:
   source_code_uri: https://github.com/warrant-dev/warrant-ruby
   changelog_uri: https://github.com/warrant-dev/warrant-ruby/CHANGELOG.md
   documentation_uri: https://docs.warrant.dev/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,8 +59,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
-signing_key: 
+rubygems_version: 3.3.11
+signing_key:
 specification_version: 4
 summary: Warrant Ruby Library
 test_files: []

data/lib/warrant/models/user_warrant.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Warrant
-    class UserWarrant
-        attr_reader :object_type, :object_id, :relation, :user
-
-        def initialize(object_type, object_id, relation, user_id)
-            @object_type = object_type
-            @object_id = object_id
-            @relation = relation
-            @user = User.new(user_id)
-        end
-    end
-end