learnosity-sdk 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "learnosity/sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/lrn-sdk-rails/.gitignore

@@ -0,0 +1,21 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history

data/examples/lrn-sdk-rails/Gemfile

@@ -0,0 +1,57 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.0.2'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use Puma as the app server
+gem 'puma', '~> 3.0'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.2'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+gem 'turbolinks', '~> 5'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 3.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platform: :mri
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '~> 3.0.5'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+# The :path allows us to use the local code, you'll likely not need that in a
+# normal project
+gem 'learnosity-sdk', :path => '../..'

data/examples/lrn-sdk-rails/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/examples/lrn-sdk-rails/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/examples/lrn-sdk-rails/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/examples/lrn-sdk-rails/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/examples/lrn-sdk-rails/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/examples/lrn-sdk-rails/app/assets/javascripts/index.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/examples/lrn-sdk-rails/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/examples/lrn-sdk-rails/app/assets/stylesheets/index.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the Index controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/lrn-sdk-rails/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/examples/lrn-sdk-rails/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/examples/lrn-sdk-rails/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/examples/lrn-sdk-rails/app/controllers/index_controller.rb

@@ -0,0 +1,105 @@
+require 'learnosity/sdk/request/init'
+require 'securerandom'
+
+class IndexController < ApplicationController
+  @@security_packet = {
+    'consumer_key'   => 'yis0TYCu7U9V4o7M',
+    'domain'         => 'localhost'
+  }
+  # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
+  @@consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+  @@items_request = {
+    "activity_id" => "itemsassessdemo",
+    "assess_inline" => true,
+    "config" => {
+      "administration" => {
+	"options" => {"show_exit" => true, "show_extend" => true, "show_save" => true},
+	"pwd" => "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
+      },
+      "configuration" => {
+	"fontsize" => "normal",
+	"idle_timeout" => {"countdown_time" => 60, "interval" => 300},
+	"lazyload" => false,
+	"ondiscard_redirect_url" => "itemsapi_assess.php",
+	"onsave_redirect_url" => "itemsapi_assess.php",
+	"onsubmit_redirect_url" => "itemsapi_assess.php",
+	"stylesheet" => "",
+	"submit_criteria" => {"type" => "attempted"}
+      },
+      "ignore_question_attributes" => [""],
+      "labelBundle" => {
+	"answerMasking" => "Answer Eliminator",
+	"colorScheme" => "Colour Scheme",
+	"item" => "Question",
+	"paletteInstructions" => "Instructions...colour"
+      },
+      "navigation" => {
+	"auto_save" => {"saveIntervalDuration" => 500, "ui" => false},
+	"item_count" => {"question_count_option" => false},
+	"scroll_to_test" => false,
+	"scroll_to_top" => false,
+	"scrolling_indicator" => false,
+	"show_accessibility" => {
+	  "show_colourscheme" => true,
+	  "show_fontsize" => true,
+	  "show_zoom" => true
+	},
+	"show_acknowledgements" => true,
+	"show_answermasking" => true,
+	"show_calculator" => false,
+	"show_configuration" => false,
+	"show_fullscreencontrol" => true,
+	"show_intro" => true,
+	"show_itemcount" => true,
+	"show_next" => true,
+	"show_outro" => true,
+	"show_prev" => true,
+	"show_progress" => true,
+	"show_save" => false,
+	"show_submit" => true,
+	"show_title" => true,
+	"skip_submit_confirmation" => false,
+	"toc" => true,
+	"transition" => "fade",
+	"transition_speed" => 400,
+	"warning_on_change" => false
+      },
+      "subtitle" => "Walter White",
+      "time" => {
+	"limit_type" => "soft",
+	"max_time" => 1500,
+	"show_pause" => true,
+	"show_time" => true,
+	"warning_time" => 120
+      },
+      "title" => "Demo activity - showcasing question types and assess options",
+      "ui_style" => "main"
+    },
+    "items" => [
+      "Demo3",
+      "Demo4",
+      "accessibility_demo_6",
+      "Demo6",
+      "Demo7",
+      "Demo8",
+      "Demo9",
+      "Demo10",
+      "audioplayer-demo-1"
+    ],
+    "name" => "Items API demo - assess activity",
+    "rendering_type" => "assess",
+    "session_id" => SecureRandom.uuid,
+    "state" => "initial",
+    "type" => "submit_practice",
+    "user_id" => "demo_student"
+  }
+
+  def index
+    @init = Learnosity::Sdk::Request::Init.new(
+      'items',
+      @@security_packet,
+      @@consumer_secret,
+      @@items_request
+    )
+  end
+end

data/examples/lrn-sdk-rails/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/examples/lrn-sdk-rails/app/helpers/index_helper.rb

@@ -0,0 +1,2 @@
+module IndexHelper
+end

data/examples/lrn-sdk-rails/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/examples/lrn-sdk-rails/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/examples/lrn-sdk-rails/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/examples/lrn-sdk-rails/app/views/index/index.html.erb

@@ -0,0 +1,24 @@
+<h1>Index#index</h1>
+
+<div id="learnosity_assess"></div>
+
+<script src="//items.learnosity.com"></script>
+<script>
+  var eventOptions = {
+    readyListener: init
+  },
+    itemsApp = LearnosityItems.init(<%= raw @init.generate %>);
+
+  function init () {
+    var assessApp = itemsApp.assessApp();
+
+
+    assessApp.on('item:load', function () {
+      console.log('Active item:', getActiveItem(this.getItems()));
+    });
+
+    assessApp.on('test:submit:success', function () {
+      toggleModalClass();
+    });
+  }
+</script>

data/examples/lrn-sdk-rails/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>LrnSdkRails</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/examples/lrn-sdk-rails/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/examples/lrn-sdk-rails/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/examples/lrn-sdk-rails/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/examples/lrn-sdk-rails/bin/rails

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('../spring', __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/examples/lrn-sdk-rails/bin/rake

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('../spring', __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run