passageidentity 0.5.0 → 0.6.0

data/lib/openapi_client.rb

@@ -29,7 +29,10 @@ require_relative 'openapi_client/models/github_user_social_connection'
 require_relative 'openapi_client/models/google_user_social_connection'
 require_relative 'openapi_client/models/layout_config'
 require_relative 'openapi_client/models/layouts'
+require_relative 'openapi_client/models/link'
 require_relative 'openapi_client/models/list_devices_response'
+require_relative 'openapi_client/models/list_paginated_users_item'
+require_relative 'openapi_client/models/list_paginated_users_response'
 require_relative 'openapi_client/models/magic_link'
 require_relative 'openapi_client/models/magic_link_auth_method'
 require_relative 'openapi_client/models/magic_link_channel'
@@ -37,16 +40,20 @@ require_relative 'openapi_client/models/magic_link_response'
 require_relative 'openapi_client/models/magic_link_type'
 require_relative 'openapi_client/models/model400_error'
 require_relative 'openapi_client/models/model401_error'
+require_relative 'openapi_client/models/model403_error'
 require_relative 'openapi_client/models/model404_error'
 require_relative 'openapi_client/models/model500_error'
+require_relative 'openapi_client/models/nonce'
 require_relative 'openapi_client/models/otp_auth_method'
+require_relative 'openapi_client/models/paginated_links'
 require_relative 'openapi_client/models/passkeys_auth_method'
 require_relative 'openapi_client/models/technologies'
 require_relative 'openapi_client/models/ttl_display_unit'
-require_relative 'openapi_client/models/update_magic_link_auth_method'
-require_relative 'openapi_client/models/update_otp_auth_method'
-require_relative 'openapi_client/models/update_passkeys_auth_method'
+require_relative 'models/update_magic_link_auth_method'
+require_relative 'models/update_otp_auth_method'
+require_relative 'models/update_passkeys_auth_method'
 require_relative 'openapi_client/models/update_user_request'
+require_relative 'openapi_client/models/user_event_status'
 require_relative 'openapi_client/models/user_info'
 require_relative 'openapi_client/models/user_metadata_field'
 require_relative 'openapi_client/models/user_metadata_field_type'

data/lib/passageidentity/user_api.rb

@@ -42,6 +42,40 @@ module Passage
       end
     end
 
+    def get_by_identifier(user_identifier:)
+      identifier_exists?(user_identifier)
+
+      begin
+        @req_opts[:limit] = 1
+        @req_opts[:identifier] = user_identifier.downcase
+        response = @user_client.list_paginated_users(@app_id, @req_opts)
+        users = response.users
+
+        if users.length() == 0
+          raise PassageError.new(
+                  message: "Passage User with identifer \"#{user_identifier}\" does not exist",
+                  status_code: 404,
+                  body: "user_not_found"
+                )
+        end
+        return get(user_id: users.first().id)
+      rescue Faraday::Error => e
+        if e.is_a? Faraday::ResourceNotFound
+          raise PassageError.new(
+                  message: "Passage User with identifer \"#{user_identifier}\" does not exist",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
+        else
+          raise PassageError.new(
+                  message: "failed to get Passage User.",
+                  status_code: e.response[:status],
+                  body: e.response[:body]
+                )
+        end
+      end
+    end
+
     def activate(user_id:)
       user_exists?(user_id)
 
@@ -210,6 +244,12 @@ module Passage
       end
     end
 
+    def identifier_exists?(identifier)
+      if identifier.to_s.empty?
+        raise PassageError.new(message: "must supply a valid identifier")
+      end
+    end
+
     def device_exists?(device_id)
       if device_id.to_s.empty?
         raise PassageError.new(message: "must supply a valid device_id")

data/lib/passageidentity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Passage
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/tests/user_api_test.rb

@@ -37,6 +37,47 @@ class TestUserAPI < Test::Unit::TestCase
     assert_equal $global_test_user.id, user.id
   end
 
+  def test_get_user_by_identifier()
+    user = PassageClient.user.get(user_id: $global_test_user.id)
+    assert_equal $global_test_user.id, user.id
+
+    user_by_identifier = PassageClient.user.get_by_identifier(user_identifier: $global_test_user.email)
+    assert_equal $global_test_user.id, user_by_identifier.id
+
+    assert_equal user, user_by_identifier
+  end
+
+  def test_get_user_by_identifier_upper_case()
+    user = PassageClient.user.get(user_id: $global_test_user.id)
+    assert_equal $global_test_user.id, user.id
+
+    user_by_identifier = PassageClient.user.get_by_identifier(user_identifier: $global_test_user.email.upcase)
+    assert_equal $global_test_user.id, user_by_identifier.id
+
+    assert_equal user, user_by_identifier
+  end
+
+  def test_get_user_by_identifier_phone()
+    $phone = "+15005550007"
+    create_user = PassageClient.user.create(
+      phone: $phone,
+    )
+    user = PassageClient.user.get(user_id: create_user.id)
+    assert_equal create_user.id, user.id
+
+    user_by_identifier = PassageClient.user.get_by_identifier(user_identifier: $phone)
+    assert_equal create_user.id, user_by_identifier.id
+
+    assert_equal user, user_by_identifier
+  end
+
+  def test_invalid_get_user_by_identifier()
+    user = PassageClient.user.get(user_id: $global_test_user.id)
+    assert_equal $global_test_user.id, user.id
+
+    assert_raise (Passage::PassageError) {PassageClient.user.get_by_identifier(user_identifier: "error@passage.id")}
+  end
+
   def test_deactivate_user()
     user = PassageClient.user.deactivate(user_id: $global_test_user.id)
     assert_equal $global_test_user.id, user.id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passageidentity
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Passage Identity
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -101,7 +101,10 @@ files:
 - 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
@@ -110,19 +113,20 @@ files:
 - 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/UpdateMagicLinkAuthMethod.md
-- docs/generated/UpdateOtpAuthMethod.md
-- docs/generated/UpdatePasskeysAuthMethod.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
@@ -135,6 +139,9 @@ files:
 - 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
 - lib/openapi_client.rb
 - lib/openapi_client/api/apps_api.rb
 - lib/openapi_client/api/magic_links_api.rb
@@ -156,7 +163,10 @@ files:
 - lib/openapi_client/models/google_user_social_connection.rb
 - lib/openapi_client/models/layout_config.rb
 - lib/openapi_client/models/layouts.rb
+- lib/openapi_client/models/link.rb
 - lib/openapi_client/models/list_devices_response.rb
+- lib/openapi_client/models/list_paginated_users_item.rb
+- lib/openapi_client/models/list_paginated_users_response.rb
 - lib/openapi_client/models/magic_link.rb
 - lib/openapi_client/models/magic_link_auth_method.rb
 - lib/openapi_client/models/magic_link_channel.rb
@@ -164,16 +174,17 @@ files:
 - lib/openapi_client/models/magic_link_type.rb
 - lib/openapi_client/models/model400_error.rb
 - lib/openapi_client/models/model401_error.rb
+- lib/openapi_client/models/model403_error.rb
 - lib/openapi_client/models/model404_error.rb
 - lib/openapi_client/models/model500_error.rb
+- lib/openapi_client/models/nonce.rb
 - 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/technologies.rb
 - lib/openapi_client/models/ttl_display_unit.rb
-- lib/openapi_client/models/update_magic_link_auth_method.rb
-- lib/openapi_client/models/update_otp_auth_method.rb
-- lib/openapi_client/models/update_passkeys_auth_method.rb
 - lib/openapi_client/models/update_user_request.rb
+- lib/openapi_client/models/user_event_status.rb
 - lib/openapi_client/models/user_info.rb
 - lib/openapi_client/models/user_metadata_field.rb
 - lib/openapi_client/models/user_metadata_field_type.rb

data/docs/generated/UpdateMagicLinkAuthMethod.md

@@ -1,22 +0,0 @@
-# OpenapiClient::UpdateMagicLinkAuthMethod
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** |  | [optional] |
-| **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [optional][default to 300] |
-| **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'openapi_client'
-
-instance = OpenapiClient::UpdateMagicLinkAuthMethod.new(
-  enabled: null,
-  ttl: null,
-  ttl_display_unit: null
-)
-```
-

data/docs/generated/UpdateOtpAuthMethod.md

@@ -1,22 +0,0 @@
-# OpenapiClient::UpdateOtpAuthMethod
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** |  | [optional] |
-| **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [optional][default to 300] |
-| **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'openapi_client'
-
-instance = OpenapiClient::UpdateOtpAuthMethod.new(
-  enabled: null,
-  ttl: null,
-  ttl_display_unit: null
-)
-```
-

data/docs/generated/UpdatePasskeysAuthMethod.md

@@ -1,18 +0,0 @@
-# OpenapiClient::UpdatePasskeysAuthMethod
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** |  | [optional][default to true] |
-
-## Example
-
-```ruby
-require 'openapi_client'
-
-instance = OpenapiClient::UpdatePasskeysAuthMethod.new(
-  enabled: null
-)
-```
-