lti_public_resources 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba026e3f8726be3d209b73c838051ca3f2116ec0
+  data.tar.gz: a3d4cac31d06ca3930a3f01b888c8a0eda2d7bdf
+SHA512:
+  metadata.gz: abb3b54573292ff0284e55c6ecd0d266616f8062eff5a9705da09e2c04472b649aafe136756da398b8982e0536e70b2df0f136be2d4f8eb3b6b88eb5716475c0
+  data.tar.gz: a7d1b3fe4db5adeb62a38291e7b7de7cab998bb2df63f924e5accbc4ad0c73efe8e8f3e7b9709fc521660ac0c0f549b7442c5c328b7561e82da9b2c4ec59d45c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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/README.rdoc

@@ -0,0 +1,3 @@
+= LtiPublicResources
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'LtiPublicResources'
+  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'
+
+
+
+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/controllers/lti_public_resources/api_controller.rb

@@ -0,0 +1,123 @@
+require_dependency "lti_public_resources/application_controller"
+
+module LtiPublicResources
+  class ApiController < ApplicationController
+    before_action :load_apps
+
+    def lti_apps
+      render json: { lti_apps: @apps }
+    end
+
+    def lti_app
+      tool_id = params[:id].to_sym
+      lti_app = @apps[tool_id]
+      render json: { lti_app: lti_app }
+    end
+
+    def search
+      tool_id = params[:tool_id].to_sym
+      lti_app = @apps[tool_id]
+      driver  = LtiPublicResources.drivers[tool_id]
+
+      case lti_app[:tool_type]
+      when 'search'
+        q = {
+          query: params[:query],
+          page: (params[:page] ? params[:page].to_i : 1),
+          content_filter: APR::RequestCriteria::CONTENT_FILTER_NONE,
+          sort: APR::RequestCriteria::SORT_RELEVANCE
+        }
+        puts q.inspect
+        criteria = APR::RequestCriteria.new(q)
+      when 'browse'
+        criteria = APR::RequestCriteria.new(folder: params[:folder])
+      else
+        raise StandardError.new("Unknown tool type!")
+      end
+
+      results = driver.perform_request(criteria)
+      render json: { driver_response: results }
+    end
+
+    def browse
+      tool_id  = params[:tool_id].to_sym
+      lti_app  = @apps[tool_id]
+      driver   = LtiPublicResources.drivers[tool_id]
+      folder   = params[:folder]
+      criteria = APR::RequestCriteria.new(folder: folder)
+      results  = driver.perform_request(criteria)
+      render json: { driver_response: results }
+    end
+
+    def embed
+      tp = tool_provider(params)
+      return_type = params[:return_type]
+      redirect_url = build_url(tp, return_type)
+      ret = return_type.to_json
+      if redirect_url.present?
+        ret = { redirectUrl: redirect_url }.to_json
+      end
+      render json: ret
+    end
+
+    def config
+      host = request.scheme + "://" + request.host_with_port + request.env['SCRIPT_NAME']
+
+      if params[:id]
+        tool_id  = params[:id]
+        lti_app  = @apps[tool_id.to_sym]
+        name = lti_app[:name]
+        description = lti_app[:description]
+        icon = "#{host}/assets/images/#{lti_app[:icon_path]}"
+        text = lti_app[:name]
+        url = host + "/?tool_id=" + tool_id
+      else
+        name = "Public Resources"
+        description = "Collection of public resources"
+        icon = "#{host}/assets/images/public_resources_icon.png"
+        text = "Public Resources"
+        url = host
+      end
+
+      tc = IMS::LTI::ToolConfig.new(:title => name, :launch_url => url)
+      tc.description = description
+      tc.extend IMS::LTI::Extensions::Canvas::ToolConfig
+      tc.canvas_privacy_anonymous!
+      tc.canvas_domain! request.host_with_port
+      tc.canvas_text! text
+      tc.canvas_icon_url! icon
+      tc.canvas_selector_dimensions! 560, 600
+      tc.canvas_editor_button!
+      tc.canvas_resource_selection!
+
+      render xml: tc.to_xml(:indent => 2)
+    end
+      
+    private
+
+    def load_apps
+      @apps = LtiPublicResources.apps
+    end
+
+    def tool_provider(params)
+      tp = IMS::LTI::ToolProvider.new(nil, nil, params[:launch_params] || params)
+      tp.extend IMS::LTI::Extensions::Content::ToolProvider
+      tp
+    end
+    
+    def build_url(tp, return_type)
+      if tp.accepts_content?
+        case return_type['return_type']
+          when 'iframe'
+            redirect_url = tp.iframe_content_return_url(return_type['url'], return_type['width'], return_type['height'], return_type['title'])
+          when 'url'
+            redirect_url = tp.url_content_return_url(return_type['url'], return_type['title'])
+          when 'lti_launch'
+            redirect_url = tp.lti_launch_content_return_url(return_type['url'], return_type['title'], return_type['title'])
+        end
+        return redirect_url
+      end
+    end
+
+  end
+end

data/app/controllers/lti_public_resources/application_controller.rb

@@ -0,0 +1,28 @@
+module LtiPublicResources
+  class ApplicationController < ActionController::Base
+    before_filter :cors_preflight_check
+    after_filter :cors_set_access_control_headers
+
+    # For all responses in this controller, return the CORS access control headers.
+    def cors_set_access_control_headers
+      headers['Access-Control-Allow-Origin'] = '*'
+      headers['Access-Control-Allow-Methods'] = 'POST, PUT, DELETE, GET, OPTIONS'
+      headers['Access-Control-Request-Method'] = '*'
+      headers['Access-Control-Allow-Headers'] = 'Origin, X-Requested-With, Content-Type, Accept, Authorization'
+      headers['Access-Control-Max-Age'] = "1728000"
+    end
+
+    # If this is a preflight OPTIONS request, then short-circuit the
+    # request, return only the necessary headers and return an empty
+    # text/plain.
+    def cors_preflight_check
+      if request.method == :options
+        headers['Access-Control-Allow-Origin'] = '*'
+        headers['Access-Control-Allow-Methods'] = 'POST, GET, OPTIONS'
+        headers['Access-Control-Allow-Headers'] = '*'
+        headers['Access-Control-Max-Age'] = '1728000'
+        render :text => '', :content_type => 'text/plain'
+      end
+    end
+  end
+end

data/app/controllers/lti_public_resources/ember_controller.rb

@@ -0,0 +1,18 @@
+require_dependency "lti_public_resources/application_controller"
+
+module LtiPublicResources
+  class EmberController < ApplicationController
+    def app
+      @full_path = request.env['SCRIPT_NAME']
+      @env = { 
+        'CONFIG' => { 
+          host: @full_path,
+          imagePath: '/lti_public_resources/assets/images'
+        },
+        'TOOL_ID' => params[:tool_id] || '',
+        'LAUNCH_PARAMS' => params.reject!{ |k,v| ['controller','action'].include? k }
+      }
+      render layout: false
+    end
+  end
+end

data/app/views/lti_public_resources/ember/app.html.erb

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <title>Public Resources LTI</title>
+  <meta name="description" content="">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
+  <link rel="stylesheet" href="/lti_public_resources/assets/app.min.css">
+  
+  <style>
+  /*#wrapper               header { background-image: url('/lti_public_resources/lti_public_resources/assets/images/khan_academy_logo.png') !important; }*/
+  #wrapper .khan_academy header { background-image: url('/lti_public_resources/assets/images/khan_academy_logo.png') !important; }
+  #wrapper .quizlet      header { background-image: url('/lti_public_resources/assets/images/quizlet_logo.png') !important; }
+  #wrapper .youtube      header { background-image: url('/lti_public_resources/assets/images/youtube_logo.png') !important; }
+  #wrapper .vimeo        header { background-image: url('/lti_public_resources/assets/images/vimeo_logo.png') !important; }
+  #wrapper .schooltube   header { background-image: url('/lti_public_resources/assets/images/schooltube_logo.png') !important; }
+  </style>
+
+  <script>
+  window.ENV = <%=raw @env.to_json %>;
+  </script>
+
+  <script src="/lti_public_resources/assets/vendor.min.js"></script>
+
+  <script src="/lti_public_resources/assets/app.min.js"></script>
+
+</head>
+<body>
+  <!--[if lt IE 8]>
+    <p class="browsehappy">
+      You are using an <strong>outdated</strong> browser. Please
+      <a href="http://browsehappy.com/">upgrade your browser</a>
+      to improve your experience.
+    </p>
+  <![endif]-->
+
+  <script>
+    window.App = require('appkit/app')["default"].create();
+  </script>
+</body>
+</html>

data/config/lti_public_resources_config.yml.example

@@ -0,0 +1,7 @@
+vimeo:
+  consumer_key: VIMEO_CONSUMER_KEY
+  consumer_secret: VIMEO_CONSUMER_SECRET
+  access_token: VIMEO_ACCESS_TOKEN
+  access_token_secret: VIMEO_ACCESS_TOKEN_SECRET
+quizlet:
+  client_id: QUIZLET_CLIENT_ID

data/config/routes.rb

@@ -0,0 +1,10 @@
+LtiPublicResources::Engine.routes.draw do
+  root "ember#app"
+
+  get  'api/lti_apps' => 'api#lti_apps'
+  get  'api/lti_apps/:id' => 'api#lti_app'
+  post 'api/search' => 'api#search'
+  post 'api/browse' => 'api#browse'
+  post 'api/embed' => 'api#embed'
+  get  'config.xml' => 'api#config'
+end

data/lib/lti_public_resources/engine.rb

@@ -0,0 +1,19 @@
+module LtiPublicResources
+  class Engine < ::Rails::Engine
+    isolate_namespace LtiPublicResources
+
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+
+    initializer "lti_public_resources.load_app_instance_data" do |app|
+      LtiPublicResources.setup do |config|
+        config.app_root = app.root
+      end
+    end
+
+    initializer "lti_public_resources.lti_public_resources_config" do |app|
+      LtiPublicResources::LtiPublicResourcesConfig.setup!
+    end
+  end
+end

data/lib/lti_public_resources/lti_public_resources_config.rb

@@ -0,0 +1,27 @@
+module LtiPublicResources
+  module LtiPublicResourcesConfig
+    def self.load_config
+      YAML::load(File.open(config_file))
+    end
+
+    def self.config_file
+      LtiPublicResources.app_root.join('config/lti_public_resources_config.yml')
+    end
+
+    def self.setup!
+      if File.exists?(config_file)
+        Rails.logger.info "Initializing using #{config_file}"
+        settings = load_config.deep_symbolize_keys
+        LtiPublicResources.drivers = {
+          youtube:      APR::Drivers::Youtube.new,
+          vimeo:        APR::Drivers::Vimeo.new(settings[:vimeo]),
+          schooltube:   APR::Drivers::Schooltube.new,
+          khan_academy: APR::Drivers::KhanAcademy.new,
+          quizlet:      APR::Drivers::Quizlet.new(settings[:quizlet])
+        }
+      else
+        raise "Warning: missing config file #{config_file}."
+      end
+    end
+  end
+end

data/lib/lti_public_resources/version.rb

@@ -0,0 +1,3 @@
+module LtiPublicResources
+  VERSION = "0.0.1"
+end

data/lib/lti_public_resources.rb

@@ -0,0 +1,59 @@
+require 'ostruct'
+require 'active_public_resources'
+require 'ims/lti'
+require 'lti_public_resources/lti_public_resources_config'
+
+module LtiPublicResources
+  mattr_accessor :app_root, :drivers
+
+  def self.setup
+    yield self
+  end
+
+  def self.apps
+    {
+      youtube: {
+        name: "YouTube",
+        description: "Search publicly available YouTube videos. A new icon will show up in your course rich editor letting you search YouTube and click to embed videos in your course material.",
+        tool_id: "youtube",
+        tool_type: "search",
+        icon_path: "youtube_icon.png",
+        image_url: "youtube_banner.png"
+      },
+      vimeo: {
+        name: "Vimeo",
+        description: "Vimeo is a video sharing website on which users can upload, share, and view videos. The community of Vimeo includes indie, professional, and novice filmmakers.",
+        tool_id: "vimeo",
+        tool_type: "search",
+        icon_path: "vimeo_icon.png",
+        image_url: "vimeo_banner.png"
+      },
+      schooltube: {
+        name: "SchoolTube",
+        description: "SchoolTube is a public, searchable collection of videos uploaded from schools. Videos can be inserted as links or embedded in course material.",
+        tool_id: "schooltube",
+        tool_type: "search",
+        icon_path: "schooltube_icon.png",
+        image_url: "schooltube_banner.png"
+      },
+      khan_academy: {
+        name: "Khan Academy",
+        description: "Search for and embed Khan Academy lessons and exercise into course material. Khan Academy focuses on short lessons on math, science, etc. Uses the embedded player so students earn points for watching videos.",
+        tool_id: "khan_academy",
+        tool_type: "browse",
+        icon_path: "khan_academy_icon.png",
+        image_url: "khan_academy_banner.png"
+      },
+      quizlet: {
+        name: "Quizlet",
+        description: "Search for and embed publicly available flashcards and question sets from Quizlet. Questions can be embedded directly into content as flash cards, review, or as a study game.",
+        tool_id: "quizlet",
+        tool_type: "search",
+        icon_path: "quizlet_icon.png",
+        image_url: "quizlet_banner.png"
+      }
+    }
+  end
+end
+
+require 'lti_public_resources/engine'

data/lib/tasks/lti_public_resources_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lti_public_resources do
+#   # Task goes here
+# end

data/test/controllers/lti_public_resources/api_controller_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module LtiPublicResources
+  class ApiControllerTest < ActionController::TestCase
+    # test "the truth" do
+    #   assert true
+    # end
+  end
+end

data/test/controllers/lti_public_resources/ember_controller_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module LtiPublicResources
+  class EmberControllerTest < ActionController::TestCase
+    test "should get index" do
+      get :index
+      assert_response :success
+    end
+
+  end
+end

data/test/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/test/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__)
+
+Dummy::Application.load_tasks

data/test/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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "lti_public_resources"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end