warrant 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eedc398b4f1277eabdabf8252acde068e1a1398f0b3752d217793ec1d22570b3
-  data.tar.gz: 035f98bda116c4177ead75b9895a86582b2b37fd7d04b1b2175e68f73c0adff5
+  metadata.gz: e1faca7fd1a9bdcb8ae4f6c4a6ac5bc68a138cca35d3eafcb888de554156f4c5
+  data.tar.gz: 7bc91b0ebf6e9cf0dd442b19edc6b6f0514b3008cf89e4ddc448fd4def3bf12c
 SHA512:
-  metadata.gz: b5d81834bffb0ac19ed371259e6b321ca23aa42a8ab0dd1bcf8c720fec168910ed8dcfe620942d17d4d399834593856080dbe802f786d273466db347089b10b4
-  data.tar.gz: 717cce9e98093c01c7412323894e7eb9f87742ae412eac1564e8e91184a3cea327dbb76ee7d5131196389c8df7e6b5a112ed24a6ccbd270f75a0277f2356b651
+  metadata.gz: b849e8be7fc0105a11677ab6aa901221c45e8f70cc3e0baf2ff4b4c590816a841536aece028d9e1d386267d654192fd61f081991ddb39b3b7c93e0c672e93168
+  data.tar.gz: 7f653279a31b8b96beb09f8e255ad19680bd3d2602c14a025b0a9e5820523264acb58568d6a6d85ccc265fc73b136040c22a5c1bff86e8bccfe6e9057382a83e

data/README.md

@@ -6,7 +6,6 @@ Use [Warrant](https://warrant.dev/) in ruby projects.
 [![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:
 
@@ -27,18 +26,15 @@ You can also build the gem from source:
     $ gem build warrant.gemspec
 
 ## Documentation
----
 
 - [Ruby API Docs](https://rubydoc.info/gems/warrant)
 - [Warrant Docs](https://docs.warrant.dev/)
 
 ## Requirements
----
 
 - Ruby 2.3+.
 
 ## Usage
----
 
 ```ruby
 require 'warrant'
@@ -52,7 +48,6 @@ Warrant::Warrant.is_authorized?(object_type: "report", object_id: "7asm24", rela
 ```
 
 ## Configuring the API and Authorize Endpoints
----
 The API and Authorize endpoints the SDK makes requests to is configurable via the `Warrant.api_base` and `Warrant.authorize_endpoint` attributes:
 
 ```ruby
@@ -64,7 +59,6 @@ Warrant.authorize_endpoint = 'http://localhost:8000'
 ```
 
 ## Configuring SSL
----
 By default, the SDK will attempt to use SSL when making requests to the API. This setting is configurable via the `Warrant.use_ssl` attribute:
 
 ```ruby
@@ -74,7 +68,6 @@ require 'warrant'
 Warrant.use_ssl = false
 ```
 
-
 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/feature.rb

@@ -66,6 +66,12 @@ module Warrant
         #
         # @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)
+        # @option filters [String] :beforeId A string representing a cursor value in the form of a featureId. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :beforeValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :afterId A string representing a cursor value in the form of a featureId. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :afterValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :sortBy A string representing the field to sort results by. Default value is featureId. (optional)
+        # @option filters [String] :sortOrder A string representing whether to sort results in ascending or descending order. Must be ASC or DESC. (optional)
         #
         # @return [Array<Feature>] all features for your organization
         #

data/lib/warrant/models/permission.rb

@@ -68,6 +68,12 @@ module Warrant
         #
         # @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)
+        # @option filters [String] :beforeId A string representing a cursor value in the form of a permissionId. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :beforeValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :afterId A string representing a cursor value in the form of a permissionId. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :afterValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :sortBy A string representing the field to sort results by. Default value is permissionId. (optional)
+        # @option filters [String] :sortOrder A string representing whether to sort results in ascending or descending order. Must be ASC or DESC. (optional)
         #
         # @return [Array<Permission>] all permissions for your organization
         #

data/lib/warrant/models/pricing_tier.rb

@@ -66,6 +66,12 @@ module Warrant
         #
         # @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)
+        # @option filters [String] :beforeId A string representing a cursor value in the form of a pricingTierId. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :beforeValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :afterId A string representing a cursor value in the form of a pricingTierId. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :afterValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :sortBy A string representing the field to sort results by. Default value is pricingTierId. (optional)
+        # @option filters [String] :sortOrder A string representing whether to sort results in ascending or descending order. Must be ASC or DESC. (optional)
         #
         # @return [Array<Feature>] all pricing tiers for your organization
         #
@@ -267,7 +273,6 @@ module Warrant
         #
         # @param feature_id [String] The feature_id of the feature to check whether the pricing tier has access to.
         # @option options [Hash] :context Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @option options [Boolean] :consistent_read Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
         # @option options [Boolean] :debug Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @return [Boolean] whether or not the pricing tier has the given feature
@@ -284,7 +289,6 @@ module Warrant
                     object_id: pricing_tier_id
                 },
                 context: opts[:context],
-                consistent_read: opts[:consistent_read],
                 debug: opts[:debug]
             )
         end

data/lib/warrant/models/role.rb

@@ -68,6 +68,12 @@ module Warrant
         #
         # @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)
+        # @option filters [String] :beforeId A string representing a cursor value in the form of a roleId. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :beforeValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :afterId A string representing a cursor value in the form of a roleId. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :afterValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :sortBy A string representing the field to sort results by. Default value is roleId. (optional)
+        # @option filters [String] :sortOrder A string representing whether to sort results in ascending or descending order. Must be ASC or DESC. (optional)
         #
         # @return [Array<Role>] all roles for your organization
         #

data/lib/warrant/models/tenant.rb

@@ -99,6 +99,12 @@ module Warrant
         #
         # @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)
+        # @option filters [String] :beforeId A string representing a cursor value in the form of a tenantId. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :beforeValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :afterId A string representing a cursor value in the form of a tenantId. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :afterValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :sortBy A string representing the field to sort results by. Default value is tenantId. (optional)
+        # @option filters [String] :sortOrder A string representing whether to sort results in ascending or descending order. Must be ASC or DESC. (optional)
         #
         # @return [Array<Tenant>] all tenants for your organization
         #
@@ -222,6 +228,12 @@ module Warrant
         # @param user_id [String] The user_id of the user from which to fetch tenants
         # @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)
+        # @option filters [String] :beforeId A string representing a cursor value in the form of a tenantId. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :beforeValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :afterId A string representing a cursor value in the form of a tenantId. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :afterValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :sortBy A string representing the field to sort results by. Default value is tenantId. (optional)
+        # @option filters [String] :sortOrder A string representing whether to sort results in ascending or descending order. Must be ASC or DESC. (optional)
         #
         # @return [Array<Tenant>] all tenants for the user
         #
@@ -344,7 +356,6 @@ module Warrant
         #
         # @param feature_id [String] The feature_id of the feature to check whether the tenant has access to.
         # @option options [Hash] :context Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @option options [Boolean] :consistent_read Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
         # @option options [Boolean] :debug Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @ return [Boolean] whether or not the tenant has the given feature
@@ -361,7 +372,6 @@ module Warrant
                     object_id: tenant_id
                 },
                 context: opts[:context],
-                consistent_read: opts[:consistent_read],
                 debug: opts[:debug]
             )
         end

data/lib/warrant/models/user.rb

@@ -100,6 +100,12 @@ module Warrant
         #
         # @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)
+        # @option filters [String] :beforeId A string representing a cursor value in the form of a userId. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :beforeValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :afterId A string representing a cursor value in the form of a userId. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :afterValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :sortBy A string representing the field to sort results by. Default value is userId. (optional)
+        # @option filters [String] :sortOrder A string representing whether to sort results in ascending or descending order. Must be ASC or DESC. (optional)
         #
         # @return [Array<User>] all users for your organization
         #
@@ -301,7 +307,6 @@ module Warrant
         #
         # @param permission_id [String] The permission_id of the permission you want to check whether or not it exists on the user.
         # @option options [Hash] :context Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @option options [Boolean] :consistent_read Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
         # @option options [Boolean] :debug Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @return [Boolean] whether or not the user has the given permission
@@ -319,7 +324,6 @@ module Warrant
                 permission_id: permission_id,
                 user_id: user_id,
                 context: opts[:context],
-                consistent_read: opts[:consistent_read],
                 debug: opts[:debug]
             )
         end
@@ -329,6 +333,12 @@ module Warrant
         # @param tenant_id [String] The tenant_id of the tenant from which to fetch users
         # @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)
+        # @option filters [String] :beforeId A string representing a cursor value in the form of a userId. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :beforeValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately before the provided value. (optional)
+        # @option filters [String] :afterId A string representing a cursor value in the form of a userId. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :afterValue A string representing a cursor value in the form of the `sortBy` value. If provided, the results returned are immediately after the provided value. (optional)
+        # @option filters [String] :sortBy A string representing the field to sort results by. Default value is userId. (optional)
+        # @option filters [String] :sortOrder A string representing whether to sort results in ascending or descending order. Must be ASC or DESC. (optional)
         #
         # @return [Array<User>] all users for the tenant
         #
@@ -485,7 +495,6 @@ module Warrant
         #
         # @param feature_id [String] The feature_id of the feature to check whether the user has access to.
         # @option options [Hash] :context Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @option options [Boolean] :consistent_read Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
         # @option options [Boolean] :debug Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @ return [Boolean] whether or not the user has the given feature
@@ -502,7 +511,6 @@ module Warrant
                     object_id: user_id
                 },
                 context: opts[:context],
-                consistent_read: opts[:consistent_read],
                 debug: opts[:debug]
             )
         end

data/lib/warrant/models/warrant.rb

@@ -2,15 +2,15 @@
 
 module Warrant
     class Warrant
-        attr_reader :id, :object_type, :object_id, :relation, :subject, :context, :is_implicit
+        attr_reader :id, :object_type, :object_id, :relation, :subject, :policy, :is_implicit
 
         # @!visibility private
-        def initialize(object_type, object_id, relation, subject, context = nil, is_implicit = nil)
+        def initialize(object_type, object_id, relation, subject, policy = nil, is_implicit = nil)
             @object_type = object_type
             @object_id = object_id
             @relation = relation
             @subject = subject
-            @context = context
+            @policy = policy
             @is_implicit = is_implicit
         end
 
@@ -19,7 +19,7 @@ module Warrant
         # @param object [WarrantObject | Hash] Object to check in the access check. Object must include WarrantObject module and implements its methods (`warrant_object_type` and `warrant_object_id`). The object type must be one of your system's existing object type.
         # @param relation [String] The relation to check for this object to subject association. The relation must be valid as per the object type definition.
         # @param subject [WarrantObject | Hash] Subject to check in the access check. Subject must include WarrantObject module and implements its methods (`warrant_object_type` and `warrant_object_id`).
-        # @param context [Hash] - Object containing key-value pairs that specifies the context the warrant should be created for. (optional)
+        # @param policy [String] - A boolean expression that must evaluate to `true` for this warrant to apply. The expression can reference variables that are provided in the `context` attribute of access check requests. (optional)
         #
         # @return [Warrant] created warrant
         #
@@ -30,7 +30,7 @@ module Warrant
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
         # @raise [Warrant::WarrantError]
-        def self.create(object, relation, subject, context = nil)
+        def self.create(object, relation, subject, policy = nil)
             params = {
                 object_type: object.respond_to?(:warrant_object_type) ? object.warrant_object_type.to_s : object[:object_type],
                 object_id: object.respond_to?(:warrant_object_id) ? object.warrant_object_id.to_s : object[:object_id],
@@ -39,7 +39,7 @@ module Warrant
                     object_type: subject.respond_to?(:warrant_object_type) ? subject.warrant_object_type.to_s : subject[:object_type],
                     object_id: subject.respond_to?(:warrant_object_id) ? subject.warrant_object_id.to_s : subject[:object_id]
                 },
-                context: context
+                policy: policy
             }
             res = APIOperations.post(URI.parse("#{::Warrant.config.api_base}/v1/warrants"), Util.normalize_params(params))
             res_json = JSON.parse(res.body)
@@ -47,7 +47,7 @@ module Warrant
             case res
             when Net::HTTPSuccess
                 subject = Subject.new(res_json['subject']['objectType'], res_json['subject']['objectId'], res_json['subject']['relation'])
-                Warrant.new(res_json['objectType'], res_json['objectId'], res_json['relation'], subject, res_json['context'])
+                Warrant.new(res_json['objectType'], res_json['objectId'], res_json['relation'], subject, res_json['policy'])
             else
                 APIOperations.raise_error(res)
             end
@@ -58,7 +58,7 @@ module Warrant
         # @param object [WarrantObject | Hash] Object to check in the access check. Object must include WarrantObject module and implements its methods (`warrant_object_type` and `warrant_object_id`). The object type must be one of your system's existing object type.
         # @param relation [String] The relation to check for this object to subject association. The relation must be valid as per the object type definition.
         # @param subject [WarrantObject | Hash] Subject to check in the access check. Subject must include WarrantObject module and implements its methods (`warrant_object_type` and `warrant_object_id`).
-        # @param context [Hash] - Object containing key-value pairs that specifies the context the warrant should be deleted in. (optional)
+        # @param policy [String] - A boolean expression that must evaluate to `true` for this warrant to apply. The expression can reference variables that are provided in the `context` attribute of access check requests. (optional)
         #
         # @return [nil] if delete was successful
         #
@@ -67,7 +67,7 @@ module Warrant
         # @raise [Warrant::NotFoundError]
         # @raise [Warrant::UnauthorizedError]
         # @raise [Warrant::WarrantError]
-        def self.delete(object, relation, subject, context = nil)
+        def self.delete(object, relation, subject, policy = nil)
             params = {
                 object_type: object.respond_to?(:warrant_object_type) ? object.warrant_object_type.to_s : object[:object_type],
                 object_id: object.respond_to?(:warrant_object_id) ? object.warrant_object_id.to_s : object[:object_id],
@@ -76,7 +76,7 @@ module Warrant
                     object_type: subject.respond_to?(:warrant_object_type) ? subject.warrant_object_type.to_s : subject[:object_type],
                     object_id: subject.respond_to?(:warrant_object_id) ? subject.warrant_object_id.to_s : subject[:object_id]
                 },
-                context: context
+                policy: policy
             }
             res = APIOperations.delete(URI.parse("#{::Warrant.config.api_base}/v1/warrants"), Util.normalize_params(params))
 
@@ -166,8 +166,7 @@ module Warrant
         #       * object_type (String) - The type of object. Must be one of your system's existing object types.
         #       * object_id (String) - The id of the specific object.
         #       * relation (String) - The relation for this object to subject association. The relation must be valid as per the object type definition. (optional)
-        # @param context [Hash] - Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @param consistent_read [Boolean] Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
+        #   * context [Hash] - Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
         # @param debug [Boolean] Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @return [Boolean] whether or not the given access check is authorized
@@ -201,8 +200,7 @@ module Warrant
         # @param object [WarrantObject] Object to check in the access check. Object must include WarrantObject module and implements its methods (`warrant_object_type` and `warrant_object_id`). The object type must be one of your system's existing object type.
         # @param relation [String] The relation to check for this object to subject association. The relation must be valid as per the object type definition.
         # @param subject [WarrantObject] Subject to check in the access check. Subject must include WarrantObject module and implements its methods (`warrant_object_type` and `warrant_object_id`).
-        # @option options [Hash] :context Object containing key-value pairs that specifies the context the warrant should be checked in. (optional) (optional)
-        # @option options [Boolean] :consistent_read Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
+        # @option options [Hash] :context Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
         # @option options [Boolean] :debug Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @return [Boolean] whether or not the given access check is authorized
@@ -239,7 +237,6 @@ module Warrant
                         subject: subject,
                         context: options[:context]
                     }],
-                    consistent_read: options[:consistent_read],
                     debug: options[:debug]
                 )
             end
@@ -252,7 +249,6 @@ module Warrant
                     subject: subject,
                     context: options[:context]
                 }],
-                consistent_read: options[:consistent_read],
                 debug: options[:debug]
             )
         end
@@ -265,7 +261,6 @@ module Warrant
         #   * relation (String) - The relation to check for this object to subject association. The relation must be valid as per the object type definition.
         #   * subject (WarrantObject) Subject to check in the access check. Subject must include WarrantObject module and implements its methods (`warrant_object_type` and `warrant_object_id`).
         # @option options [Hash] :context Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @option options [Boolean] :consistent_read Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
         # @option options [Boolean] :debug Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @return [Boolean] whether or not the given access check is authorized
@@ -314,7 +309,6 @@ module Warrant
                 return edge_authorize?(
                     op: op,
                     warrants: normalized_warrants,
-                    consistent_read: options[:consistent_read],
                     debug: options[:debug]
                 )
             end
@@ -322,7 +316,6 @@ module Warrant
             return authorize?(
                 op: op,
                 warrants: normalized_warrants,
-                consistent_read: options[:consistent_read],
                 debug: options[:debug]
             )
         end
@@ -332,7 +325,6 @@ module Warrant
         # @param user_id [String] Id of the user to check
         # @param permission_id [String] Id of the permission to check on the user
         # @param context [Hash] - Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @param consistentRead [Boolean] Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
         # @param debug [Boolean] Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @return [Boolean] whether or not the user has the given permission
@@ -353,7 +345,6 @@ module Warrant
                     },
                     context: params[:context]
                 }],
-                consistentRead: params[:consistentRead],
                 debug: params[:debug]
             )
         end
@@ -365,7 +356,6 @@ module Warrant
         #   * object_id (String) - The id of the specific object.
         # @param feature_id [String] Id of the feature to check on the subject
         # @param context [Hash] - Object containing key-value pairs that specifies the context the warrant should be checked in. (optional)
-        # @param consistent_read [Boolean] Boolean flag indicating whether or not to enforce strict consistency for this access check. Defaults to false. (optional)
         # @param debug [Boolean] Boolean flag indicating whether or not to return debug information for this access check. Defaults to false. (optional)
         #
         # @return [Boolean] whether or not the user has the given permission
@@ -386,7 +376,6 @@ module Warrant
                     },
                     context: params[:context]
                 }],
-                consistent_read: params[:consistent_read],
                 debug: params[:debug]
             )
         end

data/lib/warrant/util.rb

@@ -21,6 +21,12 @@ module Warrant
                 case params
                 when Hash
                     params.each_with_object({}) do |(k, v), new_opts|
+                        # Leave context hash as-is to allow for any naming convention (snake_case vs camelCase)
+                        if k.to_s == "context"
+                            new_opts[k] = v
+                            next
+                        end
+
                         new_key = Util.camelcase(k.to_s)
 
                         case v

data/lib/warrant/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warrant
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Warrant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies: []
 description: Ruby library for the Warrant API at https://warrant.dev.
 email: hello@warrant.dev