authress-sdk 0.1.18.0

metadata

@@ -0,0 +1,313 @@
+--- !ruby/object:Gem::Specification
+name: authress-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.18.0
+platform: ruby
+authors:
+- Rhosys
+- Authress
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !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)
+
+
+  ## Usage
+
+  ```sh
+  gem install authress-sdk
+  ```
+
+  Then required the package:
+  ```rb
+  require 'authress-sdk';
+  ```
+
+  ## Getting started examples
+
+  ### 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|
+    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);
+
+    # 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 };
+  ```
+
+  ### 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
+
+  # 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
+
+  # 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 };
+  ```
+
+  ### 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 **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.
+
+  ```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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/swagger_client.rb
+- lib/swagger_client/api/access_records_api.rb
+- lib/swagger_client/api/accounts_api.rb
+- lib/swagger_client/api/metadata_api.rb
+- lib/swagger_client/api/resource_permissions_api.rb
+- lib/swagger_client/api/roles_api.rb
+- lib/swagger_client/api/service_clients_api.rb
+- lib/swagger_client/api/user_permissions_api.rb
+- lib/swagger_client/api_client.rb
+- lib/swagger_client/api_error.rb
+- lib/swagger_client/configuration.rb
+- lib/swagger_client/models/access_record.rb
+- lib/swagger_client/models/access_record_collection.rb
+- lib/swagger_client/models/access_record_collection_records.rb
+- lib/swagger_client/models/account.rb
+- lib/swagger_client/models/account_collection.rb
+- lib/swagger_client/models/account_collection_accounts.rb
+- lib/swagger_client/models/body.rb
+- lib/swagger_client/models/body_1.rb
+- lib/swagger_client/models/body_10.rb
+- lib/swagger_client/models/body_11.rb
+- lib/swagger_client/models/body_2.rb
+- lib/swagger_client/models/body_3.rb
+- lib/swagger_client/models/body_4.rb
+- lib/swagger_client/models/body_5.rb
+- lib/swagger_client/models/body_6.rb
+- lib/swagger_client/models/body_7.rb
+- lib/swagger_client/models/body_8.rb
+- lib/swagger_client/models/body_9.rb
+- lib/swagger_client/models/claim_request.rb
+- lib/swagger_client/models/claim_response.rb
+- lib/swagger_client/models/client.rb
+- lib/swagger_client/models/client_access_key.rb
+- lib/swagger_client/models/client_collection.rb
+- lib/swagger_client/models/client_collection_clients.rb
+- lib/swagger_client/models/identity.rb
+- lib/swagger_client/models/identity_collection.rb
+- lib/swagger_client/models/identity_collection_identities.rb
+- lib/swagger_client/models/identity_request.rb
+- lib/swagger_client/models/inline_response_200.rb
+- lib/swagger_client/models/inline_response_200_1.rb
+- lib/swagger_client/models/inline_response_200_10.rb
+- lib/swagger_client/models/inline_response_200_11.rb
+- lib/swagger_client/models/inline_response_200_12.rb
+- lib/swagger_client/models/inline_response_200_13.rb
+- lib/swagger_client/models/inline_response_200_14.rb
+- lib/swagger_client/models/inline_response_200_15.rb
+- lib/swagger_client/models/inline_response_200_2.rb
+- lib/swagger_client/models/inline_response_200_3.rb
+- lib/swagger_client/models/inline_response_200_4.rb
+- lib/swagger_client/models/inline_response_200_5.rb
+- lib/swagger_client/models/inline_response_200_6.rb
+- lib/swagger_client/models/inline_response_200_7.rb
+- lib/swagger_client/models/inline_response_200_8.rb
+- lib/swagger_client/models/inline_response_200_9.rb
+- lib/swagger_client/models/invite.rb
+- lib/swagger_client/models/link.rb
+- lib/swagger_client/models/metadata_object.rb
+- lib/swagger_client/models/permission_object.rb
+- lib/swagger_client/models/permission_response.rb
+- lib/swagger_client/models/resource_permission.rb
+- lib/swagger_client/models/resource_permission_collection.rb
+- lib/swagger_client/models/resource_permission_collection_links.rb
+- lib/swagger_client/models/resource_permission_collection_links_next.rb
+- lib/swagger_client/models/resource_permission_collection_resources.rb
+- lib/swagger_client/models/resource_users_collection.rb
+- lib/swagger_client/models/role.rb
+- lib/swagger_client/models/statement.rb
+- lib/swagger_client/models/token_request.rb
+- lib/swagger_client/models/user.rb
+- lib/swagger_client/models/user_resources.rb
+- lib/swagger_client/models/user_resources_resources.rb
+- lib/swagger_client/models/user_token.rb
+- lib/swagger_client/models/user_token_links.rb
+- lib/swagger_client/models/user_token_links_self.rb
+- lib/swagger_client/models/v1clients_options.rb
+- lib/swagger_client/models/v1records_account.rb
+- lib/swagger_client/models/v1records_links.rb
+- lib/swagger_client/models/v1records_links_self.rb
+- lib/swagger_client/models/v1records_users.rb
+- lib/swagger_client/models/v1resourcesresource_uri_permissions.rb
+- lib/swagger_client/models/v1roles_permissions.rb
+- lib/swagger_client/models/v1usersuser_idresourcesresource_urimetadata_account.rb
+- lib/swagger_client/models/v1usersuser_idtokens_resources.rb
+- lib/swagger_client/models/v1usersuser_idtokens_statements.rb
+- lib/swagger_client/version.rb
+homepage: https://authress.io
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+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: []