passageidentity 0.7.1 → 1.0.0

data/lib/passageidentity/client.rb

@@ -1,113 +1,33 @@
 # frozen_string_literal: true
 
-require 'rubygems'
 require_relative 'auth'
-require_relative 'user_api'
-require_relative 'error'
+require_relative 'user'
 require_relative 'version'
-require_relative '../openapi_client'
 
 module Passage
-  COOKIE_STRATEGY = 0
-  HEADER_STRATEGY = 1
-
-  EMAIL_CHANNEL = 'email'
-  PHONE_CHANNEL = 'phone'
-
   # The Passage::Client class provides methods for interacting with Passage
   class Client
     attr_reader :auth, :user
 
-    extend Gem::Deprecate
-
-    def initialize(app_id:, api_key: '', auth_strategy: COOKIE_STRATEGY)
-      @app_id = app_id
-      @api_key = api_key
-
-      # check for valid auth strategy
-      unless [COOKIE_STRATEGY, HEADER_STRATEGY].include? auth_strategy
-        raise PassageError.new(
-          status_code: 400,
-          body: {
-            error: 'Invalid auth strategy',
-            code: 'invalid_argument'
-          }
-        )
+    def initialize(app_id:, api_key:)
+      unless app_id && !app_id.empty?
+        raise ArgumentError,
+              'A Passage App ID is required. Please include (app_id: YOUR_APP_ID, api_key: YOUR_API_KEY).'
       end
-
-      @auth_strategy = auth_strategy
-
-      header_params = { 'Passage-Version' => "passage-ruby #{Passage::VERSION}" }
-      header_params['Authorization'] = "Bearer #{@api_key}" if @api_key != ''
-
-      @req_opts = {}
-      @req_opts[:header_params] = header_params
-      @req_opts[:debug_auth_names] = ['header']
-
-      # initialize auth class
-      @auth = Passage::Auth.new(@app_id, @api_key, @auth_strategy)
-
-      # initialize user class
-      @user = Passage::UserAPI.new(@app_id, @api_key)
-
-      @magic_links_client = OpenapiClient::MagicLinksApi.new
-    end
-
-    # rubocop:disable Naming/AccessorMethodName
-    def get_app
-      client = OpenapiClient::AppsApi.new
-      client.get_app(@app_id).app
-    rescue StandardError => e
-      raise e
-    end
-    # rubocop:enable Naming/AccessorMethodName
-
-    # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    def create_magic_link(
-      user_id: '',
-      email: '',
-      phone: '',
-      channel: '',
-      send: false,
-      magic_link_path: '',
-      redirect_url: '',
-      language: '',
-      ttl: 60,
-      type: 'login'
-    )
-      args = {}
-      args['user_id'] = user_id unless user_id.empty?
-      args['email'] = email unless email.empty?
-      args['phone'] = phone unless phone.empty?
-
-      unless [PHONE_CHANNEL, EMAIL_CHANNEL].include? channel
-        raise PassageError.new(
-          message:
-            'channel: must be either Passage::EMAIL_CHANNEL or Passage::PHONE_CHANNEL'
-        )
+      unless api_key && !api_key.empty?
+        raise ArgumentError,
+              'A Passage API key is required. Please include (app_id: YOUR_APP_ID, api_key: YOUR_API_KEY).'
       end
 
-      args['channel'] = channel unless channel.empty?
-      args['type'] = type
-      args['send'] = send
-
-      args['language'] = language unless language.empty?
-      args['magic_link_path'] = magic_link_path unless magic_link_path.empty?
-      args['redirect_url'] = redirect_url unless redirect_url.empty?
-      args['ttl'] = ttl unless ttl.zero?
+      req_opts = {}
+      req_opts[:header_params] = {
+        'Passage-Version' => "passage-ruby #{Passage::VERSION}",
+        'Authorization' => "Bearer #{api_key}"
+      }
+      req_opts[:debug_auth_names] = ['header']
 
-      begin
-        @magic_links_client.create_magic_link(@app_id, args, @req_opts).magic_link
-      rescue Faraday::Error => e
-        raise PassageError.new(
-          status_code: e.response[:status],
-          body: e.response[:body]
-        )
-      end
+      @auth = Passage::Auth.new(app_id: app_id, req_opts: req_opts)
+      @user = Passage::User.new(app_id: app_id, req_opts: req_opts)
     end
-    # rubocop:enable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
-    deprecate(:create_magic_link, 'Passage::Auth.create_magic_link', 2025, 1)
-    deprecate(:get_app, :none, 2025, 1)
   end
 end

data/lib/passageidentity/user.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+require_relative '../openapi_client'
+
+module Passage
+  # The User class provides methods for interacting with Passage Users
+  class User
+    def initialize(app_id:, req_opts:)
+      @app_id = app_id
+      @req_opts = req_opts
+
+      @user_client = OpenapiClient::UsersApi.new
+      @user_device_client = OpenapiClient::UserDevicesApi.new
+      @tokens_client = OpenapiClient::TokensApi.new
+    end
+
+    def get(user_id:)
+      raise ArgumentError, 'user_id is required.' if blank_str?(user_id)
+
+      begin
+        response = @user_client.get_user(@app_id, user_id, @req_opts)
+        response.user
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    def get_by_identifier(identifier:)
+      raise ArgumentError, 'identifier is required.' if blank_str?(identifier)
+
+      begin
+        req_opts = set_get_by_identifier_query_params(identifier: identifier)
+        response = @user_client.list_paginated_users(@app_id, req_opts)
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+
+      handle_get_by_identifier(users: response.users)
+    end
+
+    def activate(user_id:)
+      raise ArgumentError, 'user_id is required.' if blank_str?(user_id)
+
+      begin
+        response = @user_client.activate_user(@app_id, user_id, @req_opts)
+        response.user
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    def deactivate(user_id:)
+      raise ArgumentError, 'user_id is required.' if blank_str?(user_id)
+
+      begin
+        response = @user_client.deactivate_user(@app_id, user_id, @req_opts)
+        response.user
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    def update(user_id:, options:)
+      raise ArgumentError, 'user_id is required.' if blank_str?(user_id)
+      raise ArgumentError, 'options are required.' if options.empty?
+
+      begin
+        response = @user_client.update_user(@app_id, user_id, options, @req_opts)
+        response.user
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    def create(args:)
+      if blank_str?(args['email']) && blank_str?(args['phone'])
+        raise ArgumentError,
+              'At least one of args.email or args.phone is required.'
+      end
+
+      begin
+        response = @user_client.create_user(@app_id, args, @req_opts)
+        response.user
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    def delete(user_id:)
+      raise ArgumentError, 'user_id is required.' if blank_str?(user_id)
+
+      begin
+        @user_client.delete_user(@app_id, user_id, @req_opts)
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          'failed to delete Passage User',
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    def revoke_device(user_id:, device_id:)
+      raise ArgumentError, 'user_id is required.' if blank_str?(user_id)
+      raise ArgumentError, 'device_id is required.' if blank_str?(device_id)
+
+      begin
+        @user_device_client.delete_user_devices(@app_id, user_id, device_id, @req_opts)
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    def list_devices(user_id:)
+      raise ArgumentError, 'user_id is required.' if blank_str?(user_id)
+
+      begin
+        response = @user_device_client.list_user_devices(@app_id, user_id, @req_opts)
+        response.devices
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    def revoke_refresh_tokens(user_id:)
+      raise ArgumentError, 'user_id is required.' if blank_str?(user_id)
+
+      begin
+        @tokens_client.revoke_user_refresh_tokens(@app_id, user_id, @req_opts)
+      rescue OpenapiClient::ApiError => e
+        raise PassageError.new(
+          status_code: e.code,
+          body: try_parse_json_string(e.response_body)
+        )
+      rescue Faraday::Error => e
+        raise PassageError.new(
+          status_code: e.response[:status],
+          body: e.response[:body]
+        )
+      end
+    end
+
+    private
+
+    def blank_str?(str)
+      blank_pattern = /\A[[:space:]]*\z/
+      str.empty? || blank_pattern.match?(str)
+    end
+
+    def set_get_by_identifier_query_params(identifier:)
+      req_opts = @req_opts.dup
+      req_opts[:limit] = 1
+      req_opts[:identifier] = identifier.downcase
+      req_opts
+    end
+
+    def handle_get_by_identifier(users:)
+      if users.empty?
+        raise PassageError.new(
+          status_code: 404,
+          body: {
+            error: 'User not found.',
+            code: 'user_not_found'
+          }
+        )
+      end
+
+      get(user_id: users.first.id)
+    end
+
+    def try_parse_json_string(string)
+      JSON.parse(string)
+    rescue JSON::ParserError
+      string
+    end
+  end
+end

data/lib/passageidentity/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passageidentity
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Passage by 1Password
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: '7.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,47 +29,67 @@ dependencies:
         version: '7.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '2.12'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '2.12'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.10.1
 - !ruby/object:Gem::Dependency
   name: marcel
   requirement: !ruby/object:Gem::Requirement
@@ -97,11 +117,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- 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
 - lib/openapi_client/api/tokens_api.rb
 - lib/openapi_client/api/user_devices_api.rb
@@ -109,25 +125,18 @@ files:
 - lib/openapi_client/api_client.rb
 - lib/openapi_client/api_error.rb
 - lib/openapi_client/configuration.rb
-- lib/openapi_client/models/app_info.rb
-- lib/openapi_client/models/app_response.rb
 - lib/openapi_client/models/apple_user_social_connection.rb
-- lib/openapi_client/models/auth_methods.rb
 - lib/openapi_client/models/create_magic_link_request.rb
-- lib/openapi_client/models/create_user_request.rb
-- lib/openapi_client/models/element_customization.rb
-- lib/openapi_client/models/font_family.rb
+- lib/openapi_client/models/create_user_args.rb
 - lib/openapi_client/models/github_user_social_connection.rb
 - 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
+- lib/openapi_client/models/magic_link_language.rb
 - lib/openapi_client/models/magic_link_response.rb
 - lib/openapi_client/models/magic_link_type.rb
 - lib/openapi_client/models/model400_error.rb
@@ -136,19 +145,12 @@ files:
 - 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/passage_user.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/update_user_args.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
-- lib/openapi_client/models/user_metadata_field_type.rb
 - lib/openapi_client/models/user_recent_event.rb
 - lib/openapi_client/models/user_response.rb
 - lib/openapi_client/models/user_social_connections.rb
@@ -161,7 +163,7 @@ files:
 - lib/passageidentity/auth.rb
 - lib/passageidentity/client.rb
 - lib/passageidentity/error.rb
-- lib/passageidentity/user_api.rb
+- lib/passageidentity/user.rb
 - lib/passageidentity/version.rb
 homepage: http://docs.passage.id/complete
 licenses:
@@ -177,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.3
+      version: 3.1.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="