rack-lti 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb5033988f314beec36f2ec28a42b36e90771687
-  data.tar.gz: 99c197e05ab5d504c5162b298b52851b953344a7
+  metadata.gz: 537b86b974404190e61290b5055b113080e7aa71
+  data.tar.gz: 7f6fd669ce3c9c836fc8385c709496a937ed7bb8
 SHA512:
-  metadata.gz: 7c6d14c8b63847b9f10844ecb371f9518e786e39a7079638c4fd120639bcde24d66dcd30eef5e7de03e1088edc4d1bace15229e3aeaf9e0d175fb86943dff73b
-  data.tar.gz: 5c136b52efd1d4301c0cfd038e348e32d10af591db4d5479017c31cf0f41fd0fcee826ec2c7b3be441b192ac16914c0cd66710bceb1ed0016a4461738e2c2c43
+  metadata.gz: f0ad5da56b771dfa481665eaf4f5bb86ac89975c54bf9ee39d049f0297d9dc94207b3d66b629e035cb5a23d04d42513737e7ac09abdf046e59b87fbe2d1fa56e
+  data.tar.gz: d8347cd911f9e5c91aed61287030878cae2d98abe07da13a2aa4162028bc1a7f2ce21ef7ff9caee62e395af35bfd419f139ac9632ad05911e506f1b3ce4f0f03

data/README.md

@@ -27,19 +27,21 @@ Add Rack::LTI to your `config/application.rb`:
 ```ruby
 class Application < Rails::Application
   config.middleware.use Rack::LTI,
-    consumer_key:    ->(key, consumer_id) { key == 'key_value' },
-    consumer_secret: ->(secret) { secret == 'top_secret' }
+    consumer_key:    ->(key, consumer_id) { 'key' },
+    consumer_secret: ->(key, consumer_id) { 'secret' }
 
     app_path:    '/',
     config_path: '/lti/config.xml',
     launch_path: '/lti/launch',
+    redirect: true,
 
     title:       'My LTI App',
     description: 'My LTI App description',
 
     nonce_validator: ->(nonce) { !FakeNonceStore.include?(nonce) },
-    success: ->(params, session) {
-      params['launch_params'] = params unless session.nil?
+    success: ->(lti_params, request, response) {
+      request.session['launch_params'] = lti_params
+      response.headers['X-Custom-Header'] = 'value'
     },
     time_limit: 60*60,
 
@@ -71,13 +73,15 @@ class Application < Sinatra::Base
     app_path:    '/',
     config_path: '/lti/config.xml',
     launch_path: '/lti/launch',
+    redirect: true,
 
     title:       'My LTI App',
     description: 'My LTI App description',
 
     nonce_validator: ->(nonce) { !FakeNonceStore.include?(nonce) },
-    success: ->(params, session) {
-      params['launch_params'] = params unless session.nil?
+    success: ->(lti_params, request, response) {
+      request.session['launch_params'] = lti_params
+      response.headers['X-Custom-Header'] = 'value'
     },
     time_limit: 60*60,
 
@@ -114,6 +118,8 @@ values are:
     '/lti/config.xml'.
   * `launch_path` The path to receive LTI launch requests at. Defaults to
     '/lti/launch'.
+  * `redirect` If true, redirect to the `app_path`. If false, pass the launch
+    request through to the application. If false, app_path is not used.
   * `title` The title of your LTI application.
   * `description` The description of your LTI application.
   * `nonce_validator` A lambda used to validate the current request's nonce.
@@ -121,9 +127,9 @@ values are:
   * `time_limit` The time limit, in seconds, to consider requests valid within.
     If not passed, the default is 3600 seconds (one hour).
   * `success` A lambda called on successful launch. It is passed the launch
-    params as a hash and the session if present. Can be used to cache params
-    for the current user, find the current user, etc. If not given, the launch
-    params are stored in the 'launch_params' key of the session.
+    params as a hash, the Rack Request, and the Rack Response. Can be used to
+    cache params for the current user, find the current user, etc. By default,
+    the launch params are stored in the 'launch_params' key of the session.
   * `extensions` A hash of extension information to include with the config.
     Format is platform -> option -> properties. See usage examples above for
     more detail.

data/lib/rack/lti/config.rb

@@ -8,7 +8,10 @@ module Rack::LTI
       description:     'An LTI Application.',
       launch_path:     '/lti/launch',
       nonce_validator: true,
-      success:         ->(params, session) { session['launch_params'] = params if session },
+      redirect:        true,
+      success:         ->(lti, req, res) {
+        req.session['launch_params'] = lti if req.env['rack.session']
+      },
       time_limit:      60*60,
       title:           'LTI App'
     }

data/lib/rack/lti/middleware.rb

@@ -3,58 +3,65 @@ require 'oauth/request_proxy/rack_request'
 require 'rack/lti/config'
 
 module Rack::LTI
-	class Middleware
-		attr_reader :app, :config
+  class Middleware
+    attr_reader :app, :config
 
-		def initialize(app, options = {}, &block)
-			@app    = app	
-			@config = Config.new(options, &block)
-		end
+    def initialize(app, options = {}, &block)
+      @app    = app 
+      @config = Config.new(options, &block)
+    end
 
-		def call(env)
-			request = Rack::Request.new(env)
+    def call(env)
+      request = Rack::Request.new(env)
 
-			if routes.has_key?(request.path)
-				env['rack.lti'] = true
-				send(routes[request.path], request, env)
+      if routes.has_key?(request.path)
+        env['rack.lti'] = true
+        send(routes[request.path], request, env)
       else
         @app.call(env)
-			end
-		end
+      end
+    end
 
-		def routes
-			{
-				@config.config_path => :config_action,
-				@config.launch_path => :launch_action
-			}
-		end
+    def routes
+      {
+        @config.config_path => :config_action,
+        @config.launch_path => :launch_action
+      }
+    end
 
     private
 
-		def config_action(request, env)
+    def config_action(request, env)
       response = [@config.to_xml(launch_url: request.url.sub(@config.config_path, @config.launch_path))]
       [200, { 'Content-Type' => 'application/xml', 'Content-Length' => response[0].length.to_s }, response]
-		end
+    end
 
-		def launch_action(request, env)
-			provider = IMS::LTI::ToolProvider.new(@config.consumer_key(*request.params.values_at('oauth_consumer_key', 'tool_consumer_instance_guid')),
-																						@config.consumer_secret(*request.params.values_at('oauth_consumer_key', 'tool_consumer_instance_guid')),
-																						request.params)
+    def launch_action(request, env)
+      provider = IMS::LTI::ToolProvider.new(@config.consumer_key(*request.params.values_at('oauth_consumer_key', 'tool_consumer_instance_guid')),
+                                            @config.consumer_secret(*request.params.values_at('oauth_consumer_key', 'tool_consumer_instance_guid')),
+                                            request.params)
 
-			if valid?(provider, request)
-        @config.success.call(provider.to_params, env['rack.session'])
-        [301, { 'Content-Length' => '0', 'Content-Type' => 'text/html', 'Location' => @config.app_path }, []]
-			else
+      if valid?(provider, request)
+        req = Rack::Request.new(env)
+        res = Rack::Response.new([], 302, { 'Content-Length' => '0',
+          'Content-Type' => 'text/html', 'Location' => @config.app_path })
+        @config.success.call(provider.to_params, req, res)
+        if @config.redirect
+          res.finish
+        else
+          @app.call(env)
+        end
+      else
         response = 'Invalid launch.'
         [403, { 'Content-Type' => 'text/plain', 'Content-Length' => response.length.to_s }, [response]]
-			end
-		end
+      end
+    end
 
-		def valid?(provider, request)
-			valid_request?(provider, request) &&
+    def valid?(provider, request)
+      valid_request?(provider, request) &&
         valid_nonce?(request.params['oauth_nonce']) &&
         valid_timestamp?(request.params['oauth_timestamp'].to_i)
-		end
+    end
 
     def valid_request?(provider, request)
       @config.public? ? true : provider.valid_request?(request)
@@ -75,5 +82,5 @@ module Rack::LTI
         (Time.now.to_i - @config.time_limit) <= timestamp
       end
     end
-	end
+  end
 end

data/lib/rack/lti/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module LTI
-    VERSION = '0.0.2'
+    VERSION = '0.1.0'
   end
 end

data/rack-lti.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler',  '~> 1.3'
-  spec.add_development_dependency 'minitest', '~> 4.7.0'
+  spec.add_development_dependency 'minitest', '~> 5.0.6'
   spec.add_development_dependency 'rake'
 
-  spec.add_dependency 'ims-lti', '~> 1.1.2'
+  spec.add_dependency 'ims-lti', '~> 1.1.3'
   spec.add_dependency 'rack'
 end

data/test/config_test.rb

@@ -2,7 +2,7 @@ require 'minitest/autorun'
 require 'rexml/document'
 require 'rack/lti/config'
 
-class ConfigTest < Minitest::Unit::TestCase
+class ConfigTest < Minitest::Test
   def setup
     @config = Rack::LTI::Config.new
   end
@@ -33,6 +33,7 @@ class ConfigTest < Minitest::Unit::TestCase
     assert_equal true,                  @config.nonce_validator
     assert_equal 3600,                  @config.time_limit
     assert_equal 'LTI App',             @config.title
+    assert_equal true,                  @config.redirect
     assert_instance_of Proc,            @config.success
   end
 

data/test/lti_test.rb

@@ -1,7 +1,7 @@
 require 'minitest/autorun'
 require 'rack-lti'
 
-class LtiTest < Minitest::Unit::TestCase
+class LtiTest < Minitest::Test
   def setup
     @app = ->(env) { [200, [], ['Hi']] }
   end

data/test/middleware_test.rb

@@ -2,7 +2,7 @@ require 'minitest/autorun'
 require 'rack'
 require 'rack/lti/middleware'
 
-class MiddlewareTest < Minitest::Unit::TestCase
+class MiddlewareTest < Minitest::Test
 	def setup
 		@app     = ->(env) { [200, {}, ['hi']] }
 		@lti_app = Rack::LTI::Middleware.new(@app)
@@ -59,11 +59,12 @@ class MiddlewareTest < Minitest::Unit::TestCase
 
   def test_call_passes_the_nonce_to_the_given_proc
     assertion = MiniTest::Mock.new
-    assertion.expect(:call, true)
-    @lti_app.config.nonce_validator = ->(nonce) { assertion.call }
+    assertion.expect(:call, true, [@params['oauth_nonce']])
+    @lti_app.config.nonce_validator = ->(nonce) { assertion.call(nonce) }
 
     @lti_app.stub(:valid_request?, true) do
-      @lti_app.call(Rack::MockRequest.env_for('/lti/launch'))
+      @lti_app.call(Rack::MockRequest.env_for('/lti/launch',
+                                              method: 'post', params: @params))
       assertion.verify
     end
   end
@@ -105,17 +106,41 @@ class MiddlewareTest < Minitest::Unit::TestCase
       env = Rack::MockRequest.env_for('/lti/launch', method: 'post',
                                       params: @params)
       response = @lti_app.call(env)
-      assert_equal 301, response[0]
+      assert_equal 302, response[0]
       assert_equal @lti_app.config[:app_path], response[1]['Location']
     end
   end
 
+  def test_passes_request_through_if_redirect_is_false
+    @lti_app.config[:redirect] = false
+    @lti_app.stub(:valid_request?, true) do
+      env = Rack::MockRequest.env_for('/lti/launch', method: 'post',
+                                      params: @params)
+      response = @lti_app.call(env)
+      assert_equal 200, response[0]
+      assert_equal %w{hi}, response[2]
+    end
+  end
+
+  def test_call_passes_params_request_and_response_to_success_proc
+    @lti_app.config.success = ->(lti, req, res) {
+      assert_equal @params.sort,         lti.sort
+      assert_instance_of Rack::Request,  req
+      assert_instance_of Rack::Response, res
+    }
+    @lti_app.stub(:valid_request?, true) do
+      env = Rack::MockRequest.env_for('/lti/launch', method: 'post',
+                                      params: @params)
+      @lti_app.call(env)
+    end
+  end
+
   def test_call_succeeds_if_sessions_are_not_used
     @lti_app.stub(:valid_request?, true) do
       env = Rack::MockRequest.env_for('/lti/launch', method: 'post',
                                       params: @params)
       response = @lti_app.call(env)
-      assert_equal 301, response[0]
+      assert_equal 302, response[0]
     end
   end
 
@@ -149,5 +174,4 @@ class MiddlewareTest < Minitest::Unit::TestCase
       @lti_app.call(env)
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-lti
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Zach Pendleton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2013-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 5.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 5.0.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Middleware for handling LTI launches inside your Rack app.