aserto-rails 0.0.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c80c8f7b8f213573d3e79b76e70e98747046dd617a7a5ccb53def1da90119be
-  data.tar.gz: 18446a39215b54a1d401ebda2e7603d82934c3e7dcc4825d6af7a966f006bbbc
+  metadata.gz: 3d7ae40725c31eb1adcb2d1df88a1a67e29dff3706d6c30ad830ea13feb5e875
+  data.tar.gz: 12557df817e967e8f158ece18607a4fbd5110b8895e177f6d48b5b212bddb919
 SHA512:
-  metadata.gz: 2c7436cec3d05adc828ce7a4a420c0e597e0eef4cd4f3a4848ea8c6cc229da3eb26f1c6db08d6993202bd12898331b1d1a084f5fcf196ce1df70849f7505dfdc
-  data.tar.gz: e2e539042d697de666858e9df0ed0d651d9cf248e750088f9fa2a3e595cd8e9d48e1e5879f2ee2640ab1c96bf1201c70bb09a9265d89f750ba1fcb1459064d33
+  metadata.gz: 177ef05bc61a60f51b84cd6bfe8ff2f914489209dff0d20818cfc8aed29d1ce74f16d029a2ee8905dfa3b702357cf53ed5156d2c1c2686866857be7dd5a00416
+  data.tar.gz: c9e3e55508e09dab96f9373eba3b3347b57490de405b6b7995e9f4a4771daa3f192e95fdd00d61133fbf291c1d980a030edbf3a59c792d5e31de23a99943465b

data/README.md

@@ -1,5 +1,10 @@
 # Aserto Rails
 
+[![Gem Version](https://badge.fury.io/rb/aserto-rails.svg)](https://badge.fury.io/rb/aserto-rails)
+[![ci](https://github.com/aserto-dev/aserto-rails/actions/workflows/ci.yaml/badge.svg)](https://github.com/aserto-dev/aserto-rails/actions/workflows/ci.yaml)
+[![slack](https://img.shields.io/badge/slack-Aserto%20Community-brightgreen)](https://asertocommunity.slack.com
+)
+
 Aserto authorization library for Ruby and Ruby on Rails.
 
 Built on top of [aserto](https://github.com/aserto-dev/aserto-ruby) and [aserto-grpc-authz](https://github.com/aserto-dev/ruby-grpc-authz).
@@ -26,7 +31,7 @@ gem install aserto-rails
 ```
 
 ## Configuration
-The following configuration settings are required for the authorization middleware:
+The following configuration settings are required for authorization:
  - policy_id
  - tenant_id
  - authorizer_api_key
@@ -34,26 +39,26 @@ The following configuration settings are required for the authorization middlewa
 
 These settings can be retrieved from the [Policy Settings](https://console.aserto.com/ui/policies) page of your Aserto account.
 
-The middleware accepts the following optional parameters:
+Optional parameters:
 
 | Parameter name | Default value | Description |
 | -------------- | ------------- | ----------- |
 | service_url | `"authorizer.prod.aserto.com:8443"` | Sets the URL for the authorizer endpoint. |
-| decision | `"allowed"` | The decision that will be used by the middleware when creating an authorizer request. |
-| logger | `STDOUT` | The logger to be used by the middleware. |
+| decision | `"allowed"` | The decision that will be used when executing an authorizer request. |
+| logger | `STDOUT` | The logger to be used. |
 | identity_mapping | `{ type: :none }` | The strategy for retrieveing the identity, possible values: `:jwt, :sub, :none` |
 
 ## Identity
-To determine the identity of the user, the middleware can be configured to use a JWT token or a claim using the `identity_mapping` config.
+To determine the identity of the user, the gem can be configured to use a JWT token or a claim using the `identity_mapping` config.
 ```ruby
-# configure the middleware to use a JWT token form the `my-auth-header` header.
+# configure the gem to use a JWT token form the `my-auth-header` header.
 config.identity_mapping = {
   type: :jwt,
   from: "my-auth-header",
 }
 ```
 ```ruby
-# configure the middleware to use a claim from the JWT token.
+# configure the gem to use a claim from the JWT token.
 # This will decode the JWT token and extract the `sub` field from payload.
 config.identity_mapping = {
   type: :sub,
@@ -76,7 +81,7 @@ end
 ```
 
 ## URL path to policy mapping
-By default, when computing the policy path, the middleware:
+By default, when computing the policy path:
 * converts all slashes to dots
 * converts any character that is not alpha, digit, dot or underscore to underscore
 * converts uppercase characters in the URL path to lowercases
@@ -96,7 +101,7 @@ end
 ```
 
 ## Resource
-A resource can be any structured data that the authorization policy uses to evaluate decisions. By default, middleware do not include a resource in authorization calls.
+A resource can be any structured data that the authorization policy uses to evaluate decisions. By default, gem do not include a resource in authorization calls.
 
 This behavior can be overwritten by providing a custom function:
 
@@ -114,13 +119,14 @@ end
 # config/initializers/aserto.rb
 require "aserto/rails"
 
-Rails.application.config.middleware.use Aserto::Authorization do |config|
+Aserto.configure do |config|
   config.enabled = true
-  config.policy_id = "my-policy-id"
-  config.tenant_id = "my-tenant-id"
+  config.policy_name = "my-policy-name"
+  config.instance_label = "my-instance"
   config.authorizer_api_key = Rails.application.credentials.aserto[:authorizer_api_key]
   config.policy_root = "peoplefinder"
-  config.service_url = "authorizer.eng.aserto.com:8443"
+  config.service_url = "localhost:8282"
+  config.cert_path = "/path/to/topaz/cert.crt"
   config.decision = "allowed"
   config.logger = Rails.logger
   config.identity_mapping = {
@@ -141,12 +147,15 @@ def show
 end
 ```
 
-Setting this for every action can be tedious, therefore the `aserto_authorize_resource` method is provided to automatically authorize all actions in a RESTful style resource controller.
+Setting this for every action can be tedious, therefore the `aserto_authorize_resource` method is provided to
+automatically authorize all actions in a RESTful style resource controller.
 It will use a before action to load the resource into an instance variable and authorize it for every action.
 
 ```ruby
 class PostsController < ApplicationController
   aserto_authorize_resource
+  # aserto_authorize_resource only: %i[show]
+  # aserto_authorize_resource except: %i[index]
 
   def show
     # getting a single post authorized

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.20.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aserto-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Aserto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aserto
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.20.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.20.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement