Module: ApiEngineBase

Defined in:

lib/api_engine_base.rb,
lib/api_engine_base/error.rb,
lib/api_engine_base/engine.rb,
lib/api_engine_base/schema.rb,
lib/api_engine_base/version.rb,
lib/api_engine_base/schema/page.rb,
lib/api_engine_base/schema/user.rb,
lib/api_engine_base/spec_helper.rb,
lib/api_engine_base/authorization.rb,
lib/api_engine_base/schema/error/base.rb,
lib/api_engine_base/authorization/role.rb,
lib/api_engine_base/configuration/base.rb,
lib/api_engine_base/schema/admin/users.rb,
app/jobs/api_engine_base/application_job.rb,
lib/api_engine_base/authorization/entity.rb,
lib/api_engine_base/configuration/config.rb,
app/helpers/api_engine_base/schema_helper.rb,
lib/api_engine_base/configuration/jwt/config.rb,
lib/api_engine_base/configuration/otp/config.rb,
app/models/api_engine_base/application_record.rb,
lib/api_engine_base/configuration/user/config.rb,
app/helpers/api_engine_base/application_helper.rb,
app/mailers/api_engine_base/application_mailer.rb,
lib/api_engine_base/configuration/admin/config.rb,
lib/api_engine_base/configuration/email/config.rb,
lib/api_engine_base/configuration/login/config.rb,
app/controllers/api_engine_base/user_controller.rb,
app/controllers/api_engine_base/admin_controller.rb,
lib/api_engine_base/configuration/username/check.rb,
lib/api_engine_base/schema/error/invalid_argument.rb,
app/controllers/api_engine_base/username_controller.rb,
lib/api_engine_base/schema/plain_text/login_request.rb,
lib/api_engine_base/configuration/application/config.rb,
lib/api_engine_base/schema/plain_text/login_response.rb,
app/mailers/api_engine_base/email_verification_mailer.rb,
app/controllers/api_engine_base/application_controller.rb,
app/controllers/concerns/api_engine_base/schematizable.rb,
lib/api_engine_base/configuration/authorization/config.rb,
lib/api_engine_base/schema/plain_text/create_user_request.rb,
app/controllers/api_engine_base/auth/plain_text_controller.rb,
lib/api_engine_base/schema/error/invalid_argument_response.rb,
lib/api_engine_base/schema/plain_text/create_user_response.rb,
lib/api_engine_base/schema/plain_text/email_verify_request.rb,
lib/api_engine_base/schema/plain_text/email_verify_response.rb,
lib/api_engine_base/schema/plain_text/email_verify_send_request.rb,
lib/api_engine_base/schema/plain_text/email_verify_send_response.rb,
lib/api_engine_base/configuration/login/strategy/plain_text/config.rb,
lib/api_engine_base/configuration/login/strategy/plain_text/lockable.rb,
lib/api_engine_base/configuration/login/strategy/plain_text/email_verify.rb

Defined Under Namespace

Modules: ApplicationHelper, ArgumentValidation, Auth, Authorization, Authorize, Configuration, Jwt, Schema, SchemaHelper, Secrets, ServiceLogging, SpecHelper, UserAttributes, Username Classes: AdminController, ApplicationController, ApplicationJob, ApplicationMailer, ApplicationRecord, ConfigureGenerator, EmailVerificationMailer, Engine, Error, Schematizable, ServiceBase, UserController, UsernameController

Constant Summary

VERSION =

"0.1.2"

Class Method Summary

• .app_name ⇒ Object
• .app_name_for_comms ⇒ Object
• .config ⇒ Object
• .config=(configuration) ⇒ Object
• .configure {|config| ... } ⇒ Object
• .default_app_name ⇒ Object

Class Method Details

.app_name ⇒ Object

# File 'lib/api_engine_base.rb', line 22

def self.app_name
  Proc === config.app.app_name ? config.app.app_name.() : config.app.app_name
end

.app_name_for_comms ⇒ Object

# File 'lib/api_engine_base.rb', line 26

def self.app_name_for_comms
  Proc === config.app.communication_name ? config.app.communication_name.() : config.app.communication_name
end

.config ⇒ Object

# File 'lib/api_engine_base.rb', line 8

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

.config=(configuration) ⇒ Object

Raises:

• (ArgumentError)

# File 'lib/api_engine_base.rb', line 16

def self.config=(configuration)
  raise ArgumentError, "Expected Configuration::Config. Given #{configuration.class}" unless Configuration::Config === configuration

  @config = configuration
end

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

Yields:

• (config)

# File 'lib/api_engine_base.rb', line 12

def self.configure
  yield(config)
end

.default_app_name ⇒ Object

# File 'lib/api_engine_base.rb', line 30

def self.default_app_name
  ::Rails.application.class.module_parent_name
end