add variable substitutions and capabilities needed for lti2

fixes PLAT-765

test-plan:
specs pass

Change-Id: I8d365f16c954194a103ec7f3047a91c70500712b
Reviewed-on: https://gerrit.instructure.com/44376
Tested-by: Jenkins <jenkins@instructure.com>
Reviewed-by: Brad Humphrey <brad@instructure.com>
Product-Review: Nathan Mills <nathanm@instructure.com>
QA-Review: Nathan Mills <nathanm@instructure.com>

Author: rivernate

app/controllers/lti/message_controller.rb

@@ -18,7 +18,9 @@
 
 module Lti
   class MessageController < ApplicationController
-    before_filter :require_context
+    before_filter :require_context, except: :registration_return
+    skip_before_filter :require_user, only: :registration_return
+    skip_before_filter :load_user, only: :registration_return
 
     def registration
       if authorized_action(@context, @current_user, :update)
@@ -69,6 +71,11 @@ def basic_lti_launch_request
       not_found
     end
 
+    def registration_return
+      #params['lti_log']
+      @message = params['lti_errormsg'] || params['lti_msg']
+    end
+
     private
 
     def module_sequence(message_handler)
@@ -109,9 +116,9 @@ def tool_consumer_profile_url
     def registration_return_url
       case context
         when Course
-          course_settings_url(context)
+          course_registration_return_url(context)
         when Account
-          account_settings_url(context)
+          account_registration_return_url(context)
         else
           raise "Unsupported context"
       end

app/controllers/lti/tool_consumer_profile_controller.rb

@@ -25,7 +25,7 @@ class ToolConsumerProfileController < ApplicationController
     def show
       uuid = "339b6700-e4cb-47c5-a54f-3ee0064921a9" #Hard coded until we start persisting the tcp
       profile = Lti::ToolConsumerProfileCreator.new(@context, tool_consumer_profile_url(uuid)).create
-      render json: profile.to_json, :content_type => 'application/json'
+      render json: profile.to_json, :content_type => 'application/vnd.ims.lti.v2.toolconsumerprofile+json'
     end
 
     private

app/views/lti/message/registration_return.html.erb

@@ -0,0 +1 @@
+<div><%= @message %></div>

config/routes.rb

@@ -286,7 +286,7 @@
 
     get 'lti/basic_lti_launch_request/:message_handler_id', controller: 'lti/message', action: 'basic_lti_launch_request', as: :basic_lti_launch_request
     get 'lti/tool_proxy_registration', controller: 'lti/message', action: 'registration', as: :tool_proxy_registration
-
+    get 'lti/registration_return', controller: 'lti/message', action: 'registration_return', as: :registration_return
 
     resources :submissions
     resources :calendar_events
@@ -547,7 +547,7 @@
 
     get 'lti/basic_lti_launch_request/:message_handler_id', controller: 'lti/message', action: 'basic_lti_launch_request', as: :basic_lti_launch_request
     get 'lti/tool_proxy_registration', controller: 'lti/message', action: 'registration', as: :tool_proxy_registration
-
+    get 'lti/registration_return', controller: 'lti/message', action: 'registration_return', as: :registration_return
 
     get 'outcomes/users/:user_id' => 'outcomes#user_outcome_results', as: :user_outcomes_results
     resources :outcomes do

gems/lti_outbound/lib/lti_outbound/tool_launch.rb

@@ -87,11 +87,11 @@ def generate(overrides={})
       if tool.public?
         hash['user_image'] = user.avatar_url
         hash['custom_canvas_user_id'] = '$Canvas.user.id'
-        hash['lis_person_sourcedid'] = user.sis_source_id if user.sis_source_id
+        hash['lis_person_sourcedid'] = '$Person.sourcedId' if user.sis_source_id
         hash['custom_canvas_user_login_id'] = '$Canvas.user.loginId'
         if context.is_a?(LTICourse)
           hash['custom_canvas_course_id'] = '$Canvas.course.id'
-          hash['lis_course_offering_sourcedid'] = context.sis_source_id if context.sis_source_id
+          hash['lis_course_offering_sourcedid'] = '$CourseSection.sourcedId' if context.sis_source_id
         elsif context.is_a?(LTIAccount) || context.is_a?(LTIUser)
           hash['custom_canvas_account_id'] = '$Canvas.account.id'
           hash['custom_canvas_account_sis_id'] = '$Canvas.account.sisSourceId'

gems/lti_outbound/spec/lti_outbound/tool_launch_spec.rb

@@ -118,12 +118,12 @@
       expect(hash['custom_canvas_user_login_id']).to eq 'user_login_id'
       expect(hash['custom_canvas_course_id']).to eq 'course_id'
       expect(hash['custom_canvas_api_domain']).to eq 'root_account_domain'
-      expect(hash['lis_course_offering_sourcedid']).to eq 'course_sis_source_id'
+      expect(hash['lis_course_offering_sourcedid']).to eq '$CourseSection.sourcedId'
       expect(hash['lis_person_contact_email_primary']).to eq 'nobody@example.com'
       expect(hash['lis_person_name_full']).to eq 'user_name'
       expect(hash['lis_person_name_family']).to eq 'last_name'
       expect(hash['lis_person_name_given']).to eq 'first_name'
-      expect(hash['lis_person_sourcedid']).to eq 'sis_user_id'
+      expect(hash['lis_person_sourcedid']).to eq '$Person.sourcedId'
       expect(hash['launch_presentation_locale']).to eq 'en' #was I18n.default_locale.to_s
       expect(hash['launch_presentation_document_target']).to eq 'iframe'
       expect(hash['launch_presentation_return_url']).to eq 'http://www.google.com'
@@ -208,7 +208,7 @@
                                          :variable_substitutor => @variable_substitutor).generate
       expect(hash['custom_canvas_account_id']).to eq 'root_account_id'
       expect(hash['custom_canvas_account_sis_id']).to eq 'root_account_sis_source_id'
-      expect(hash['lis_person_sourcedid']).to eq 'sis_user_id'
+      expect(hash['lis_person_sourcedid']).to eq '$Person.sourcedId'
       expect(hash['custom_canvas_user_id']).to eq 'user_id'
       expect(hash['tool_consumer_instance_guid']).to eq 'root_account_lti_guid' #was hash['tool_consumer_instance_guid']).to eq sub_account.root_account.lti_guid
     end

lib/lti/message_helper.rb

@@ -47,6 +47,7 @@ def common_variable_substitutions
         substitutions.merge!(
           {
             '$Canvas.course.id' => @context.id,
+            '$CourseSection.sourcedId' => @context.sis_source_id,
             '$Canvas.course.sisSourceId' => @context.sis_source_id,
             '$Canvas.enrollment.enrollmentState' => -> { lti_helper.enrollment_state },
             '$Canvas.membership.roles' => -> { lti_helper.current_canvas_roles },
@@ -73,6 +74,8 @@ def common_variable_substitutions
                 '$User.id' => @current_user.id,
                 '$Canvas.user.id' => @current_user.id,
                 '$Canvas.user.prefersHighContrast' => -> { @current_user.prefers_high_contrast? ? 'true' : 'false' },
+                '$Membership.role' => -> { lti_helper.lis2_roles },
+                '$Canvas.xuser.allRoles' => -> { lti_helper.all_roles}
             }
         )
         if sis_pseudonym
@@ -84,6 +87,7 @@ def common_variable_substitutions
                   '$User.username' => sis_pseudonym.unique_id,
                   '$Canvas.user.loginId' => sis_pseudonym.unique_id,
                   '$Canvas.user.sisSourceId' => sis_pseudonym.sis_user_id,
+                  '$Person.sourcedId' => sis_pseudonym.sis_user_id,
               }
           )
         end

spec/apis/lti/tool_consumer_profile_api_spec.rb

@@ -28,7 +28,7 @@ module Lti
       it 'renders "application/json"' do
         tool_consumer_profile_id = 'a_made_up_id'
         get "/api/lti/accounts/#{account.id}/tool_consumer_profile/#{tool_consumer_profile_id}", tool_consumer_profile_id: tool_consumer_profile_id, account_id: account.id
-        expect(response.content_type).to eq 'application/json'
+        expect(response.content_type.to_s).to eq 'application/vnd.ims.lti.v2.toolconsumerprofile+json'
       end
 
       it 'returns the consumer profile JSON' do

spec/lib/lti/message_helper_spec.rb

@@ -103,6 +103,11 @@ def logged_in_user
           expect(subject.common_variable_substitutions['$Canvas.course.id']).to eq 123
         end
 
+        it 'has substitution for $CourseSection.sourcedId' do
+          course.sis_source_id = 'course1'
+          expect(subject.common_variable_substitutions['$CourseSection.sourcedId']).to eq 'course1'
+        end
+
         it 'has substitution for $Canvas.course.sisSourceId' do
           course.sis_source_id = 'course1'
           expect(subject.common_variable_substitutions['$Canvas.course.sisSourceId']).to eq 'course1'
@@ -192,6 +197,18 @@ def logged_in_user
           expect(subject.common_variable_substitutions['$Canvas.user.id']).to eq 456
         end
 
+        it 'has substitution for $Canvas.xuser.allRoles' do
+          Lti::SubstitutionsHelper.stubs(:new).returns(substitution_helper)
+          substitution_helper.stubs(:all_roles).returns('Admin,User')
+          expect(subject.common_variable_substitutions['$Canvas.xuser.allRoles'].call).to eq 'Admin,User'
+        end
+
+        it 'has substitution for $Membership.role' do
+          Lti::SubstitutionsHelper.stubs(:new).returns(substitution_helper)
+          substitution_helper.stubs(:lis2_roles).returns('Admin,User')
+          expect(subject.common_variable_substitutions['$Membership.role'].call).to eq 'Admin,User'
+        end
+
         it 'has substitution for $User.id' do
           user.stubs(:id).returns(456)
           expect(subject.common_variable_substitutions['$User.id']).to eq 456
@@ -209,6 +226,7 @@ def logged_in_user
           end
         end
 
+
         context 'pseudonym' do
           let(:pseudonym) { Pseudonym.new }
 
@@ -221,6 +239,12 @@ def logged_in_user
             expect(subject.common_variable_substitutions['$Canvas.user.sisSourceId']).to eq '1a2b3c'
           end
 
+          it 'has substitution for $Person.sourcedId' do
+            pseudonym.sis_user_id = '1a2b3c'
+            expect(subject.common_variable_substitutions['$Person.sourcedId']).to eq '1a2b3c'
+          end
+
+
           it 'has substitution for $Canvas.user.loginId' do
             pseudonym.unique_id = 'username'
             expect(subject.common_variable_substitutions['$Canvas.user.loginId']).to eq 'username'

spec/models/lti/lti_integration_spec.rb

@@ -108,12 +108,12 @@
     expect(post_payload['launch_presentation_document_target']).to eq 'iframe'
     expect(post_payload['launch_presentation_locale']).to eq 'en'
     expect(post_payload['launch_presentation_return_url']).to eq '/return/url'
-    expect(post_payload['lis_course_offering_sourcedid']).to eq canvas_course.sis_source_id
+    expect(post_payload['lis_course_offering_sourcedid']).to eq '$CourseSection.sourcedId'
     expect(post_payload['lis_person_contact_email_primary']).to eq canvas_user.email
     expect(post_payload['lis_person_name_family']).to eq canvas_user.last_name
     expect(post_payload['lis_person_name_full']).to eq canvas_user.name
     expect(post_payload['lis_person_name_given']).to eq canvas_user.first_name
-    expect(post_payload['lis_person_sourcedid']).to eq pseudonym.sis_user_id
+    expect(post_payload['lis_person_sourcedid']).to eq '$Person.sourcedId'
     expect(post_payload['lti_message_type']).to eq 'basic-lti-launch-request'
     expect(post_payload['lti_version']).to eq 'LTI-1p0'
     expect(post_payload['oauth_callback']).to eq 'about:blank'
@@ -176,12 +176,12 @@
       expect(hash['custom_canvas_user_login_id']).to eq '$Canvas.user.loginId'
       expect(hash['custom_canvas_course_id']).to eq @course.id.to_s
       expect(hash['custom_canvas_api_domain']).to eq '$Canvas.api.domain'
-      expect(hash['lis_course_offering_sourcedid']).to eq 'coursesis'
+      expect(hash['lis_course_offering_sourcedid']).to eq '$CourseSection.sourcedId'
       expect(hash['lis_person_contact_email_primary']).to eq 'nobody@example.com'
       expect(hash['lis_person_name_full']).to eq 'A Name'
       expect(hash['lis_person_name_family']).to eq 'Name'
       expect(hash['lis_person_name_given']).to eq 'A'
-      expect(hash['lis_person_sourcedid']).to eq 'testfun'
+      expect(hash['lis_person_sourcedid']).to eq '$Person.sourcedId'
       expect(hash['launch_presentation_locale']).to eq I18n.default_locale.to_s
       expect(hash['launch_presentation_document_target']).to eq 'iframe'
       expect(hash['launch_presentation_return_url']).to eq 'http://www.google.com'
@@ -233,7 +233,7 @@
 
       hash['custom_canvas_account_id'] = sub_account.id.to_s
       hash['custom_canvas_account_sis_id'] = 'accountsis'
-      expect(hash['lis_person_sourcedid']).to eq 'testfun'
+      expect(hash['lis_person_sourcedid']).to eq '$Person.sourcedId'
       expect(hash['custom_canvas_user_id']).to eq '$Canvas.user.id'
       expect(hash['tool_consumer_instance_guid']).to eq sub_account.root_account.lti_guid
     end