cedar_policy 0.2.0-x86_64-darwin → 0.3.0-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce44693f09d56711a213ce02a119e8440fad3ac73cef24a72344d943efe6a39
-  data.tar.gz: 6fd283eaa41422ef8693c03e66724dcf1764a571a8372af88cddc55b0fa5e86f
+  metadata.gz: 1f1d5ac3c49b355c06fc93d1cd5d03f1b58e9d85a16a64523f781e5cdc1c6624
+  data.tar.gz: ddc3c1ba57167a3107ed345cf1d5ed51f2f48e9c9831e25a338d953fbde366ea
 SHA512:
-  metadata.gz: 765e7d6fdacac0d270779889ad0262884928e76df799b23e54a58d609791b08e9e843311d8f699a224b5718402279a9a84559ff4ecc18d42c01d45c480102b4a
-  data.tar.gz: 5e400f787263f9234f80aa812dc9fe5cc8c2f0bb3fe9acb11ce6d4a56a98516bd95254bab1454a51a9a566d909a68b8d28fc92e95cef482061887c0bcd5f59a5
+  metadata.gz: ecf2f04de628205249c01e60940cb10d7b6d710d8953d2e4c40fc526ae7a5ee4065d4530649b6708d6112d72ee56f87f1da3c8d1d5dbd574a849475dc3f91036
+  data.tar.gz: 7bebaefb23125cbdf10941cabbd5887abdeef46c9324c768de8346b65de86782231043daaaa18315ac5c3767e2343c79a1d03cb0b7201f25f22823707ffd5697

data/.rubocop.yml

@@ -1,6 +1,8 @@
 AllCops:
   NewCops: enable
   TargetRubyVersion: 3.0
+  SuggestExtensions: false
+
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/README.md

@@ -18,6 +18,10 @@ If bundler is not being used to manage dependencies, install the gem by executin
 > [!WARNING]
 > This gem is still under development and the API may change in the future.
 
+### PolicySet
+
+Define a policy by Cedar Language:
+
 ```ruby
 policy = <<~POLICY
           permit(
@@ -27,28 +31,75 @@ policy = <<~POLICY
           );
         POLICY
 policy_set = CedarPolicy::PolicySet.new(policy)
+```
+
+> Currently, the single policy is not supported.
 
-principal = CedarPolicy::EntityUid.new("User", "1")
+### Request
+
+Prepare the Entity's ID via `EntityUid` or an object with `#to_hash` method which returns a hash with `:type` and `:id` keys.
+
+```ruby
+principal = CedarPolicy::EntityUid.new("User", "1") # or { type: "User", id: "1" }
 action = CedarPolicy::EntityUid.new("Action", "view")
 resource = CedarPolicy::EntityUid.new("Image", "1")
-ctx = CedarPolicy::Context.new
+```
 
+The `Context` object is used to store the request context. Use `Context` or an object with `#to_hash` method which returns a hash.
+
+```ruby
+ctx = CedarPolicy::Context.new({ ip: "127.0.0.1" }) # or { ip: "127.0.0.1" }
+```
+> The `Context` object can initialize without any arguments as an empty context.
+
+Create a `Request` object with the principal, action, resource, and context.
+
+```ruby
 request = CedarPolicy::Request.new(principal, action, resource, ctx)
+```
 
+### Entities
+
+Define the entities with related this request. It should be an array of `Entity` objects which have `#to_hash` method returns a hash with `:uid`,`:attrs`, and `:parents` keys.
+
+```ruby
 entities = CedarPolicy::Entities.new([
     CedarPolicy::Entity.new(
         CedarPolicy::EntityUid.new("User", "1"),
-        { role: "admin" }
-    )
+        { role: "admin" },
+        [] # Parents' EntityUid
+    ),
+    {
+        uid: { type: "Image", id: "1" },
+        attrs: {},
+        parents: []
+    }
 ])
+```
 
+### Authorizer
+
+Create an `Authorizer` object and authorize the request with the policy set and entities.
+
+```ruby
 authorizer = CedarPolicy::Authorizer.new
+```
+
+If boolean result is enough, use `#authorize?` method.
+
+```ruby
 authorizer.authorize?(request, policy_set, entities) # => true
+```
 
+If you want to get the decision object, use `#authorize` method.
+
+```ruby
 response = authorizer.authorize(request, policy_set, entities)
 response.decision # => CedarPolicy::Decision::ALLOW
 ```
 
+> The diagnostics is not supported yet in the response.
+
 ## Roadmap
 
 * [ ] Add DSL to improve developer experience

data/lib/cedar_policy/entities.rb

@@ -3,8 +3,20 @@
 module CedarPolicy
   # :nodoc:
   class Entities
+    include Enumerable
+
     def initialize(entities = [])
-      @entities = Set.new(entities)
+      @entities = Set.new(entities.map do |entity|
+        next entity if entity.is_a?(Entity)
+
+        Entity.new(*entity.values_at(:uid, :attrs, :parents))
+      end)
+    end
+
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      @entities.each(&block)
     end
 
     def to_ary

data/lib/cedar_policy/entity.rb

@@ -6,15 +6,19 @@ module CedarPolicy
     attr_reader :uid, :attrs, :parents
 
     def initialize(uid, attrs = {}, parents = [])
-      raise ArgumentError unless uid.is_a?(EntityUid)
+      raise ArgumentError unless uid.is_a?(EntityUid) || uid.is_a?(Hash)
 
-      @uid = uid
+      @uid = if uid.is_a?(EntityUid)
+               uid
+             else
+               EntityUid.new(*uid.values_at(:type, :id))
+             end
       @attrs = attrs
       @parents = Set.new(parents)
     end
 
-    def ==(other)
-      hahs == other.hash
+    def eql?(other)
+      hash == other.hash
     end
 
     def hash

data/lib/cedar_policy/entity_uid.rb

@@ -8,11 +8,14 @@ module CedarPolicy
     def initialize(type_name, id)
       @type_name = type_name.to_s
       @id = id.to_s
+
+      freeze
     end
 
-    def ==(other)
+    def eql?(other)
       hash == other.hash
     end
+    alias == eql?
 
     def hash
       [self.class, @type_name, @id].hash

data/lib/cedar_policy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CedarPolicy
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cedar_policy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: x86_64-darwin
 authors:
 - Aotokitsuruya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2024-09-07 00:00:00.000000000 Z
 dependencies: []
 description: Ruby bindings for Cedar policy evaluation engine.
 email: