lti2 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2b8f62bd07c6bbec6c19d4f056168731dabad1b
-  data.tar.gz: a32c3c21c909f1df452c6b004dd954a285e797b4
+  metadata.gz: bb9b1cb9478fafe356ddd56f682e39e9ccb0fb40
+  data.tar.gz: 089955ed0fad9c04e5ca52c43091962568b679b7
 SHA512:
-  metadata.gz: 41847909bd2bd35c4311dde85c80fe9f884b8177c9282356d0a4fc88f6f52ac6384d8b1673253772854a7de832256040a5d7b720918d40aceb5ac3537267320e
-  data.tar.gz: ff6cb38ecd446ac1ce84c95507181bcc0c57a4ac269596a9134ec7db6dc076711fd99f600a729d537597ebc3d2f2468024365f2da265fc3330b226aa5bf2ab12
+  metadata.gz: 070e5d2d36507e3461aaae053a4ef698d0ae01ed5c8ffe28f4b5c20e04194da3c3a396a739a118e9a8f86d67c58f1a65a9d1c31073dc4397602232aa101cba2c
+  data.tar.gz: 89e35ca4f8969b6014dad1ebd22901fc2bfdbd8fbda2e1a2592c7c3e2ba9a90db6ce38bbb2b61d56e55d910aa22872024f87cf786d91398ac2f29e16449b2516

data/lib/lti2/version.rb

@@ -1,3 +1,3 @@
 module Lti2
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lti2_tp/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in lti2_tp.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/lti2_tp/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    lti2_tp (0.0.2)
+      mysql2 (~> 0.3.13)
+      rails (~> 4.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.5)
+      actionpack (= 4.1.5)
+      actionview (= 4.1.5)
+      mail (~> 2.5.4)
+    actionpack (4.1.5)
+      actionview (= 4.1.5)
+      activesupport (= 4.1.5)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activerecord (4.1.5)
+      activemodel (= 4.1.5)
+      activesupport (= 4.1.5)
+      arel (~> 5.0.0)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (5.4.1)
+    multi_json (1.10.1)
+    mysql2 (0.3.16)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.5)
+      actionmailer (= 4.1.5)
+      actionpack (= 4.1.5)
+      actionview (= 4.1.5)
+      activemodel (= 4.1.5)
+      activerecord (= 4.1.5)
+      activesupport (= 4.1.5)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.5)
+      sprockets-rails (~> 2.0)
+    railties (4.1.5)
+      actionpack (= 4.1.5)
+      activesupport (= 4.1.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    sprockets (2.12.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  lti2_tp!
+  sqlite3

data/lti2_tp/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lti2_tp/README.md

@@ -0,0 +1,77 @@
+Lti2_Tp -- Tool Provider
+========================
+
+Lti2_Tp is a Rails gem (implemented here as a mountable Rails engine) that implements the Tool Provider of Lti2.  It
+can be added to a Rails application by adding the following to the application.
+
+1. Mount the Rails engine within the application's routes.rb file:
+
+```ruby
+MyToolApp::Application.routes.draw do
+
+  mount Lti2Tp::Engine, at: '/lti2_tp'
+  ...
+  <rest of routes.rb>
+```
+
+2. Mixin Lti2_Tp migrations with the application's own migrations:
+
+```
+rake lti2_tc:install:migrations
+```
+
+3. Implement a application-specific LtiRegistrationsController class in the application (not in Lti2_Tp).
+
+The LtiRegistrationsController is needed to implement the specific user interface, models or other behavior to register
+a new LTI2 ToolConsumer.  It must implement the following paths:
+
+a. Register action
+
+The register action gives this controller the ingredients needed to do tool-specific validation, customization and
+creation of the ToolProxy.
+
+POST /lti_register_wip?action=register
+
+request content-type: application/json
+```javascript
+{
+    "service_owner_name": <string>,
+    "lti_version": <string>,
+    "tool_consumer_profile", <text>,
+    "tool_profile", <text>,
+    "registration_return_url", <url>
+}
+```
+
+Use the tool_consumer_profile and tool_profile to generate a tool_proxy (or to reject it).  When this action is
+complete do one of the following:
+
+On success: redirect_to <registration_return_url>, action: 'accept_tool_proxy', id: <a_lti_register_wip_id>
+
+On failure: redirect_to <registration_return_url>, action: 'reject_registration', status: <integer>,
+                                    message: <string>
+
+
+b. Get ToolProxy
+
+Gets the currently computed tool_proxy (or empty if not computed).
+
+GET /lti_register_wip/:id
+
+response content-type: application/json
+
+<tool_proxy>
+
+
+c. Update secret
+
+Do whatever is necessary to update the shared secret.  This is typically used at the last phase of registration.
+
+PUT /lti_register_wip/:id/secret
+
+request content-type: application/json
+
+```javascript
+{"secret": <string}
+```
+

data/lti2_tp/README.rdoc

@@ -0,0 +1,3 @@
+= Lti2Tp
+
+This project rocks and uses MIT-LICENSE.

data/lti2_tp/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Lti2Tp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path( '../test/dummy/Rakefile', __FILE__ )
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lti2_tp/app/assets/javascripts/lti2_tp/application.js

@@ -0,0 +1,13 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/lti2_tp/app/assets/stylesheets/lti2_tp/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/lti2_tp/app/controllers/lti2_tp/application_controller.rb

@@ -0,0 +1,4 @@
+module Lti2Tp
+  class ApplicationController < ActionController::Base
+  end
+end

data/lti2_tp/app/controllers/lti2_tp/registrations_controller.rb

@@ -0,0 +1,200 @@
+
+module Lti2Tp
+  class RegistrationsController < InheritedResources::Base
+    protect_from_forgery :except => :create
+
+    include Lti2Commons
+    include MessageSupport
+    include Signer
+
+    def create
+      # this signals initial POST from TC
+      tool = params[:tool]
+      if tool.present?
+        tools = Tool.where( :id => tool )
+        if tools.present?
+          @tool = tools.first
+        else
+          tools = Tool.where( :tool_name => tool )
+          if tools.present?
+            @tool = tools.first
+          end
+        end
+      end
+      if @tool.nil?
+        @tool = Tool.first
+      end
+
+      @registration = Lti2Tp::Registration.new
+      @registration.user_id = params['user_id']
+      @registration.tc_profile_url = params['tc_profile_url']
+      @registration.reg_key = params['reg_key']
+      @registration.reg_password = params['reg_password']
+      @registration.launch_presentation_return_url = params['launch_presentation_return_url']
+      @registration.message_type = 'registration'
+      @registration.status = 'received'
+
+      @tool_consumer_profile = @registration.get_tool_consumer_profile()
+      tcp_wrapper = JsonWrapper.new( @tool_consumer_profile )
+
+      @registration.tool_consumer_profile_json = @tool_consumer_profile.to_json
+      @registration.tenant_basename = tcp_wrapper.first_at('product_instance.service_owner.service_owner_name.default_value')
+      @registration.tenant_name = @registration.tenant_basename   # initialize here until we can qualify it
+      @registration.tenant_id = nil
+      @registration.tool_id = @tool.id
+      @registration.tool_profile_json = @tool.get_tool_profile.to_json
+      @registration.lti_version = @tool_consumer_profile['lti_version']
+
+      @registration.save
+
+      redirect_to "/lti_registration_wips?registration_id=#{@registration.id}&return_url=/lti2_tp/registrations"
+    end
+
+    def end_registration
+      response = pre_process_tenant
+      if response.nil?
+        return
+      else
+        if response.kind_of?(Array)
+          return unless response[0] == 200
+        end
+      end
+
+      @registration = Lti2Tp::Registration.where(:tenant_name => @tenant.tenant_name).first
+
+      json_str = request.body.read
+
+      @registration = Registration.where(:tenant_id => @tenant.id).first
+      end_registration_id = request.headers[Registration::HTTP_CORRELATION_ID]
+      (abort_registration("Missing #{Registration::CORRELATION_ID} header") and return) if end_registration_id.nil?
+      (abort_registration("Out of sequence #{Registration::CORRELATION_ID} header") \
+        and return) if end_registration_id != @registration.end_registration_id
+
+      begin
+        tool_proxy_disposition_wrapper = JsonWrapper.new(json_str)
+      rescue
+        render :json => 'JSON validation failure', :status => '500'
+      end
+
+      tool_proxy_disposition = tool_proxy_disposition_wrapper.root
+      tool_proxy_guid = tool_proxy_disposition['tool_proxy_guid']
+      tool_proxy_id = tool_proxy_disposition['@id']
+
+      disposition = request.headers[Registration::HTTP_DISPOSITION]
+
+      if disposition != 'commit'
+        abort_registration("Tool Consumer requested abort") and return
+      end
+
+      @registration.tool_proxy_json = @registration.proposed_tool_proxy_json
+      @registration.status = 'reregistered'
+      @registration.proposed_tool_proxy_json = nil
+      @registration.end_registration_id = nil
+
+      # recover secret from new tool_proxy
+      tool_proxy_wrapper = JsonWrapper.new(@registration.tool_proxy_json)
+      @registration.reg_password = tool_proxy_wrapper.first_at('security_contract.shared_secret')
+
+      LtiRegistrationWip.change_tenant_secret(@registration.tenant_id, @registration.reg_password)
+
+
+      @registration.save
+
+      end_registration_response = {
+          "@context" => "http://purl.imsglobal.org/ctx/lti/v2/ToolProxyId",
+          "@type" => "ToolProxy",
+          "@id" => tool_proxy_id,
+          "tool_proxy_guid" => tool_proxy_guid,
+          "disposition" => 'commit'
+      }
+
+      content_type = 'application/vnd.ims.lti.v2.toolproxy.id+json'
+      logger.info("Exit from Tool/create(POST)--status 201  content-type: #{content_type}")
+      logger.info(JSON.dump(end_registration_response))
+
+      render :json => end_registration_response.to_json, :content_type => content_type, :status => '201'
+    end
+
+    def index
+      registration = Lti2Tp::Registration.find( params[:id] )
+      final_hash = params.select { |k,v| [ :status, :tool_guid, :lti_errormsg, :lti_errorlog ].include? k.to_sym }
+      final_qs = final_hash.to_query
+      final_url = "#{registration.launch_presentation_return_url}?#{final_qs}"
+      redirect_to final_url
+    end
+
+    def reregister
+      response = pre_process_tenant
+      if response.nil?
+        return
+      else
+        if response.kind_of?(Array)
+          return unless response[0] == 200
+        end
+      end
+
+      @registration = Lti2Tp::Registration.where(:tenant_name => @tenant.tenant_name).first
+
+      @registration.tc_profile_url = params['tc_profile_url']
+      @registration.launch_presentation_return_url = params['launch_presentation_return_url']
+      @registration.message_type = "reregistration"
+      @registration.status = 'received'
+
+      # Use OLD key/secret to send NEW ToolProxy
+      (old_key, old_secret) = LtiRegistrationWip.get_tenant_credentials(@registration.tenant_id)
+      @registration.reg_key = old_key
+      @registration.reg_password = old_secret
+      @tool_consumer_profile = @registration.get_tool_consumer_profile()
+      tcp_wrapper = JsonWrapper.new @tool_consumer_profile
+
+      @registration.tool_consumer_profile_json = @tool_consumer_profile.to_json
+      @registration.tenant_basename = tcp_wrapper.first_at('product_instance.service_owner.service_owner_name.default_value')
+      @registration.tenant_id = @tenant.id
+
+      @tool = Tool.find(@registration.tool_id)
+      @registration.tool_profile_json = @tool.get_tool_profile.to_json
+      @registration.lti_version = @tool_consumer_profile['lti_version']
+
+      @registration.save
+
+      redirect_to "/lti_registration_wips?registration_id=#{@registration.id}&return_url=/lti2_tp/registrations"
+    end
+
+    def update
+      get_tool_consumer_profile Lti2Tp::Context.get_holder( session )
+      form_params = request.params['deployment_proposal']
+      @registration = Lti2Tp::Registration.find( request.params[:id] )
+      @registration.tenant_basename = form_params['tenant_name']
+
+      is_tenant_exists = Tenant.where( :tenant_name => @registration.tenant_basename ).exists?
+      if @registration.message_type == 'registration' and is_tenant_exists
+        @registration.errors[:tenant_name] << 'Institution name is already in database'
+        return render_view
+      elsif @registration.message_type == 'reregistration' and not is_tenant_exists
+        raise 'Attempt to reregister but not tenant currently exists'
+      end
+
+      @tool_options = []
+      params.each { |p|
+        if p.first =~ /^tool_/
+          @tool_options << p.first[5..-1]
+        end
+      }
+
+      if @tool_options.length == 0
+        @registration.errors[:tenant_name] << 'You must check at least one tool below to download'
+        return render_view
+      end
+
+      @registration.save!
+
+      show
+    end
+
+    private
+
+    def abort_registration(abort_msg)
+      render :status => 500, :json => abort_msg
+      end
+    end
+end