lti2 0.0.2 → 0.0.3

data/lti2_tp/app/models/lti2_tp/context.rb

@@ -0,0 +1,55 @@
+module Lti2Tp
+  class Context < ActiveRecord::Base
+    
+    SESSION_LTI2_CONTEXT_ID = 'lti2_tc_profile.key'
+
+    class Holder
+      attr_accessor :lti2_context
+      def initialize( id=nil )
+        unless id.nil?
+          @lti2_context = Lti2Tp::Context.find_all_by_id([id]).first
+        end
+        if id.nil? || @lti2_context.blank?
+          @lti2_context = Lti2Tp::Context.create()
+        end
+        begin
+          @context_hash = JSON.load( @lti2_context.content )
+        rescue
+          @context_hash = nil
+        end
+        @context_hash ||= {}
+        self
+      end
+
+      def [] name
+        @context_hash[name]
+      end
+
+      def []= name, value
+        @context_hash[name] = value
+        @lti2_context.content = JSON.dump( @context_hash )
+        @lti2_context.save
+      end
+
+      def clear name
+        @context_hash.delete( name )
+        @lti2_context.content = JSON.dump( @context_hash )
+        @lti2_context.save
+      end
+    end
+
+    def self.get_holder( session )
+      # lazy create for holder
+      if session.has_key?( SESSION_LTI2_CONTEXT_ID )
+        result = Lti2Tp::Context::Holder.new( session[SESSION_LTI2_CONTEXT_ID] )
+      end
+      if result.blank?
+        result = Lti2Tp::Context::Holder.new()
+      end
+      # reassert in class new run in same browser session
+      session[SESSION_LTI2_CONTEXT_ID] = result.lti2_context.id
+      result
+    end
+
+  end
+end

data/lti2_tp/app/models/lti2_tp/registration.rb

@@ -0,0 +1,180 @@
+module Lti2Tp
+  class Registration < ActiveRecord::Base
+
+    CORRELATION_ID = 'VND-IMS-CORRELATION-ID'
+    DISPOSITION = 'VND-IMS-DISPOSITION'
+
+    HTTP_CORRELATION_ID = 'HTTP_VND_IMS_CORRELATION_ID'
+    HTTP_DISPOSITION = 'HTTP_VND_IMS_DISPOSITION'
+
+    def create_tool_proxy tool_consumer_profile, tool_proxy_guid, disposition
+      tool_provider_registry = Rails.application.config.tool_provider_registry
+      tool_proxy = {}
+      # clone from provided TCP
+      tool_proxy['@context'] = tool_consumer_profile['@context'].clone
+      tool_proxy['@type'] = 'ToolProxy'
+      tool_proxy['@id'] = "ToolProxyProposal_at_#{Time.now.utc.iso8601}"
+
+      tool_proxy['lti_version'] = 'LTI-2p0'
+      tool_proxy['tool_proxy_guid'] = tool_proxy_guid if disposition == 'reregister'
+
+      tool_proxy['tool_consumer_profile'] = self.tc_profile_url
+      tool_proxy['tool_profile'] = JSON.load( tool_profile_json )
+      tool_proxy['security_contract'] = resolve_security_contract( tool_consumer_profile )
+
+      tool_proxy_wrapper = JsonWrapper.new( tool_proxy )
+      tool_proxy_wrapper.root
+    end
+
+    def get_tool_consumer_profile()
+      tcp_response = invoke_unsigned_service(self.tc_profile_url, 'get', {}, {}, nil, Rails.application.config.wire_log, "Get Tool Consumer Profile")
+      JSON.load( tcp_response.body )
+    end
+
+    def prepare_tool_proxy disposition, tool_proxy_guid
+      tool_consumer_profile = JSON.load( self.tool_consumer_profile_json )
+      tool_proxy = create_tool_proxy(tool_consumer_profile, tool_proxy_guid, disposition)
+      if tool_proxy
+        self.end_registration_id = UUID.generate
+        if disposition == 'register'
+          self.tool_proxy_json = tool_proxy.to_json
+        else
+          self.proposed_tool_proxy_json = tool_proxy.to_json
+        end
+        self.save!
+
+        service_offered = nil
+        tool_consumer_profile['service_offered'].select do |entry|
+          if match_services( entry['@id'] , ':ToolProxy.collection' )
+            service_offered = entry
+            break
+          end
+        end
+        if service_offered.nil?
+          status = create_status(false, nil, "No matching service definition")
+          return_url = self.launch_presentation_return_url + '?status=failure'
+          (redirect_to return_url) and return
+        end
+
+        (tool_proxy_response, err_code, err_msg) = register_tool_proxy service_offered, "post", disposition
+        unless err_code == 201
+          status = create_status(false, nil, "#{err_code}-#{err_msg}")
+          return status
+        end
+        if disposition.blank? || disposition == 'register' 
+          # get guid from the response returned by the TC
+          tool_proxy['tool_proxy_guid'] = tool_proxy_response['tool_proxy_guid']
+
+
+          # substitute tool_proxy_guid now in the Proxy where needed
+          tool_proxy_wrapper = JsonWrapper.new( tool_proxy )
+          tool_proxy_wrapper.substitute_text_in_all_nodes( '{', '}', { 'tool_proxy_guid' => tool_proxy['tool_proxy_guid'] } )
+
+          self.tool_proxy_json = tool_proxy.to_json
+          self.status = disposition
+          self.save!
+
+          status = create_status(true, tool_proxy_wrapper.first_at('tool_proxy_guid'))
+        else
+          status = create_status(true)
+        end
+      else
+        status = create_status(false, nil, "Can't access ToolProxy")
+      end
+
+      status
+    end
+
+    def create_status(is_success, tool_guid=nil, message=nil)
+      status = "?"
+      if is_success
+        status += 'status=success&'
+        status += "tool_guid=#{tool_guid}&" if tool_guid.present?
+      else
+        status += 'status=failure&'
+        encoded_message = Rack::Utils.escape( message )
+        status += "lti_errormsg=#{encoded_message}&lti_errorlog=#{encoded_message}&"
+      end
+      status
+    end
+
+    def is_status_failure? status
+      status.include? "status=failure&"
+    end
+
+    private
+
+    def match_services( test_service, model_service )
+      service_name_pattern = /.*\W(\w+?\.\w+)$/
+      m = service_name_pattern.match( test_service )
+      if m.present?
+        test_word = m[1]
+        m = service_name_pattern.match( model_service )
+        if m.present?
+          model_word = m[1]
+          return test_word == model_word
+        end
+      end
+      return false
+    end
+
+    def register_tool_proxy service_offered, method, disposition
+      if disposition == 'register'
+      data = self.tool_proxy_json
+        label = 'Register'
+      else
+        data = self.proposed_tool_proxy_json
+        label = 'ReRegister'
+      end
+
+      data = JSON.pretty_generate(JSON.load(data))
+
+      # data = CGI::escape(data)
+      signed_request = create_signed_request \
+        service_offered['endpoint'],
+        method,
+        self.reg_key,
+        self.reg_password,
+        {},
+        data,
+        "application/vnd.ims.lti.v2.toolproxy+json"
+
+      puts "Register request: #{signed_request.signature_base_string}"
+      puts "Register secret: #{self.reg_password}"
+      headers = {}
+      (headers[CORRELATION_ID] = self.end_registration_id) if disposition == 'reregister'
+      response = invoke_service(signed_request, Rails.application.config.wire_log, "#{label} ToolProxy with ToolConsumer",
+          headers)
+      if response.code.between?( 200, 202 )
+        response_body = response.body
+        response_content = JSON.load( response_body ) unless response_body.strip.empty?
+      else
+        response_content = nil
+      end
+      [ response_content, response.code, response.message ]
+    end
+
+
+    def resolve_security_contract tool_consumer_profile
+      security_contract = {}
+
+      security_contract['shared_secret'] = SecureRandom.hex
+      security_contract['tool_service'] = []
+
+      services_offered = tool_consumer_profile['service_offered']
+      services_offered.each { |service_offered|
+        tool_service = {}
+        tool_service['@type'] = 'RestServiceProfile'
+        tool_service['service'] = service_offered['@id']
+        tool_service['action'] = service_offered['action']
+
+        # following may be wrong...check on proper construction of RestService
+        # tool_service['format'] = service_offered['format']
+        security_contract['tool_service'] << tool_service
+      }
+
+      security_contract
+    end
+
+  end
+end

data/lti2_tp/app/models/lti2_tp/registry.rb

@@ -0,0 +1,5 @@
+module Lti2Tp
+
+  class Registry < ActiveRecord::Base
+  end
+end

data/lti2_tp/app/models/lti2_tp/tool.rb

@@ -0,0 +1,27 @@
+module Lti2Tp
+  class Tool < ActiveRecord::Base
+    
+    def get_tool_profile( tool_options=nil )
+      tool_provider_registry = Rails.application.config.tool_provider_registry
+      tool_profile = Lti2Commons::JsonWrapper.new( self.tool_profile_template )
+      tool_profile.substitute_text_in_all_nodes( '{', '}', tool_provider_registry.registry )
+
+      # only if tool_options, provided prune day available resource_handlers
+      if tool_options
+        resource_handlers = tool_profile.first_at('resource_handler')
+        resource_handlers_to_delete = []
+        resource_handlers.each { |resource_handler|
+          resource_handler_wrapper = Lti2Commons::JsonWrapper.new( resource_handler )
+          unless tool_options.include? resource_handler_wrapper.first_at('resource_name.default_value')
+            resource_handlers_to_delete << resource_handler
+          end
+        }
+        resource_handlers_to_delete.each { |rh|
+          resource_handlers.delete( rh )
+        }
+      end
+      tool_profile.root
+    end
+
+  end
+end

data/lti2_tp/app/models/lti2_tp/tool_deployment.rb

@@ -0,0 +1,5 @@
+module Lti2Tp
+  class ToolDeployment < ActiveRecord::Base
+    belongs_to :tenant
+  end
+end

data/lti2_tp/app/models/lti2_tp/tool_provider_registry.rb

@@ -0,0 +1,21 @@
+module Lti2Tp
+
+  class ToolProviderRegistry
+
+    attr_reader :security_contract_template, :tp_deployment_url, :relaxed_oauth_check, :result_template,
+                :tool_provider_name, :registry
+
+    def initialize
+      registry_entries = Registry.all()
+      @registry = {}
+      registry_entries.each { |entry| @registry[entry.name] = entry.content unless entry.name == 'content' }
+
+      @tp_deployment_url = registry['tp_deployment_url']
+      @relaxed_oauth_check = registry['relaxed_oauth_check']
+      @result_template = registry['result_template']
+      @tool_provider_name = registry['tool_provider_name']
+    end
+
+  end
+
+end

data/lti2_tp/app/views/layouts/lti2_tp/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Lti2Tp</title>
+  <%= stylesheet_link_tag    "lti2_tp/application", media: "all" %>
+  <%= javascript_include_tag "lti2_tp/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/lti2_tp/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/lti2_tp/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/lti2_tp/config/initializers/lti2_tp.rb

@@ -0,0 +1,11 @@
+include Lti2Commons
+include WireLogSupport
+
+NONCE_TIME_TO_LIVE = 300  # seconds
+Rails.application.config.nonce_cache = Cache.new :ttl => NONCE_TIME_TO_LIVE
+
+if ActiveRecord::Base.connection.table_exists? 'lti2_tp_registries'
+  Rails.application.config.tool_provider_registry = Lti2Tp::ToolProviderRegistry.new
+end
+
+Rails.application.config.wire_log = WireLog.new "ToolProvider", File.expand_path("../tc_sample_app/public/wirelog.html")

data/lti2_tp/config/routes.rb

@@ -0,0 +1,9 @@
+Lti2Tp::Engine.routes.draw do
+
+  resources :registrations
+
+  match 'reregistrations' => 'registrations#reregister', :via => :post
+
+  match 'tool_proxies' => 'registrations#end_registration', :via => :post
+
+end

data/lti2_tp/db/migrate/20140826151614_create_lti2_tp_resources.rb

@@ -0,0 +1,67 @@
+class CreateLti2TpResources < ActiveRecord::Migration
+  def up
+    create_table :lti2_tp_registrations do |t|
+      t.integer  :tool_id
+      t.integer  :tenant_id
+      t.string   :tenant_name
+      t.string   :tenant_basename
+      t.string   :user_id
+      t.string   :reg_key
+      t.string   :reg_password
+      t.string   :tc_profile_url
+      t.string   :launch_presentation_return_url
+      t.string   :status
+      t.string   :message_type
+      t.string   :lti_version
+      t.string   :end_registration_id
+      t.text     :tool_consumer_profile_json
+      t.text     :tool_profile_json
+      t.text     :tool_proxy_json
+      t.text     :proposed_tool_proxy_json
+
+      t.timestamps
+    end
+    execute('ALTER TABLE lti2_tp_registrations CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;')
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `tenant_name` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `tenant_basename` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `user_id` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `reg_key` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `reg_password` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `tc_profile_url` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `launch_presentation_return_url` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `status` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `message_type` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `lti_version` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `end_registration_id` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `tool_consumer_profile_json` TEXT CHARACTER SET utf8mb4 NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `tool_profile_json` TEXT CHARACTER SET utf8mb4 NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `tool_proxy_json` TEXT CHARACTER SET utf8mb4 NULL;")
+    execute("ALTER TABLE lti2_tp_registrations MODIFY `proposed_tool_proxy_json` TEXT CHARACTER SET utf8mb4 NULL;")
+
+    create_table :lti2_tp_registries do |t|
+      t.string   :name
+      t.text     :content
+
+      t.timestamps
+    end
+    execute('ALTER TABLE lti2_tp_registries CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;')
+    execute("ALTER TABLE lti2_tp_registries MODIFY `name` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_registries MODIFY `content` TEXT CHARACTER SET utf8mb4 NULL;")
+
+    create_table :lti2_tp_tools do |t|
+      t.string   :tool_name
+      t.text     :tool_profile_template
+
+      t.timestamps
+    end
+    execute('ALTER TABLE lti2_tp_tools CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;')
+    execute("ALTER TABLE lti2_tp_tools MODIFY `tool_name` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL;")
+    execute("ALTER TABLE lti2_tp_tools MODIFY `tool_profile_template` TEXT CHARACTER SET utf8mb4 NULL;")
+  end
+
+  def down
+    drop_table :lti2_tp_registrations
+    drop_table :lti2_tp_registries
+    drop_table :lti2_tp_tools
+  end
+end

data/lti2_tp/lib/lti2_tp.rb

@@ -0,0 +1,4 @@
+require 'lti2_tp/engine'
+
+module Lti2Tp
+end

data/lti2_tp/lib/lti2_tp/engine.rb

@@ -0,0 +1,5 @@
+module Lti2Tp
+  class Engine < ::Rails::Engine
+    isolate_namespace Lti2Tp
+  end
+end

data/lti2_tp/lib/lti2_tp/version.rb

@@ -0,0 +1,3 @@
+module Lti2Tp
+  VERSION = '0.0.2'
+end

data/lti2_tp/lib/tasks/lti2_tp_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lti2_tp do
+#   # Task goes here
+# end

data/lti2_tp/lti2_tp.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path( '../lib', __FILE__ )
+
+# Maintain your gem's version:
+require 'lti2_tp/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+
+  s.name        = 'lti2_tp'
+  s.version     = Lti2Tp::VERSION
+  s.authors     = ['John Tibbetts']
+  s.email       = ['john.tibbetts@ingramcontent.com']
+  s.homepage    = 'http://vitalsource.com'
+  s.summary     = 'LTI2 Tool Provider'
+  s.description = 'LTI2 Tool Provider'
+
+  s.files = Dir[ '{app,config,db,lib}/**/*', 'MIT-LICENSE', 'Rakefile', 'README.rdoc' ]
+  s.test_files = Dir[ 'test/**/*' ]
+
+  s.required_ruby_version = '~> 2.0.0'
+
+  s.add_dependency 'rails', '~> 4.1.1'
+  s.add_dependency 'mysql2', '~> 0.3.13'
+
+  s.add_development_dependency 'sqlite3'
+
+end