scorm_engine 0.1.0

data/spec/support/scorm_engine_client.rb

@@ -0,0 +1,6 @@
+# A helper to easily instantiate a ScormEngine::Client in a tenant namespaced
+# to "ScormEngineGemTesting" to help avoid conflicts with other testers/users
+# of the server.
+def scorm_engine_client(suffix = "default")
+  ScormEngine::Client.new(tenant: "ScormEngineGemTesting-#{suffix}")
+end

data/spec/support/scorm_engine_configuration.rb

@@ -0,0 +1,7 @@
+# Reset the ScormEngine configuration before every example in case the previous
+# example intentionally changed it (perhaps to test invalid settings).
+RSpec.configure do |config|
+  config.before do
+    ScormEngine.configuration.reset
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,53 @@
+require "base64"
+require "vcr"
+require "set"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/fixtures/vcr"
+  c.hook_into :faraday
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :once }
+  c.filter_sensitive_data("<SCORM_ENGINE_HOST>") { ENV["SCORM_ENGINE_HOST"] }
+  c.filter_sensitive_data("<BASIC_AUTH>") { Base64.urlsafe_encode64("#{ENV["SCORM_ENGINE_USERNAME"]}:#{ENV["SCORM_ENGINE_PASSWORD"]}") }
+end
+
+#
+# Track every cassette used so that we can optionally (only if doing a full spec suite)
+# print out no longer used cassettes in an easy to git/rm format.
+#
+INSERTED_CASSETTES = Set.new
+module CassetteReporter
+  def insert_cassette(name, options = {})
+    INSERTED_CASSETTES << VCR::Cassette.new(name, options).file
+    super
+  end
+end
+VCR.extend(CassetteReporter)
+
+RSpec.configure do |config|
+  config.after(:suite) do
+    if config.instance_variable_get(:@files_or_directories_to_run) == ["spec"]
+      files = Dir["#{VCR.configuration.cassette_library_dir}/**/*.yml"] - INSERTED_CASSETTES.to_a
+      unless files.empty?
+        puts "\nThe following VCR cassettes are no longer in use:\n\n"
+        gem_directory = File.expand_path("#{File.dirname(__FILE__)}/../../")
+        files.uniq.each_with_index do |expanded_path, idx|
+          relative_path = expanded_path.sub(%r{^#{gem_directory}/}, "")
+          backslash = idx == files.size - 1 ? "" : "\\"
+          if idx.zero?
+            puts "  git rm -f #{relative_path} #{backslash}"
+          else
+            puts "            #{relative_path} #{backslash}"
+          end
+        end
+      end
+    end
+  end
+end
+
+# A helper used by specs to potentially sleep while we wait for async SCORM
+# jobs to process before checking their status. This is necessary because
+# otherwise VCR will cache the first status request and never update.
+def recording_vcr?
+  ENV.key?("RECORDING_VCR")
+end

metadata

@@ -0,0 +1,329 @@
+--- !ruby/object:Gem::Specification
+name: scorm_engine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Hallstrom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Ruby Client for Rustici's SCORM Engine 2007.1 API
+email:
+- phallstrom@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Rakefile
+- lib/scorm_engine.rb
+- lib/scorm_engine/api/endpoints.rb
+- lib/scorm_engine/api/endpoints/about.rb
+- lib/scorm_engine/api/endpoints/courses.rb
+- lib/scorm_engine/api/endpoints/courses/configuration.rb
+- lib/scorm_engine/api/endpoints/courses/import.rb
+- lib/scorm_engine/api/endpoints/ping.rb
+- lib/scorm_engine/api/endpoints/registrations.rb
+- lib/scorm_engine/api/endpoints/registrations/configuration.rb
+- lib/scorm_engine/api/endpoints/registrations/launch_history.rb
+- lib/scorm_engine/client.rb
+- lib/scorm_engine/configuration.rb
+- lib/scorm_engine/faraday/connection.rb
+- lib/scorm_engine/faraday/request.rb
+- lib/scorm_engine/models.rb
+- lib/scorm_engine/models/course.rb
+- lib/scorm_engine/models/course_configuration.rb
+- lib/scorm_engine/models/course_import.rb
+- lib/scorm_engine/models/learner.rb
+- lib/scorm_engine/models/registration.rb
+- lib/scorm_engine/models/registration_activity_detail.rb
+- lib/scorm_engine/models/registration_configuration.rb
+- lib/scorm_engine/models/registration_launch_history.rb
+- lib/scorm_engine/models/registration_runtime_interaction.rb
+- lib/scorm_engine/response.rb
+- lib/scorm_engine/utils.rb
+- lib/scorm_engine/version.rb
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about/knows_the_platform.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about/knows_the_version.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about_user_count/accepts_before_option.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about_user_count/accepts_since_option.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about_user_count/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about_user_count/tracks_combined_counts.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about_user_count/tracks_per_tenantcounts.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_delete_course/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_delete_course/works.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_course_detail/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_course_detail/results/sucessfully_creates_the_Course_attributes.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_course_preview/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_course_preview/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_course_preview/results/returns_a_URL_string.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/_course_id_option/fetches_a_single_course_but_perhaps_multiple_versions.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/_course_id_option/returns_404_when_ID_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/_more_option_pagination_/returns_all_the_courses.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/_more_option_pagination_/returns_the_more_key_in_the_raw_response.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/_since_option/fails_when_passed_an_invalid_value.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/_since_option/works.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/results/is_an_enumerator_of_Course_models.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_courses/results/sucessfully_creates_the_Course_attributes.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_get_course_configuration/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_get_course_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_get_course_configuration/results/makes_settings_available_as_key/value_pairs.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_get_course_configuration_setting/fails_when_course_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_get_course_configuration_setting/fails_when_setting_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_get_course_configuration_setting/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_get_course_configuration_setting/results/returns_the_value_as_a_string.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_post_course_configuration/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_post_course_configuration/fails_when_settings_are_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_post_course_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_post_course_configuration/persists_the_settings.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_put_course_configuration_setting/fails_when_course_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_put_course_configuration_setting/fails_when_setting_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_put_course_configuration_setting/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Configuration/_put_course_configuration_setting/results/persists_the_changes.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Import/_get_course_import/successful_imports/works.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Import/_get_course_import/unsuccessful_imports/fails_to_import_given_an_invalid_url.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Import/_post_course_import/successful_imports/works.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses_Import/_post_course_import/unsuccessful_imports/fails_to_import_a_previously_existing_course.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Ping/_get_ping/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Ping/_get_ping/reports_the_api_is_up.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Ping/_get_ping/with_invalid_password/is_unsuccessful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Ping/_get_ping/with_invalid_password/returns_status_403.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_delete_registration/is_failure_when_registration_does_not_exist.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_delete_registration/is_successful_when_registration_exists.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_exists/is_false_when_registration_does_not_exist.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_exists/is_true_when_registration_exists.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_instances/includes_results_we_expect.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_instances/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_instances/returns_an_array_of_registrations.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_launch_link/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_launch_link/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_launch_link/results/returns_a_URL_string.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_progress/detail/does_not_return_activity_details_by_default.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_progress/detail/returns_activity_details_if_requested.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_progress/fails_when_registration_does_not_exist.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registration_progress/returns_a_registration_when_it_exists.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registrations/filtering_by_course_id/excludes_results.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registrations/filtering_by_course_id/includes_results.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registrations/filtering_by_learner_id/excludes_results.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registrations/filtering_by_learner_id/includes_results.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registrations/includes_results_we_expect.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registrations/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_get_registrations/returns_an_array_of_registrations.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_post_registration/fails_if_course_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_post_registration/fails_if_registration_id_already_exists.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations/_post_registration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_get_registration_configuration/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_get_registration_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_get_registration_configuration/results/makes_settings_available_as_key/value_pairs.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_get_registration_configuration_setting/fails_when_registration_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_get_registration_configuration_setting/fails_when_setting_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_get_registration_configuration_setting/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_get_registration_configuration_setting/results/returns_the_value_as_a_string.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_post_registration_configuration/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_post_registration_configuration/fails_when_settings_are_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_post_registration_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_post_registration_configuration/persists_the_settings.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_put_registration_configuration_setting/fails_when_registration_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_put_registration_configuration_setting/fails_when_setting_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_put_registration_configuration_setting/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_put_registration_configuration_setting/results/persists_the_changes.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_LaunchHistory/_get_registration_launch_history/fails_when_registration_does_not_exist.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_LaunchHistory/_get_registration_launch_history/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_LaunchHistory/_get_registration_launch_history/returns_an_array_of_registration_launch_histories.yml
+- spec/fixtures/zip/Non-working SCORM.zip
+- spec/fixtures/zip/RuntimeBasicCalls_SCORM20043rdEdition.zip
+- spec/scorm_engine/api/endpoints/about_spec.rb
+- spec/scorm_engine/api/endpoints/courses/configuration_spec.rb
+- spec/scorm_engine/api/endpoints/courses/import_spec.rb
+- spec/scorm_engine/api/endpoints/courses_spec.rb
+- spec/scorm_engine/api/endpoints/ping_spec.rb
+- spec/scorm_engine/api/endpoints/registrations/configuration_spec.rb
+- spec/scorm_engine/api/endpoints/registrations/launch_history_spec.rb
+- spec/scorm_engine/api/endpoints/registrations_spec.rb
+- spec/scorm_engine/configuration_spec.rb
+- spec/scorm_engine/models/course_configuration_spec.rb
+- spec/scorm_engine/models/course_import_spec.rb
+- spec/scorm_engine/models/course_spec.rb
+- spec/scorm_engine/models/learner_spec.rb
+- spec/scorm_engine/models/registration_activity_detail_spec.rb
+- spec/scorm_engine/models/registration_launch_history_spec.rb
+- spec/scorm_engine/models/registration_runtime_interaction_spec.rb
+- spec/scorm_engine/models/registration_spec.rb
+- spec/scorm_engine/utils_spec.rb
+- spec/scorm_engine/version_spec.rb
+- spec/scorm_engine_spec.rb
+- spec/spec_helper.rb
+- spec/support/scorm_engine.rb
+- spec/support/scorm_engine_client.rb
+- spec/support/scorm_engine_configuration.rb
+- spec/support/vcr.rb
+homepage: https://github.com/phallstrom/scorm_engine
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby Client for Rustici's SCORM Engine 2007.1 API
+test_files: []