panda_pal 5.4.0.beta1 → 5.4.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46890814bf0be5add6c0db17248c08bbc756bd7bdbdd4eb1ef52a23494bfcf1f
-  data.tar.gz: a76de9599bd0ca52b4488814e2d5d03bffde6bb94c1614f3e45e886bd001d55a
+  metadata.gz: 2ad739feb20cd4db69778441ccc21256211d3a8715b1ea82921a9786ed1d6f44
+  data.tar.gz: 6d0e6927cd23b2a56336a0a9e3dbfda787cb59415c13d1fc4eb316e1c87c400c
 SHA512:
-  metadata.gz: 7d8640b016ca32a5d1c9d57f4abb7380e2d41f0035f138b2e6fb61155a0e6dec93be6601bdf607303606b5a8d0f3901dafa04424e09f66a942952980c3c2959d
-  data.tar.gz: 6ae5fbd00abad5e6387ad87226f533c8a1c73561865341d16f821c71eadff43e685643387f8d0745606b3d688965dd9a22d12b060aef735385d662b90cafa692
+  metadata.gz: 9389b4e09c6fb0c270c7cb1c641bbe4cdc010b9084b51519100dfdf9cd4c103e36a8f0d86819d6619e2dc27f42afa52d214c7936c75c120ce6c994ca30ce1e21
+  data.tar.gz: 4fe4207ca646e48c6d13dfe7b259d306066b812b3a1502fb866f0501cffcb43dc4e935c8cd3ad198980d16582125441e5eb11c94601d6a3f3cad12e60c900c5e

data/app/assets/config/panda_pal_manifest.js

@@ -0,0 +1,3 @@
+// link_tree ../images/panda_pal
+//= link_directory ../javascripts/panda_pal .js
+//= link_directory ../stylesheets/panda_pal .css

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/task_scheduling.rb

@@ -1,4 +1,17 @@
-return unless defined?(Sidekiq.schedule)
+unless defined?(Sidekiq.schedule)
+  module PandaPal
+    module OrganizationConcerns
+      module TaskScheduling
+        extend ActiveSupport::Concern
+
+        included do
+          raise "The PandaPal TaskScheduling requires Sidekiq-scheduler to be installed"
+        end
+      end
+    end
+  end
+  return
+end
 
 require_relative 'settings_validation'
 

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

@@ -65,6 +65,10 @@ module PandaPal
       end
     end
 
+    initializer "panda_pal.assets.precompile" do |app|
+      app.config.assets.precompile << "panda_pal_manifest.js"
+    end
+
     initializer :secure_headers do |app|
       begin
         ::SecureHeaders::Configuration.default do |config|

data/lib/panda_pal/helpers/session_replacement.rb

@@ -13,11 +13,15 @@ module PandaPal::Helpers
     end
 
     class_methods do
-      def link_nonce_type(value = :not_given)
-        if value == :not_given
-          @link_nonce_type || superclass.try(:link_nonce_type) || :nonce
+      def link_nonce_type(value = :not_given, use_non_app: false)
+        if use_non_app || !defined?(::ApplicationController) || self <= ::ApplicationController
+          if value == :not_given
+            @link_nonce_type || superclass.try(:link_nonce_type) || :nonce
+          else
+            @link_nonce_type = value
+          end
         else
-          @link_nonce_type = value
+          ::ApplicationController.link_nonce_type(value, use_non_app: true)
         end
       end
     end

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.4.0.beta1"
+  VERSION = "5.4.0.beta6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.4.0.beta1
+  version: 5.4.0.beta6
 platform: ruby
 authors:
 - Instructure ProServe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -208,6 +208,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/config/panda_pal_manifest.js
 - app/assets/javascripts/panda_pal/application.js
 - app/assets/javascripts/panda_pal/lti.js
 - app/assets/stylesheets/panda_pal/application.css
@@ -243,12 +244,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