Module: Booth

Defined in:
lib/booth/configure.rb,
lib/booth/test.rb,
lib/booth/engine.rb,
lib/booth/errors.rb,
lib/booth/logging.rb,
lib/booth/request.rb,
lib/booth/version.rb,
lib/booth/userland.rb,
lib/booth/adminland.rb,
lib/booth/to_struct.rb,
lib/booth/credential.rb,
lib/booth/requests/ip.rb,
lib/booth/syntaxes/ip.rb,
lib/booth/models/audit.rb,
lib/booth/configuration.rb,
lib/booth/models/remote.rb,
lib/booth/requests/sudo.rb,
lib/booth/syntaxes/uuid.rb,
lib/booth/coercers/scope.rb,
lib/booth/models/session.rb,
lib/booth/requests/agent.rb,
lib/booth/syntaxes/email.rb,
lib/booth/syntaxes/scope.rb,
lib/booth/coercers/domain.rb,
lib/booth/concerns/action.rb,
lib/booth/routes/userland.rb,
lib/booth/syntaxes/domain.rb,
lib/booth/coercers/request.rb,
lib/booth/core/geolocation.rb,
lib/booth/core/remotes/get.rb,
lib/booth/requests/session.rb,
lib/booth/requests/storage.rb,
lib/booth/testing/userland.rb,
lib/booth/comparisons/scope.rb,
lib/booth/core/audit/logout.rb,
lib/booth/hooks/after_fetch.rb,
lib/booth/models/credential.rb,
lib/booth/models/onboarding.rb,
lib/booth/models/user_agent.rb,
lib/booth/syntaxes/username.rb,
lib/booth/testing/shortcuts.rb,
lib/booth/comparisons/domain.rb,
lib/booth/concerns/transition.rb,
lib/booth/core/sessions/index.rb,
lib/booth/hooks/before_logout.rb,
lib/booth/syntaxes/secret_key.rb,
lib/booth/userland/logins/new.rb,
lib/booth/core/remotes/respond.rb,
lib/booth/core/sessions/revoke.rb,
lib/booth/models/authenticator.rb,
lib/booth/requests/return_path.rb,
lib/booth/syntaxes/remote_code.rb,
lib/booth/core/onboardings/find.rb,
lib/booth/core/onboardings/step.rb,
lib/booth/core/webauth/provider.rb,
lib/booth/testing/support/visit.rb,
lib/booth/userland/remotes/show.rb,
lib/booth/userland/webauths/new.rb,
lib/booth/core/credentials/index.rb,
lib/booth/userland/logins/create.rb,
lib/booth/userland/sessions/show.rb,
lib/booth/userland/webauths/sudo.rb,
lib/booth/core/credentials/create.rb,
lib/booth/requests/authentication.rb,
lib/booth/requests/storages/login.rb,
lib/booth/userland/logins/destroy.rb,
lib/booth/userland/remotes/update.rb,
lib/booth/userland/sessions/index.rb,
lib/booth/userland/webauths/index.rb,
lib/booth/core/authenticators/step.rb,
lib/booth/testing/support/scenario.rb,
lib/booth/userland/webauths/create.rb,
lib/booth/core/sessions/to_passport.rb,
lib/booth/models/application_record.rb,
lib/booth/requests/storages/webauth.rb,
lib/booth/userland/onboardings/show.rb,
lib/booth/userland/webauths/destroy.rb,
lib/booth/adminland/onboardings/find.rb,
lib/booth/adminland/periodic_cleanup.rb,
lib/booth/core/remotes/set_for_login.rb,
lib/booth/userland/registrations/new.rb,
lib/booth/adminland/onboardings/index.rb,
lib/booth/core/authenticators/confirm.rb,
lib/booth/testing/support/force_login.rb,
lib/booth/userland/onboardings/update.rb,
lib/booth/adminland/credentials/create.rb,
lib/booth/adminland/onboardings/create.rb,
lib/booth/core/webauth/options_for_get.rb,
lib/booth/hooks/serialize_from_session.rb,
lib/booth/hooks/serialize_into_session.rb,
lib/booth/adminland/onboardings/destroy.rb,
lib/booth/core/audit/credential_created.rb,
lib/booth/userland/registrations/create.rb,
lib/booth/userland/webauths/guards/sudo.rb,
lib/booth/core/sessions/create_and_login.rb,
lib/booth/requests/storages/registration.rb,
lib/booth/testing/support/assert_partial.rb,
lib/booth/core/audit/completed_onboarding.rb,
lib/booth/core/cooldowns/distance_of_time.rb,
lib/booth/core/sessions/revoke_all_others.rb,
lib/booth/core/webauth/options_for_create.rb,
lib/booth/testing/incorporation_test_case.rb,
lib/booth/testing/userland/login_remotely.rb,
lib/booth/userland/extract_flash_messages.rb,
lib/booth/core/cooldowns/strategies/global.rb,
lib/booth/core/cooldowns/strategies/result.rb,
lib/booth/testing/support/assert_logged_in.rb,
lib/booth/core/credentials/find_by_username.rb,
lib/booth/testing/support/assert_logged_out.rb,
lib/booth/testing/support/get_session_value.rb,
lib/booth/core/credentials/webauth_challenge.rb,
lib/booth/core/sessions/historical_locations.rb,
lib/booth/testing/support/soft_reset_session.rb,
lib/booth/testing/userland/sessions_revoke_one.rb,
lib/booth/adminland/onboardings/find_unconsumed.rb,
lib/booth/core/cooldowns/strategies/exponential.rb,
lib/booth/core/webauth/registration_verification.rb,
lib/booth/models/remotes/scopes/recently_created.rb,
lib/booth/testing/userland/onboarding_first_time.rb,
lib/booth/userland/sessions/destroy_one_or_other.rb,
lib/booth/core/webauth/authentication_verification.rb,
lib/booth/models/remotes/scopes/recently_responded.rb,
lib/booth/userland/logins/transitions/new/fallible.rb,
lib/generators/booth/migration/migration_generator.rb,
lib/booth/testing/userland/sessions_manage_behavior.rb,
lib/booth/userland/logins/transitions/new/timed_out.rb,
lib/booth/testing/userland/registration_with_passkey.rb,
lib/booth/userland/webauths/transitions/create/reset.rb,
lib/booth/testing/support/virtual_authenticators/load.rb,
lib/booth/testing/userland/sessions_revoke_all_others.rb,
lib/booth/testing/support/shortcuts/create_and_onboard.rb,
lib/booth/testing/support/shortcuts/login_with_passkey.rb,
lib/booth/testing/support/virtual_authenticators/create.rb,
lib/booth/testing/support/virtual_authenticators/enable.rb,
lib/booth/testing/userland/onboarding_to_reset_passkeys.rb,
lib/booth/testing/userland/registration_without_passkey.rb,
lib/booth/testing/support/shortcuts/register_new_passkey.rb,
lib/booth/testing/support/virtual_authenticators/destroy.rb,
lib/booth/testing/support/virtual_authenticators/manager.rb,
lib/booth/userland/logins/transitions/create/skip_remotes.rb,
lib/booth/testing/support/assert_all_partials_were_covered.rb,
lib/booth/userland/sessions/transitions/show/enter_webauth.rb,
lib/booth/userland/logins/transitions/new/already_logged_in.rb,
lib/booth/userland/logins/transitions/create/choose_username.rb,
lib/booth/userland/logins/transitions/new/no_username_chosen.rb,
lib/booth/userland/sessions/transitions/destroy/enter_webauth.rb,
lib/booth/userland/webauths/transitions/create/choose_nickname.rb,
lib/booth/userland/logins/transitions/new/missing_authenticators.rb,
lib/booth/userland/logins/transitions/new/remote_session_available.rb,
lib/booth/userland/logins/transitions/new/mode_username_and_webauth.rb,
lib/booth/userland/webauths/transitions/create/registration_initiation.rb,
lib/booth/userland/webauths/transitions/sudo/authentication_initiation.rb,
lib/booth/userland/webauths/transitions/create/authentication_initiation.rb,
lib/booth/userland/webauths/transitions/create/registration_verification.rb,
lib/booth/userland/webauths/transitions/sudo/authentication_verification.rb,
lib/booth/userland/webauths/transitions/create/authentication_verification.rb,
lib/booth/userland/logins/transitions/create/webauth_authentication_initiation.rb,
lib/booth/userland/logins/transitions/create/webauth_authentication_verification.rb,
lib/booth/userland/sessions/transitions/destroy/webauth_authentication_initiation.rb,
lib/booth/userland/sessions/transitions/destroy/webauth_authentication_verification.rb

Overview

The main module for this Ruby gem.

Defined Under Namespace

Modules: Adminland, Coercers, Comparisons, Concerns, Core, Errors, Generators, Hooks, Logging, Models, Requests, Routes, Syntaxes, Test, Testing, Userland Classes: Configuration, Credential, Engine, Request, ToStruct

Constant Summary collapse

VERSION = 
'0.0.2'

Class Method Summary collapse

Class Method Details

.config ⇒ Booth::Configuration

Lazy-loads and returns the global configuration instance.

Examples:

Booth.config.logger = MyLogger.new

Returns:

See Also:



13
14
15
 
# File 'lib/booth/configure.rb', line 13

def self.config
  @config ||= ::Booth::Configuration.new
end

.configure {|config| ... } ⇒ Object

Yields the configuration instance.

Examples:

Booth.configure do |config|
  config.logger = MyLogger.new
end

Yield Parameters:

See Also:



27
28
29
 
# File 'lib/booth/configure.rb', line 27

def self.configure
  yield config
end