cerbos 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f2bb2c6e0ffb8fc9e59238a36388b706ae790057473f62c51b181a30c1ec93
-  data.tar.gz: 91e8c713dac8b1f7f89245b53463f3f8098af17ade471249d10c0fae5e4cabfe
+  metadata.gz: 41c6a1f790cc09bff5f0c542d5338161730c4c649e66074afb381af8581637d3
+  data.tar.gz: f7fbd30bc55b357b1a0a77d1da2e48d06cf9af1fe4cfc44947c879e661a81768
 SHA512:
-  metadata.gz: 2224efcc85af2a8238c946f44d853985cd3ce5d9b5c0c913992eaad7b738bc196c2fc88f985ae3ea38b3d03f6c72dcc851af77586e2628b6f80773db6d49894e
-  data.tar.gz: 9ac45962052d139c904134eafb42dce8ac781af74a4041d22950ba4a997da1cf02e55e55462ff8237da0e916e56909822631dcc0be5a2873e933cbd6900a6e71
+  metadata.gz: e0bbda1a092e1ec55fe9565765609fd0ed3dd77a4fa12f627cddbb1b7b48177d423114a9e8d21a454e2fcfd9257e6ce82da303f4f3df82d2d24d766519734100
+  data.tar.gz: 525b97f8aee44d35fe4039ab75ecad4315f79fedd0f2ad94a2b308fa99700579e8800009a38735ebdfc3a9f462aae230f71ef637ab682fc461c2d40cb6a897cb

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## [Unreleased]
 No notable changes.
 
+## [0.3.0] - 2022-05-13
+### Added
+- More helper methods ([#11](https://github.com/cerbos/cerbos-sdk-ruby/pull/11))
+  - `Cerbos::Client#allow?` for checking a single action on a resource
+  - `Cerbos::Output::CheckResources#allow_all?` and `Cerbos::Output::CheckResources::Result#allow_all?` for checking if all input actions were allowed
+
 ## [0.2.0] - 2022-05-12
 ### Changed
 - Increased `grpc` version requirement to 1.46+ to avoid [installing a native gem compiled for `x86_64-darwin` on `arm64-darwin`](https://github.com/grpc/grpc/issues/29100) ([#8](https://github.com/cerbos/cerbos-sdk-ruby/pull/8))
@@ -9,6 +15,7 @@ No notable changes.
 ### Added
 - Initial implementation of `Cerbos::Client` ([#2](https://github.com/cerbos/cerbos-sdk-ruby/pull/2))
 
-[Unreleased]: https://github.com/cerbos/cerbos-sdk-ruby/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/cerbos/cerbos-sdk-ruby/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/cerbos/cerbos-sdk-ruby/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/cerbos/cerbos-sdk-ruby/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/cerbos/cerbos-sdk-ruby/compare/4481009e9dec2e1e6a2df8ea2f828690ceabbefc...v0.1.0

data/lib/cerbos/client.rb

@@ -44,11 +44,30 @@ module Cerbos
       end
     end
 
+    # Check if a principal is allowed to perform an action on a resource.
+    #
+    # @param principal [Input::Principal, Hash] the principal to check.
+    # @param resource [Input::Resource, Hash] the resource to check.
+    # @param action [String] the action to check.
+    # @param aux_data [Input::AuxData, Hash, nil] auxiliary data.
+    # @param request_id [String] identifier for tracing the request.
+    #
+    # @return [Boolean]
+    def allow?(principal:, resource:, action:, aux_data: nil, request_id: SecureRandom.uuid)
+      check_resource(
+        principal: principal,
+        resource: resource,
+        actions: [action],
+        aux_data: aux_data,
+        request_id: request_id
+      ).allow?(action)
+    end
+
     # Check a principal's permissions on a resource.
     #
     # @param principal [Input::Principal, Hash] the principal to check.
     # @param resource [Input::Resource, Hash] the resource to check.
-    # @param actions [Input::Resource, Hash] the actions to check.
+    # @param actions [Array<String>] the actions to check.
     # @param aux_data [Input::AuxData, Hash, nil] auxiliary data.
     # @param include_metadata [Boolean] `true` to include additional metadata ({Output::CheckResources::Result::Metadata}) in the results.
     # @param request_id [String] identifier for tracing the request.

data/lib/cerbos/output/check_resources.rb

@@ -23,7 +23,7 @@ module Cerbos
         )
       end
 
-      # Check the policy decision was that an action should be allowed for a resource.
+      # Check if the policy decision was that an action should be allowed for a resource.
       #
       # @param resource [Input::Resource, Hash] the resource search criteria (see {#find_result}).
       # @param action [String] the action to check.
@@ -34,6 +34,16 @@ module Cerbos
         find_result(resource)&.allow?(action)
       end
 
+      # Check if the policy decision was that all input actions should be allowed for a resource.
+      #
+      # @param resource [Input::Resource, Hash] the resource search criteria (see {#find_result}).
+      #
+      # @return [Boolean]
+      # @return [nil] if the resource is not present in the results.
+      def allow_all?(resource)
+        find_result(resource)&.allow_all?
+      end
+
       # Find an item from {#results} by resource.
       #
       # @param resource [Input::Resource, Hash] the resource search criteria. `kind` and `id` are required; `policy_version` and `scope` may also be provided if needed to distinguish between multiple results for the same `kind` and `id`.
@@ -95,6 +105,13 @@ module Cerbos
         actions[action]&.eql?(:EFFECT_ALLOW)
       end
 
+      # Check if the policy decision was that all input actions should be allowed for the resource.
+      #
+      # @return [Boolean]
+      def allow_all?
+        actions.each_value.all? { |effect| effect == :EFFECT_ALLOW }
+      end
+
       # List the actions that should be allowed for the resource.
       #
       # @return [Array<String>]

data/lib/cerbos/version.rb

@@ -2,5 +2,5 @@
 
 module Cerbos
   # Current version of the `cerbos` gem.
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cerbos
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Cerbos
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -81,7 +81,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/cerbos/cerbos-sdk-ruby/issues
   changelog_uri: https://github.com/cerbos/cerbos-sdk-ruby/blob/main/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/cerbos/0.2.0
+  documentation_uri: https://www.rubydoc.info/gems/cerbos/0.3.0
   homepage_uri: https://github.com/cerbos/cerbos-sdk-ruby
   source_code_uri: https://github.com/cerbos/cerbos-sdk-ruby
   rubygems_mfa_required: 'true'