passageidentity 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f38ac4af6f724f0c6a1a627dc2b0f03cf6ab7bb444eedccf31f34088913e892
-  data.tar.gz: 671196153c6d5d8e91f9524e5e2766e81b9ba1fb34611949911d1b32852f276e
+  metadata.gz: f5fad890a1b4da5a9bda57cf0441dbfb76e7b5275c6e63b97ea001897f146847
+  data.tar.gz: f5008109d3d726a62312ee8ff85b008ecce5fc993b5f89d963cb44d0f7d21775
 SHA512:
-  metadata.gz: 061e2fe45361d9b498ab76a3945ce88960fc78d1b465b6cc4a87e94ab954ec2e6abd8ad803941a38f62787e5cda9ff464d9b2b709455a846fa398942be728cef
-  data.tar.gz: 92ed644ed4a7eeea9eca3219e8121c2ebd2ff16376603cc0daf15475223093cf36eae4f349297a51a668a3606e275018d6de0f74bd01cf4e78e595a8b5631f57
+  metadata.gz: 1beabd989e6a3357f42326c974cf61a118d8cc076be7ba2df4adccbcd0d90877c1052b03d331b3d20d6defc2d74c285ed38664943810358960dcfe02064431e3
+  data.tar.gz: 60811539a0ae157adcb4f4f4fcbab795bbd3041cbee5c80710a4793a95dae1d0485e9b68f58b24f3a02f1e6ccf8bd6a237d673d03305c65f43031fdac7cfc76e

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.3.0] - 2023-12-06
+
+### Added
+
+- Generate types and api calls with openapi generator.
+- Version constant instead of parsing gemspec.
+
+
+### Deprecate
+
+- `user.signout()` -> `auth.revoke_user_refresh_tokens()`
+- `auth.authenticate_request()` -> `auth.validate_jwt()`
+
+
+### Possible Breaking Changes
+
+- Types are now generated. Previous type names may have changed. [See documentation](https://github.com/passageidentity/passage-ruby/tree/main/docs/generated) for model definitions.

data/README.md

@@ -64,23 +64,6 @@ app_info = PassageClient.get_app()
   
 ```
 
-The information available in the Passage App struct returned by PassageClient.get_app():
-
-```ruby
-    Struct.new :name,
-               :id,
-               :auth_origin,
-               :redirect_url,
-               :login_url,
-               :rsa_public_key,
-               :allowed_identifer,
-               :require_identifier_verification,
-               :session_timeout_length,
-               :user_metadata_schema,
-               :layouts,
-               :auth_fallback_method,
-               :auth_fallback_method_ttl
-```
 
 ## Retrieve User Info
 
@@ -104,24 +87,6 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-The information available in the Passage User struct returned by PassageClient.user.get(user_id:):
-
-```ruby
-    Struct.new :id,
-               :status,
-               :email,
-               :phone,
-               :email_verified,
-               :phone_verified,
-               :created_at,
-               :updated_at,
-               :last_login_at,
-               :login_count,
-               :recent_events,
-               :webauthn,
-               :webauthn_devices,
-               :user_metadata,
-```
 
 ## Activate/Deactivate User
 
@@ -179,18 +144,6 @@ PassageClient =
 devices = PassageClient.user.list_devices(user_id: user_id)
 ```
 
-The information available in the array of Passage Device struct returned by PassageClient.user.list_devices(user_id:):
-
-```ruby
-    Struct.new :id,
-               :cred_id,
-               :friendly_name,
-               :usage_count,
-               :updated_at,
-               :created_at,
-               :last_login_at,
-
-```
 
 ## List User Devices
 
@@ -227,17 +180,21 @@ magic_link =
   )
 ```
 
-The information available in the Passage Magic Link struct returned this method is below:
-
-```ruby
-Struct.new :id,
-           :secret,
-           :activated,
-           :user_id,
-           :app_id,
-           :identifier,
-           :type,
-           :redirect_url,
-           :ttl,
-           :url
-```
+## Available Functions
+
+
+Class | Method | Description
+------------ | ------------- | -------------
+*ClientApi* | [**get_app**](docs/custom/ClientApi.md#get_app) |  Get App
+*ClientApi* | [**create_magic_link**](docs/custom/Passage/ClientApi.md#create_magic_link) | Create Embeddable Magic Link
+*AuthApi* | [**auth.authenticate_request**](docs/custom/AuthApi.md#authenticate_request) | Validates user jwt token
+*AuthApi* | [**auth.validate_jwt**](docs/custom/AuthApi.md#validate_jwt) | Validates user jwt token
+*UserAPI* | [**user.delete_device**](docs/custom/UserApi.md#delete_device) | Delete a device for a user
+*UserAPI* | [**user.list_devices**](docs/custom/UserApi.md#list_devices) | List User Devices
+*UserAPI* | [**user.activate**](docs/custom/UserApi.md#activate) | Activate User
+*UserAPI* | [**user.create**](docs/custom/UserApi.md#create) | Create User
+*UserAPI* | [**user.deactivate**](docs/custom/UserApi.md#deactivate) | Deactivate User
+*UserAPI* | [**user.delete**](docs/custom/UserApi.md#delete) | Delete User
+*UserAPI* | [**user.get**](docs/custom/UserApi.md#get) | Get User
+*UserAPI* | [**user.update**](docs/custom/UserApi.md#update) | Update User
+*UserAPI* | [**user.signout**](docs/custom/UserApi.md#signout) | Signout User

data/docs/custom/AuthApi.md

@@ -0,0 +1,141 @@
+# Passage::AuthApi
+
+All URIs are relative to *https://api.passage.id/v1*
+
+| Method | Description |
+| ------ | ----------- |
+| [**authenticate_request**](AuthApi.md#authenticate_request) |  **Deprecated:** Revokes refresh tokens |
+| [**revoke_user_refresh_tokens**](AuthApi.md#revoke_user_refresh_tokens) | Revokes user tokens |
+| [**validate_jwt**](AuthApi.md#validate_jwt) |  Validates jwt token
+
+
+---
+
+## authenticate_request (deprecated)
+
+> authenticate_request(request)
+
+Validates that request has the correct jwt token
+
+
+### Examples
+
+```ruby
+require 'passageidentity'
+
+class ApplicationController < ActionController::Base
+    PassageClient = Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
+
+  def authorize!
+    begin
+      request.to_hash()
+      @user_id = Passage.auth.authenticate_request(request)
+      session[:psg_user_id] = @user_id
+    rescue Exception => e
+      # unauthorized
+      redirect_to "/unauthorized"
+    end
+  end
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request** | **RequestObject** | request |  |
+
+### Return type
+
+[**UserInfo**](UserInfo.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+
+---
+
+## revoke_user_refresh_tokens()
+
+> revoke_user_refresh_tokens(user_id)
+
+Revokes user tokens
+
+### Examples
+
+```ruby
+require 'passageidentity'
+
+class ApplicationController < ActionController::Base
+    PassageClient = Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
+
+  def authorize!
+    begin
+      revoke = PassageClient.auth.revoke_user_refresh_tokens(USER_ID)
+    rescue Exception => e
+      # handle exception (user is not authorized)
+      # unauthorized
+      redirect_to "/unauthorized"
+    end
+  end
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **string** | user id |  |
+
+### Return type
+
+boolean
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+
+
+---
+
+## validate_jwt
+
+> validate_jwt(token)
+
+Validates jwt token for a user
+
+### Examples
+
+```ruby
+require 'passageidentity'
+
+class ApplicationController < ActionController::Base
+    PassageClient = Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
+
+  def validate_passage_user!
+    begin
+        # tokens are revoked
+        revoke = PassageClient.auth.validate_jwt(token)
+    rescue Exception => e
+        # handle exception (user is not authorized)
+    end
+  end
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | jwt token |  |
+
+### Return type
+
+[**UserInfo**](UserInfo.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+

data/docs/custom/ClientApi.md

@@ -0,0 +1,107 @@
+# Passage::ClientApi
+
+All URIs are relative to *https://api.passage.id/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_app**](ClientApi.md#get_app) | **GET** /apps/{app_id} | Get App |
+| [**create_magic_link**](ClientApi.md#create_magic_link) | **POST** /apps/{app_id}/magic-links | Create Embeddable Magic Link |
+
+
+## get_app
+
+> <AppResponse> get_app()
+
+Get App
+
+Get app information.
+
+### Examples
+
+```ruby
+PassageClient = Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
+
+begin
+  # Get App
+  result = PassageClient.get_app()
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->get_app: #{e}"
+end
+```
+
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+
+### Return type
+
+[**AppResponse**](AppResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+---
+
+
+## create_magic_link
+
+> <MagicLinkResponse> create_magic_link(create_magic_link_request)
+
+Create Embeddable Magic Link
+
+Create magic link for a user.
+
+### Examples
+
+```ruby
+PassageClient = Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
+
+api_instance = PassageClient.create_magic_link()
+
+create_magic_link_request = OpenapiClient::create_magic_link({channel: OpenapiClient::MagicLinkChannel::EMAIL, email: 'email_example', magic_link_path: 'magic_link_path_example', phone: 'phone_example', redirect_url: 'redirect_url_example', _send: false, ttl: 37, user_id: 'user_id_example'}) # CreateMagicLinkRequest | magic link request
+
+begin
+  # Create Embeddable Magic Link
+  result = PassageClient.create_magic_link.create_magic_link(create_magic_link_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling MagicLinksApi->create_magic_link: #{e}"
+end
+```
+
+#### Using the create_magic_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MagicLinkResponse>, Integer, Hash)> create_magic_link_with_http_info(app_id, create_magic_link_request)
+
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_magic_link_request** | [**CreateMagicLinkRequest**](CreateMagicLinkRequest.md) | magic link request |  |
+
+### Return type
+
+[**MagicLinkResponse**](MagicLinkResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+