panda_pal 5.3.10 → 5.4.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42e9ffbf3704935100156e28b5d3f2490fba75a5974b352f0092c14bb8b87ffb
-  data.tar.gz: 5d511a85fe356dfe659ecaacfc7023315f649947ff483c6969e253802549e825
+  metadata.gz: 711da479bf7e495d72287d508109c520c7c0dd0fba08d67b4f746853ac20b535
+  data.tar.gz: d18ae002b72f96f88213245ca18fc4d756cbf896de87b623cb02d44686c2e1fd
 SHA512:
-  metadata.gz: a4d2a7242e203c4c86866ff7efb3ba211c2b3b7f41463b776785371e06997470fdee569ed4e4ba0025a7eef6198bb067e1fdf71fc8b7c9307bf26c1d343de7db
-  data.tar.gz: 7c3f0facf0767b7afea02ad0368bf6a0d79c8522109289e463a95719cd7f3762a34b5ad641499ff96871815f2db1ec76f192dd6221936d3af2586399a402bf1f
+  metadata.gz: 7257fd004deacbc44fdf45818a85cc5c8294587003679f84e9f144288ee75680bdd1478b55b63839e30d4f1df587d9f8c69261ad143aa327aab49a8370df8a70
+  data.tar.gz: b8d09741fc6743ec3a2eff3b8f4ba68f3205afd574dd17ed596fb331f6b98e31aba8e24a615a34f59a2fa498e07051fd5f2776ade4edea5f83544a3e5667546c

data/app/lib/lti_xml/base_platform.rb

@@ -42,7 +42,7 @@ module LtiXml
       else
         ims_lti_config[:launch_url] = parsed_request_url.host
       end
-      @tc = IMS::LTI::Services::ToolConfig.new(ims_lti_config)
+      @tc = IMS::LTI::ToolConfig.new(ims_lti_config)
     end
 
     def add_domain

data/app/models/panda_pal/organization.rb

@@ -1,3 +1,6 @@
+require_relative './organization_concerns/settings_validation'
+require_relative './organization_concerns/task_scheduling'
+
 module PandaPal
   module OrganizationConcerns; 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,35 +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] = PandaPal::OrganizationConcerns::TaskScheduling.build_settings_entry(desc)
-                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)
@@ -168,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,10 +10,10 @@ Apartment.configure do |config|
 end
 
 Rails.application.config.middleware.use Apartment::Elevators::Generic, lambda { |request|
-  if request.path.starts_with?('/rails/active_storage/blobs/')
-    PandaPal::Organization.find_by(id: request.params['organization_id']).try(:name)
-  elsif 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/lib/panda_pal.rb

@@ -1,6 +1,8 @@
 require "panda_pal/engine"
 require 'panda_pal/plugins'
 require 'panda_pal/helpers'
+require 'oauth/request_proxy/rack_request'
+require 'oauth/request_proxy/action_dispatch_request'
 
 module PandaPal
   class LtiNavigationInUse < StandardError;end

data/lib/panda_pal/ability_mixin.rb

@@ -0,0 +1,85 @@
+module PandaPal
+  module AbilityMixin
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def self.role_permissions(labels)
+        roles = find_roles_by_label(labels)
+
+        if Rails.env.test? && roles.count == 0 && (labels || []).include?('Administrator')
+          return Hash.new(true)
+        end
+
+        final = {}
+        roles.find_each do |role|
+          role.permissions.each do |perm_name, perm|
+            final[perm_name] = false if final[perm_name].nil?
+            final[perm_name] = true if perm['enabled'] == true
+          end
+        end
+        final
+      end
+
+      def self.find_roles_by_label(labels)
+        raise "PandaPal AbilityMixin's support for Roles and Permissions requires that Roles be synced by CanvasSync" unless defined?(Role)
+
+        built_ins = []
+        labels = labels.split(',') if labels.is_a?(String)
+        custom_labels = Array(labels).reject do |l|
+          if role_is_default?(l)
+            built_ins << l
+          elsif l == 'Account Admin'
+            built_ins << 'AccountMembership'
+          else
+            next
+          end
+          true
+        end
+        Role.where(workflow_state: 'built_in', base_role_type: built_ins)
+            .or(Role.where.not(workflow_state: 'built_in').where(label: custom_labels))
+      end
+
+      def self.role_is_default?(role)
+        %w[TeacherEnrollment TaEnrollment StudentEnrollment DesignerEnrollment ObserverEnrollment].include? role
+      end
+    end
+
+    def is_lti_launch?
+      @controller.current_session.present?
+    end
+
+    def panda_pal_session
+      @panda_pal_session ||= @controller.current_session&.data || {}
+    end
+
+    def rails_session
+      @rails_session ||= @controller.session
+    end
+
+    def launch_params
+      @launch_params ||= panda_pal_session[:launch_params] || {}
+    end
+
+    # Roles and Permissions
+    def lti_roles
+      @lti_roles ||= LTIRoles::RoleManager.new(launch_params['ext_roles'] || '')
+    end
+
+    def canvas_permissions
+      panda_pal_session[:canvas_permissions] ||= self.class.role_permissions(launch_params['custom_canvas_role'])
+    end
+
+    def canvas_role_labels
+      labels = launch_params['custom_canvas_role']
+      labels.is_a?(String) ? labels.split(',') : []
+    end
+
+    def canvas_roles
+      self.class.find_roles_by_label(canvas_role_labels)
+    end
+
+    def launch_role_ids
+      panda_pal_session[:launch_role_ids] ||= canvas_roles.map(&:canvas_id)
+    end
+  end
+end

data/lib/panda_pal/engine.rb

@@ -24,6 +24,29 @@ module PandaPal
       end
     end
 
+    initializer 'interop dependencies' do
+      if $LOADED_FEATURES.grep(/\/ros-apartment-\d/).present?
+        if $LOADED_FEATURES.grep(/\/apartment-\d/).present? || $LOADED_FEATURES.grep(/\/apartment-sidekiq-\d/).present?
+          raise "ros-apartment is used, but apartment or apartment-sidekiq is loaded. Do not mix legacy and ros- variants! (You most likely need to update your Gemfile to use the ros- variant)"
+        end
+      end
+      if defined?(Sidekiq)
+        begin
+          require 'apartment-sidekiq'
+        rescue LoadError
+          raise "Sidekiq is used, but apartment-sidekiq is not installed. Add [gem 'ros-apartment-sidekiq'] to your Gemfile"
+        end
+      end
+    end
+
+    initializer 'Sidekiq Scheduler Hooks' do
+      ActiveSupport.on_load(:active_record) do
+        if defined?(Sidekiq) && 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

@@ -50,8 +50,8 @@ module PandaPal::Helpers
         safe_unexpected_params.each do |p|
           sanitized_params.delete(p)
         end
-        authenticator = IMS::LTI::Services::MessageAuthenticator.new(request.original_url, sanitized_params, @organization.secret)
-        authorized = authenticator.valid_signature?
+        tp = IMS::LTI::ToolProvider.new(@organization.key, @organization.secret, sanitized_params)
+        authorized = tp.valid_request?(request)
       end
 
       if !authorized

data/lib/panda_pal/jobs/grade_passback_job.rb

@@ -0,0 +1,50 @@
+module PandaPal::Jobs
+  class MissingGradePassbackParams < StandardError; end
+
+  class GradePassbackFailure < StandardError; end
+
+  class GradePassbackJob < ActiveJob::Base
+    sidekiq_options retry: 5
+
+    attr_accessor :organization, :opts
+
+    # Required values for opts: passback_guid, passback_url, score AND/OR total_score.
+    # Possible values for opts: cdata_text, text, url, submitted_at, lti_launch_url.
+    # passback_guid is sent in launch params as 'lis_result_sourcedid'.
+    # passback_url is sent in LTI launch params as 'lis_outcome_service_url'.
+    # See https://canvas.instructure.com/doc/api/file.assignment_tools.html
+    def perform(organization, opts = {})
+      opts = opts.with_indifferent_access
+      raise MissingGradePassbackParams unless valid_options(opts)
+
+      @organization = organization
+      @opts = opts
+
+      post_to_lms
+    end
+
+    private
+
+    def post_to_lms
+      result = tool_provider.post_extended_replace_result!(opts)
+      unless result.success?
+        Rails.logger.error "Grade passback failure: #{result.response_code} #{result.code_major} #{result.severity} #{result.description}"
+        raise GradePassbackFailure
+      end
+    end
+
+    def tool_provider
+      @tool_provider ||= IMS::LTI::ToolProvider.new(
+        organization.key,
+        organization.secret,
+        'lis_result_sourcedid' => opts[:passback_guid],
+        'lis_outcome_service_url' => opts[:passback_url]
+      ).extend(IMS::LTI::Extensions::OutcomeData::ToolProvider)
+    end
+
+    def valid_options(opts = {})
+      return opts[:passback_guid] && opts[:passback_url] && (opts[:score] || opts[:total_score])
+    end
+
+  end
+end

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.3.10"
+  VERSION = "5.4.0.beta2"
 end

data/panda_pal.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |s|
   s.test_files = Dir["spec/**/*"]
 
   s.add_dependency "rails", ">= 4.2"
+  s.add_dependency 'ros-apartment', '~> 2.2'
   s.add_dependency 'pg', '>= 0.20', '< 1.0.0'
-  s.add_dependency 'apartment', '~> 2.2.0'
-  s.add_dependency 'ims-lti', '~> 2.2.3'
+  s.add_dependency 'ims-lti', '~> 1.2.4'
   s.add_dependency 'browser', '2.5.0'
   s.add_dependency 'attr_encrypted', '~> 3.0.0'
   s.add_dependency 'secure_headers', '~> 6.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.3.10
+  version: 5.4.0.beta2
 platform: ruby
 authors:
 - Instructure ProServe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: ros-apartment
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -44,34 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: apartment
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: ims-lti
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 1.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 1.2.4
 - !ruby/object:Gem::Dependency
   name: browser
   requirement: !ruby/object:Gem::Requirement
@@ -243,12 +243,14 @@ files:
 - db/migrate/20171205183457_encrypt_organization_settings.rb
 - db/migrate/20171205194657_remove_old_organization_settings.rb
 - lib/panda_pal.rb
+- lib/panda_pal/ability_mixin.rb
 - lib/panda_pal/engine.rb
 - lib/panda_pal/helpers.rb
 - lib/panda_pal/helpers/controller_helper.rb
 - lib/panda_pal/helpers/route_helper.rb
 - lib/panda_pal/helpers/secure_headers.rb
 - lib/panda_pal/helpers/session_replacement.rb
+- lib/panda_pal/jobs/grade_passback_job.rb
 - lib/panda_pal/plugins.rb
 - lib/panda_pal/version.rb
 - lib/tasks/panda_pal_tasks.rake
@@ -312,9 +314,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: