authress-sdk 0.1.18.0 → 0.1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780c05e767e2999aed766676c564ac7003c6e0255895ff3fdf5dd69f8eebe1da
-  data.tar.gz: 9573215968e0a8b2f53f7b43cc7557cdfa5a1cc0592acb43e9ca222224b45f33
+  metadata.gz: 7181eae557d3464a2626ffa2f35cab55a291392c7e51cb56aeb094f15127b3f2
+  data.tar.gz: ce4d5eab18ff90687aa34c302408c5de5dad85e97bec8e71f44d8b73c7fb57b9
 SHA512:
-  metadata.gz: 86b42ff1df2d460f38f14d374d7e67ef36e323c65c44c88ecc0d9553b1c0b5fc6bb60baf2ad36e75a90263621f105eff79651a3c46df76ef8ebc654dcc4888a5
-  data.tar.gz: c91ba75c6f49a5c85475fa69e197febd0ae4568c966529fdccbd3e214f4170cc896fd0dfcd4a6665dfb3e7327752d3dbf9e2db1c729b32d123778d81a14d17e5
+  metadata.gz: 9de5a2e1dc97a754abfd180f517b8d17d7151ce84d8a87f009ba1e0c6291ddba53a9fc6b505576a386f48c2c9e6deee22df9e88d9fab4b3ba5f2d49162be5c1a
+  data.tar.gz: 6551410fd9d0c61e2049bb00a0f48fd960acadecdabd5a4a7434d28afbfa8f6e94a62f4d754f742d66cc7c8c1f20d374e5bbae15c2bc63e91b7ccfb5b488f384

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authress-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.18.0
+  version: 0.1.19.0
 platform: ruby
 authors:
 - Rhosys
@@ -71,129 +71,133 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
-description: |-
-  # authress-sdk.rb
-  This is the Authress SDK used to integrate with the authorization as a service provider Authress at https://authress.io.
-
-  [![Gem Version](https://badge.fury.io/rb/authress-sdk.svg)](http://badge.fury.io/rb/authress-sdk)
+description: |+
+  # authress-sdk.rb This is the Authress SDK used to integrate with the
+  authorization as a service provider Authress at https://authress.io.
 
+  [![Gem
+  Version](https://badge.fury.io/rb/authress-sdk.svg)](http://badge.fury.io/rb/a
+  uthress-sdk)
 
   ## Usage
 
-  ```sh
-  gem install authress-sdk
-  ```
+  ```sh gem install authress-sdk ```
 
-  Then required the package:
-  ```rb
-  require 'authress-sdk';
-  ```
+  Then required the package: ```rb require 'authress-sdk'; ```
 
   ## Getting started examples
 
-  ### Authorize using a user token
-  ```rb
-  require 'authress-sdk';
+  ### Authorize using a user token ```rb require 'authress-sdk';
 
-  # create an instance of the API class during service initialization
-  # Replace DOMAIN with the Authress domain for your account
-  AuthressClient.configure do |config|
+  # create an instance of the API class during service initialization # Replace
+  DOMAIN with the Authress domain for your account AuthressClient.configure do
+  |config|
     config.base_url = 'https://DOMAIN.api-REGION.authress.io'
+
   end
 
   # on api route
-  [route('/resources/<resourceId>')]
-  function getResource(resourceId) {
-    # Get the user token and pass it to authress
-    authorizationToken = request.headers.get('authorization');
-    AuthressClient.setToken(authorizationToken);
+  route('/resources/<resourceId>'):
+    function getResource(resourceId) {
+      # Get the user token and pass it to authress
+      authorizationToken = request.headers.get('authorization');
+      AuthressClient.setToken(authorizationToken);
 
-    # Check Authress to authorize the user
-    user_id = 'user_id_example' # String | The user to check permissions on
-    resource_uri = `resources/${resourceId}` # String | The uri path of a resource to validate, must be URL encoded, uri segments are allowed, the resource must be a full path, and permissions are not inherited by sub-resources.
-    permission = 'READ' # String | Permission to check, '*' and scoped permissions can also be checked here.
-    begin
-      #Check to see if a user has permissions to a resource.
-      api_instance = SwaggerClient::UserPermissionsApi.new
-      api_instance.authorize_user(user_id, resource_uri, permission)
-    rescue SwaggerClient::ApiError => e
-      # Will throw except if the user is not authorized to read the resource
-      if (e.status === 404) {
-        return { statusCode: 404 };
-      }
-      puts "Exception when calling UserPermissionsApi->authorize_user: #{e}"
-      throw e;
-    end
+      # Check Authress to authorize the user
+      user_id = 'user_id_example' # String | The user to check permissions on
+      resource_uri = `resources/${resourceId}` # String | The uri path of a resource to validate, must be URL encoded, uri segments are allowed, the resource must be a full path, and permissions are not inherited by sub-resources.
+      permission = 'READ' # String | Permission to check, '*' and scoped permissions can also be checked here.
+      begin
+        #Check to see if a user has permissions to a resource.
+        api_instance = SwaggerClient::UserPermissionsApi.new
+        api_instance.authorize_user(user_id, resource_uri, permission)
+      rescue SwaggerClient::ApiError => e
+        # Will throw except if the user is not authorized to read the resource
+        if (e.status === 404) {
+          return { statusCode: 404 };
+        }
+        puts "Exception when calling UserPermissionsApi->authorize_user: #{e}"
+        throw e;
+      end
 
-    # On success, continue with the route code to load resource and return it
-    return { resource: {}, statusCode: 200 };
-  ```
+      # On success, continue with the route code to load resource and return it
+      return { resource: {}, statusCode: 200 };
 
-  ### Authorize with a service client
-  ```rb
-  require 'authress-sdk';
+    ```
 
-  # create an instance of the API class during service initialization
-  # Replace DOMAIN with the Authress domain for your account
+    ### Authorize with a service client ```rb require 'authress-sdk';
 
-  # Create a service client in the Authress management portal and past the access token here
-  # This will generate a token automatically instead of passing the user token to the api
-  AuthressClient.configure do |config|
-    config.base_url = 'https://DOMAIN.api-REGION.authress.io'
-    accessToken = 'eyJrZXlJ....';
-    config.token_provider = ServiceClientTokenProvider.new(accessToken)
-  end
+    # create an instance of the API class during service initialization #
+    Replace DOMAIN with the Authress domain for your account
+
+    # Create a service client in the Authress management portal and past the
+    access token here # This will generate a token automatically instead of
+    passing the user token to the api AuthressClient.configure do |config|
+      config.base_url = 'https://DOMAIN.api-REGION.authress.io'
+      accessToken = 'eyJrZXlJ....';
+      config.token_provider = ServiceClientTokenProvider.new(accessToken)
 
-  # on api route
-  [route('/resources/<resourceId>')]
-  function getResource(resourceId) {
-    # Check Authress to authorize the user
-    user_id = 'user_id_example' # String | The user to check permissions on
-    resource_uri = `resources/${resourceId}` # String | The uri path of a resource to validate, must be URL encoded, uri segments are allowed, the resource must be a full path, and permissions are not inherited by sub-resources.
-    permission = 'READ' # String | Permission to check, '*' and scoped permissions can also be checked here.
-    begin
-      #Check to see if a user has permissions to a resource.
-      api_instance = SwaggerClient::UserPermissionsApi.new
-      api_instance.authorize_user(user_id, resource_uri, permission)
-    rescue SwaggerClient::ApiError => e
-      # Will throw except if the user is not authorized to read the resource
-      if (e.status === 404) {
-        return { statusCode: 404 };
-      }
-      puts "Exception when calling UserPermissionsApi->authorize_user: #{e}"
-      throw e;
     end
 
-    # On success, continue with the route code to load resource and return it
-    return { resource: {}, statusCode: 200 };
-  ```
+    # on api route
+    route('/resources/<resourceId>'):
+      function getResource(resourceId) {
+        # Check Authress to authorize the user
+        user_id = 'user_id_example' # String | The user to check permissions on
+        resource_uri = `resources/${resourceId}` # String | The uri path of a resource to validate, must be URL encoded, uri segments are allowed, the resource must be a full path, and permissions are not inherited by sub-resources.
+        permission = 'READ' # String | Permission to check, '*' and scoped permissions can also be checked here.
+        begin
+          #Check to see if a user has permissions to a resource.
+          api_instance = SwaggerClient::UserPermissionsApi.new
+          api_instance.authorize_user(user_id, resource_uri, permission)
+        rescue SwaggerClient::ApiError => e
+          # Will throw except if the user is not authorized to read the resource
+          if (e.status === 404) {
+            return { statusCode: 404 };
+          }
+          puts "Exception when calling UserPermissionsApi->authorize_user: #{e}"
+          throw e;
+        end
 
-  ### Creating resources
-  When a user creates a resource in your application, we want to ensure that they get access own that resource.
+        # On success, continue with the route code to load resource and return it
+        return { resource: {}, statusCode: 200 };
 
-  You may receive **User does not have sufficient access to grant permissions to resources** as an error along with the status code **403**. This means that the service client or user jwt does not have access to create the access record. If using a service client, go to the Authress portal and create a one time record which grants the service client `Authress:Owner` to `Resources/` so that it can manage access records for these types of resources.
+      ```
+
+      ### Creating resources When a user creates a resource in your application,
+      we want to ensure that they get access own that resource.
+
+      You may receive **User does not have sufficient access to grant
+      permissions to resources** as an error along with the status code
+      *<b>403</b>*. This means that the service client or user jwt does not have
+      access to create the access record. If using a service client, go to the
+      Authress portal and create a one time record which grants the service
+      client `Authress:Owner` to `Resources/` so that it can manage access
+      records for these types of resources.
+
+      ```rb require 'authress-sdk';
+
+      begin
+        #Create a new access record.
+        new_record = SwaggerClient::Body3.new {
+          name: `Access To New Resource ${NewResourceId}`,
+          users: [{ userId: requestUserId }],
+          statements: [{
+            resources: [{ resourceUri: `Resources/${NewResourceId}` }],
+            # Owner by default gives full control over this new resource, including the ability to grant others access as well.
+            roles: ['Authress:Owner']
+          }]
+        };
+        api_instance = SwaggerClient::AccessRecordsApi.new
+        result = api_instance.create_record(new_record)
+        puts result
+
+      rescue SwaggerClient::ApiError => e
+        puts "Exception when calling AccessRecordsApi->create_record: #{e}"
+
+      end ```
 
-  ```rb
-  require 'authress-sdk';
 
-  begin
-    #Create a new access record.
-    new_record = SwaggerClient::Body3.new {
-      name: `Access To New Resource ${NewResourceId}`,
-      users: [{ userId: requestUserId }],
-      statements: [{
-        resources: [{ resourceUri: `Resources/${NewResourceId}` }],
-        # Owner by default gives full control over this new resource, including the ability to grant others access as well.
-        roles: ['Authress:Owner']
-      }]
-    };
-    api_instance = SwaggerClient::AccessRecordsApi.new
-    result = api_instance.create_record(new_record)
-    puts result
-  rescue SwaggerClient::ApiError => e
-    puts "Exception when calling AccessRecordsApi->create_record: #{e}"
-  end
-  ```
 email:
 - support@authress.io
 executables: []
@@ -311,3 +315,4 @@ specification_version: 4
 summary: The Authress SDK for Ruby provides authorization as a service with fully
   compatible REST apis to integrate with Authress at https://authress.io.
 test_files: []
+...