Module: Hanko

Defined in:
lib/hanko.rb,
lib/hanko/client.rb,
lib/hanko/errors.rb,
lib/hanko/version.rb,
lib/hanko/resource.rb,
lib/hanko/api/admin.rb,
lib/hanko/api/public.rb,
lib/hanko/connection.rb,
lib/hanko/test_helper.rb,
lib/hanko/configuration.rb,
lib/hanko/flow_response.rb,
lib/hanko/api/admin/users.rb,
lib/hanko/api/public/flow.rb,
lib/hanko/api/admin/emails.rb,
lib/hanko/webhook_verifier.rb,
lib/hanko/api/base_resource.rb,
lib/hanko/api/admin/metadata.rb,
lib/hanko/api/admin/sessions.rb,
lib/hanko/api/admin/webhooks.rb,
lib/hanko/api/admin/passwords.rb,
lib/hanko/api/public/sessions.rb,
lib/hanko/api/admin/audit_logs.rb,
lib/hanko/api/public/well_known.rb,
lib/hanko/middleware/raise_error.rb,
lib/hanko/api/admin/webauthn_credentials.rb

Overview

Top-level module for the Hanko Ruby SDK.

Provides authentication and user management via the Hanko API. Use Hanko.configure to set global defaults shared across all Client instances.

Examples:

Configure global defaults

Hanko.configure do |c|
  c.api_url  = "https://example.hanko.io"
  c.api_key  = "your-api-key"
  c.timeout  = 10
end

Create a client using global configuration

client = Hanko::Client.new

Defined Under Namespace

Modules: Api, Middleware, TestHelper Classes: ApiError, AuthenticationError, Client, Configuration, ConfigurationError, Connection, ConnectionError, Error, ExpiredTokenError, FlowResponse, InvalidTokenError, JwksError, NotFoundError, RateLimitError, Resource, WebhookVerifier

Constant Summary collapse

VERSION = 
'0.1.5'

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration

Returns the global configuration instance.

Returns:



35
36
37
 
# File 'lib/hanko.rb', line 35

def configuration
  @configuration ||= Configuration.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Yields the global configuration for modification.

Examples:

Hanko.configure do |c|
  c.api_url = "https://example.hanko.io"
  c.api_key = "your-api-key"
end

Yields:

Yield Parameters:



50
51
52
 
# File 'lib/hanko.rb', line 50

def configure
  yield(configuration)
end

.reset_configuration! ⇒ void

This method returns an undefined value.

Resets the global configuration to defaults.



57
58
59
 
# File 'lib/hanko.rb', line 57

def reset_configuration!
  @configuration = Configuration.new
end