lti2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7fb808b35c9fa1aa859277f7fbf6e7789a126cc
-  data.tar.gz: 58137b32270008ffd738b49b609b27997afd5c5b
+  metadata.gz: b2b8f62bd07c6bbec6c19d4f056168731dabad1b
+  data.tar.gz: a32c3c21c909f1df452c6b004dd954a285e797b4
 SHA512:
-  metadata.gz: c8ebbfa0b82662ebd64d16228ffcc11b68d697f595f4758cbf7841073df1971046b9696761c442300da34192420fbf95bd975fdff857d050fa55f1c654783d3c
-  data.tar.gz: d78b7a644c7b29e1a4298e6199b3a8edda475cf5d263e40b4483ab592384056c6acdc97cc90e96561d89b1893e1dce4c42af891ce41a92dbaabb2fda0a1a7fa6
+  metadata.gz: 41847909bd2bd35c4311dde85c80fe9f884b8177c9282356d0a4fc88f6f52ac6384d8b1673253772854a7de832256040a5d7b720918d40aceb5ac3537267320e
+  data.tar.gz: ff6cb38ecd446ac1ce84c95507181bcc0c57a4ac269596a9134ec7db6dc076711fd99f600a729d537597ebc3d2f2468024365f2da265fc3330b226aa5bf2ab12

data/lib/lti2/version.rb

@@ -1,3 +1,3 @@
 module Lti2
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lti2_tc/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in lti2_tc.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/lti2_tc/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    lti2_tc (0.0.2)
+      mysql2 (~> 0.3.13)
+      rails (~> 4.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.5)
+      actionpack (= 4.1.5)
+      actionview (= 4.1.5)
+      mail (~> 2.5.4)
+    actionpack (4.1.5)
+      actionview (= 4.1.5)
+      activesupport (= 4.1.5)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activerecord (4.1.5)
+      activemodel (= 4.1.5)
+      activesupport (= 4.1.5)
+      arel (~> 5.0.0)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (5.4.1)
+    multi_json (1.10.1)
+    mysql2 (0.3.16)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.5)
+      actionmailer (= 4.1.5)
+      actionpack (= 4.1.5)
+      actionview (= 4.1.5)
+      activemodel (= 4.1.5)
+      activerecord (= 4.1.5)
+      activesupport (= 4.1.5)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.5)
+      sprockets-rails (~> 2.0)
+    railties (4.1.5)
+      actionpack (= 4.1.5)
+      activesupport (= 4.1.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    sprockets (2.12.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  lti2_tc!
+  sqlite3

data/lti2_tc/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/lti2_tc/README.rdoc

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

data/lti2_tc/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    = 'Lti2Tc'
+  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/lti2_tc/app/assets/javascripts/lti2_tc/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/lti2_tc/app/assets/stylesheets/lti2_tc/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/lti2_tc/app/controllers/lti2_tc/application_controller.rb

@@ -0,0 +1,13 @@
+module Lti2Tc
+
+  class ApplicationController < ActionController::Base
+    include OAuth::OAuthProxy
+    def pre_process_tenant
+      Lti2Tc::Authorizer::pre_process_tenant( request )
+    end
+
+    def oauth_validation_using_secret( secret )
+      Lti2Tc::Authorizer::validate( request, secret )
+    end
+  end
+end

data/lti2_tc/app/controllers/lti2_tc/deployment_requests_controller.rb

@@ -0,0 +1,9 @@
+require_dependency 'lti2_tc/application_controller'
+
+module Lti2Tc
+  class DeploymentRequestsController < ApplicationController
+    def show
+      render :json => Rails.application.config.tool_consumer_registry.tool_consumer_profile
+    end
+  end
+end

data/lti2_tc/app/controllers/lti2_tc/tool_consumer_profiles_controller.rb

@@ -0,0 +1,23 @@
+require_dependency 'lti2_tc/application_controller'
+
+module Lti2Tc
+  class ToolConsumerProfilesController < ApplicationController
+    def index
+      show
+    end
+
+    def show
+      tcp_objects = Lti2Tc::ToolConsumerProfile.where( :tc_profile_guid => params[:id] )
+      tcp_object = tcp_objects.first
+      if tcp_object.present?
+        registry = Rails.application.config.tool_consumer_registry
+        tcp = registry.tool_consumer_profile_wrapper
+        tcp.substitute_text_in_all_nodes( '{', '}', { 'tc_profile_guid' => tcp_object.tc_profile_guid } )
+        logger.info( JSON.pretty_generate tcp.root )
+        render :json => tcp.root, :content_type => 'application/vnd.ims.lti.v2.toolconsumerprofile+json'
+      else
+        render :inline => '<h2>ToolConsumerProfile not found</h2>',  :status => 404
+      end
+    end
+  end
+end

data/lti2_tc/app/controllers/lti2_tc/tool_proxies_controller.rb

@@ -0,0 +1,8 @@
+require_dependency 'lti2_tc/application_controller'
+
+module Lti2Tc
+  class ToolProxiesController < ApplicationController
+    def index
+    end
+  end
+end

data/lti2_tc/app/controllers/lti2_tc/tool_settings_controller.rb

@@ -0,0 +1,215 @@
+require_dependency 'lti2_tc/application_controller'
+
+module Lti2Tc
+  class ToolSettingsController < ApplicationController
+    skip_before_filter :verify_authenticity_token
+
+    def initialize
+      @acceptable_headers = [ 'application/vnd.ims.lti.v2.toolsettings+json',
+                              'application/vnd.ims.lti.v2.toolsettings.simple+json' ]
+      @tool_setting_binding_map = { :Tool => :ToolProxy, :Context => :ToolProxyBinding, :Ltilink => :LtiLink }
+    end
+
+    def self.add_ancestor_settings( target_matches )
+      return if target_matches.blank?
+      tool_id = target_matches.first.tool_id
+      node_id = target_matches.first.scopeable_id
+      now_collection_type = target_matches.first.scopeable_type
+      if now_collection_type == 'Ltilink'
+        # we have link in hand, now find courses for link
+        course_id = Lti2Tc::Link.find( node_id ).course.id
+        target_matches << Lti2Tc::ToolSetting.where(
+          :tool_id => tool_id, :scopeable_type => 'Context', :scopeable_id => course_id
+        )
+        now_node_id = course_id
+        now_collection_type = 'Context'
+      end
+      if now_collection_type == 'Context'
+        # we have course settings, now find tool settings for that course
+        target_matches << Lti2Tc::ToolSetting.where( :tool_id => tool_id, :scopeable_type => 'Tool' )
+        now_collection_type == 'Context'
+      end
+      target_matches.flatten
+    end
+
+    def self.get_collection_type( path )
+      Lti2Tc::ToolSetting.parse_uri( path )[0]
+    end
+
+    def self.get_distinct_matches( matches )
+      dupe_check_set = Set.new
+      all_matches = []
+      matches.each do |match|
+        unless dupe_check_set.include?( match.name )
+          all_matches << match
+          dupe_check_set.add( match.name )
+        end
+      end
+      all_matches
+    end
+
+    def self.get_trimmed_request_uri( uri )
+      uri.split('?').first
+    end
+
+    def self.get_target_matches( collection_type, tool_guid, node_id )
+      tool = Lti2Tc::Tool.where( :key => tool_guid ).first
+      case collection_type
+        when 'Tool'
+          Lti2Tc::ToolSetting.where( :tool_id => tool.id, :scopeable_type => 'Tool' )
+        when 'Context'
+          Lti2Tc::ToolSetting.where( :tool_id => tool.id, :scopeable_type => 'Context', :scopeable_id => node_id )
+        when 'Ltilink'
+          Lti2Tc::ToolSetting.where( :tool_id => tool.id, :scopeable_type => 'Ltilink', :scopeable_id => node_id )
+        else
+          nil
+      end
+    end
+
+    def is_header_full_not_simple( header )
+      @acceptable_headers.index( header ) == 0
+    end
+
+    def is_unacceptable( header )
+      ! @acceptable_headers.include?( header )
+    end
+
+    def pre_process
+      Lti2Tc::Authorizer::pre_process_tenant(request)
+    end
+
+    def show
+      oauth_error = pre_process
+      (render :text => "Authentication error", :status => 401 if oauth_error) and return
+
+      tool_guid = params[:tool_guid]
+      collection_type = ToolSettingsController.get_collection_type( request.path )
+      node_id = collection_type == 'tool' ? nil : params[:node_id]
+      bubble = params[:bubble]
+
+      accept = request.headers['ACCEPT']
+
+      ( render :json => {}, :status => 406 if is_unacceptable( accept ) ) and return
+
+      puts "collection_type: #{collection_type}"
+      puts "accept: #{accept}"
+
+      all_match_names = Set.new
+      result = {}
+      if is_header_full_not_simple( accept )
+        content_type = 'application/vnd.ims.lti.v2.toolsettings+json'
+        target_matches = ToolSettingsController.get_target_matches( collection_type, tool_guid, node_id )
+
+        if bubble.present?
+          reverse_collections = Lti2Tc::ToolSetting::COLLECTION_TYPES.reverse
+          collection_index = reverse_collections.find_index( collection_type.to_sym )
+          all_collection_types = reverse_collections[collection_index..-1]
+          target_matches = ToolSettingsController.add_ancestor_settings( target_matches )
+          reachable_uris = Lti2Tc::ToolSetting.create_reachable_uris( tool_guid, collection_type, node_id )
+        else
+          all_collection_types = [collection_type]
+          reachable_uris = {}
+          reachable_uris[collection_type.to_sym] = Lti2Tc::ToolSetting.create_uri( tool_guid, collection_type, node_id )
+        end
+
+        result[:@context] = 'http://purl.imsglobal.org/ctx/lti/v2/ToolSettings'
+        result[:@graph] = []
+
+        all_collection_types.each do |collect_type|
+          @match_dict = nil
+          graph_element = {}
+          result[:@graph] << graph_element
+          collection_matches = target_matches.select { |match| match.scopeable_type == collect_type.to_s }
+          #if collection_matches.length > 0
+            graph_element['@type'] = @tool_setting_binding_map[collect_type.to_sym]
+            a_match = collection_matches[0]
+            uri = reachable_uris[collect_type.to_sym]
+            graph_element['@id'] = uri
+            @match_dict = {}
+            graph_element['custom'] = @match_dict
+
+            target_matches = ToolSettingsController.get_distinct_matches( target_matches ) if bubble == 'distinct'
+
+            target_matches.each do |match|
+              if match.scopeable_type.to_sym == collect_type.to_sym
+                unless all_match_names.include? match.name
+                  @match_dict[match.name] = match.value
+                  all_match_names << match.name if bubble == 'distinct'
+                end
+              end
+            end
+          #end
+        end
+      else
+        content_type = 'application/vnd.ims.lti.v2.toolsettings.simple+json'
+        target_matches = ToolSettingsController.get_target_matches( collection_type, tool_guid, node_id )
+
+        if bubble.present?
+          if bubble == 'all' && accept == 'application/vnd.ims.lti.v2.toolsettings.simple+json'
+            (render :text => 'bubble=all option cannot be used for toolsettings.simple media type', :status => 400) and return
+          end
+          target_matches = ToolSettingsController.add_ancestor_settings( target_matches )
+        end
+
+        # simple only allows 'distinct' output
+        target_matches.flatten
+        target_matches = ToolSettingsController.get_distinct_matches( target_matches )
+        target_matches.each { |match| result[match['name']] = match['value'] }
+      end
+
+      puts JSON.pretty_generate( result )
+
+      render :json => result, :content_type => content_type
+    end
+
+    def update
+      oauth_error = pre_process
+      (render :text => "Authentication error", :status => 401 if oauth_error) and return
+
+      tool_guid = params[:tool_guid]
+      collection_type = ToolSettingsController.get_collection_type(request.path)
+      node_id = collection_type == 'Tool' ? nil : params[:node_id]
+
+      content_type = request.headers['CONTENT_TYPE']
+      (render :text => "Unacceptable Content_Type header for ToolSettings", :status => 406 if is_unacceptable(content_type)) and return
+
+      body_str = request.body.read
+      json_str = CGI::unescape body_str
+
+      if is_header_full_not_simple( content_type )
+        settings_object = JSON.load( json_str )
+        (render :json => "Multiple level tool setting updates not allowed", :status => 400 if settings_object['@graph'].length > 1) and return
+        settings = settings_object['@graph'][0]['custom']
+      else
+        settings = JSON.load( json_str )
+      end
+
+      scopeable_type, tool_guid, scopeable_id = ToolSetting.parse_uri( request.path )
+      tool = Tool.where( :key => tool_guid ).first
+
+      # for Tool only
+      scopeable_id = tool.id if scopeable_type == 'Tool'
+
+      # first clear out the old data
+      if scopeable_type == 'Tool'
+        ToolSetting.where( :scopeable_type => scopeable_type, :tool_id => tool.id ).delete_all
+      else
+        ToolSetting.where( :scopeable_type => scopeable_type, :tool_id => tool.id, :scopeable_id => scopeable_id ).delete_all
+      end
+
+      settings.each_pair do |k,v|
+        ts = ToolSetting.create(
+          :scopeable_type => scopeable_type,
+          :tool_id => tool.id,
+          :scopeable_id => scopeable_id,
+          :name => k,
+          :value => v
+        )
+        ts.save
+      end
+
+      render :json => "Successfully updated #{settings.length} values"
+    end
+  end
+
+end