lti2 0.0.1 → 0.0.2

data/lti2_tc/app/controllers/lti2_tc/tools_controller.rb

@@ -0,0 +1,361 @@
+require_dependency 'lti2_tc/application_controller'
+
+module Lti2Tc
+  class ToolsController < Lti2Tc::ApplicationController
+    include OAuth::OAuthProxy
+    include Lti2Commons::Utils
+
+    LTI2TC_SESSION_MAP = 'lti2_tc_session_map'
+
+    CORRELATION_ID = 'VND-IMS-CORRELATION-ID'
+    DISPOSITION = 'VND-IMS-DISPOSITION'
+
+    DISPOSITION_COMMIT = 'commit'
+    DISPOSITION_ABORT = 'abort'
+
+
+    def create
+      rack_parameters = OAuthRequest.collect_rack_parameters request
+
+      (tool_proxy_wrapper, status, error_msg) = process_tool_proxy(request)
+      if error_msg.present?
+        ( render :json => { :errors => [error_msg] }, :status => status ) and return
+      end
+
+      end_registration_id = request.headers[CORRELATION_ID]
+
+      disposition = (tool_proxy_wrapper.root.has_key? 'tool_proxy_guid') ? 'reregister' : 'register'
+      if disposition == 'register'
+        reg_key = rack_parameters[:oauth_consumer_key]
+        @deployment_request = Lti2Tc::DeploymentRequest.where(:reg_key => reg_key).first
+      else
+        reg_key = tool_proxy_wrapper.root['tool_proxy_guid']
+        tool = Lti2Tc::Tool.where(:key => reg_key).first
+        @deployment_request = Lti2Tc::DeploymentRequest.where(:tool_proxy_guid => reg_key).first
+      end
+
+      # prompt for disposition
+      session_map = {}
+      session[LTI2TC_SESSION_MAP] = session_map
+      session_map['deployment_request_id'] = @deployment_request.id
+      @deployment_request.disposition = disposition
+      @deployment_request.end_registration_id = end_registration_id
+      @deployment_request.tool_proxy_json = tool_proxy_wrapper.root.to_json
+      @deployment_request.save
+
+      if disposition == 'reregister'
+        #tool = Tool.where(:key => reg_key).last
+        #tool.new_deployment_request_id = @deployment_request.id
+        #tool.save
+        (render :nothing => true, :status => 201) and return
+      end
+
+      secret = @deployment_request.reg_password
+      begin
+        oauth_validation_using_secret secret
+      rescue
+        (render :json => {:errors => ['Invalid signature']}, :status => 401) and return
+      end
+
+      # generate guid for tool_proxy
+      tool_proxy_guid = UUID.generate
+      tool_proxy_wrapper.root['tool_proxy_guid'] = tool_proxy_guid
+      tool_proxy_wrapper.substitute_text_in_all_nodes '{', '}', {'tool_proxy_guid' => tool_proxy_guid}
+      tool_consumer_registry = Rails.application.config.tool_consumer_registry
+
+      product_name = tool_proxy_wrapper.first_at('tool_profile.product_instance.product_info.product_name.default_value')
+
+      @tool = Tool.new
+      @tool.is_enabled = false
+
+      @tool.tool_proxy = JSON.pretty_generate tool_proxy_wrapper.root
+      @tool.product_name = product_name
+      @tool.description = tool_proxy_wrapper.first_at('tool_profile.product_instance.product_info.description.default_value')
+      @tool.key = tool_proxy_guid
+      @tool.secret = tool_proxy_wrapper.first_at('security_contract.shared_secret')
+      @tool.status = 'registered'
+      @tool.end_registration_id = end_registration_id
+
+      # TEMPORARY: enable tool...FOR DEMOS
+      # @tool.is_enabled = true
+
+      @tool.save
+
+      resource_nodes = tool_proxy_wrapper.first_at('tool_profile.resource_handler')
+
+      # course 2(SMPL101), 11 & 12 DEP from conformance test
+      target_courses = [2, 5, 6]
+      for resource_node in resource_nodes
+        target_courses.each do |course_id|
+          # create resource-relative jsonpath
+          resource_json_obj = JsonWrapper.new resource_node
+          resource = Resource.new
+          resource.tool = @tool
+          resource.resource_type = resource_json_obj.first_at('resource_type.code')
+          resource.resource_name = resource_json_obj.first_at('resource_name.default_value')
+          resource.description = resource_json_obj.first_at('description.default_value')
+          resource.save
+
+          # TEMPORARY: auto-create one link for SMPL101 (#2)
+          link = Lti2Tc::Link.new
+          link.course_id = course_id
+          link.resource = resource
+          link.resource_link_label = resource.resource_name
+          link_parameter_str = "{"
+          if ["Book", "BookSelection", "InteractiveResource"].include? resource.resource_name
+            link_parameter_str += "\"vbid\":\"L-999-74180\""
+          end
+          if resource.resource_name == "BookSelection"
+            link_parameter_str += ",\"book_location\":\"outline\/3\""
+          end
+          link_parameter_str += "}"
+          link.link_parameters = link_parameter_str
+
+          # and a grade_item for resource iResource only
+          if resource.resource_name == "InteractiveResource"
+            grade_item = GradeItem.new
+            grade_item.course_id = link.course_id
+            grade_item.label = "IRTestGrade"
+            grade_item.save
+
+            link.grade_item_id = grade_item.id
+          end
+
+          link.is_enabled = true
+          link.save
+        end
+      end
+
+      # create links for conformance test
+      tc_profile_url = tool_proxy_wrapper.first_at('tool_consumer_profile')
+      tc_profile_guid = tc_profile_url.split('/').last if tc_profile_url =~ /\//
+
+      tool_proxy_guid = tool_proxy_wrapper.first_at('tool_proxy_guid')
+      tool_proxy_id = "#{tool_consumer_registry.tc_deployment_url}/tools/#{tool_proxy_guid}"
+      tool_proxy_wrapper.root['@id'] = tool_proxy_id
+      @tool.tool_proxy = JSON.pretty_generate tool_proxy_wrapper.root
+
+      capture_and_excise_settings(tool_proxy_wrapper.root, @tool)
+
+      @tool.save
+
+      @deployment_request.tool_proxy_guid = tool_proxy_guid
+      @deployment_request.save
+
+      #@deployment_request.delete
+
+
+      tool_proxy_response = {
+          "@context" => "http://purl.imsglobal.org/ctx/lti/v2/ToolProxyId",
+          "@type" => "ToolProxy",
+          "@id" => tool_proxy_id,
+          "tool_proxy_guid" => tool_proxy_guid
+      }
+
+      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( tool_proxy_response ) )
+
+      render :json => tool_proxy_response, :content_type => content_type, :status => '201'
+    end
+
+    def show
+      oauth_validation
+
+      id_parm = params[:id]
+      match = /^id=(\d+)/.match( id_parm )
+      if match.present?
+        id = match[1]
+        @tool = Lti2Tc::Tool.find_by_id( id )
+      else
+        @tool = Lti2Tc::Tool.where( :key => id_parm ).first
+      end
+      ( render :text => "Unauthorized", :status => 401 unless @tool.present? ) and return
+      secret = @tool.secret
+      #oauth_validation_using_secret secret
+
+      tool_proxy_str = @tool.tool_proxy
+      tool_proxy = JSON.load( tool_proxy_str )
+
+      # merge in Tool Settings for ToolProxy level
+      tool_settings = Lti2Tc::ToolSetting.where( :scopeable_id => @tool.id )
+      tool_settings_custom = {}
+      tool_settings.each do |tool_setting|
+        tool_settings_custom[tool_setting.name] = tool_setting.value
+      end
+      if tool_settings_custom.length > 0
+        tool_settings_custom['@id'] = ""
+        tool_proxy[:custom] = tool_settings_custom
+      end
+
+      tool_proxy_pretty_str = JSON.pretty_generate( tool_proxy )
+
+      content_type = 'application/vnd.ims.lti.v2.toolproxy+json'
+
+      logger.info( "Exit from Tool/show(GET)--status: 200  content-type: #{content_type}" )
+      logger.info( JSON.dump( tool_proxy_pretty_str ) )
+
+      render :text => "<pre>#{tool_proxy_pretty_str}</pre>", :content_type => content_type
+    end
+
+    def reregister_continue
+
+
+      message_type = "reregistration"
+
+      tool_id = params[:tool_id]
+      @tool = Lti2Tc::Tool.find(tool_id)
+      new_deployment_request_id = @tool.new_deployment_request_id
+      @deployment_request = DeploymentRequest.find(new_deployment_request_id)
+      tool_proxy_wrapper = JsonWrapper.new(@deployment_request.tool_proxy_json)
+
+      @tool.end_registration_id = @deployment_request.end_registration_id
+      @tool.save
+
+      tool_proxy_guid = tool_proxy_wrapper.first_at('tool_proxy_guid')
+      tool_consumer_registry = Rails.application.config.tool_consumer_registry
+      tool_proxy_id = "#{tool_consumer_registry.tc_deployment_url}/tools/#{tool_proxy_guid}"
+
+      # Post EndRegistration
+      tool_proxy_service_hash = {}
+      content_type = 'application/vnd.ims.lti.v2.toolproxy.id+json'
+      reregistration_service = nil
+      reregistration_service_endpoint = nil
+
+      tool_proxy_wrapper.root['tool_profile']['service_offered'].each do |service|
+        if service['format'][0] == content_type
+          reregistration_service = service
+        end
+        if reregistration_service.nil?
+          return [nil, 500, 'No reregistration service defined']
+        end
+        reregistration_service_endpoint = reregistration_service['endpoint']
+        if reregistration_service_endpoint.nil?
+          return [nil, 500, 'No reregistration endpoint defined in reregistration service']
+        end
+      end
+
+      end_registration_request = {
+          "@context" => "http://purl.imsglobal.org/ctx/lti/v2/ToolProxyId",
+          "@type" => "ToolProxy",
+          "@id" => tool_proxy_id,
+          "tool_proxy_guid" => tool_proxy_guid
+      }
+
+      headers = {}
+      headers[CORRELATION_ID] = @tool.end_registration_id
+      headers[DISPOSITION] = DISPOSITION_COMMIT
+
+      #DEBUG ONLY
+      if reregistration_service_endpoint.include? 'http://localhost:5000'
+        reregistration_service_endpoint.sub!('http://localhost:5000', 'http://localhost:5100')
+      end
+
+      #response = HTTParty.post reregistration_service_endpoint, :body => end_registration_request.to_json, :headers => headers
+      signed_request = create_signed_request \
+        reregistration_service_endpoint,
+        'POST',
+        @tool.key,
+        @tool.secret,
+        {},
+        end_registration_request.to_json,
+        "application/vnd.ims.lti.v2.toolproxy.id+json"
+
+      puts "Register request: #{signed_request.signature_base_string}"
+      puts "Register secret: #{@tool.secret}"
+      response = invoke_service(signed_request, Rails.application.config.wire_log, "Reregister ToolProxy",
+                                CORRELATION_ID => @tool.end_registration_id, DISPOSITION => DISPOSITION_COMMIT)
+      # handle response error
+
+      product_name = tool_proxy_wrapper.first_at('tool_profile.product_instance.product_info.product_name.default_value')
+
+      @tool.tool_proxy = JSON.pretty_generate tool_proxy_wrapper.root
+      @tool.product_name = product_name
+      @tool.description = tool_proxy_wrapper.first_at('tool_profile.product_instance.product_info.description.default_value')
+      @tool.key = tool_proxy_wrapper.first_at('tool_proxy_guid')
+      @tool.secret = tool_proxy_wrapper.first_at('security_contract.shared_secret')
+      @tool.new_deployment_request_id = nil
+
+      tool_proxy_wrapper.root['@id'] = tool_proxy_id
+
+      @tool.tool_proxy = JSON.pretty_generate tool_proxy_wrapper.root
+
+      capture_and_excise_settings(tool_proxy_wrapper.root, @tool)
+
+      @tool.save
+
+      redirect_to @tool.registration_return_url
+    end
+
+    private
+
+    # for this reference impl: tool proxy settings system-of-record is db not TP itself
+    def capture_and_excise_settings( tool_proxy, tool )
+      settings = tool_proxy['custom']
+      if settings.present?
+        Lti2Tc::ToolSetting.where( :scopeable_type => 'Tool', :tool_id => tool.id ).delete_all
+
+        settings.each_pair do |k,v|
+          ts = Lti2Tc::ToolSetting.create(
+            :scopeable_type => 'Tool',
+            :tool_id => tool.id,
+            :scopeable_id => tool.id,
+            :name => k,
+            :value => v
+          )
+          ts.save
+        end
+
+        tool_proxy.delete( 'custom' )
+
+      end
+    end
+
+    def check_for_validity(tool_proxy_wrapper)
+      if tool_proxy_wrapper.first_at('security_contract.shared_secret').blank?
+        return 'Missing shared_secret'
+      end
+
+      # check that services are a subset of those offered
+      # first, grab guid from tc_profile_url
+      tc_profile_guid = tool_proxy_wrapper.root['tool_consumer_profile'].split('/').last
+      tcp_obj = ToolConsumerProfile.where( :tc_profile_guid => tc_profile_guid ).first
+      tcp_str = tcp_obj.tc_profile
+      tcp = JsonWrapper.new( tcp_str ).root
+      tcp_service_hash = {}
+      tcp['service_offered'].each { |service| tcp_service_hash[service['@id']] = service['action'] }
+      tool_proxy_wrapper.root['security_contract']['tool_service'].each do |tp_service_item|
+        if tcp_service_hash.keys.include?( tp_service_item['service'] )
+          tp_service_item['action'].each do |action|
+            unless tcp_service_hash[tp_service_item['service']].include?( action )
+              return "Service #{tp_service_item['service']} does not support #{action}"
+            end
+          end
+        else
+          return "Service mismatch on #{tp_service_item['service']}"
+        end
+      end
+      nil
+    end
+
+    def process_tool_proxy(request)
+      json_str = request.body.read
+
+      begin
+        tool_proxy_wrapper = JsonWrapper.new(json_str)
+      rescue
+        return [ nil, 400, 'JSON validation failure' ]
+      end
+
+      error_msg = check_for_validity(tool_proxy_wrapper)
+      if error_msg.present?
+        return [ nil, 400, error_msg ]
+      end
+
+      logger.info("ToolProxy as received: ")
+      logger.info(JSON.pretty_generate(tool_proxy_wrapper.root))
+
+      [tool_proxy_wrapper, nil, nil]
+    end
+  end
+end

data/lti2_tc/app/models/lti2_tc/deployment_request.rb

@@ -0,0 +1,43 @@
+include Lti2Commons
+include MessageSupport
+include Signer
+
+module Lti2Tc
+
+  class DeploymentRequest < ActiveRecord::Base
+
+    after_initialize :initialize_fields
+    
+    def create_lti_message( base_url, current_user )
+      parameters = create_request_tool_deployment( base_url, current_user.to_s )
+      create_lti_message_body( partner_url, parameters,
+        Rails.application.config.wire_log, 'Request Tool Registration' )
+    end
+
+    def create_request_tool_deployment( base_url, user_id, lti_message_type = 'ToolProxyRegistrationRequest' )
+      parameters = {
+          'lti_message_type' => lti_message_type,
+          'lti_version' => 'LTI-2p0',
+          'user_id' => "#{user_id}",
+          'roles' => 'urn:lti:sysrole:ims/lis/SysAdmin',
+          'tc_profile_url' => "#{base_url}/lti2_tc/tool_consumer_profiles/#{self.tc_profile_guid}",
+          'reg_key' => self.reg_key,
+          'reg_password' => self.reg_password,
+          'launch_presentation_return_url' => "#{base_url}/admin/tool_actions",
+          'launch_presentation_document_target' => 'window'
+      }
+      parameters
+    end
+
+    private
+
+    def initialize_fields
+      unless persisted?
+        self.reg_key = UUID.generate
+        self.tc_profile_guid = UUID.generate
+        self.reg_password = SecureRandom.hex
+        self.status = 'prepared'
+      end
+    end
+  end
+end

data/lti2_tc/app/models/lti2_tc/link.rb

@@ -0,0 +1,24 @@
+include Lti2Commons
+include MessageSupport
+include Signer
+
+module Lti2Tc
+
+  class Link < ActiveRecord::Base
+    belongs_to :course
+    belongs_to :resource
+    has_many :tool_settings, :as => :scopeable
+
+    attr_accessor :is_link_visible, :url, :toggle_label, :grade_item_label, :grade_result
+
+    def lti_launch( user, return_url )
+      enrollment = Enrollment.where( :admin_user_id => user.id, :course_id => course.id ).first
+      Lti2Tc::Lti2Launch.new( user, self, self.resource, self.course, enrollment, return_url ).launch()
+    end
+
+    def is_ready_for_use
+      self.is_enabled and self.resource.tool.is_enabled
+    end
+
+  end
+end

data/lti2_tc/app/models/lti2_tc/registry.rb

@@ -0,0 +1,4 @@
+module Lti2Tc
+  class Registry < ActiveRecord::Base
+  end
+end

data/lti2_tc/app/models/lti2_tc/resource.rb

@@ -0,0 +1,6 @@
+module Lti2Tc
+  class Resource < ActiveRecord::Base
+    belongs_to :tool
+
+  end
+end

data/lti2_tc/app/models/lti2_tc/tool.rb

@@ -0,0 +1,12 @@
+module Lti2Tc
+  class Tool < ActiveRecord::Base
+    has_many :resources
+    has_many :tool_settings, :as => :scopeable
+
+    attr_accessor :toggle_label, :new_tool_proxy_url
+
+    def get_tool_proxy
+      Lti2Commons::JsonWrapper.new( self.tool_proxy )
+    end
+  end
+end