Module: ActiveLrs

Defined in:
lib/active_lrs.rb,
lib/active_lrs/xapi.rb,
lib/active_lrs/error.rb,
lib/active_lrs/client.rb,
lib/active_lrs/railtie.rb,
lib/active_lrs/version.rb,
lib/active_lrs/statement.rb,
lib/active_lrs/xapi/verb.rb,
lib/active_lrs/xapi/agent.rb,
lib/active_lrs/xapi/group.rb,
lib/active_lrs/xapi/score.rb,
lib/active_lrs/xapi/result.rb,
lib/active_lrs/xapi/context.rb,
lib/active_lrs/configuration.rb,
lib/active_lrs/xapi/activity.rb,
lib/active_lrs/xapi/statement.rb,
lib/active_lrs/xapi/attachment.rb,
lib/active_lrs/xapi/agent_account.rb,
lib/active_lrs/xapi/statement_ref.rb,
lib/active_lrs/xapi/sub_statement.rb,
lib/active_lrs/xapi/statement_base.rb,
lib/active_lrs/xapi/context_activities.rb,
lib/active_lrs/xapi/activity_definition.rb,
lib/active_lrs/xapi/localization_helper.rb,
lib/active_lrs/xapi/interaction_component.rb,
lib/generators/active_lrs/install/install_generator.rb

Overview

Top-level namespace for ActiveLrs, a Ruby client for xAPI/LRS interactions.

This module provides configuration, autoloads core xAPI models, and includes helper methods to access LRS instances, statements, and client functionality.

Defined Under Namespace

Modules: Xapi Classes: Client, Configuration, ConfigurationError, Error, HttpError, InstallGenerator, ParseError, Railtie, Statement, StatementGenerator

Constant Summary collapse

VERSION =

Current version of the ActiveLrs gem.

Returns:

  • (String) —

    Gem version

"0.1.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ ActiveLrs::Configuration

Access the global ActiveLrs configuration.

Returns:



25
26
27
 
# File 'lib/active_lrs.rb', line 25

def configuration
  @configuration ||= Configuration.new
end

.configure {|config| ... } ⇒ ActiveLrs::Configuration

Configure ActiveLrs using a block.

Examples:

Configure the default locale and remote LRS instances

ActiveLrs.configure do |config|
  config.default_locale = "en-US"
  config.remote_lrs_instances = [{ "url" => "https://lrs.example.com", "username" => "user", "password" => "pass" }]
end

Yield Parameters:

Returns:



39
40
41
42
43
 
# File 'lib/active_lrs.rb', line 39

def configure
  config = configuration
  yield(config) if block_given?
  config
end

.finalize_configuration! ⇒ void

This method returns an undefined value.

Freeze the configuration after Rails initialization.

Typically called by ActiveLrs::Railtie to prevent further changes.



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

def finalize_configuration!
  configuration.freeze
end