panda_pal 3.1.4 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5151e80c3e03b0e17390bcd3c84feda6f9a22846
-  data.tar.gz: a092fda80b1baf5f034785b17554068f64579bcd
+  metadata.gz: f3df9fdf70cde120c96b5c6d58580bfa3eac730a
+  data.tar.gz: a12fae868bf6809b3c58f67dea9f17daa3f48527
 SHA512:
-  metadata.gz: 6daaa931198bbaf296dd57b8c98912969884c3b869a9596cbd8e8f854ccf6b61c6b87348807c38c90ff37438f5db0d187abb1b07dd43dae9ab9d2bac6a82236b
-  data.tar.gz: 38bcf161b7e9ab36b7b972e154d5b1b5e6c13f5a7365d751c255fbb1dbae4b74d79683492571b344e06604e7ee4077e68122b3cd4410a6434c7667ef4131f8c4
+  metadata.gz: 36c1f80a58381ff37585ffbd304c2f1fe6d661e97ba4e5d3c8dc953b5daf450e6e05879ab00efd0bdc25b404a36dac42bcdbf1529510b744931c422ae5e87cdf
+  data.tar.gz: ea225e44fb0afa53fed6a4d5d5a258a23e5a062e3e7e16edca1978fbe2f31bc425b4b6d62440c697a078963d70363d2bfa6feaa4e5f6666f7472f4121bfc2ed6

data/app/controllers/panda_pal/lti_controller.rb

@@ -4,63 +4,25 @@ module PandaPal
   class LtiController < ApplicationController
 
     def tool_config
-      lti_options = PandaPal.lti_options
-      lti_properties = PandaPal.lti_properties
-      lti_nav = PandaPal.lti_paths
-      lti_environments = PandaPal.lti_environments
-      lti_custom_params = PandaPal.lti_custom_params
 
-      if lti_environments.empty?
+      if PandaPal.lti_environments.empty?
         render plain: 'Domains must be set in lti_environments'
         return
       end
-
-      platform = lti_options.delete(:platform) || 'canvas.instructure.com'
-      host = "#{request.scheme}://#{request.host_with_port}"
-      ims_lti_config = {title: lti_options[:title]}
-      if lti_options[:secure_launch_url].present? # Assumes full URL is provided
-        ims_lti_config[:secure_launch_url] = lti_options[:secure_launch_url]
-      elsif lti_options[:secure_launch_path].present? # Assumes path is provided
-        ims_lti_config[:secure_launch_url] = "#{host}#{lti_options[:secure_launch_path]}"
-      elsif lti_options[:launch_url].present? # Assumes full URL is provided
-        ims_lti_config[:launch_url] = lti_options[:launch_url]
-      elsif lti_options[:launch_path].present? # Assumes path is provided
-        ims_lti_config[:launch_url] = "#{host}#{lti_options[:launch_path]}"
-      else
-        ims_lti_config[:launch_url] = host
-      end
-      tc = IMS::LTI::Services::ToolConfig.new(ims_lti_config)
-      tc.set_ext_param(platform, :domain, request.host) unless lti_properties.has_key?(:domain)
-      tc.set_ext_param(platform, :privacy_level, 'public') unless lti_properties.has_key?(:public)
-      lti_properties.each do |k, v|
-        tc.set_ext_param(platform, k, v)
-      end
-      lti_custom_params.each do |k, v|
-        tc.set_custom_param k, v
-      end
-      if lti_options.has_key?(:custom_fields)
-        tc.set_ext_param(platform, :custom_fields, lti_options[:custom_fields])
-        lti_options[:custom_fields].each do |k, v|
-          tc.set_ext_param(platform, k, v)
-        end
+      platform = PandaPal.lti_options.delete(:platform) || 'canvas.instructure.com'
+      case platform
+        when 'canvas.instructure.com'
+          xml_config = LtiXml::CanvasPlatform.new(platform, request, main_app)
+        when 'bridgeapp.com'
+          xml_config = LtiXml::BridgePlatform.new(platform, request, main_app)
+        else
+          render plain: 'platform must be set under lti_options'
+          return
       end
 
-      lti_nav.each do |k, v|
-        tc.set_ext_param(platform, k.to_sym, ext_params(v))
-      end
-
-      tc.set_ext_param(platform, :environments, lti_environments)
 
-      #strip the launch url
-      xml = tc.to_xml
-      xml = xml.sub(/<blti:launch_url>.*<\/blti:launch_url>/, '') if lti_options[:launch_url] === false
-      render xml: xml
+      render xml: xml_config.xml
     end
 
-    def ext_params(options)
-      url = options.delete(:url)
-      options[:url] = main_app.send([url, '_url'].join)
-      options
-    end
   end
 end

data/lib/lti_xml/base_platform.rb

@@ -0,0 +1,94 @@
+class LtiXml::BasePlatform
+
+  attr_accessor :request, :host, :platform, :main_app
+
+  def initialize(platform, request, main_app)
+    @request = request
+    @host = "#{request.scheme}://#{request.host_with_port}"
+    @main_app = main_app
+    @platform = platform
+  end
+
+  # Override one of the following formatter methods in your individual platform class, or if you must, you can override
+  # the whole xml method and do it all custom.
+  def xml
+    ims_tool_config
+    add_domain
+    add_privacy_level
+    add_lti_properties
+    add_lti_custom_params
+    add_lti_options
+    add_lti_nav
+    add_environments
+
+    #strip the launch url
+    xml = @tc.to_xml
+    xml = xml.sub(/<blti:launch_url>.*<\/blti:launch_url>/, '') if PandaPal.lti_options[:launch_url] === false
+
+    return xml
+  end
+
+  private
+
+  def ims_tool_config
+    ims_lti_config = {title: PandaPal.lti_options[:title]}
+    if PandaPal.lti_options[:secure_launch_url].present? # Assumes full URL is provided
+      ims_lti_config[:secure_launch_url] = PandaPal.lti_options[:secure_launch_url]
+    elsif PandaPal.lti_options[:secure_launch_path].present? # Assumes path is provided
+      ims_lti_config[:secure_launch_url] = "#{host}#{PandaPal.lti_options[:secure_launch_path]}"
+    elsif PandaPal.lti_options[:launch_url].present? # Assumes full URL is provided
+      ims_lti_config[:launch_url] = PandaPal.lti_options[:launch_url]
+    elsif PandaPal.lti_options[:launch_path].present? # Assumes path is provided
+      ims_lti_config[:launch_url] = "#{host}#{PandaPal.lti_options[:launch_path]}"
+    else
+      ims_lti_config[:launch_url] = host
+    end
+    @tc = IMS::LTI::Services::ToolConfig.new(ims_lti_config)
+  end
+
+  def add_domain
+    @tc.set_ext_param(platform, :domain, request.host) unless PandaPal.lti_properties.has_key?(:domain)
+  end
+
+  def add_privacy_level
+    @tc.set_ext_param(platform, :privacy_level, 'public') unless PandaPal.lti_properties.has_key?(:public)
+  end
+
+  def add_lti_properties
+    PandaPal.lti_properties.each do |k, v|
+      @tc.set_ext_param(platform, k, v)
+    end
+  end
+
+  def add_lti_custom_params
+    PandaPal.lti_custom_params.each do |k, v|
+      @tc.set_custom_param k, v
+    end
+  end
+
+  def add_lti_options
+    if PandaPal.lti_options.has_key?(:custom_fields)
+      @tc.set_ext_param(platform, :custom_fields, PandaPal.lti_options[:custom_fields])
+      PandaPal.lti_options[:custom_fields].each do |k, v|
+        @tc.set_ext_param(platform, k, v)
+      end
+    end
+  end
+
+  def add_lti_nav
+    PandaPal.lti_paths.each do |k, v|
+      @tc.set_ext_param(platform, k.to_sym, ext_params(v))
+    end
+  end
+
+  def add_environments
+    @tc.set_ext_param(platform, :environments, PandaPal.lti_environments)
+  end
+
+  def ext_params(options)
+    url = options.delete(:url)
+    options[:url] = main_app.send([url, '_url'].join)
+    options
+  end
+
+end

data/lib/lti_xml/bridge_platform.rb

@@ -0,0 +1,8 @@
+class LtiXml::BridgePlatform < LtiXml::BasePlatform
+
+  def add_lti_custom_params
+    if PandaPal.lti_custom_params.any?
+      @tc.set_ext_param(platform, :custom_fields, PandaPal.lti_custom_params)
+    end
+  end
+end

data/lib/lti_xml/canvas_platform.rb

@@ -0,0 +1,3 @@
+class LtiXml::CanvasPlatform < LtiXml::BasePlatform
+
+end

data/lib/panda_pal/version.rb

@@ -1,3 +1,3 @@
 module PandaPal
-  VERSION = "3.1.4"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_pal
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.2.0
 platform: ruby
 authors:
 - Instructure ProServe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -161,6 +161,9 @@ files:
 - db/migrate/20170106165533_add_salesforce_id_to_organizations.rb
 - db/migrate/20171205183457_encrypt_organization_settings.rb
 - db/migrate/20171205194657_remove_old_organization_settings.rb
+- lib/lti_xml/base_platform.rb
+- lib/lti_xml/bridge_platform.rb
+- lib/lti_xml/canvas_platform.rb
 - lib/panda_pal.rb
 - lib/panda_pal/engine.rb
 - lib/panda_pal/helpers.rb