panda_pal 5.9.7 → 5.9.8.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 799fa888cac92c1bdd0f8db04306a6ca3eac462f8cf545fa28aa1fee2cd8d2e2
-  data.tar.gz: c52ec2f608302a2c646634691bbe05730455fcec5716493e400f3c2066be2830
+  metadata.gz: 0d130670af8eb3c98ac19c8cf001e4fc69b09d4a0c2c2774537213a3b02f935d
+  data.tar.gz: f2294052c154c0aa7adb89ac5506c028822dc42c90e6167b77799ba9662468a7
 SHA512:
-  metadata.gz: 9c76429c86e9a999aaa90d953175988b86c5af85de9c8021608cd34d911af3bc299f31fe22729c9b91a622749fd2665801de21e34a1076bf11f0be9ec2690090
-  data.tar.gz: 3c0a7d8aab01ebcdc6eb70fcf89a6936cf138fb661634194417ac55961645e0654d65bf2a9264dac7b53652a6eb67afdc1edf0bc83d7611ac7f5781b337cf79d
+  metadata.gz: ca636402af5eb76e8588a9815c3ccd6488096fb8a25f2097663386c2ab5181eb73668a97ffa108589f1760f5e1f7f44531f121f895f171b459fc54cd421e01a2
+  data.tar.gz: 975028818d776f606acd2a599e238229ba19292019549583b506b8a3c4bb930f61a44356a065dd52274eaa8dc5b53d7bf0112fbd53265d2a6b4bc1ddb671cf05

data/app/models/panda_pal/session.rb

@@ -6,15 +6,26 @@ module PandaPal
       self.session_key ||= SecureRandom.urlsafe_base64(60)
     end
 
+    def cache(key, &blk)
+      panda_pal_session[:cache] ||= {}
+      panda_pal_session[:cache][key] ||= blk.call
+    end
+
+    def launch_params
+      data[:launch_params] || {}
+    end
+
     def lti_platform
       return nil unless data[:lti_platform].present?
 
       @lti_platform ||= Platform.from_serialized(data[:lti_platform])
     end
 
-    def custom_lti_params
-      launch_params = data[:launch_params] || {}
+    def lti_launch_placement
+      launch_params['https://www.instructure.com/placement'] || launch_params[:launch_type]
+    end
 
+    def custom_lti_params
       # LT 1.3
       custom_params = launch_params["https://purl.imsglobal.org/spec/lti/claim/custom"]
       return custom_params if custom_params.present?
@@ -29,6 +40,113 @@ module PandaPal
       custom_params.with_indifferent_access
     end
 
+    def get_lti_cust_param(key)
+      nkey = key.to_s.gsub(/^custom_/, '')
+
+      launch_params.dig("https://purl.imsglobal.org/spec/lti/claim/custom", nkey) || launch_params[nkey] || launch_params["custom_#{nkey}"]
+    end
+
+    def canvas_role_labels
+      labels = get_lti_cust_param('custom_canvas_role')
+      labels.is_a?(String) ? labels.split(',') : []
+    end
+
+    def canvas_account_role_labels(account = 'self')
+      account = 'self' if account.to_s == "root"
+      account = account.canvas_id if account.respond_to?(:canvas_id)
+
+      if "::Admin".safe_constantize && ::Admin < ::ActiveRecord::Base
+        account = current_organization.canvas_account_id if account == 'self'
+        adm_query = ::Admin.where(canvas_account_id: account, workflow_state: "active")
+        adm_query.pluck(:role_name)
+      else
+        Rails.cache.fetch([self.class.name, "AccountAdminLinks", account, canvas_user_id], expires_in: 1.hour) do
+          admin_entries = canvas_sync_client.account_admins(account, user_id: [canvas_user_id])
+          admin_entries = admin_entries.select{|ent| ent[:workflow_state] == 'active' }
+          admin_entries.map{|ent| ent[:role] }
+        end
+      end
+    end
+
+    def lti_roles
+      @lti_roles ||= RoleStore.new(launch_params["https://purl.imsglobal.org/spec/lti/claim/roles"] || launch_params['ext_roles'] || '')
+    end
+
+    def canvas_site_admin?
+      lti_roles.system_roles.include?("sys_admin")
+    end
+
+    class RoleStore
+      ContextTypeURN = 'urn:lti:context-type:ims/lis/'.freeze
+
+      ROLE_TYPES = [
+        { type: "system", urn: "urn:lti:sysrole:ims/lis/", url: "http://purl.imsglobal.org/vocab/lis/v2/system/person#" },
+        { type: "institution", urn: "urn:lti:instrole:ims/lis/", url: "http://purl.imsglobal.org/vocab/lis/v2/institution/person#" },
+        { type: "context", urn: "urn:lti:role:ims/lis/", url: "http://purl.imsglobal.org/vocab/lis/v2/membership#" },
+      ]
+
+      attr_accessor :roles, :context_types, :other_roles
+
+      def initialize(roles = '')
+        roles = roles.split(',') if roles.is_a?(String)
+        @roles = roles || []
+
+        @context_types = []
+        @other_roles = []
+        @parsed_roles = HashWithIndifferentAccess.new
+
+        map_roles
+      end
+
+      def system_roles; @parsed_roles[:system] || []; end
+      def institution_roles; @parsed_roles[:institution] || []; end
+      def context_roles; @parsed_roles[:context] || []; end
+
+      def to_h
+        {
+          'roles' => roles,
+          'context_type' => context_types,
+          'system_roles' => system_roles,
+          'institution_roles' => institution_roles,
+          'context_roles' => context_roles
+        }
+      end
+
+      protected
+
+      def map_roles
+        roles.each do |role|
+          if role.downcase.include?(ContextTypeURN)
+            context_types << clean_role(ContextTypeURN, role)
+          elsif (simple_role, type = match_role(role)).present?
+            (@parsed_roles[type[:type]] ||= []) << simple_role
+          else
+            other_roles << role
+          end
+        end
+      end
+
+      def match_role(role)
+        ROLE_TYPES.each do |rt|
+          # LIS V1
+          if role.downcase.start_with?(rt[:urn])
+            return clean_role(ContextTypeURN, role), rt
+          end
+
+          # LIS V2
+          if role.downcase.start_with?(rt[:url])
+            return role.split('#')[1].underscore, rt
+          end
+        end
+
+        nil
+      end
+
+      def clean_role(urn_prefix, role)
+        role.gsub(/#{Regexp.quote(urn_prefix)}/i, '').gsub('/', '').underscore
+      end
+    end
+
     class DataSerializer
       def self.load(str)
         return {} unless str.present?

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

@@ -2,8 +2,10 @@
 <html>
 <head>
   <title>PandaPal</title>
-  <%= stylesheet_link_tag    "panda_pal/application", media: "all" %>
-  <%= javascript_include_tag "panda_pal/application" %>
+  <% if defined? Sprockets%>
+    <%= stylesheet_link_tag    "panda_pal/application", media: "all" %>
+    <%= javascript_include_tag "panda_pal/application" %>
+  <% end %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/lib/panda_pal/concerns/ability_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module PandaPal::Concerns
+  module AbilityHelper
+    extend ActiveSupport::Concern
+
+    # @return PandaPal::Session
+    def panda_pal_session
+      @panda_pal_session ||= begin
+                               raise "Ability class needs to set @panda_pal_session or @controller to use this feature" unless @controller.present?
+                               @controller.current_session
+                             end
+    end
+
+    def rails_session
+      @rails_session ||= begin
+                           raise "Ability class needs to set @rails_session or @controller to use this feature" unless @controller.present?
+                           @controller.session
+                         end
+    end
+
+    def is_lti_launch?
+      panda_pal_session.present?
+    end
+
+    def launch_params
+      @launch_params ||= panda_pal_session[:launch_params] || {}
+    end
+
+    def canvas_site_admin?
+      panda_pal_session.canvas_site_admin?
+    end
+  end
+end

data/lib/panda_pal/engine.rb

@@ -210,6 +210,7 @@ module PandaPal
       OAUTH_10_SUPPORT = true
       ActiveSupport.on_load(:action_controller) do
         include PandaPal::Helpers::ControllerHelper
+        include PandaPal::Concerns::AbilityHelper
       end
     end
 

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.9.7"
+  VERSION = "5.9.8.beta1"
 end

data/lib/panda_pal.rb

@@ -4,6 +4,8 @@ require 'panda_pal/helpers'
 require 'oauth/request_proxy/rack_request'
 require 'oauth/request_proxy/action_dispatch_request'
 
+Dir[File.dirname(__FILE__) +  "/panda_pal/concerns/**/*.rb"].each { |file| require file }
+
 module PandaPal
   class LtiNavigationInUse < StandardError;end
   class NotMounted < StandardError;end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.9.7
+  version: 5.9.8.beta1
 platform: ruby
 authors:
 - Instructure CustomDev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -282,7 +282,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.7.1
-description: 
+description:
 email:
 - pseng@instructure.com
 executables: []
@@ -333,6 +333,7 @@ files:
 - db/migrate/20171205194657_remove_old_organization_settings.rb
 - db/migrate/20220721095653_create_panda_pal_api_calls.rb
 - lib/panda_pal.rb
+- lib/panda_pal/concerns/ability_helper.rb
 - lib/panda_pal/engine.rb
 - lib/panda_pal/helpers.rb
 - lib/panda_pal/helpers/console_helpers.rb
@@ -393,7 +394,7 @@ homepage: http://instructure.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -408,52 +409,52 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.4
+signing_key:
 specification_version: 4
 summary: LTI mountable engine
 test_files:
-- spec/rails_helper.rb
-- spec/models/panda_pal/api_call_spec.rb
-- spec/models/panda_pal/organization_spec.rb
-- spec/models/panda_pal/session_spec.rb
-- spec/models/panda_pal/organization/settings_validation_spec.rb
-- spec/models/panda_pal/organization/task_scheduling_spec.rb
 - spec/controllers/panda_pal/api_call_controller_spec.rb
-- spec/spec_helper.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/public/422.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/404.html
-- spec/dummy/public/500.html
+- spec/dummy/README.rdoc
 - spec/dummy/Rakefile
-- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/config/secrets.yml
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
 - spec/dummy/config/application.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/database.yml
 - spec/dummy/config/boot.rb
-- spec/dummy/config/routes.rb
+- spec/dummy/config/database.yml
 - spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
-- spec/dummy/README.rdoc
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
 - spec/dummy/config.ru
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rake
-- spec/dummy/bin/setup
-- spec/dummy/bin/rails
+- spec/dummy/db/schema.rb
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
 - spec/factories/panda_pal_organizations.rb
 - spec/factories/panda_pal_sessions.rb
+- spec/models/panda_pal/api_call_spec.rb
+- spec/models/panda_pal/organization/settings_validation_spec.rb
+- spec/models/panda_pal/organization/task_scheduling_spec.rb
+- spec/models/panda_pal/organization_spec.rb
+- spec/models/panda_pal/session_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb