panda_pal 5.3.5 → 5.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 751203d046fbd547e8f194feabb335a81a08be96f6a557712f1673d139576a29
-  data.tar.gz: b06b642432ce0d1e4a42a4bc93520b3782c6d8cce801e91508b296be60501482
+  metadata.gz: 2e3454f04c4cbf7a07dc7a041118bb3b60db681c531ebf228115de69f1114d50
+  data.tar.gz: bc600d9940213278b6a0b9e908df51c24012a75ac120746758719faa91e8abbc
 SHA512:
-  metadata.gz: cc338a137cec8f7abb900b801ace89f1588b265d534babf98f6bb940307289b8a3175a9ce0d5d70a5ddeb520f3525d13e1ba0f7e52df34e75c6fda40ca03a3de
-  data.tar.gz: 717e7355ae2cfb990f40c589df6c29c138f55d660fa0095367a275e000a7041e98e99ec631f6dd1bf9e9f3068c7a01006d4a3580ac017cb358a18b9c9711a87f
+  metadata.gz: 507728d1f3dbe751125f4bd7fbda5a2245c20eee20ea8d446f12d5b701007ab1fbee5cfe81d741d400966db2f526d484e4f8ffde1c82f5db43a1e685f96362cc
+  data.tar.gz: c97afd8ec0a896f46a5b63a6eb8d9b9f13d31d995d448d29800f88f23c6fd4897877e7958e54d5d47e23dab04277c1eba7c73b852dc61704d197f3ec47ed27aa

data/README.md

@@ -21,6 +21,14 @@ PandaPal::stage_navigation(:account_navigation, {
 
 Configuration data for an installation can be set by creating a `PandaPal::Organization` record.  Due to the nature of the data segregation, once created, the name of the organization should not be changed (and will raise a validation error).
 
+### LTI 1.3 Configuration
+LTI 1.3 has some additional configuration steps required to setup an LTI:
+
+1. If you're running Canvas locally, make sure the `config/redis.yml` and `config/dynamic_settings.yml` files exist in Canvas.
+2. In prod, you'll need to generate a RSA Private Key for the LTI to use. You can set the `LTI_PRIVATE_KEY` ENV variable, or manually set `PandaPal.lti_private_key = OpenSSL::PKey::RSA.new(key)`.
+3. Make sure you have Redis installed and linked correctly
+4. Your PandaPal::Organization's `key` should be `CLIENT_ID/DEPLOYMENT_ID` (which can be found in Canvas). If a Deployment ID is not given, the key should just be `CLIENT_ID`.
+
 ### Launch URL property
 LTI Spec: `The launch_url contains the URL to which the LTI Launch is to be sent.   The secure_launch_url is the URL to use if secure http is required.  One of either the launch_url or the secure_launch_url must be specified.`
 

data/app/controllers/panda_pal/lti_v1_p0_controller.rb

@@ -2,6 +2,8 @@ require_dependency "panda_pal/application_controller"
 
 module PandaPal
   class LtiV1P0Controller < ApplicationController
+    skip_before_action :verify_authenticity_token
+
     def launch
       current_session_data.merge!({
         lti_version: 'v1p0',

data/app/controllers/panda_pal/lti_v1_p3_controller.rb

@@ -2,6 +2,7 @@ require_dependency "panda_pal/application_controller"
 
 module PandaPal
   class LtiV1P3Controller < ApplicationController
+    skip_before_action :verify_authenticity_token
     before_action :validate_launch!, only: [:resource_link_request]
     around_action :switch_tenant, only: [:resource_link_request]
 
@@ -54,8 +55,7 @@ module PandaPal
       parsed_request_url = URI.parse(request_url)
 
       mapped_placements = PandaPal.lti_paths.map do |k, opts|
-        opts = opts.dup
-        opts.delete(:route_helper_key)
+        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),

data/app/lib/lti_xml/base_platform.rb

@@ -85,7 +85,7 @@ module LtiXml
     end
 
     def ext_params(options, k)
-      options.delete(:route_helper_key)
+      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
     end

data/app/lib/panda_pal/launch_url_helpers.rb

@@ -2,11 +2,10 @@ module PandaPal
   module LaunchUrlHelpers
     def self.absolute_launch_url(launch_type, host:, launch_handler: nil)
       opts = PandaPal.lti_paths[launch_type]
-      final_url = launch_url(opts, launch_type: launch_type)
-
-      is_direct = opts[:route_helper_key].present? || !launch_handler.present?
+      is_direct = opts[:no_redirect] || !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
@@ -17,6 +16,13 @@ module PandaPal
       end
     end
 
+    def self.normalize_lti_launch_desc(opts)
+      opts = opts.dup
+      opts.delete(:route_helper_key)
+      opts.delete(:no_redirect)
+      opts
+    end
+
     def self.launch_url(opts, launch_type: nil)
       url = launch_route(opts, launch_type: launch_type)
       url = resolve_url_symbol(url) if url.is_a?(Symbol)

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

@@ -99,6 +99,20 @@ module PandaPal
           errors.concat(val_errors)
         end
 
+        if settings.is_a?(Array)
+          if spec[:length].is_a?(Range)
+            errors << "#{human_path} should contain #{spec[:length]} items" unless spec[:length].include?(settings.count)
+          elsif spec[:length].is_a?(Numeric)
+            errors << "#{human_path} should contain exactly #{spec[:length]} items" unless spec[:length] == settings.count
+          end
+
+          if spec[:item] != nil
+            settings.each_with_index do |value, i|
+              validate_settings_level(settings[i], spec[:item], path: [*path, i], errors: errors)
+            end
+          end
+        end
+
         if settings.is_a?(Hash)
           if spec[:properties] != nil
             spec[:properties].each do |key, pspec|

data/lib/panda_pal.rb

@@ -81,6 +81,7 @@ module PandaPal
 
   def self.validate_lti_navigation(errors = [])
     @@lti_navigation.each do |k, v|
+      next if v[:route_helper_key]
       errors << "lti navigation '#{k}' does not have a Route!" unless (LaunchUrlHelpers.launch_url(k) rescue nil)
     end
     errors

data/lib/panda_pal/helpers/controller_helper.rb

@@ -127,7 +127,8 @@ module PandaPal::Helpers
 
     def organization_key
       org_key ||= params[:oauth_consumer_key]
-      org_key ||= "#{params[:client_id]}/#{params[:deployment_id]}" if params[:client_id].present?
+      org_key ||= "#{params[:client_id]}/#{params[:deployment_id]}" if params[:client_id].present? && params[:deployment_id].present?
+      org_key ||= params[:client_id] if params[:client_id].present?
       org_key ||= session[:organization_key]
       org_key
     end

data/lib/panda_pal/helpers/route_helper.rb

@@ -9,6 +9,7 @@ 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[:route_helper_key] = path.split('/').reject(&:empty?).join('_')
     post(path, options.dup, &block)
     get(path, options.dup, &block)

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "5.3.5"
+  VERSION = "5.3.7"
 end

data/panda_pal.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'attr_encrypted', '~> 3.0.0'
   s.add_dependency 'secure_headers', '~> 6.1'
   s.add_dependency 'json-jwt'
+  s.add_dependency 'httparty'
 
   s.add_development_dependency 'sidekiq'
   s.add_development_dependency 'sidekiq-scheduler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 5.3.5
+  version: 5.3.7
 platform: ruby
 authors:
 - Instructure ProServe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -128,6 +128,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: sidekiq
   requirement: !ruby/object:Gem::Requirement