passageidentity 0.6.1 → 0.7.0

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: passageidentity
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
-- Passage Identity
+- Passage by 1Password
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-26 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,94 +71,32 @@ 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
-description: Enables verification of server-side authentication and user management
-  for applications using Passage
+        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
 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: https://rubygems.org/gems/passageidentity
+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,15 +177,15 @@ 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 SDK for biometric authentication
+summary: Passage Passkey Complete SDK
 test_files: []

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,51 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this 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) 2022 Passage
-
-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,218 +0,0 @@
-<img src="https://storage.googleapis.com/passage-docs/passage-logo-gradient.svg" alt="Passage logo" style="width:250px;"/>
-
-[![Gem Version](https://badge.fury.io/rb/passageidentity.svg)](https://badge.fury.io/rb/passageidentity)
-
-# passage-ruby
-
-This Ruby SDK allows for verification of server-side authentication and user management for Ruby applications build with [Passage](https://passage.id). For more information, please visit [Passage Documentation](https://docs.passage.id).
-
-Install this package using [RubyGems](https://rubygems.org/gems/passageidentity).
-
-```
-gem install passageidentity
-```
-
-## Instantiating the Passage Class
-
-Initialize the Passage Client as follows:
-
-```ruby
-PassageClient =
-  Passage::Client.new(
-    app_id: 'YOUR APP ID',
-    api_key: 'YOUR APIKEY',
-    auth_strategy: Passage::HEADER_AUTH,
-  )
-```
-
-Passage has three arguments that can be used for initialization: `app_id`, `api_key`, and `auth_strategy`.
-
-- `app_id` is the Passage App ID that specifies which app should be authorized. It has no default value and must to be set upon initialization.
-- `api_key` is an API key for the Passage app, which can be generated in the 'App Settings' section of the [Passage Console](https://console.passage.id). It is an optional parameter and not required for authenticating requests. It is required to get or update user information.
-- `auth_strategy` defines where the Passage SDK should look for the authentication token. It is set by default to `Passage::COOKIE_AUTH`, but can be changed to `Passage::HEADER_AUTH`.
-
-## Authenticating a Request
-
-To authenticate an HTTP request in a Rails application, you can use the Passage library in a middleware function. You need to provide Passage with your App ID in order to verify the JWTs.
-
-```ruby
-require 'passageidentity'
-
-class ApplicationController < ActionController::Base
-  PassageClient = Passage::Client.new(app_id: PASSAGE_APP_ID)
-  def authorize!
-    begin
-      user_id = PassageClient.auth.authenticate_request(request)
-      # user is authorized
-    rescue Exception => e
-      # handle exception (user is not authorized)
-    end
-  end
-end
-```
-
-## Retrieve App Info
-
-To retrieve information about an app , you should use the `get_app` method.
-
-```ruby
-require 'passageidentity'
-
-PassageClient =
-  Passage::Client.new(app_id: PASSAGE_APP_ID)
-app_info = PassageClient.get_app()
-
-```
-
-## Retrieve User Info
-
-To retrieve information about a user, you should use the `get` method. You will need to use a Passage API key, which can be created in the Passage Console under your Application Settings. This API key grants your web server access to the Passage management APIs to get and update information about users. This API key must be protected and stored in an appropriate secure storage location. It should never be hard-coded in the repository.
-
-```ruby
-require 'passageidentity'
-
-class ApplicationController < ActionController::Base
-  PassageClient =
-    Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
-  def authorize!
-    begin
-      user_id = PassageClient.auth.authenticate_request(request)
-      user = PassageClient.user.get(user_id: @user_id)
-      # user is authorized
-    rescue Exception => e
-      # handle exception (user is not authorized)
-    end
-  end
-end
-```
-
-## Retrieve User Info By Identifier
-
-To retrieve information about a user, you can also use the `get_by_identifier` method. You will need to use a Passage API key, which can be created in the Passage Console under your Application Settings. This API key grants your web server access to the Passage management APIs to get and update information about users. This API key must be protected and stored in an appropriate secure storage location. It should never be hard-coded in the repository.
-
-```ruby
-require 'passageidentity'
-
-class ApplicationController < ActionController::Base
-  PassageClient =
-    Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
-  def authorize!
-    begin
-      user_id = PassageClient.auth.authenticate_request(request)
-      user = PassageClient.user.get_by_identifier(identifier: @identifier)
-      # user is authorized
-    rescue Exception => e
-      # handle exception (user is not authorized)
-    end
-  end
-end
-```
-
-## Activate/Deactivate User
-
-You can activate or deactivate a user using the Passage SDK. These actions require an API Key and deactivating a user will prevent them from logging into your application
-with Passage.
-
-```ruby
-require 'passageidentity'
-
-PassageClient =
-  Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
-
-user = PassageClient.user.deactivate(user_id: user_id)
-user = PassageClient.user.activate(user_id: user_id)
-```
-
-## Create User
-
-You can create users using their email address or phone number. Note that their phone number must be in E164 format (example shown below).
-
-```ruby
-require 'passageidentity'
-
-PassageClient =
-  Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
-
-user = PassageClient.user.create(email: 'exampleEmail@domain.com')
-user = PassageClient.user.create(phone: '+15005550007')
-```
-
-## Delete User
-
-You can delete a user using the Passage SDK.
-
-```ruby
-require 'passageidentity'
-
-PassageClient =
-  Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
-
-success = PassageClient.user.delete(user_id: user_id)
-puts 'passage user was successfully deleted' if success
-```
-
-## List User Devices
-
-You can list the devices associated with a particular Passage User.
-
-```ruby
-require 'passageidentity'
-
-PassageClient =
-  Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
-
-devices = PassageClient.user.list_devices(user_id: user_id)
-```
-
-## List User Devices
-
-You can list the devices associated with a particular Passage User.
-
-```ruby
-require 'passageidentity'
-
-PassageClient = Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
-
-success = PassageClient.user.delete_device(user_id: user_id, device_id)
-if success
-    puts "passage user device was successfully deleted"
-end
-```
-
-## Create an Embeddable Magic Link
-
-To create a magic link, you should use the `create_magic_link` method. You can check out our guide on embeddable magic links in our [docs](https://docs.passage.id/complete/magic-links).
-
-```ruby
-require 'passageidentity'
-
-PassageClient =
-  Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
-
-magic_link = PassageClient.create_magic_link(user_id: user_id)
-magic_link =
-  PassageClient.create_magic_link(
-    email: 'example@domain.com',
-    send: true,
-    channel: Passage::EMAIL_CHANNEL,
-    ttl: 120,
-  )
-```
-
-## 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                 |