panda_pal 5.3.7 → 5.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e3454f04c4cbf7a07dc7a041118bb3b60db681c531ebf228115de69f1114d50
-  data.tar.gz: bc600d9940213278b6a0b9e908df51c24012a75ac120746758719faa91e8abbc
+  metadata.gz: c8eb58ee2c4df4d91c08b20c3ea717a1227ebbc212500b6f5a0abad01855fd8c
+  data.tar.gz: ba0b60f6ee46634a554ac779b6cadf671edb922bc33201ac762de4fa9263ec45
 SHA512:
-  metadata.gz: 507728d1f3dbe751125f4bd7fbda5a2245c20eee20ea8d446f12d5b701007ab1fbee5cfe81d741d400966db2f526d484e4f8ffde1c82f5db43a1e685f96362cc
-  data.tar.gz: c97afd8ec0a896f46a5b63a6eb8d9b9f13d31d995d448d29800f88f23c6fd4897877e7958e54d5d47e23dab04277c1eba7c73b852dc61704d197f3ec47ed27aa
+  metadata.gz: 1337a89241f5a12bc0f5d202197f17f6ea4478be3e44786e68cd2b2161fc8df0cc2338418c4cdacbaa99cb1ec9e07a06446bac3a9a9a965285f35b4cbdce91cb
+  data.tar.gz: 83c6c892aad41adc5fd7ec2709dd8f5b5a70c238764b9caad989f5a2021ee92d81c64ac05e6ce7a3e72d321d2abfa8b1aba3b1298b2225fff4d476b57d4bd3c6

data/README.md

@@ -93,10 +93,22 @@ The following routes should be added to the routes.rb file of the implementing L
 ```ruby
 # config/routes.rb
 mount PandaPal::Engine, at: '/lti'
-lti_nav account_navigation: 'accounts#launch' # Use lti_nav to provide a custom Launch implementation, otherwise use the url: param of stage_navigation to let PandaPal handle launch.
 root to: 'panda_pal/lti#launch'
+
+# Add Launch Endpoints:
+lti_nav account_navigation: 'accounts#launch', auto_launch: false # (LTI <1.3 Default)
+# -- OR --
+scope '/organizations/:organization_id' do
+  lti_nav account_navigation: 'accounts#launch_landing', auto_launch: true # (LTI 1.3 Default)
+  lti_nav account_navigation: 'accounts#launch_landing' # Automatically sets auto_launch to true because :organization_id is part of the path
+  # ...
+end
 ```
 
+`auto_launch`: Setting to `true` will tell PandaPal to handle all of the launch details and session creation, and then pass off to
+the defined action. Setting it to `false` indicates that the defined action handles launch validation and setup itself (this has been the legacy approach).
+Because `auto_launch: false` is most similar to the previous behavior, it is the default for LTI 1.0/1.1 LTIs. For LTI 1.3 LTIs, `auto_launch: true` is the default. If not specified and `:organization_id` is detected in the Route Path, `auto_launch` will be set to `true`
+
 ## Implementating data segregation
 This engine uses Apartment to keep data segregated between installations of the implementing LTI tool.
 By default, it does this by inspecting the path of the request, and matching URLs containing `orgs` or `organizations`,

data/app/controllers/panda_pal/lti_v1_p3_controller.rb

@@ -58,7 +58,12 @@ module PandaPal
         opts = LaunchUrlHelpers.normalize_lti_launch_desc(opts)
         opts.merge!({
           placement: k,
-          target_link_uri: LaunchUrlHelpers.absolute_launch_url(k.to_sym, host: parsed_request_url, launch_handler: v1p3_resource_link_request_path),
+          target_link_uri: LaunchUrlHelpers.absolute_launch_url(
+            k.to_sym,
+            host: parsed_request_url,
+            launch_handler: v1p3_resource_link_request_path,
+            default_auto_launch: true
+          ),
         })
         opts
       end

data/app/lib/lti_xml/base_platform.rb

@@ -86,7 +86,12 @@ module LtiXml
 
     def ext_params(options, k)
       options = PandaPal::LaunchUrlHelpers.normalize_lti_launch_desc(options)
-      options[:url] = PandaPal::LaunchUrlHelpers.absolute_launch_url(k.to_sym, host: parsed_request_url, launch_handler: nil)
+      options[:url] = PandaPal::LaunchUrlHelpers.absolute_launch_url(
+        k.to_sym,
+        host: parsed_request_url,
+        launch_handler: :v1p0_launch_path,
+        default_auto_launch: false
+      )
       options
     end
   end

data/app/lib/panda_pal/batch_processor.rb

@@ -0,0 +1,41 @@
+module PandaPal
+  # An array that "processes" after so many items are added.
+  #
+  # Example Usage:
+  #   batches = BatchProcessor.new(of: 1000) do |batch|
+  #     # Process the batch somehow
+  #   end
+  #   enumerator_of_some_kind.each { |item| batches << item }
+  #   batches.flush
+  class BatchProcessor
+    attr_reader :batch_size
+
+    def initialize(of: 1000, &blk)
+      @batch_size = of
+      @block = blk
+      @current_batch = []
+    end
+
+    def <<(item)
+      @current_batch << item
+      process_batch if @current_batch.count >= batch_size
+    end
+
+    def add_all(items)
+      items.each do |i|
+        self << i
+      end
+    end
+
+    def flush
+      process_batch if @current_batch.present?
+    end
+
+    protected
+
+    def process_batch
+      @block.call(@current_batch)
+      @current_batch = []
+    end
+  end
+end

data/app/lib/panda_pal/launch_url_helpers.rb

@@ -1,25 +1,26 @@
 module PandaPal
   module LaunchUrlHelpers
-    def self.absolute_launch_url(launch_type, host:, launch_handler: nil)
+    def self.absolute_launch_url(launch_type, host:, launch_handler: nil, default_auto_launch: false)
       opts = PandaPal.lti_paths[launch_type]
-      is_direct = opts[:no_redirect] || !launch_handler.present?
+      auto_launch = opts[:auto_launch] != nil ? opts[:auto_launch] : default_auto_launch
+      auto_launch = auto_launch && launch_handler.present?
 
-      if is_direct
-        final_url = launch_url(opts, launch_type: launch_type)
-        return final_url if URI.parse(final_url).absolute?
-        return [host.to_s, final_url].join
-      else
+      if auto_launch
         launch_handler = resolve_route(launch_handler) if launch_handler.is_a?(Symbol)
         return add_url_params([host.to_s, launch_handler].join, {
           launch_type: launch_type,
         })
+      else
+        final_url = launch_url(opts, launch_type: launch_type)
+        return final_url if URI.parse(final_url).absolute?
+        return [host.to_s, final_url].join
       end
     end
 
     def self.normalize_lti_launch_desc(opts)
       opts = opts.dup
       opts.delete(:route_helper_key)
-      opts.delete(:no_redirect)
+      opts.delete(:auto_launch)
       opts
     end
 

data/app/models/panda_pal/organization_concerns/settings_validation.rb

@@ -8,8 +8,16 @@ module PandaPal
       end
 
       class_methods do
+        def define_setting(*args, &blk)
+          @_injected_settings_definitions ||= []
+          @_injected_settings_definitions << {
+            args: args,
+            block: blk,
+          }
+        end
+
         def settings_structure
-          if PandaPal.lti_options&.[](:settings_structure).present?
+          struc = if PandaPal.lti_options&.[](:settings_structure).present?
             normalize_settings_structure(PandaPal.lti_options[:settings_structure])
           else
             {
@@ -18,6 +26,32 @@ module PandaPal
               properties: {},
             }
           end
+
+          (@_injected_settings_definitions || []).each do |sub|
+            args = [*sub[:args]]
+            path = args.shift || []
+            path = path.split('.') if path.is_a?(String)
+            path = Array(path)
+
+            if path.present?
+              key = path.pop
+
+              root = struc
+              path.each do |p|
+                root = root[:properties][p.to_sym]
+              end
+
+              if sub[:block]
+                root[:properties][key.to_sym] = sub[:block].call
+              else
+                root[:properties][key.to_sym] = args.shift
+              end
+            else
+              sub[:block].call(struc)
+            end
+          end
+
+          struc
         end
 
         def normalize_settings_structure(struc)
@@ -69,7 +103,7 @@ module PandaPal
           any_match = norm_types.any? do |t|
             if t == 'Boolean'
               settings == true || settings == false
-            else
+            elsif t.is_a?(Class)
               settings.is_a?(t)
             end
           end

data/app/models/panda_pal/organization_concerns/task_scheduling.rb

@@ -11,6 +11,31 @@ module PandaPal
       included do
         after_commit :sync_schedule, on: [:create, :update]
         after_commit :unschedule_tasks, on: :destroy
+
+        define_setting do |struc|
+          next unless _schedule_descriptors.present?
+
+          struc[:properties][:timezone] ||= {
+            type: 'String',
+            required: false,
+            validate: ->(timezone, *args) {
+              ActiveSupport::TimeZone[timezone].present? ? nil : "<path> Invalid Timezone '#{timezone}'"
+            },
+          }
+
+          struc[:properties][:task_schedules] = {
+            type: 'Hash',
+            required: false,
+            properties: _schedule_descriptors.keys.reduce({}) do |hash, k|
+              desc = _schedule_descriptors[k]
+
+              hash.tap do |hash|
+                kl = ' ' * (k.to_s.length - 4)
+                hash[k.to_sym] = hash[k.to_s] = PandaPal::OrganizationConcerns::TaskScheduling.build_settings_entry(desc)
+              end
+            end,
+          }
+        end
       end
 
       class_methods do
@@ -18,69 +43,6 @@ module PandaPal
           @_schedule_descriptors ||= {}
         end
 
-        def settings_structure
-          return super unless _schedule_descriptors.present?
-
-          super.tap do |struc|
-            struc[:properties] ||= {}
-
-            struc[:properties][:timezone] ||= {
-              type: 'String',
-              required: false,
-              validate: ->(timezone, *args) {
-                ActiveSupport::TimeZone[timezone].present? ? nil : "<path> Invalid Timezone '#{timezone}'"
-              },
-            }
-
-            struc[:properties][:task_schedules] = {
-              type: 'Hash',
-              required: false,
-              properties: _schedule_descriptors.keys.reduce({}) do |hash, k|
-                desc = _schedule_descriptors[k]
-
-                hash.tap do |hash|
-                  kl = ' ' * (k.to_s.length - 4)
-                  hash[k.to_sym] = hash[k.to_s] = {
-                    required: false,
-                    description: <<~MARKDOWN,
-                      Override schedule for '#{k.to_s}' task.
-
-                      **Default**: #{desc[:schedule].is_a?(String) ? desc[:schedule] : '<Computed>'}
-
-                      Set to `false` to disable or supply a Cron string:
-                      ```yaml
-                      #{k.to_s}: 0 0 0 * * * America/Denver
-                      ##{kl}     │ │ │ │ │ │ └── Timezone (Optional)
-                      ##{kl}     │ │ │ │ │ └── Day of Week
-                      ##{kl}     │ │ │ │ └── Month
-                      ##{kl}     │ │ │ └── Day of Month
-                      ##{kl}     │ │ └── Hour
-                      ##{kl}     │ └── Minute
-                      ##{kl}     └── Second (Optional)
-                      ````
-                    MARKDOWN
-                    json_schema: {
-                      oneOf: [
-                        { type: 'string', pattern: '^((((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|\*) ?){5,6})(\w+\/\w+)?$' },
-                        { enum: [false] },
-                      ],
-                      default: desc[:schedule].is_a?(String) ? desc[:schedule] : '0 0 3 * * * America/Denver',
-                    },
-                    validate: ->(value, *args, errors:, **kwargs) {
-                      begin
-                        Rufus::Scheduler.parse(value) if value
-                        nil
-                      rescue ArgumentError
-                        errors << "<path> must be false or a Crontab string"
-                      end
-                    }
-                  }
-                end
-              end,
-            }
-          end
-        end
-
         def scheduled_task(cron_time, name_or_method = nil, worker: nil, queue: nil, &block)
           task_key = (name_or_method.presence || "scheduled_task_#{caller_locations[0].lineno}").to_s
           raise "Task key '#{task_key}' already taken!" if _schedule_descriptors.key?(task_key)
@@ -137,6 +99,51 @@ module PandaPal
         end
       end
 
+      def self.build_settings_entry(desc)
+        k = desc[:key]
+        kl = ' ' * (k.to_s.length - 4)
+
+        default_schedule = '<Computed>'
+        default_schedule = desc[:schedule] if desc[:schedule].is_a?(String)
+        default_schedule = '<Disabled>' unless desc[:schedule].present?
+
+        {
+          required: false,
+          description: <<~MARKDOWN,
+            Override schedule for '#{k.to_s}' task.
+
+            **Default**: #{default_schedule}
+
+            Set to `false` to disable or supply a Cron string:
+            ```yaml
+            #{k.to_s}: 0 0 0 * * * America/Denver
+            ##{kl}     │ │ │ │ │ │ └── Timezone (Optional)
+            ##{kl}     │ │ │ │ │ └── Day of Week
+            ##{kl}     │ │ │ │ └── Month
+            ##{kl}     │ │ │ └── Day of Month
+            ##{kl}     │ │ └── Hour
+            ##{kl}     │ └── Minute
+            ##{kl}     └── Second (Optional)
+            ````
+          MARKDOWN
+          json_schema: {
+            oneOf: [
+              { type: 'string', pattern: '^((((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|\*) ?){5,6})(\w+\/\w+)?$' },
+              { enum: [false] },
+            ],
+            default: desc[:schedule].is_a?(String) ? desc[:schedule] : '0 0 3 * * * America/Denver',
+          },
+          validate: ->(value, *args, errors:, **kwargs) {
+            begin
+              Rufus::Scheduler.parse(value) if value
+              nil
+            rescue ArgumentError
+              errors << "<path> must be false or a Crontab string"
+            end
+          }
+        }
+      end
+
       private
 
       def unschedule_tasks(new_task_keys = nil)
@@ -157,13 +164,17 @@ module PandaPal
         return nil unless cron_time.present?
 
         cron_time = instance_exec(&cron_time) if cron_time.is_a?(Proc)
-        if !Rufus::Scheduler.parse(cron_time).zone.present? && settings && settings[:timezone]
-          cron_time += " #{settings[:timezone]}"
+        if !Rufus::Scheduler.parse(cron_time).zone.present? && settings && settings_timezone
+          cron_time += " #{settings_timezone}"
         end
 
         cron_time
       end
 
+      def settings_timezone
+        settings[:timezone] || settings.dig(:canvas, :root_account_timezone).presence || nil
+      end
+
       class ScheduledTaskExecutor
         include Sidekiq::Worker
 

data/config/initializers/apartment.rb

@@ -10,8 +10,10 @@ Apartment.configure do |config|
 end
 
 Rails.application.config.middleware.use Apartment::Elevators::Generic, lambda { |request|
-  if match = request.path.match(/\/(?:orgs|organizations)\/(\d+)/)
+  if match = request.path.match(/\/(?:orgs?|organizations?)\/(\d+)/)
     PandaPal::Organization.find_by(id: match[1]).try(:name)
+  elsif request.path.starts_with?('/rails/active_storage/blobs/')
+    PandaPal::Organization.find_by(id: request.params['organization_id']).try(:name)
   end
 }
 

data/config/routes.rb

@@ -3,6 +3,7 @@ PandaPal::Engine.routes.draw do
 
   scope '/v1p0', as: 'v1p0' do
     get '/config' => 'lti_v1_p0#tool_config'
+    post '/launch' => 'lti_v1_p0#launch'
   end
 
   scope '/v1p3', as: 'v1p3' do

data/db/migrate/20171205194657_remove_old_organization_settings.rb

@@ -19,7 +19,6 @@ class RemoveOldOrganizationSettings < PandaPal::MiscHelper::MigrationClass
       #PandaPal::Organization.reset_column_information
       PandaPal::Organization.find_each do |o|
         # Would like to just be able to do this:
-        # PandaPal::Organization.reset_column_information
         # o.settings = YAML.load(o.old_settings)
         # o.save!
         # but for some reason that is always making the settings null.  Instead we will encrypt the settings manually.

data/lib/panda_pal/engine.rb

@@ -24,6 +24,14 @@ module PandaPal
       end
     end
 
+    initializer 'Sidekiq Scheduler Hooks' do
+      ActiveSupport.on_load(:active_record) do
+        if Sidekiq.server? && PandaPal::Organization.respond_to?(:sync_schedules)
+          PandaPal::Organization.sync_schedules
+        end
+      end
+    end
+
     initializer 'panda_pal.app_controller' do |app|
       OAUTH_10_SUPPORT = true
       ActiveSupport.on_load(:action_controller) do

data/lib/panda_pal/helpers/controller_helper.rb

@@ -39,7 +39,11 @@ module PandaPal::Helpers
 
     def validate_v1p0_launch
       authorized = false
-      if @organization = params['oauth_consumer_key'] && PandaPal::Organization.find_by_key(params['oauth_consumer_key'])
+      # We should verify the timestamp is recent (within 5 minutes).  The approved timestamp is part of the signature,
+      # so we don't need to worry about malicious users messing with it.  We should deny requests that come too long
+      # after the approved timestamp.  
+      good_timestamp = params['oauth_timestamp'] && params['oauth_timestamp'].to_i > Time.now.to_i - 300
+      if @organization = good_timestamp && params['oauth_consumer_key'] && PandaPal::Organization.find_by_key(params['oauth_consumer_key'])
         sanitized_params = request.request_parameters
         # These params come over with a safari-workaround launch.  The authenticator doesn't like them, so clean them out.
         safe_unexpected_params = ["full_win_launch_requested", "platform_redirect_url", "dummy_param"]

data/lib/panda_pal/helpers/route_helper.rb

@@ -9,7 +9,12 @@ module PandaPal::Helpers::RouteHelper
     path = "#{base_path}/#{nav.to_s}"
 
     lti_options = options.delete(:lti_options) || {}
-    lti_options[:no_redirect] = options.delete(:no_redirect)
+    lti_options[:auto_launch] = options.delete(:auto_launch)
+
+    if lti_options[:auto_launch].nil?
+      lti_options[:auto_launch] = (@scope[:path] || '').include?(':organization_id')
+    end
+
     lti_options[:route_helper_key] = path.split('/').reject(&:empty?).join('_')
     post(path, options.dup, &block)
     get(path, options.dup, &block)