passageidentity 0.6.2 → 0.7.0

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: passageidentity
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Passage by 1Password
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 2024-12-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -51,25 +71,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: openssl
+  name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.0.4
 description: Passkey Complete for Ruby - Integrate into your Ruby API or service to
   enable a completely passwordless standalone auth solution with Passage by 1Password.
 email: support@passage.id
@@ -77,68 +97,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/deploy.yml"
-- ".github/workflows/on-pull-request.yml"
-- ".gitignore"
-- CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
-- LICENSE
-- README.md
-- docs/custom/AuthApi.md
-- docs/custom/ClientApi.md
-- docs/custom/UserApi.md
-- docs/generated/AppInfo.md
-- docs/generated/AppResponse.md
-- docs/generated/AppleUserSocialConnection.md
-- docs/generated/AppsApi.md
-- docs/generated/AuthMethods.md
-- docs/generated/CreateMagicLinkRequest.md
-- docs/generated/CreateUserRequest.md
-- docs/generated/ElementCustomization.md
-- docs/generated/FontFamily.md
-- docs/generated/GithubUserSocialConnection.md
-- docs/generated/GoogleUserSocialConnection.md
-- docs/generated/LayoutConfig.md
-- docs/generated/Layouts.md
-- docs/generated/Link.md
-- docs/generated/ListDevicesResponse.md
-- docs/generated/ListPaginatedUsersItem.md
-- docs/generated/ListPaginatedUsersResponse.md
-- docs/generated/MagicLink.md
-- docs/generated/MagicLinkAuthMethod.md
-- docs/generated/MagicLinkChannel.md
-- docs/generated/MagicLinkResponse.md
-- docs/generated/MagicLinkType.md
-- docs/generated/MagicLinksApi.md
-- docs/generated/Model400Error.md
-- docs/generated/Model401Error.md
-- docs/generated/Model403Error.md
-- docs/generated/Model404Error.md
-- docs/generated/Model500Error.md
-- docs/generated/Nonce.md
-- docs/generated/OtpAuthMethod.md
-- docs/generated/PaginatedLinks.md
-- docs/generated/PasskeysAuthMethod.md
-- docs/generated/README.md
-- docs/generated/Technologies.md
-- docs/generated/TokensApi.md
-- docs/generated/TtlDisplayUnit.md
-- docs/generated/UpdateUserRequest.md
-- docs/generated/UserDevicesApi.md
-- docs/generated/UserEventStatus.md
-- docs/generated/UserInfo.md
-- docs/generated/UserMetadataField.md
-- docs/generated/UserMetadataFieldType.md
-- docs/generated/UserRecentEvent.md
-- docs/generated/UserResponse.md
-- docs/generated/UserSocialConnections.md
-- docs/generated/UserStatus.md
-- docs/generated/UsersApi.md
-- docs/generated/WebAuthnDevices.md
-- docs/generated/WebAuthnIcons.md
-- docs/generated/WebAuthnType.md
-- generate.sh
 - lib/models/update_magic_link_auth_method.rb
 - lib/models/update_otp_auth_method.rb
 - lib/models/update_passkeys_auth_method.rb
@@ -181,9 +139,12 @@ files:
 - lib/openapi_client/models/otp_auth_method.rb
 - lib/openapi_client/models/paginated_links.rb
 - lib/openapi_client/models/passkeys_auth_method.rb
+- lib/openapi_client/models/social_connection_type.rb
 - lib/openapi_client/models/technologies.rb
+- lib/openapi_client/models/theme_type.rb
 - lib/openapi_client/models/ttl_display_unit.rb
 - lib/openapi_client/models/update_user_request.rb
+- lib/openapi_client/models/user_event_action.rb
 - lib/openapi_client/models/user_event_status.rb
 - lib/openapi_client/models/user_info.rb
 - lib/openapi_client/models/user_metadata_field.rb
@@ -202,19 +163,12 @@ files:
 - lib/passageidentity/error.rb
 - lib/passageidentity/user_api.rb
 - lib/passageidentity/version.rb
-- openapitools.json
-- passageidentity.gemspec
-- tests/all.rb
-- tests/app_test.rb
-- tests/auth_test.rb
-- tests/errors_test.rb
-- tests/magic_link_test.rb
-- tests/user_api_test.rb
 homepage: http://docs.passage.id/complete
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/passageidentity/passage-ruby
+  changelog_uri: https://github.com/passageidentity/passage-ruby/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -223,14 +177,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Passage Passkey Complete SDK

data/.github/workflows/deploy.yml

@@ -1,30 +0,0 @@
-name: Deploy Ruby Gem
-
-on:
-  push:
-    branches: [main]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.0'
-
-      - name: Publish to RubyGems
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
-        env:
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/on-pull-request.yml

@@ -1,33 +0,0 @@
-name: PR Checks
-
-on:
-  workflow_dispatch:
-  pull_request:
-    branches:
-      - main
-
-env:
-  API_KEY: ${{ secrets.API_KEY }}
-  APP_ID: ${{ secrets.APP_ID }}
-  PSG_JWT: ${{ secrets.PSG_JWT }}
-  TEST_USER_ID: ${{ secrets.TEST_USER_ID }}
-
-jobs:
-  build:
-    name: Test and Lint
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '3.1'
-
-    - name: Run Tests
-      run: |
-        bundle install
-        ruby tests/all.rb
-    - name: Run Linting
-      run: |
-        npm install -g prettier @prettier/plugin-ruby
-        prettier --check '**/*.rb'

data/.gitignore

@@ -1,58 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-.env
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
-Gemfile.lock

data/CHANGELOG.md

@@ -1,57 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## [0.6.2] - 2024-10-22
-
-### Changed
-
-- Update to the new README template, updated license, updated metadata in gemspec file
-
-## [0.6.1] - 2024-09-26
-
-### Changed
-
-- Updated documentation links to point to new documentation
-
-## [0.6.0] - 2024-03-21
-
-### Added
-
-- `GetUserByIdentifier` method has been added
-- `ListPaginatedUsersItem` model has been added
-
-## [0.5.0] - 2024-01-30
-
-### Added
-
-- `AppleUserSocialConnection` model has been added
-
-### Changed
-
-- `UserEventInfo` has been renamed to `UserRecentEvent`
-- Docs have been moved to `/docs`
-- `GithubSocialConnection` has been renamed to `GithubUserSocialConnection`
-- `GoogleSocialConnection` has been renamed to `GoogleUserSocialConnection`
-
-## [0.4.0] - 2024-01-18
-
-### Added
-
-- The `UserInfo` class has a new `'social_connections' =>:'UserSocialConnections'` field for GitHub and Google
-
-## [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/CONTRIBUTING.md

@@ -1,66 +0,0 @@
-# Ruby SDK for Passage
-
-## Testing the gem locally
-
-Install the gem
-
-```
-gem build passageidentity.gemspec -o {$FILE_NAME}.gem
-gem install ./{$FILE_NAME}.gem
-```
-
-Test it out:
-
-```
-irb -Ilib -rpassageidentity
->> passage = Passage::Client.new(app_id: 'YOUR_APP_ID')
->> passage.auth.authenticate("JWT_HERE")
-<passage_user_id>
-```
-
-Run Tests:
-
-```
-# all tests
-ruby tests/all.rb
-# individual test files
-ruby tests/*_test.rb
-```
-
-Run Linter:
-
-```
-npm install -g prettier @prettier/plugin-ruby
-gem install bundler prettier_print syntax_tree syntax_tree-haml syntax_tree-rbs
-prettier --write '**/*.rb'
-```
-
-
-To test in the example app, change the Gemfile to include this path:
-
-```
-gem "passageidentity", path: "../../passage-ruby"
-```
-
-## Publishing
-
-Create an account in rubygems.org then run the following command with your username.
-
-```
-$ curl -u <username> https://rubygems.org/api/v1/api_key.yaml >
-~/.gem/credentials; chmod 0600 ~/.gem/credentials
-
-Enter host password for user '<username>':
-```
-
-```
-gem push passage-0.0.0.gem
-```
-
-You can check for the gem here:
-
-```
-gem list -r passage
-```
-
-```

data/Gemfile

@@ -1,13 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in passageidentity.gemspec
-gemspec
-
-group :development do
-  gem 'rack'
-  gem 'dotenv'
-  gem 'prettier_print'
-  gem 'syntax_tree'
-  gem 'syntax_tree-haml'
-  gem 'syntax_tree-rbs'
-end

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Passage by 1Password
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/README.md

@@ -1,84 +0,0 @@
-![passage-ruby](https://storage.googleapis.com/passage-docs/github-md-assets/passage-ruby.png)
-
-![Gem Version](https://img.shields.io/gem/v/passageidentity)
-![GitHub License](https://img.shields.io/github/license/passageidentity/passage-ruby)
-![Static Badge](https://img.shields.io/badge/Built_by_1Password-grey?logo=1password)
-
-## About
-
-[Passage by 1Password](https://1password.com/product/passage) unlocks the passwordless future with a simpler, more secure passkey authentication experience. Passage handles the complexities of the [WebAuthn API](https://blog.1password.com/what-is-webauthn/), and allows you to implement passkeys with ease.
-
-Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience.
-
-Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution.
-
-Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys.
-
-### In passage-ruby
-
-Use passage-ruby to implement Passkey Complete into your Ruby backend to authenticate requests and manage users.
-
-| Product | Compatible |
-| --- | --- |
-| ![Passkey Flex](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-flex-icon.png) Passkey **Flex** | ✖️ For Passkey Flex, check out the [Passkey Flex APIs](https://docs.passage.id/flex/apis)
-| ![Passkey Complete](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-complete-icon.png) Passkey **Complete** | ✅
-| ![Passkey Ready](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-ready-icon.png) Passkey **Ready** | ✖️ For Passkey Ready, check out [Authentikit](https://www.npmjs.com/package/@passageidentity/authentikit)
-
-<br />
-
-## Getting Started
-
-### Check Prerequisites
-
-<p>
- You'll need a free Passage account and a Passkey Complete app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
- <sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
-</p>
-
-### Install
-
-```shell
-gem install passageidentity
-```
-
-### Import
-
-```ruby
-require 'passageidentity'
-```
-
-### Initialize
-
-```ruby
-PassageClient =
-  Passage::Client.new(
-    app_id: 'YOUR_PASSAGE_APP_ID',
-    api_key: 'YOUR_PASSAGE_API_KEY',
-    auth_strategy: Passage::HEADER_AUTH,
-  )
-```
-
-### Go Passwordless
-
-Find all core functions, user management details, and more implementation guidance on our [Passkey Complete Ruby Documentation](https://docs.passage.id/complete/backend-sdks/ruby) page.
-
-## Support & Feedback
-
-We are here to help! Find additional docs, the best ways to get in touch with our team, and more within our [support resources](https://github.com/passageidentity/.github/blob/main/SUPPORT.md).
-
-<br />
-
----
-
-<p align="center">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-dark.png">
-      <source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
-      <img alt="Passage by 1Password Logo" src="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
-    </picture>
-</p>
-
-<p align="center">
-    <sub>Passage is a product by <a href="https://1password.com/product/passage">1Password</a>, the global leader in access management solutions with nearly 150k business customers.</sub><br />
-    <sub>This project is licensed under the MIT license. See the <a href="LICENSE">LICENSE</a> file for more info.</sub>
-</p>

data/docs/custom/AuthApi.md

@@ -1,141 +0,0 @@
-# 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)
-