scorm_cloud 0.0.3

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/apikey.rb
+.rspec
+
+

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rspec'
+gem 'cucumber'
+

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new('spec')
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--tags ~@apibug"
+end
+
+namespace :cucumber do
+	Cucumber::Rake::Task.new('apibugs') do |t|
+  	t.cucumber_opts = "--tags @apibug"
+	end
+	Cucumber::Rake::Task.new('wip') do |t|
+  	t.cucumber_opts = "--tags @wip"
+	end
+end
+
+task :test do
+	[:spec, :cucumber].each { |t| Rake::Task[t].execute }
+end
+
+task :default => :test

data/bin/scorm_cloud

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'scorm_cloud'
+require 'scorm_cloud/CLI'
+ScormCloud::CLI.start
+

data/features/api_bugs.feature

@@ -0,0 +1,12 @@
+@apibug
+Feature: API Bugs and Questions
+
+	Scenario: Deleting a non-existant package should return an error
+	in this case it seems to return deleted=true even when the file
+	does not exist
+
+		When I delete a non-existant package
+		Then I should get an error
+
+
+# Preview documentation doesn't list redirect URL as a parameter

data/features/course_service.feature

@@ -0,0 +1,19 @@
+Feature: Course Service Interface
+
+	Scenario: A user can import a previously uploaded course
+		When I import a course
+		Then there should be 1 course in the list
+		And the course should be in the course list
+		And the course should exist
+		And I can get a preview URL for the course
+		And I can get the manifest for the course
+		And I can get the attributes for the course
+
+		When I delete the course
+		Then there should be 0 courses in the list
+		Then the course should not be in the course list
+
+	Scenario: A user can update course attributes
+		When I import a course
+		And I update course attributes
+		Then the course attributes should be updated

data/features/debug_service.feature

@@ -0,0 +1,12 @@
+Feature: Debug Service Interface
+
+	Scenario: Debug Services Function
+
+		When I ping the server
+		Then the response should be "pong"
+
+		When I authping the server
+		Then the response should be "pong"
+
+		When I get the current time
+		Then the resonse should be the current time

data/features/registration_service.feature

@@ -0,0 +1,21 @@
+Feature: Registration Service
+
+	Background: Setup a course
+		Given a registered course
+
+	Scenario: Register a learner
+
+		When I register a learner
+		Then the learner should be in the registration list
+		And I can get the registration results
+
+		When I launch the course
+		Then I will get a valid url
+
+		When I reset the registration
+		Then the learner should be in the registration list
+		And I can get the registration results
+
+		When I delete the registration
+		Then the learner should not be in the registration list
+

data/features/step_definitions/scorm_cloud_steps.rb

@@ -0,0 +1,184 @@
+##
+## Generic
+##
+Then /^I will get a valid url$/ do
+	@last_url.should match(/http\:\/\/.+/)
+end
+
+
+##
+## Debug Service
+##
+
+When /^I ping the server$/ do
+	@last_response = @c.debug.ping
+end
+
+When /^I authping the server$/ do
+	@last_response = @c.debug.auth_ping
+end
+
+When /^I get the current time$/ do
+	@last_response = @c.debug.get_time
+end
+
+Then /^the response should be "([^"]*)"$/ do |arg1| #"
+  @last_response.should eq(arg1)
+end
+
+Then /^the resonse should be the current time$/ do
+	@last_response.should match(/\d+/)
+end
+
+##
+## Upload Service
+##
+
+When /^I upload a package$/ do
+	token = @c.upload.get_upload_token
+	token.should_not be_nil
+	path = File.join(File.dirname(__FILE__), '..', '..', 'spec', 'small_scorm_package.zip')
+	@last_upload_path = @c.upload.upload_file(token, path)
+	@last_uploaded_dir, @last_uploaded_file = @last_upload_path.split('/')
+	@last_uploaded_file.should include('.zip')
+end
+
+Then /^the package files should be available$/ do
+	list = @c.upload.list_files.map { |f| f[:file] }
+	list.should include(@last_uploaded_file)
+end
+
+Then /^the package files should not be available$/ do
+	list = @c.upload.list_files.map { |f| f[:file] }
+	list.should_not include(@last_uploaded_file)
+end
+
+When /^I delete the package$/ do
+	@c.upload.delete_files(@last_uploaded_file)
+end
+
+When /^I delete a non\-existant package$/ do
+	@last_error = nil
+	begin
+		@c.upload.delete_files("thiscoursedoesnotexist")
+	rescue => e
+		puts e.inspect
+		@last_error = e
+	end
+end
+
+Then /^I should get an error$/ do
+  @last_error.should_not be_nil
+end
+
+
+
+##
+## Course Service
+##
+
+When /^I import a course$/ do
+	@last_uploaded_file.should_not be_nil
+	@last_course_id = "small_scorm_course_#{rand(1000)}"
+	hash = @c.course.import_course(@last_course_id, @last_uploaded_path)
+	hash.should_not be_nil
+	hash[:title].should_not be_nil
+end
+
+Given /^a registered course$/ do
+	When "I import a course"
+end
+
+Then /^the course should be in the course list$/ do
+	@c.course.get_course_list.find { |c| c.id == @last_course_id}.should_not be_nil
+end
+
+Then /^there should be (\d+) courses? in the list$/ do |count|
+	@c.course.get_course_list.size.should eq(count.to_i)
+end
+
+When /^I delete the course$/ do
+	@c.course.delete_course(@last_course_id).should eq(true)
+end
+
+Then /^the course should not be in the course list$/ do
+	@c.course.get_course_list.find { |c| c.id == @last_course_id}.should be_nil
+end
+
+Then /^I can get a preview URL for the course$/ do
+	@c.course.preview(@last_course_id, "http://www.example.com").should match(/http:\/\/.+/)
+end
+
+Then /^the course will have a properties url$/ do
+	@c.course.properties(@last_course_id).should match(/http:\/\/.+/)
+end
+
+Then /^the course should exist$/ do
+  @c.course.exists(@last_course_id).should be_true
+end
+
+Then /^I can get the manifest for the course$/ do
+  xml = @c.course.get_manifest(@last_course_id)
+  doc = REXML::Document.new(xml)
+  doc.elements["//manifest"].should_not be_nil
+end
+
+Then /^I can get the attributes for the course$/ do
+	h = @c.course.get_attributes(@last_course_id)
+	h.should be_kind_of(Hash)
+	h[:showProgressBar].should eq("false")
+	h[:showCourseStructure].should eq("false")
+end
+
+When /^I update course attributes$/ do
+	updated = @c.course.update_attributes(@last_course_id, 
+		{:desiredHeight => "700", :commCommitFrequency => "59999" })
+	updated[:desiredHeight].should eq("700")
+	updated[:commCommitFrequency].should eq("59999")
+end
+
+Then /^the course attributes should be updated$/ do
+	h = @c.course.get_attributes(@last_course_id)
+	h.should be_kind_of(Hash)
+	h[:desiredHeight].should eq("700")
+	h[:commCommitFrequency].should eq("59999")
+end
+
+
+##
+## Registration
+##
+
+When /^I register a learner$/ do
+	@last_reg_id = "small_scorm_course_#{rand(1000)}"
+	r = @c.registration.create_registration(@last_course_id, @last_reg_id, 
+			"fname", "lname", "lid", :email => "lid@example.com")
+	r.should be_true
+end
+
+Then /^the learner should be in the registration list$/ do
+	list = @c.registration.get_registration_list
+	list.find { |r| r.id == @last_reg_id }.should_not be_nil
+end
+
+Then /^the learner should not be in the registration list$/ do
+	list = @c.registration.get_registration_list
+	list.find { |r| r.id == @last_reg_id }.should be_nil
+end
+
+When /^I delete the registration$/ do
+	@c.registration.delete_registration(@last_reg_id).should be_true
+end
+
+When /^I reset the registration$/ do
+  @c.registration.reset_registration(@last_reg_id).should be_true
+end
+
+When /^I launch the course$/ do
+  @last_url = @c.registration.launch(@last_reg_id, "http://www.example.com/")
+end
+
+Then /^I can get the registration results$/ do
+  @reg_results = @c.registration.get_registration_result(@last_reg_id, "full")
+  @reg_results.should include('<rsp stat="ok"><registrationreport')
+end

data/features/support/env.rb

@@ -0,0 +1,71 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require File.join(File.dirname(__FILE__), '/../../spec/apikey.rb')
+require 'scorm_cloud'
+
+require 'rspec/expectations'
+
+
+##
+## Cleanup before testing
+##
+Before do
+
+	# Grab a connection
+	unless @c
+		@c = ScormCloud::ScormCloud.new($scorm_cloud_appid,$scorm_cloud_secret)
+	end
+
+	# Cleanup all courses
+	@c.course.get_course_list.each do |course|
+		@c.course.delete_course(course.id)
+	end
+	@c.course.get_course_list.count.should eq(0)
+
+	unless @last_uploaded_file
+
+		# Cleanup all zip packages
+		@c.upload.list_files.each do |file|
+			@c.upload.delete_files(file[:file])
+		end
+		raise "Cannot delete files" unless @c.upload.list_files.length == 0
+
+		# Upload one we can use for testing
+		token = @c.upload.get_upload_token
+		path = File.join(File.dirname(__FILE__), '..', '..', 'spec', 'small_scorm_package.zip')
+		@last_uploaded_path = @c.upload.upload_file(token, path)
+		@last_uploaded_dir, @last_uploaded_file = @last_uploaded_path.split('/')
+		@last_uploaded_file.should include('.zip')
+
+		sleep(5)
+
+	end
+
+	# was a course created?
+	@c.course.get_course_list.count.should eq(0)
+	@c.upload.list_files.count.should eq(1)
+
+	@last_course_id = nil
+	@last_error = nil
+	@last_response = nil
+
+end
+
+
+After do
+
+	# Cleanup all courses
+	@c.course.get_course_list.each do |course|
+		@c.course.delete_course(course.id)
+	end
+
+end
+

data/features/upload_service.feature

@@ -0,0 +1,9 @@
+Feature: Upload Service Interface
+
+	Scenario: Upload a course
+
+		When I upload a package
+		Then the package files should be available
+
+		When I delete the package
+		Then the package files should not be available

data/lib/scorm_cloud.rb

@@ -0,0 +1,36 @@
+require 'rexml/document'
+require 'digest/md5'
+require 'net/http'
+require 'net/http/post/multipart'
+require 'uri'
+require 'scorm_cloud/base'
+
+require 'scorm_cloud/base_object'
+require 'scorm_cloud/course'
+require 'scorm_cloud/registration'
+
+require 'scorm_cloud/base_service'
+require 'scorm_cloud/debug_service'
+require 'scorm_cloud/upload_service'
+require 'scorm_cloud/course_service'
+require 'scorm_cloud/registration_service'
+require 'scorm_cloud/tagging_service'
+require 'scorm_cloud/reporting_service'
+require 'scorm_cloud/dispatch_service'
+require 'scorm_cloud/export_service'
+
+# Rails 3 Integration
+require 'scorm_cloud/railtie' if defined?(Rails::Railtie)
+
+module ScormCloud
+	class ScormCloud < Base
+		add_service :debug => DebugService
+		add_service :upload => UploadService
+		add_service :course => CourseService
+		add_service :registration => RegistrationService
+		add_service :tagging => TaggingService
+		add_service :reporting => ReportingService
+		add_service :dispatch => DispatchService
+		add_service :export => ExportService
+	end
+end

data/lib/scorm_cloud/base.rb

@@ -0,0 +1,110 @@
+module ScormCloud
+	class Base
+
+		attr_reader :appid
+
+		def initialize(appid, secret)
+			@appid = appid
+			@secret = secret
+		end
+
+		def call(method, params = {})
+			url = prepare_url(method, params)
+			execute_call_xml(url)
+		end
+
+		def call_raw(method, params = {})
+			url = prepare_url(method, params)
+			execute_call_plain(url)
+		end			
+
+		def call_url(url)
+			execute_call_plain(url)
+		end
+
+		def post(method, path, params = {})
+			url = URI.parse(prepare_url(method, params))
+			body = nil
+			File.open(path) do |f|
+  				req = Net::HTTP::Post::Multipart.new "#{url.path}?#{url.query}",
+    				"file" => UploadIO.new(f, "application/zip", "scorm.zip")
+  				res = Net::HTTP.start(url.host, url.port) do |http|
+    				http.request(req)
+  				end
+  				body = res.body
+			end
+			REXML::Document.new(body)
+		end
+
+		def launch_url(method, params = {})
+			prepare_url(method, params)
+		end
+
+
+	private
+
+		# Get the URL for the call
+		def prepare_url(method, params = {})
+			timestamp = Time.now.utc.strftime('%Y%m%d%H%M%S')
+			params[:method] = method
+			params[:appid] = @appid
+			params[:ts] = timestamp
+			html_params = params.map { |k,v| "#{k.to_s}=#{v}" }.join("&")
+
+			raw = @secret + params.keys.
+					sort{ |a,b| a.to_s.downcase <=> b.to_s.downcase }.
+					map{ |k| "#{k.to_s}#{params[k]}" }.
+					join
+
+			sig = Digest::MD5.hexdigest(raw)
+			"http://cloud.scorm.com/api?#{html_params}&sig=#{sig}"
+		end
+
+
+		# Get plain response body and parse the XML doc
+		def execute_call_xml(url)
+			doc = REXML::Document.new(execute_call_plain(url))
+			raise create_error(doc, url) unless doc.elements["rsp"].attributes["stat"] == "ok"
+			doc
+		end
+
+		# Execute the call - returns response body or redirect url
+		def execute_call_plain(url)
+			res = Net::HTTP.get_response(URI.parse(url))
+			case res
+			when Net::HTTPRedirection
+				# Return the new URL
+				res['location']
+			when Net::HTTPSuccess
+				res.body
+			else
+				raise "HTTP Error connecting to scorm cloud: #{res.inspect}"
+			end
+		end
+
+	
+		# Create an exception with code & message
+		def create_error(doc, url)
+			err = doc.elements["rsp"].elements["err"]
+			code = err.attributes["code"]
+			msg = err.attributes["msg"]
+			"Error In Scorm Cloud: Error=#{code} Message=#{msg} URL=#{url}"
+		end
+
+
+		# Add services
+		def self.add_service(hash)
+			hash.each do |name, klass|
+				define_method(name) do
+					service = instance_variable_get("@#{name.to_s}") 
+					unless service
+						service = instance_variable_set("@#{name.to_s}", klass.new(self))
+					end
+					service
+				end
+			end
+		end
+
+
+	end
+end