rails-xapi 0.1.2

data/db/migrate/20240716144233_create_rails_xapi_results.rb

@@ -0,0 +1,21 @@
+class CreateRailsXapiResults < ActiveRecord::Migration[7.1]
+  def up
+    create_table :rails_xapi_results do |t|
+      t.decimal :score_scaled, precision: 3, scale: 2
+      t.integer :score_raw
+      t.integer :score_min
+      t.integer :score_max
+      t.boolean :success, default: false
+      t.boolean :completion, default: false
+      t.text :response
+      t.string :duration
+      t.bigint :statement_id, null: false
+    end
+
+    add_index :rails_xapi_results, :statement_id
+  end
+
+  def down
+    drop_table :rails_xapi_results
+  end
+end

data/db/migrate/20240716144234_create_rails_xapi_contexts.rb

@@ -0,0 +1,23 @@
+class CreateRailsXapiContexts < ActiveRecord::Migration[7.1]
+  def up
+    create_table :rails_xapi_contexts do |t|
+      t.string :registration, null: true
+      t.bigint :instructor_id, null: true
+      t.bigint :team_id, null: true
+      t.string :revision, null: true
+      t.string :platform, null: true
+      t.string :language, null: true
+      t.bigint :statement_ref, null: true
+      t.bigint :statement_id, null: false
+    end
+
+    add_index :rails_xapi_contexts, :instructor_id
+    add_index :rails_xapi_contexts, :team_id
+    add_index :rails_xapi_contexts, :statement_ref
+    add_index :rails_xapi_contexts, :statement_id
+  end
+
+  def down
+    drop_table :rails_xapi_contexts
+  end
+end

data/db/migrate/20240716144235_create_rails_xapi_context_activities.rb

@@ -0,0 +1,16 @@
+class CreateRailsXapiContextActivities < ActiveRecord::Migration[7.1]
+  def up
+    create_table :rails_xapi_context_activities do |t|
+      t.string :activity_type, null: false
+      t.bigint :context_id, null: false
+      t.string :object_id, null: false
+    end
+
+    add_index :rails_xapi_context_activities, :context_id
+    add_index :rails_xapi_context_activities, :object_id
+  end
+
+  def down
+    drop_table :rails_xapi_context_activities
+  end
+end

data/db/migrate/20240716144236_create_rails_xapi_group_members.rb

@@ -0,0 +1,16 @@
+class CreateRailsXapiGroupMembers < ActiveRecord::Migration[7.1]
+  def up
+    create_table :rails_xapi_group_members do |t|
+      t.bigint :group_id, null: false
+      t.bigint :actor_id, null: false
+      t.datetime :created_at, null: false
+    end
+
+    add_index :rails_xapi_group_members, :group_id
+    add_index :rails_xapi_group_members, :actor_id
+  end
+
+  def down
+    drop_table :rails_xapi_group_members
+  end
+end

data/db/migrate/20250522093846_create_rails_xapi_interaction_activities.rb

@@ -0,0 +1,15 @@
+class CreateRailsXapiInteractionActivities < ActiveRecord::Migration[7.2]
+  def change
+    create_table :rails_xapi_interaction_activities do |t|
+      t.string :interaction_type, null: false
+      t.text :correct_responses_pattern, null: true
+      t.bigint :activity_definition_id, null: false
+    end
+
+    add_index :rails_xapi_interaction_activities, :activity_definition_id
+  end
+
+  def down
+    drop_table :rails_xapi_interaction_activities
+  end
+end

data/db/migrate/20250522122830_create_rails_xapi_interaction_component.rb

@@ -0,0 +1,16 @@
+class CreateRailsXapiInteractionComponent < ActiveRecord::Migration[7.2]
+  def change
+    create_table :rails_xapi_interaction_components do |t|
+      t.string :component_type, null: false
+      t.string :component_id, null: false
+      t.text :description, null: true
+      t.bigint :interaction_activity_id, null: false
+    end
+
+    add_index :rails_xapi_interaction_components, :interaction_activity_id
+  end
+
+  def down
+    drop_table :rails_xapi_interaction_components
+  end
+end

data/lib/rails-xapi/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsXapi
+  class Configuration
+    # mattr_accessor :output_xapi_logs, :colored_xapi_logs
+    attr_accessor :output_xapi_logs, :colored_xapi_logs
+
+    def initialize
+      @output_xapi_logs ||= true
+      @colored_xapi_logs ||= true
+    end
+  end
+end

data/lib/rails-xapi/engine.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RailsXapi
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsXapi
+
+    initializer "local_helper.action_controller" do
+      ActiveSupport.on_load :action_controller do
+        helper RailsXapi::ApplicationHelper
+      end
+    end
+
+    initializer :load_factories, after: "factory_bot.set_factory_paths" do
+      if defined?(FactoryBot) && !Rails.env.production?
+        FactoryBot.definition_file_paths.prepend(
+          File.join(RailsXapi::Engine.root, "spec", "factories")
+        )
+      end
+    end
+
+    config.before_configuration do
+      RailsXapi.configuration ||= RailsXapi::Configuration.new
+    end
+
+    config.i18n.default_locale = :en
+    config.i18n.fallbacks = [:en]
+  end
+end

data/lib/rails-xapi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsXapi
+  VERSION = "0.1.2"
+end

data/lib/rails-xapi.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rails-xapi/version"
+require "rails-xapi/engine"
+require "rails-xapi/configuration"
+
+module RailsXapi
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,62 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it"s just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if defined?(Rails) && Rails.env.development?
+  if Gem::Specification.find_all_by_name("annotate").any?
+    require "annotate"
+
+    task :set_annotation_options do
+      # You can override any of these by setting an environment variable of the
+      # same name.
+      Annotate.set_defaults(
+        "active_admin" => "false",
+        "additional_file_patterns" => [],
+        "routes" => "false",
+        "models" => "true",
+        "position_in_routes" => "after",
+        "position_in_class" => "after",
+        "position_in_test" => "after",
+        "position_in_fixture" => "before",
+        "position_in_factory" => "before",
+        "position_in_serializer" => "after",
+        "show_foreign_keys" => "true",
+        "show_complete_foreign_keys" => "false",
+        "show_indexes" => "true",
+        "simple_indexes" => "false",
+        "model_dir" => "app/models",
+        "root_dir" => "",
+        "include_version" => "false",
+        "require" => "",
+        "exclude_tests" => "false",
+        "exclude_fixtures" => "false",
+        "exclude_factories" => "false",
+        "exclude_serializers" => "false",
+        "exclude_scaffolds" => "true",
+        "exclude_controllers" => "true",
+        "exclude_helpers" => "true",
+        "exclude_sti_subclasses" => "false",
+        "ignore_model_sub_dir" => "false",
+        "ignore_columns" => nil,
+        "ignore_routes" => nil,
+        "ignore_unknown_models" => "false",
+        "hide_limit_column_types" => "integer,bigint,boolean",
+        "hide_default_column_types" => "json,jsonb,hstore",
+        "skip_on_db_migrate" => "false",
+        "format_bare" => "true",
+        "format_rdoc" => "false",
+        "format_yard" => "false",
+        "format_markdown" => "false",
+        "sort" => "false",
+        "force" => "false",
+        "frozen" => "false",
+        "classified_sort" => "true",
+        "trace" => "false",
+        "wrapper_open" => nil,
+        "wrapper_close" => nil,
+        "with_comment" => "true"
+      )
+    end
+
+    Annotate.load_tasks
+  end
+end

data/lib/tasks/rails-xapi_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails-xapi do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rails-xapi
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Hipjea
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails engine for generating xAPI statements.
+email:
+- pierre.duverneix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/rails_xapi/application_controller.rb
+- app/helpers/rails_xapi/application_helper.rb
+- app/jobs/rails_xapi/application_job.rb
+- app/jobs/rails_xapi/create_statement_job.rb
+- app/mailers/rails_xapi/application_mailer.rb
+- app/models/concerns/serializable.rb
+- app/models/rails_xapi/account.rb
+- app/models/rails_xapi/activity_definition.rb
+- app/models/rails_xapi/actor.rb
+- app/models/rails_xapi/application_record.rb
+- app/models/rails_xapi/context.rb
+- app/models/rails_xapi/context_activity.rb
+- app/models/rails_xapi/errors/xapi_error.rb
+- app/models/rails_xapi/extension.rb
+- app/models/rails_xapi/group_member.rb
+- app/models/rails_xapi/interaction_activity.rb
+- app/models/rails_xapi/interaction_component.rb
+- app/models/rails_xapi/object.rb
+- app/models/rails_xapi/result.rb
+- app/models/rails_xapi/statement.rb
+- app/models/rails_xapi/validators/language_map_validator.rb
+- app/models/rails_xapi/verb.rb
+- app/services/application_service.rb
+- app/services/rails_xapi/query.rb
+- app/services/rails_xapi/statement_creator.rb
+- app/views/layouts/rails_xapi/application.html.erb
+- config/locales/rails_xapi.en.yml
+- config/locales/rails_xapi.fr.yml
+- config/routes.rb
+- db/migrate/20240716144226_create_rails_xapi_actors.rb
+- db/migrate/20240716144227_create_rails_xapi_accounts.rb
+- db/migrate/20240716144228_create_rails_xapi_verbs.rb
+- db/migrate/20240716144229_create_rails_xapi_objects.rb
+- db/migrate/20240716144230_create_rails_xapi_activity_definitions.rb
+- db/migrate/20240716144231_create_rails_xapi_extensions.rb
+- db/migrate/20240716144232_create_rails_xapi_statements.rb
+- db/migrate/20240716144233_create_rails_xapi_results.rb
+- db/migrate/20240716144234_create_rails_xapi_contexts.rb
+- db/migrate/20240716144235_create_rails_xapi_context_activities.rb
+- db/migrate/20240716144236_create_rails_xapi_group_members.rb
+- db/migrate/20250522093846_create_rails_xapi_interaction_activities.rb
+- db/migrate/20250522122830_create_rails_xapi_interaction_component.rb
+- lib/rails-xapi.rb
+- lib/rails-xapi/configuration.rb
+- lib/rails-xapi/engine.rb
+- lib/rails-xapi/version.rb
+- lib/tasks/auto_annotate_models.rake
+- lib/tasks/rails-xapi_tasks.rake
+homepage: https://github.com/fondation-unit/rails-xapi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fondation-unit/rails-xapi
+  source_code_uri: https://github.com/fondation-unit/rails-xapi
+  changelog_uri: https://github.com/fondation-unit/rails-xapi/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Rails engine for generating xAPI statements.
+test_files: []