scorm_engine 0.7.3 → 0.9.0

data/spec/scorm_engine/api/endpoints/courses_spec.rb

@@ -25,7 +25,6 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses do
           course = courses.results.detect { |c| c.id == "testing-golf-explained" }
           expect(course.version).to be >= 0
           expect(course.title).to eq "Golf Explained - Run-time Basic Calls"
-          expect(course.registration_count).to eq 0
           expect(course.updated).to be_a Time
           expect(course.description).to eq nil
         end
@@ -42,7 +41,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses do
         response = subject.get_courses(course_id: "invalid-bogus")
         expect(response.success?).to eq false
         expect(response.status).to eq 404
-        expect(response.message).to match(/External Package ID 'invalid-bogus'/)
+        expect(response.message).to match(/'invalid-bogus'/)
       end
     end
 
@@ -76,7 +75,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses do
       end
 
       it "returns the :more key in the raw response" do
-        expect(subject.get_courses.raw_response.body["more"]).to match(%r{https?://.*&more=.+})
+        expect(subject.get_courses.raw_response.body["more"]).to match(%r{(https?://)?.*&more=.+})
       end
 
       it "returns all the courses" do
@@ -106,7 +105,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses do
       response = subject.delete_course(course_id: "nonexistent-course")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Package ID 'nonexistent-course'/)
+      expect(response.message).to match(/'nonexistent-course'/)
     end
   end
 
@@ -136,7 +135,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses do
       response = subject.get_course_preview(course_id: "nonexistent-course")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Package ID 'nonexistent-course'/)
+      expect(response.message).to match(/'nonexistent-course'/)
       expect(response.result).to eq nil
     end
   end
@@ -151,6 +150,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses do
     describe "results" do
       it "returns a URL string" do
         url = response.result
+        # expect(url).to match(%r{/ScormEngineInterface/defaultui/launch.jsp\?jwt=.*})
         expect(url).to match(%r{/defaultui/launch.jsp\?.*testing-golf-explained.*RedirectOnExitUrl=https%3A%2F%2Fexample.com})
       end
     end
@@ -159,7 +159,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses do
       response = subject.get_course_preview(course_id: "nonexistent-course")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Package ID 'nonexistent-course'/)
+      expect(response.message).to match(/'nonexistent-course'/)
       expect(response.result).to eq nil
     end
   end

data/spec/scorm_engine/api/endpoints/destinations_spec.rb

@@ -48,7 +48,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Destinations do
           expect(destinations.success?).to eq false
           expect(destinations.status).to eq 400
           expect(destinations.results.to_a).to eq []
-          expect(destinations.message).to match(/'invalid' is either not a timestamp or seems to be not formatted according to ISO 8601/)
+          expect(destinations.message).to match(/'invalid'/)
         end
       end
     end
@@ -63,7 +63,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Destinations do
       end
 
       it "returns the :more key in the raw response" do
-        expect(subject.get_destinations.raw_response.body["more"]).to match(%r{https?://.*&more=.+})
+        expect(subject.get_destinations.raw_response.body["more"]).to match(%r{(https?://)?.*&more=.+})
       end
 
       it "returns all the destinations" do

data/spec/scorm_engine/api/endpoints/dispatches_spec.rb

@@ -85,7 +85,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Dispatches do
       end
 
       it "returns the :more key in the raw response" do
-        expect(subject.get_dispatches.raw_response.body["more"]).to match(%r{https?://.*&more=.+})
+        expect(subject.get_dispatches.raw_response.body["more"]).to match(%r{(https?://)?.*&more=.+})
       end
 
       it "returns all the dispatches" do

data/spec/scorm_engine/api/endpoints/registrations/configuration_spec.rb

@@ -40,7 +40,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations::Configuration do
       response = subject.get_registration_configuration(registration_id: "nonexistent-registration", settings: {})
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Registration ID 'nonexistent-registration'/)
+      expect(response.message).to match(/Registration ID 'nonexistent-registration'/)
       expect(response.result).to eq nil
     end
   end
@@ -79,7 +79,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations::Configuration do
       response = subject.post_registration_configuration(registration_id: "nonexistent-registration", settings: {})
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Registration ID 'nonexistent-registration'/)
+      expect(response.message).to match(/Registration ID 'nonexistent-registration'/)
       expect(response.result).to eq nil
     end
 
@@ -87,7 +87,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations::Configuration do
       response = subject.post_registration_configuration(registration_id: registration_options[:registration_id], settings: { "NonExistentSettingTotesBogus" => "YES" })
       expect(response.success?).to eq false
       expect(response.status).to eq 400
-      expect(response.message).to match(/No configuration setting found with id.*NonExistentSettingTotesBogus/)
+      expect(response.message).to match(/NonExistentSettingTotesBogus/)
     end
   end
 
@@ -111,7 +111,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations::Configuration do
       response = subject.get_registration_configuration_setting(registration_id: "nonexistent-registration", setting_id: "PlayerStatusRollupModeThresholdScore")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Registration ID 'nonexistent-registration'/)
+      expect(response.message).to match(/Registration ID 'nonexistent-registration'/)
       expect(response.result).to eq nil
     end
 
@@ -144,7 +144,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations::Configuration do
       response = subject.put_registration_configuration_setting(registration_id: "nonexistent-registration", setting_id: "PlayerStatusRollupModeThresholdScore", value: "42")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Registration ID 'nonexistent-registration'/)
+      expect(response.message).to match(/Registration ID 'nonexistent-registration'/)
       expect(response.result).to eq nil
     end
 

data/spec/scorm_engine/api/endpoints/registrations_spec.rb

@@ -22,7 +22,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations do
     against_real_scorm_engine do
       ensure_course_exists(client: subject, course_id: registration_options[:course_id])
       ensure_registration_exists(registration_options.merge(client: subject))
-      ensure_course_exists(client: subject, course_id: registration_options[:course_id] + "-no-registrations")
+      ensure_course_exists(client: subject, course_id: "#{registration_options[:course_id]}-no-registrations")
     end
   end
 
@@ -50,7 +50,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations do
       end
 
       it "excludes results" do
-        registrations = subject.get_registrations(course_id: registration_options[:course_id] + "-no-registrations")
+        registrations = subject.get_registrations(course_id: "#{registration_options[:course_id]}-no-registrations")
         reg = registrations.result.detect { |r| r.id == registration_options[:registration_id] }
         expect(reg).to be nil
       end
@@ -183,7 +183,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations do
       aggregate_failures do
         expect(response.success?).to eq false
         expect(response.status).to eq 400
-        expect(response.message).to match(/External Package ID 'invalid-bogus'/)
+        expect(response.message).to match(/'invalid-bogus'/)
       end
     end
 
@@ -215,7 +215,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Registrations do
       response = subject.get_registration_launch_link(registration_id: "nonexistent-registration")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Registration ID 'nonexistent-registration'/)
+      expect(response.message).to match(/'nonexistent-registration'/)
       expect(response.result).to eq nil
     end
   end

data/spec/scorm_engine/api/endpoints/tenants/configuration_spec.rb

@@ -70,7 +70,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Tenants::Configuration do
       response = subject.post_tenant_configuration(settings: { "NonExistentSettingTotesBogus" => "YES" })
       expect(response.success?).to eq false
       expect(response.status).to eq 400
-      expect(response.message).to match(/No configuration setting found with id.*NonExistentSettingTotesBogus/)
+      expect(response.message).to match(/NonExistentSettingTotesBogus/)
     end
   end
 

data/spec/scorm_engine/faraday/connection_spec.rb

@@ -8,14 +8,32 @@ RSpec.describe ScormEngine::Faraday::Connection do
   end
 
   describe "#base_uri" do
-    let(:uri) { scorm_engine_client.base_uri }
+    {
+      1 => "https://scorm.engine/ScormEngineInterface/api/v1/",
+      2 => "https://scorm.engine/ScormEngineInterface/api/v2/",
+    }.each do |version, expected_url|
+      context "with version #{version}" do
+        let(:uri) { scorm_engine_client.base_uri(version: version) }
 
-    it "returns a URI::HTTPS instance" do
-      expect(uri).to be_a(URI::HTTPS)
+        it "returns a URI::HTTPS instance" do
+          expect(uri).to be_a(URI::HTTPS)
+        end
+
+        it "is correct given the configuration" do
+          expect(uri.to_s).to eq expected_url
+        end
+      end
     end
+  end
+
+  describe "#connection" do
+    describe "version" do
+      it "passes on to #base_uri" do
+        client = ScormEngine::Client.new(tenant: "test")
 
-    it "is correct given the configuration" do
-      expect(uri.to_s).to eq "https://scorm.engine/ScormEngineInterface/api/v1/"
+        expect(client).to receive(:base_uri).with(version: 2).and_call_original
+        client.send(:connection, version: 2)
+      end
     end
   end
 end

data/spec/scorm_engine/models/base_spec.rb

@@ -1,14 +1,16 @@
-RSpec.describe ScormEngine::Models::Base do
-  module ScormEngine
-    module Models
-      class Test < Base
-        def initialize(options = {})
-          @options = options
-        end
+module ScormEngine
+  module Models
+    class Test < Base
+      # rubocop:disable Lint/MissingSuper
+      def initialize(options = {})
+        @options = options
       end
+      # rubocop:enable Lint/MissingSuper
     end
   end
+end
 
+RSpec.describe ScormEngine::Models::Base do
   describe "#to_hash" do
     it "returns a hash of the options" do
       options = { i: 1, s: "str", a: [1, 2, 3] }

data/spec/spec_helper.rb

@@ -4,7 +4,10 @@ require "pry"
 require "scorm_engine"
 
 # Ensure we're picking up only the test scorm settings
-Dotenv.load(".env.test")
+Dotenv.load(".env.test.local",
+            ".env.test",
+            ".env.local",
+            ".env")
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
@@ -42,6 +45,6 @@ RSpec.configure do |config|
 end
 
 # Require every spec support file
-Dir[File.join(File.dirname(__FILE__), "support", "**/*.rb")].each do |file|
+Dir[File.join(File.dirname(__FILE__), "support", "**/*.rb")].sort.each do |file|
   require file
 end

data/spec/support/scorm_engine.rb

@@ -7,13 +7,11 @@ module ScormEngineHelpers
   # importing a course and play it back other tests that expect the actual
   # record to exist in SCORM will fail.
   #
-  def against_real_scorm_engine
+  def against_real_scorm_engine(&block)
     return unless scorm_engine_is_available?
 
     cassette = VCR.eject_cassette
-    VCR.turned_off do
-      yield
-    end
+    VCR.turned_off(&block)
     VCR.insert_cassette(cassette.name, cassette.instance_variable_get(:@options))
   end
 

metadata

@@ -1,57 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: scorm_engine
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Philip Hallstrom
-autorequire: 
+- Mel Green
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.12'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.12'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +85,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +127,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -164,9 +177,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Ruby Client for Rustici's SCORM Engine 2017.1 API
+description: Ruby Client for Rustici's SCORM Engine 2017.1 & 20.1 API
 email:
 - phallstrom@instructure.com
+- mgreen@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -176,6 +190,7 @@ files:
 - lib/scorm_engine.rb
 - lib/scorm_engine/api/endpoints.rb
 - lib/scorm_engine/api/endpoints/about.rb
+- lib/scorm_engine/api/endpoints/configuration.rb
 - lib/scorm_engine/api/endpoints/courses.rb
 - lib/scorm_engine/api/endpoints/courses/configuration.rb
 - lib/scorm_engine/api/endpoints/courses/import.rb
@@ -217,6 +232,15 @@ files:
 - 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_Configuration/_delete_app_configuration/fails_when_settings_are_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_delete_app_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_get_app_configuration/includeMetadata/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_get_app_configuration/includeMetadata/returns_metadata_in_raw_response_when_included_in_options.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_get_app_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_get_app_configuration/returns_settings_and_values.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_post_app_configuration/fails_when_settings_are_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_post_app_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_post_app_configuration/persists_the_settings.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/fails_when_id_is_invalid.yml
@@ -252,7 +276,6 @@ files:
 - 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/unsuccessful_imports/fails_to_import_a_previously_existing_course.yml
-- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_delete_destination/raises_ArgumentError_when_destination_id_is_missing.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_delete_destination/returns_success_even_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_delete_destination/works.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_get_destination/fails_when_id_is_invalid.yml
@@ -289,7 +312,6 @@ files:
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/fails_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/is_successful.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/results/sucessfully_creates_the_dispatch_attributes.yml
-- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/when_dispatch_has_registrations/knows_it_s_registration_count.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/fails_given_an_invalid_id.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/fails_given_an_invalid_type.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/works.yml
@@ -360,6 +382,7 @@ files:
 - 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/configuration_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
@@ -397,8 +420,9 @@ files:
 homepage: https://github.com/instructure-bridge/scorm_engine
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  documentation_uri: https://instructure-bridge.github.io/scorm_engine/
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -406,16 +430,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
-summary: Ruby Client for Rustici's SCORM Engine 2017.1 API
+summary: Ruby Client for Rustici's SCORM Engine API
 test_files: []