panda_pal 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a4d8f00cdcebbcbcf57fb961606da6de1ddd429
+  data.tar.gz: 2ff5dc92d8bf4156db09664130c435a80a0546b2
+SHA512:
+  metadata.gz: 8f7a8df21f81ce3f3f8083b29606d5650d99ae9ef5e7d206a57274c2596b0fe1654e2009ac8685c49f88df1d33cd2815d0db777e81f46953b1e1c10b69ade2ea
+  data.tar.gz: b9fd96b44ee9eab58e607a2cf7604acadc239dfcd537d110c21328b98abd5c77e0e9f8f65f280e351230828d50e400eee27dc871509444c3fb96d67e9ea4edfc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PandaPal'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/panda_pal/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/panda_pal/lti.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/panda_pal/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/panda_pal/lti.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/panda_pal/application_controller.rb

@@ -0,0 +1,4 @@
+module PandaPal
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/panda_pal/lti_controller.rb

@@ -0,0 +1,50 @@
+require_dependency "panda_pal/application_controller"
+
+module PandaPal
+  class LtiController < ApplicationController
+
+    def config
+      lti_options = PandaPal.lti_options
+      lti_nav = PandaPal.lti_paths
+      lti_environments = PandaPal.lti_environments
+      lti_custom_params = PandaPal.lti_custom_params
+
+      if lti_environments.empty?
+        render text: 'Domains must be set in lti_environments'
+        return
+      end
+
+      platform = lti_options.delete(:platform) || 'canvas.instructure.com'
+      host = "#{request.scheme}://#{request.host_with_port}"
+      tc = IMS::LTI::ToolConfig.new(:title => lti_options[:title], :launch_url => ("#{host}#{lti_options[:launch_route]}") || 'ABC')
+      tc.set_ext_param(platform, :domain, request.host)
+      tc.set_ext_param(platform, :privacy_level, 'public')
+      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
+      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_route].blank?
+      render :xml => xml
+    end
+
+    def ext_params(options)
+      url = options.delete(:url)
+      options[:url] = main_app.send([url,'_url'].join)
+      options
+    end
+  end
+end

data/app/helpers/panda_pal/application_helper.rb

@@ -0,0 +1,4 @@
+module PandaPal
+  module ApplicationHelper
+  end
+end

data/app/models/panda_pal/organization.rb

@@ -0,0 +1,28 @@
+module PandaPal
+  class Organization < ActiveRecord::Base
+
+    validates :key, uniqueness: { case_sensitive: false }, presence: true
+    validates :secret, presence: true
+    validates :name, uniqueness: { case_sensitive: false }, presence: true, format: { with: /\A[a-z0-9_]+\z/i }
+    validates :canvas_account_id, presence: true
+
+    after_create :create_schema
+    after_commit :destroy_schema, on: :destroy
+
+    before_validation on: [:update] do
+      errors.add(:name, 'should not be changed after creation') if name_changed?
+    end
+
+    serialize :settings, Hash
+
+    private
+
+    def create_schema
+      Apartment::Tenant.create name
+    end
+
+    def destroy_schema
+      Apartment::Tenant.drop name
+    end
+  end
+end

data/app/models/panda_pal/session.rb

@@ -0,0 +1,9 @@
+module PandaPal
+  class Session < ActiveRecord::Base
+    after_initialize do
+      self.session_key ||= SecureRandom.urlsafe_base64(60)
+    end
+
+    serialize :data, Hash
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PandaPal</title>
+  <%= stylesheet_link_tag    "panda_pal/application", media: "all" %>
+  <%= javascript_include_tag "panda_pal/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/panda_pal/lti/launch.html.erb

@@ -0,0 +1 @@
+<h1>You should do an LTI Tool Launch.</h1>

data/config/initializers/apartment.rb

@@ -0,0 +1,15 @@
+require 'apartment/elevators/generic'
+
+Apartment.configure do |config|
+  config.excluded_models = ['PandaPal::Organization', 'PandaPal::Session', 'Delayed::Job']
+
+  config.tenant_names = lambda {
+    PandaPal::Organization.pluck(:name)
+  }
+end
+
+Rails.application.config.middleware.use 'Apartment::Elevators::Generic', lambda { |request|
+  if match = request.path.match(/\/(?:orgs|organizations)\/(\d+)/)
+    PandaPal::Organization.find_by(id: match[1]).try(:name)
+  end
+}

data/config/initializers/delayed_job.rb

@@ -0,0 +1 @@
+Delayed::Worker.plugins << PandaPal::Plugins::ApartmentDelayedJobsPlugin

data/config/routes.rb

@@ -0,0 +1,4 @@
+PandaPal::Engine.routes.draw do
+  get '/config' => 'lti#config'
+  get '/launch' => 'lti#launch'
+end

data/db/migrate/20160412205931_create_panda_pal_organizations.rb

@@ -0,0 +1,15 @@
+class CreatePandaPalOrganizations < ActiveRecord::Migration
+  def change
+    create_table :panda_pal_organizations do |t|
+      t.string :name
+      t.string :key
+      t.string :secret
+      t.string :canvas_account_id
+      t.text :settings
+
+      t.timestamps null: false
+    end
+    add_index :panda_pal_organizations, :name, unique: true
+    add_index :panda_pal_organizations, :key, unique: true
+  end
+end

data/db/migrate/20160413132229_create_delayed_jobs.rb

@@ -0,0 +1,23 @@
+class CreateDelayedJobs < ActiveRecord::Migration
+  def self.up
+    create_table :delayed_jobs, force: true do |table|
+      table.integer :priority, default: 0, null: false # Allows some jobs to jump to the front of the queue
+      table.integer :attempts, default: 0, null: false # Provides for retries, but still fail eventually.
+      table.text :handler,                 null: false # YAML-encoded string of the object that will do work
+      table.text :last_error                           # reason for last failure (See Note below)
+      table.datetime :run_at                           # When to run. Could be Time.zone.now for immediately, or sometime in the future.
+      table.datetime :locked_at                        # Set when a client is working on this object
+      table.datetime :failed_at                        # Set when all retries have failed (actually, by default, the record is deleted instead)
+      table.string :locked_by                          # Who is working on this object (if locked)
+      table.string :queue                              # The name of the queue this job is in
+      table.string :tenant
+      table.timestamps null: true
+    end
+
+    add_index :delayed_jobs, [:priority, :run_at], name: "delayed_jobs_priority"
+  end
+
+  def self.down
+    drop_table :delayed_jobs
+  end
+end

data/db/migrate/20160413135653_create_panda_pal_sessions.rb

@@ -0,0 +1,11 @@
+class CreatePandaPalSessions < ActiveRecord::Migration
+  def change
+    create_table :panda_pal_sessions do |t|
+      t.string :session_key
+      t.text :data
+
+      t.timestamps null: false
+    end
+    add_index :panda_pal_sessions, :session_key, unique: true
+  end
+end

data/lib/panda_pal/engine.rb

@@ -0,0 +1,45 @@
+require 'apartment'
+require 'delayed_job_active_record'
+require 'ims/lti'
+require 'oauth/request_proxy/rack_request'
+require 'panda_pal/plugins'
+require 'panda_pal/helpers'
+
+module PandaPal
+  class Engine < ::Rails::Engine
+    config.autoload_once_paths += Dir["#{config.root}/lib/**/"]
+
+    isolate_namespace PandaPal
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+    end
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+    initializer 'panda_pal.app_controller' do |app|
+      OAUTH_10_SUPPORT = true
+      ActiveSupport.on_load(:action_controller) do
+        include PandaPal::Helpers::ControllerHelper
+      end
+    end
+
+    initializer 'panda_pal.route_helper' do |route|
+      ActionDispatch::Routing::Mapper.send :include, PandaPal::Helpers::RouteHelper
+    end
+
+    initializer 'panda_pal.route_options', :after => :disable_dependency_loading do |app|
+      ActiveSupport.on_load(:action_controller) do
+        Rails.application.reload_routes!
+        PandaPal::propagate_lti_navigation
+      end
+    end
+  end
+end

data/lib/panda_pal/helpers/controller_helper.rb

@@ -0,0 +1,62 @@
+module PandaPal::Helpers::ControllerHelper
+  def save_session
+    current_session.try(:save)
+  end
+
+  def current_session
+    @current_session ||= PandaPal::Session.find_by(session_key: session_key) if session_key
+    @current_session ||= PandaPal::Session.new
+  end
+
+  def current_organization
+    @organization ||= PandaPal::Organization.find_by!(key: organization_key) if organization_key
+    @organization ||= PandaPal::Organization.find_by(id: params[:organization_id]) if params[:organization_id]
+    @organization ||= PandaPal::Organization.find_by_name(Apartment::Tenant.current)
+  end
+
+  def current_session_data
+    current_session.data
+  end
+
+  def session_changed?
+    current_session.changed? && current_session.changes[:data].present?
+  end
+
+  def validate_launch!
+    authorized = false
+    if @organization = params['oauth_consumer_key'] && PandaPal::Organization.find_by_key(params['oauth_consumer_key'])
+      @tp = IMS::LTI::ToolProvider.new(@organization.key, @organization.secret, params)
+      authorized = @tp.valid_request?(request)
+    end
+    render :text => 'Invalid Credentials, please contact your Administrator.', :status => :unauthorized unless authorized
+    authorized
+  end
+
+  def switch_tenant(organization = current_organization, &block)
+    return unless organization
+    raise 'This method should be called in an around_action callback' unless block_given?
+
+    Apartment::Tenant.switch(organization.name) do
+      yield
+    end
+  end
+
+  def forbid_access_if_lacking_session
+    render text: 'You should do an LTI Tool Launch.', status: :unauthorized unless current_session.persisted?
+  end
+
+  private
+  def organization_key
+    params[:oauth_consumer_key] || current_session_data[:organization_key] || session[:organization_key]
+  end
+
+  def session_key
+    params[:session_key] || session_key_header || flash[:session_key] || session[:session_key]
+  end
+
+  def session_key_header
+    if match = request.headers['Authorization'].try(:match, /token=(.+)/)
+      match[1]
+    end
+  end
+end

data/lib/panda_pal/helpers/route_helper.rb

@@ -0,0 +1,17 @@
+module PandaPal::Helpers::RouteHelper
+  def lti_nav(nav, *rest, &block)
+    base_path = Rails.application.routes.named_routes[:panda_pal].path.spec
+    raise LtiNavigationInUse.new('PandaPal must be mounted before defining lti_nav routes') if base_path.blank?
+    options = nav
+    nav, to = options.first
+    options[:to] = to
+    options.delete nav
+    lti_options = options.delete(:lti_options) || {}
+    path = "#{base_path}/#{nav.to_s}"
+    lti_options[:url] = path.split('/').reject(&:empty?).join('_')
+    post path, options, &block
+    get path, options, &block
+    PandaPal::register_navigation(nav)
+    PandaPal::lti_navigation(nav, lti_options)
+  end
+end

data/lib/panda_pal/helpers.rb

@@ -0,0 +1,4 @@
+module PandaPal::Helpers
+  require_relative 'helpers/controller_helper'
+  require_relative 'helpers/route_helper'
+end

data/lib/panda_pal/plugins/apartment_delayed_jobs_plugin.rb

@@ -0,0 +1,40 @@
+module PandaPal::Plugins
+  class ApartmentDelayedJobsPlugin < ::Delayed::Plugin
+    callbacks do |lifecycle|
+      lifecycle.around(:enqueue) do |job, *args, &block|
+        current_tenant = Apartment::Tenant.current
+
+        #make sure enqueue on public tenant unless we are testing since delayed job is set to run immediately
+        Apartment::Tenant.switch!('public') unless Rails.env.test?
+        job.tenant = current_tenant
+        begin
+          block.call(job, *args)
+        rescue Exception => e
+          Rails.logger.error("Error enqueing job #{job.to_s} - #{e.backtrace}")
+        ensure
+          #switch back to prev tenant
+          Apartment::Tenant.switch!(current_tenant)
+        end
+      end
+
+
+      lifecycle.before(:perform) do |worker, *args, &block|
+        tenant = args.first.tenant
+        Apartment::Tenant.switch!(tenant) if tenant.present?
+        Rails.logger.debug("Running job with tenant #{Apartment::Tenant.current}")
+      end
+
+      lifecycle.around(:invoke_job) do |job, *args, &block|
+        block.call(job, *args)
+        Apartment::Tenant.switch!('public')
+        Rails.logger.debug("Resetting Tenant back to: #{Apartment::Tenant.current}")
+      end
+
+      lifecycle.after(:failure) do |job, *args|
+        Rails.logger.error("Job failed on tenant: #{Apartment::Tenant.current}")
+      end
+
+
+    end
+  end
+end

data/lib/panda_pal/plugins.rb

@@ -0,0 +1,3 @@
+module PandaPal::Plugins
+  require_relative 'plugins/apartment_delayed_jobs_plugin'
+end

data/lib/panda_pal/version.rb

@@ -0,0 +1,3 @@
+module PandaPal
+  VERSION = "0.0.2"
+end

data/lib/panda_pal.rb

@@ -0,0 +1,63 @@
+require "panda_pal/engine"
+
+module PandaPal
+  class LtiNavigationInUse < StandardError;end
+  class NotMounted < StandardError;end
+
+  @@lti_navigation = {}
+  @@staged_navigation = {}
+  @@lti_options = {}
+  @@lti_environments = {}
+  @@lti_custom_params = {}
+
+  def self.lti_options= lti_options
+    @@lti_options = lti_options
+  end
+
+  def self.lti_options
+    @@lti_options.deep_dup
+  end
+
+  def self.lti_environments=(lti_environments)
+    @@lti_environments = lti_environments
+  end
+
+  def self.lti_environments
+    @@lti_environments.deep_dup
+  end
+
+  def self.lti_custom_params=(custom_params)
+    @@lti_custom_params = custom_params
+  end
+
+  def self.lti_custom_params
+    @@lti_custom_params.deep_dup
+  end
+
+  def self.register_navigation(navigation)
+    @@lti_navigation[navigation] ||= {}
+  end
+
+  def self.stage_navigation(navigation, options)
+    @@staged_navigation[navigation] = {} unless @@staged_navigation.has_key?(navigation)
+    @@staged_navigation[navigation].merge!(options)
+  end
+
+  def self.lti_paths
+    @@lti_navigation.deep_dup
+  end
+
+  def self.propagate_lti_navigation
+    @@staged_navigation.each do |k,v|
+      lti_navigation(k,v)
+      @@staged_navigation.delete(k)
+    end
+  end
+
+  private
+
+  def self.lti_navigation(navigation, options)
+    raise "lti navigation '#{navigation}' has not been registered!" unless @@lti_navigation.has_key?(navigation)
+    @@lti_navigation[navigation].merge!(options)
+  end
+end

data/lib/tasks/panda_pal_tasks.rake

@@ -0,0 +1,6 @@
+namespace :panda_pal do
+  desc 'Cleans up old session data'
+  task clean_sessions: :environment do
+    PandaPal::Session.where('updated_at < ?', 1.week.ago).delete_all
+  end
+end

data/panda_pal.gemspec

@@ -0,0 +1,28 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "panda_pal/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "panda_pal"
+  s.version     = PandaPal::VERSION
+  s.authors     = ["Ben Young"]
+  s.email       = ["byoung@instructure.com"]
+  s.homepage    = "http://instructure.com"
+  s.summary     = "LTI mountable engine"
+  s.license     = "MIT"
+
+  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc", "panda_pal.gemspec"]
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "rails", "~> 4.2.5.2"
+  s.add_dependency "pg", '~> 0.18.4'
+  s.add_dependency 'apartment', '~> 1.0.2'
+  s.add_dependency 'delayed_job_active_record'
+  s.add_dependency 'ims-lti'
+
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'factory_girl_rails'
+  s.add_development_dependency 'test_after_commit'
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */