cedar_policy 0.2.0-x86_64-linux → 0.5.2-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23013475dfcde8ac6ec153416cac35b80852ae34033b387bdd2698c1738efc0b
-  data.tar.gz: 1c11138c2e7fae23d5b302dfdada9b163cf19728bd7d9797265f0e8318fb7b9f
+  metadata.gz: 0d70d8d232fc3c61e8e7a84883b0e29f0945176cfd21e33bbeb6c2de988f5ec4
+  data.tar.gz: e79e71b96da97d5dbbb0d0e6ef1c0f78b343216bf8920ab348d72ddaf83ac26e
 SHA512:
-  metadata.gz: 0c0aeb20f0ca58767b258f4a3aedfe9c6a00eb4c6fa403510b37d643eef7d6547ce9a32a88614100ad0a0ca17878e1a727410a5811c4abd9d879de583fb826c1
-  data.tar.gz: 60470fe3a709ccd2a1ebe245d223544e6b7d3e3c77170aecbecad22693c4a140b6c1f42e37ba7c2542e0a1b81e104b86fd4bc730cd41308030198714cdeb5fbc
+  metadata.gz: 18c7ead5618d2d796ff9f7e3e8a51a71a6ff76ea87b647804b6f75114a11d76c98ef5c8c356916bea7339b4210f5e4a72e986dbfd77eda3a69ba589dbb73dd38
+  data.tar.gz: ae146c75001414f15197e623aa8e24c33f676d3d0b6bb876e486e3aab1255ae9358f56937edec1384b8f82c0d14f0c559a91beb7c9c408c2a8250263fb973672

data/.release-please-manifest.json

@@ -0,0 +1 @@
+{".":"0.5.2"}

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## [0.5.2](https://github.com/elct9620/cedar-policy-rb/compare/v0.5.1...v0.5.2) (2025-01-22)
+
+
+### Bug Fixes
+
+* rb-sys version too old cause build failed ([6b58381](https://github.com/elct9620/cedar-policy-rb/commit/6b583811e9d7e8eef3fe1843e7a04f8b9fc6f975))
+
+## [0.5.1](https://github.com/elct9620/cedar-policy-rb/compare/v0.5.0...v0.5.1) (2025-01-22)
+
+
+### Bug Fixes
+
+* the Gemfile.lock not updated ([8853e74](https://github.com/elct9620/cedar-policy-rb/commit/8853e747188e83aa4ac1bfa7b4d1c361932cdb76))
+
+## [0.5.0](https://github.com/elct9620/cedar-policy-rb/compare/v0.4.0...v0.5.0) (2025-01-22)
+
+
+### Features
+
+* **deps:** bump rust cedar_policy to v4.3.0 ([9aea4f1](https://github.com/elct9620/cedar-policy-rb/commit/9aea4f130867243b4d61be41a2f8abfd3d021df2))
+* **deps:** update cedar-policy to 4.2.0 ([a7218d7](https://github.com/elct9620/cedar-policy-rb/commit/a7218d7c3af0384cfcdae735f07b06c624ea8002))
+
+## [0.4.0](https://github.com/elct9620/cedar-policy-rb/compare/cedar_policy-v0.3.0...cedar_policy/v0.4.0) (2024-10-06)
+
+
+### Features
+
+* **deps:** upgrade cedar-policy to v4.1.0 ([61d6fa1](https://github.com/elct9620/cedar-policy-rb/commit/61d6fa1a59ab2edd71972410c1d9d697fde60776))
+
+
+### Bug Fixes
+
+* commitizen hook file bundled into gem ([b0c9c77](https://github.com/elct9620/cedar-policy-rb/commit/b0c9c77459ec614bfd4698d804969adb9b4bccc1))

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,32 +31,80 @@ 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
-* [ ] Diagnostics return with response
+* [ ] Add batch authorization support
+* [x] Diagnostics return with response
 * [ ] Validator support
 * [ ] Schema support
 

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.5.2"
 end

data/release-please-config.json

@@ -0,0 +1,18 @@
+{
+  "release-type": "ruby",
+  "last-release-sha": "7d06a6458e9805cc6ec05f456c650708cc9d9e9f",
+  "packages": {
+    ".":{
+        "component": "cedar_policy",
+        "include-component-in-tag": false,
+        "release-type": "ruby"
+      }
+  },
+  "extra-files": [
+    {
+      "type": "toml",
+      "path": "ext/cedar_policy/Cargo.toml",
+      "jsonpath": "$.package.version"
+    }
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cedar_policy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.2
 platform: x86_64-linux
 authors:
 - Aotokitsuruya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies: []
 description: Ruby bindings for Cedar policy evaluation engine.
 email:
@@ -18,8 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".cross_rubies"
+- ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -27,12 +29,12 @@ files:
 - lib/cedar_policy/3.0/cedar_policy.so
 - lib/cedar_policy/3.1/cedar_policy.so
 - lib/cedar_policy/3.2/cedar_policy.so
-- lib/cedar_policy/3.3/cedar_policy.so
 - lib/cedar_policy/context.rb
 - lib/cedar_policy/entities.rb
 - lib/cedar_policy/entity.rb
 - lib/cedar_policy/entity_uid.rb
 - lib/cedar_policy/version.rb
+- release-please-config.json
 - sig/cedar_policy.rbs
 homepage: https://github.com/elct9620/cedar-policy-rb
 licenses:
@@ -53,14 +55,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.4.dev
+      version: 3.3.dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.4.4
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Cedar policy evaluation engine.