qalam_lti_provider_engine 2.0.6 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8241935a752778f3aaf18a334c18e0ca34f38942f1f08bbdcc937f77c9913e
-  data.tar.gz: 7a5ed02a9a13c728c8ffe34c1fd66e2c8b07b66da5541f3b55742886aa5e3879
+  metadata.gz: ffc7781e66b1cae37477f81e36d212e3e52a115aa49e908a8954dda144d05ede
+  data.tar.gz: ee3ad8f02faa0314cea6192a5d264935d5b0ecb8d10b9622125acc4c635fd608
 SHA512:
-  metadata.gz: 738e91d04b9c70e04d10d575b2b8a497cf0fa064dd6cb0d39aadcc8226d6c13d1de35528edcb4b308a942466e0c0c37ac751f76c3f3e91f644a1b315d80c7972
-  data.tar.gz: b0aa71ce229a8dcb0a631029fd2fd15899b4c2daa3dc32d2c52f6777acd79ab7507aa2efc1749a3abded690a1e1c8ab75ff711dcca086b2aa740f68e74a7b57c
+  metadata.gz: d180b3146931ff792403020def0d9b562dedd791fd3ec5f869199736d11501390675b9003c4701b1f0354ce2477808ce23c8e565749df339b79858efcd57b86c
+  data.tar.gz: d5cd47670bef6e30fb0f4764e7c4c509aa21083edc8afd44aaffce076f2caad9d90dd0b2c67d0b96bd2816b2702b75a9fab5f0e4fc3b8e42b8a1998fc3dd8bd3

data/app/controllers/lti_provider/lti_controller.rb

@@ -4,9 +4,18 @@ require 'colorize'
 module LtiProvider
   class LtiController < LtiProvider::LtiApplicationController
     skip_before_action :require_lti_launch
+    skip_before_action :verify_authenticity_token, only: :launch, if: :digital_library?
 
     def launch
-      provider = IMS::LTI::ToolProvider.new(params['oauth_consumer_key'], LtiProvider::Config.secret, params)
+      tool_key = params['oauth_consumer_key']
+      if canvas_url_domain && ToolLtiKey.table_exists?
+        tool_lti_key = ToolLtiKey.where(key: tool_key).where('lower(canvas_url) LIKE :q', q: "%#{canvas_url_domain.downcase}%" ).first
+        tool_secret = tool_lti_key&.secret or LtiProvider::Config.secret
+      else
+        tool_secret = LtiProvider::Config.secret
+      end
+      
+      provider = IMS::LTI::ToolProvider.new(tool_key, tool_secret, params)
       launch = Launch.initialize_from_request(provider, request)
 
       if !launch.valid_provider?
@@ -14,7 +23,6 @@ module LtiProvider
         return show_error msg
       elsif launch.save
         session[:cookie_test] = true
-
         ### QALAM ###
         if params[:timetable_date] && params[:section_room]
           redirect_to cookie_test_path(nonce: launch.nonce, timetable_date: params[:timetable_date], section_room: params[:section_room])
@@ -23,26 +31,34 @@ module LtiProvider
         end
         ### END ###
       else
-        return show_error "Unable to launch #{LtiProvider::XmlConfig.tool_title}. Please check your External Tools configuration and try again."
+        # if params[:qalam_url] && params[:launch_tool] == 'digital_library'
+        #   redirect_to main_app.root_path and return 
+        # else
+          return show_error "Unable to launch #{LtiProvider::XmlConfig.tool_title}. Please check your External Tools configuration and try again."
+        # end
       end
     end
 
     def cookie_test
+      @launch = Launch.where("created_at > ?", 5.minutes.ago).find_by_nonce(params[:nonce])
+
       if session[:cookie_test]
         # success!!! we've got a session!
         consume_launch
       else
-        render
+        # if @launch.launch_tool && @launch.launch_tool == 'digital_library'
+        #   redirect_to main_app.root_path and return 
+        # else
+          render and return
+        # end
       end
     end
 
     def consume_launch
-      launch = Launch.where("created_at > ?", 5.minutes.ago).find_by_nonce(params[:nonce])
-
-      if launch
+      if @launch
         [:account_id, :course_name, :course_id, :canvas_url, :tool_consumer_instance_guid,
          :user_id, :user_name, :user_roles, :user_avatar_url, :launch_tool].each do |attribute|
-          session[attribute] = launch.public_send(attribute)
+          session[attribute] = @launch.public_send(attribute)
         end
 
         ### QALAM ###
@@ -52,11 +68,19 @@ module LtiProvider
         end
         ### END ###
         
-        launch.destroy
+        @launch.destroy
 
-        redirect_to main_app.root_path
+        # if @launch.launch_tool && @launch.launch_tool == 'digital_library'
+        #   redirect_to main_app.root_path and return 
+        # else
+          redirect_to main_app.root_path and return
+        # end
       else
-        return show_error "The tool was not launched successfully. Please try again."
+        # if @launch.launch_tool && @launch.launch_tool == 'digital_library'
+        #   redirect_to main_app.root_path and return 
+        # else
+          return show_error "The tool was not launched successfully. Please try again."
+        # end
       end
     end
 
@@ -72,5 +96,19 @@ module LtiProvider
       def show_error(message)
         render plain: message
       end
+
+    private
+      def canvas_url_domain
+        if params['launch_presentation_return_url']
+          uri = URI.parse(params['launch_presentation_return_url'])
+          domain = "#{uri.scheme}://#{uri.host}"
+          domain += ":#{uri.port}" unless uri.port.nil? || [80, 443].include?(uri.port.to_i)
+          return domain
+        end
+      end
+
+      def digital_library? 
+        session[:qalam_url] ? true : false
+      end
   end
 end

data/app/models/tool_lti_key.rb

@@ -0,0 +1,4 @@
+class ToolLtiKey < ApplicationRecord
+    validates :canvas_url, :secret, presence: true
+    validates :key, presence: true, :uniqueness => {:scope=>:canvas_url}
+end

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

@@ -1,12 +1,14 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>LtiProvider</title>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>
+  <head>
+    <title>QalamLtiProvider</title>
+    <%= csrf_meta_tags %>
+    <meta name="description" content="About QalamLtiProvider">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/db/migrate/20210809101126_create_tool_lti_keys.rb

@@ -0,0 +1,11 @@
+class CreateToolLtiKeys < ActiveRecord::Migration[6.0]
+  def change
+    create_table :tool_lti_keys do |t|
+      t.string :key
+      t.string :secret
+      t.string :canvas_url
+
+      t.timestamps
+    end
+  end
+end

data/lib/lti_provider/lti_application.rb

@@ -12,8 +12,13 @@ module LtiProvider
     protected
     def require_lti_launch
       if canvas_url.blank? || user_id.blank?
-        reset_session
-        prompt_for_launch
+        if session[:qalam_url]
+          reset_session
+          prompt_for_launch_authorized
+        else
+          reset_session
+          prompt_for_launch
+        end
       end
     end
 
@@ -21,6 +26,10 @@ module LtiProvider
       render plain: 'Please launch this tool from Qalam and then try again.'
     end
 
+    def prompt_for_launch_authorized
+      render plain: 'You need to be login on Qalam.'
+    end
+
     def canvas_url
       session[:canvas_url]
     end
@@ -59,19 +68,19 @@ module LtiProvider
     end
 
     def student_launch?
-      user_roles.split(',').include? 'urn:lti:role:ims/lis/Learner'
+      user_roles&.split(',')&.include? 'urn:lti:role:ims/lis/Learner'
     end
 
     def teacher_launch?
-      user_roles.split(',').include? 'urn:lti:role:ims/lis/Instructor'
+      user_roles&.split(',')&.include? 'urn:lti:role:ims/lis/Instructor'
     end
 
     def account_admin_launch?
-      user_roles.split(',').include? 'urn:lti:instrole:ims/lis/Administrator'
+      user_roles&.split(',')&.include? 'urn:lti:instrole:ims/lis/Administrator'
     end
 
     def root_admin_launch?
-      user_roles.split(',').include? 'urn:lti:sysrole:ims/lis/SysAdmin'
+      user_roles&.split(',')&.include? 'urn:lti:sysrole:ims/lis/SysAdmin'
     end
     ### END ###
 
@@ -79,4 +88,4 @@ module LtiProvider
       render plain: "Unable to process request", status: 406
     end
   end
-end
+end

data/lib/lti_provider/lti_config.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'colorize'
 
 module LtiProvider
   module LtiConfig
@@ -13,12 +14,12 @@ module LtiProvider
     def self.setup!
       config = LtiProvider::Config
       if File.exists?(config_file)
-        Rails.logger.info "Initializing LTI key and secret using configuration in #{config_file}"
+        Rails.logger.info "Initializing LTI key and secret using configuration in #{config_file}".green
         load_config.each do |k,v|
           config.send("#{k}=", v)
         end
       elsif ENV['LTI_KEY'].present? && ENV['LTI_SECRET'].present?
-        Rails.logger.info "Initializing LTI key and secret using environment vars LTI_KEY and LTI_SECRET"
+        Rails.logger.info "Initializing LTI key and secret using environment vars LTI_KEY and LTI_SECRET".green
         config.key = ENV['LTI_KEY']
         config.secret = ENV['LTI_SECRET']
         config.require_canvas = !!ENV['LTI_REQUIRE_CANVAS']

data/lib/lti_provider/lti_xml_config.rb

@@ -1,3 +1,6 @@
+require 'yaml'
+require 'colorize'
+
 module LtiProvider
   module LtiXmlConfig
     def self.load_config
@@ -11,7 +14,7 @@ module LtiProvider
     def self.setup!
       config = LtiProvider::XmlConfig
       if File.exists?(config_file)
-        Rails.logger.info "Initializing LTI XML config using configuration in #{config_file}"
+        Rails.logger.info "Initializing LTI XML config using configuration in #{config_file}".green
         load_config.each do |k,v|
           config.send("#{k}=", v)
         end

data/lib/lti_provider/version.rb

@@ -1,3 +1,3 @@
 module LtiProvider
-  VERSION = "2.0.6"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qalam_lti_provider_engine
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.1.0
 platform: ruby
 authors:
 - Dave Donahue
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -47,6 +47,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -245,12 +259,14 @@ files:
 - app/controllers/lti_provider/lti_application_controller.rb
 - app/controllers/lti_provider/lti_controller.rb
 - app/models/lti_provider/launch.rb
+- app/models/tool_lti_key.rb
 - app/views/layouts/lti_provider/application.html.erb
 - app/views/lti_provider/lti/cookie_test.html.erb
 - config/lti.yml.example
 - config/lti_xml.yml.example
 - config/routes.rb
 - db/migrate/20130319050003_create_lti_provider_launches.rb
+- db/migrate/20210809101126_create_tool_lti_keys.rb
 - lib/lti_provider.rb
 - lib/lti_provider/config.rb
 - lib/lti_provider/engine.rb
@@ -312,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: LtiProvider is a mountable engine for handling the LTI launch and exposing