lti2 0.0.1

data/lib/lti2_commons/test/test_jsonwrapper.rb

@@ -0,0 +1,230 @@
+require "test/unit"
+require "rubygems"
+require 'json'
+require 'jsonpath'
+
+require File.expand_path('../../lib/lti2_commons/json_wrapper', __FILE__)
+require File.expand_path('../../lib/lti2_commons/utils', __FILE__)
+
+include Lti2Commons
+include Utils
+
+class TestJsonWrapper < Test::Unit::TestCase
+  def setup
+    @json_str =
+<<PROXY
+{
+  "@context" : [
+      "http://www.imsglobal.org/imspurl/lti/v2/ctx/ToolProxy",
+      "http://purl.org/blackboard/ctx/v1/iconStyle"
+  ],
+  "@type" : "ToolProxy",
+  "@id" : "http://fabericious..com/ToolProxy/869e5ce5-214c-4e85-86c6-b99e8458a592",
+  "lti_version" : "LTI-2p0",
+  "tool_proxy_guid" : "869e5ce5-214c-4e85-86c6-b99e8458a592",
+  "tool_consumer_profile" : "http://lms.example.com/profile/b6ffa601-ce1d-4549-9ccf-145670a964d4",
+  "tool_profile" : {
+    "lti_version" : "LTI-2p0",
+    "product_instance" : {
+      "guid" : "fd75124a-140e-470f-944c-114d2d92bb40",
+      "product_info" : {
+        "product_name" : {
+          "default_value" : "Acme Assessments",
+          "key" : "tool.name"
+        },
+        "description" : {
+          "default_value" : "Acme Assessments provide an interactive test format.",
+          "key" : "tool.description"
+        },
+        "product_version" : "10.3",
+        "technical_description" : {
+          "default_value" : "Support provided for all LTI 1 extensions as well as LTI 2",
+          "key" : "tool.technical"
+        },
+        "product_family" : {
+          "code" : "assessment-tool",
+          "vendor" : {
+            "code" : "acme.com",
+            "name" : {
+              "default_value" : "Acme",
+              "key" : "tool.vendor.name"
+            },
+            "description" : {
+              "default_value" : "Acme is a leading provider of interactive tools for education",
+              "key" : "tool.vendor.description"
+            },
+            "website" : "http://acme.example.com",
+            "timestamp" : "2012-04-05T09:08:16-04:00",
+            "contact" : {
+              "email" : "info@example.com"
+            }
+          }
+        }
+      },
+      "support" : {
+        "email" : "helpdesk@example.com"
+      },
+      "service_provider" : {
+        "guid" : "18e7ea50-3d6d-4f6b-aff2-ed3ab577716c",
+        "provider_name" : {
+          "default_value" : "Acme Hosting",
+          "key" : "service_provider.name"
+        },
+        "description" : {
+          "default_value" : "Provider of high performance managed hosting environments",
+          "key" : "service_provider.description"
+        },
+        "support" : {
+          "email" : "support@acme-hosting.example.com"
+        },
+        "timestamp" : "2012-04-05T09:08:16-04:00"
+      }
+    },
+    "base_url_choice" : [
+       { "default_base_url" : "http://acme.example.com",
+         "secure_base_url" : "https://acme.example.com",
+         "selector" : {
+           "applies_to" : [
+             "IconEndpoint",
+             "MessageHandler"
+           ]
+         }
+       }
+     ],
+    "resource_handler" : [
+      {
+       "resource_type": "urn:lti:ResourceType:{fabericious.lti.org}/handler/launchRequest",
+        "name" : {
+          "default_value" : "Acme Assessment",
+          "key" : "assessment.resource.name"
+        },
+        "description" : {
+          "default_value" : "An interactive assessment using the Acme scale.",
+          "key" : "assessment.resource.description"
+        },
+        "message" : [{
+          "message_type" : "basic-lti-launch-request",
+          "path" : "/handler/launchRequest",
+          "capability" : [
+            "Result.autocreate",
+            "Result.sourcedGUID"
+          ],
+          "parameter" : [
+            { "name" : "result_id",
+              "variable" : "$Result.sourcedGUID"
+            },
+            { "name" : "discipline",
+              "fixed" : "chemistry"
+            }
+          ]
+        }],
+        "icon_info" : [
+           {
+             "default_location" : {
+               "path" : "/images/bb/en/icon.png"
+             },
+             "key" : "iconStyle.default.path"
+           },
+           { "icon_style" : "BbListElementIcon",
+             "default_location" : {
+               "path" : "/images/bb/en/listElement.png"
+             },
+             "key" : "iconStyle.bb.listElement.path"
+           },
+           { "icon_style" : "BbPushButtonIcon",
+             "default_location" : {
+               "path" : "images/bb/en/pushButton.png"
+             },
+             "key" : "iconStyle.bb.pushButton.path"
+           }
+         ]
+      }
+    ]
+  },
+  "security_contract" : {
+    "shared_secret" : "ThisIsASecret!",
+    "tool_service" : [
+      { "@type" : "RestServiceProfile",
+        "service" : "http://lms.example.com/profile/b6ffa601-ce1d-4549-9ccf-145670a964d4#ToolProxy.collection",
+        "action" : "POST"
+      },
+      { "@type" : "RestServiceProfile",
+        "service" : "http://lms.example.com/profile/b6ffa601-ce1d-4549-9ccf-145670a964d4#ToolProxy.item",
+        "action" : [
+          "GET",
+          "PUT"
+        ]
+      },
+      { "@type" : "RestService",
+        "service" : "http://lms.example.com/profile/b6ffa601-ce1d-4549-9ccf-145670a964d4#Result.item",
+        "action" : [
+          "GET",
+          "PUT"
+        ]
+      }
+    ]
+  }
+}
+PROXY
+
+  @json_wrapper = JsonWrapper.new @json_str
+  end
+
+  def test_constuctor
+    assert_not_nil @json_wrapper.root
+  end
+
+  def test_at
+    assert_equal ["869e5ce5-214c-4e85-86c6-b99e8458a592"], @json_wrapper.at('tool_proxy_guid')
+  end
+
+  def test_first_at
+    assert_equal "869e5ce5-214c-4e85-86c6-b99e8458a592", @json_wrapper.first_at('tool_proxy_guid')
+    assert_nil @json_wrapper.first_at('asdf')
+  end
+
+  def test_each_leaf
+    counter = 0
+    @json_wrapper.each_leaf { |node| counter += 1 }
+    assert_equal 70, counter
+  end
+
+  def test_deep_copy
+    new_json_wrapper = @json_wrapper.deep_copy
+    assert_not_equal new_json_wrapper.object_id, @json_wrapper.object_id
+    assert_equal "869e5ce5-214c-4e85-86c6-b99e8458a592", new_json_wrapper.first_at('tool_proxy_guid')
+  end
+
+  def test_search
+    assert_equal "/handler/launchRequest",
+        ( @json_wrapper.search 'tool_profile.resource_handler..message',
+            { 'message_type' => "basic-lti-launch-request" },
+            "path")
+    assert_nil @json_wrapper.search 'tool_profile.resource_handler..message',
+            { 'message_type' => "basic-lti-launch-request" },
+            "xxxx"
+    assert_nil @json_wrapper.search 'tool_profile.resource_handler..message',
+            { 'message_type' => "xxx" },
+            "path"
+  end
+
+  def test_select
+    assert_equal "http://acme.example.com",
+        @json_wrapper.select('tool_profile.base_url_choice',
+            "selector.applies_to", "MessageHandler", 'default_base_url')
+    assert_equal nil, @json_wrapper.select('tool_profile.xxxxx',
+            "selector.applies_to", "MessageHandler", 'default_base_url')
+  end
+
+  def test_each_deep_with_substitution
+    hash = {"root" => {"child1" => "{value}1", "child2" => {"grandchild1" => "{grand}{value}1"}, "child3" => "{value}3"}}
+    json_hash = JsonWrapper.new hash
+    subst_hash = {'value' => 'VLU', 'great' => 'GRT', 'grand' => 'GRND'}
+    json_hash.substitute_text_in_all_nodes '{', '}', subst_hash
+    assert_equal "VLU1", json_hash.first_at('$..child1')
+    assert_equal "GRNDVLU1", json_hash.first_at('$..grandchild1')
+  end
+
+  ARGV = ['', "--name", "test_select"]
+  # Test::Unit::AutoRunner.run(false, nil, ARGV)
+end

data/lib/lti2_commons/test/test_oauth_request.rb

@@ -0,0 +1,143 @@
+require 'test/unit'
+require File.expand_path('../../lib/lti2_commons/message_support', __FILE__)
+require File.expand_path('../../lib/lti2_commons/cache', __FILE__)
+require File.expand_path('../../lib/lti2_commons/utils', __FILE__)
+require File.expand_path('../../lib/lti2_commons/signer', __FILE__)
+require File.expand_path('../../lib/lti2_commons/oauth_request', __FILE__)
+
+require 'rack'
+require 'oauth'
+
+include Lti2Commons
+include Signer
+include Utils
+include MessageSupport
+include OAuth::RequestProxy
+
+class TestOAuthRequest < Test::Unit::TestCase
+  def setup
+    @launch_url = 'http://localhost:3000/tenants/3'
+    # @launch_url = 'http://vst-bc.com/tenants/3/books'
+    @http_method = 'post'
+    @consumer_key = '12345'
+    @consumer_secret = 'secret'
+    @params = {'oauth_consumer_key'=>'12345', 'oauth_signature_method'=> "HMAC-SHA1", 'user_id'=>'jt'}
+    @oauth_request = OAuth::OAuthProxy::OAuthRequest.new \
+      "method" => @http_method,
+      "uri" => @launch_url, 
+      "parameters" => @params
+    @nonce_cache = Lti2Commons::Cache.new :ttl => 300
+  end
+
+  def create_stale_request(minutes_stale)
+    now = Time::now
+    stale_time = now + (minutes_stale*60.0)
+    # puts "Now: #{now}  Stale_time: #{stale_time}]"
+    params = @params.dup
+    params['oauth_timestamp'] = stale_time.to_i
+    request = Lti2Commons::Signer.create_signed_request @launch_url, @http_method, @consumer_key, @consumer_secret, params
+    # dump_oauth_parameters request, "stale create"
+    request
+  end
+
+  def dump_oauth_parameters(request, label=nil)
+    puts ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+    if label
+      puts "*** #{label}"
+    end
+    puts "non_oauth_parameters: #{request.non_oauth_parameters.inspect}"
+    puts "oauth_header: #{request.oauth_header}"
+    puts "oauth_parameters: #{request.oauth_parameters.inspect}"
+    puts "signature_base_string: #{request.signature_base_string}"
+    puts "signed? #{request.signed?}"
+    puts "signed_uri: #{request.signed_uri}"
+    puts "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<"
+  end
+
+  def test_oauth_request
+    request = Signer.create_signed_request @launch_url, @http_method, @consumer_key, @consumer_secret, @params
+    dump_oauth_parameters(request, 'postsigning')
+  end
+
+  def test_valid_request
+    request = Signer.create_signed_request @launch_url, @http_method, @consumer_key, @consumer_secret, @params
+    assert_not_nil request
+    assert_equal true, request.verify_signature?(@consumer_secret, @nonce_cache)
+  end
+
+  def test_create_signed_request_simple_post
+    request = Lti2Commons::Signer.create_signed_request @launch_url, @http_method, @consumer_key, @consumer_secret, @params
+    assert_not_nil request
+    signature_base_string = request.signature_base_string
+    assert_equal "POST&http%3A%2F%2Flocalhost%3A3000%2Ftenants%2F3&basiclti_submit%3DPress%2520t", signature_base_string[0..77]
+  end
+
+  def test_create_signed_request_get
+    request = Lti2Commons::Signer.create_signed_request @launch_url, 'get', @consumer_key, @consumer_secret, @params
+    assert_not_nil request
+    signature_base_string = request.signature_base_string
+    assert_equal "GET&http%3A%2F%2Flocalhost%3A3000%2Ftenants%2F3&basiclti_submit%3DPress%2520t", signature_base_string[0..76]
+  end
+
+  def test_create_signed_request_put
+    request = Lti2Commons::Signer.create_signed_request @launch_url, 'put', @consumer_key, @consumer_secret, @params
+    assert_not_nil request
+    signature_base_string = request.signature_base_string
+    assert_equal "PUT&http%3A%2F%2Flocalhost%3A3000%2Ftenants%2F3&basiclti_submit%3DPress%2520t", signature_base_string[0..76]
+  end
+
+  def test_lti_message_body_from_signed_request
+    request = Signer.create_signed_request @launch_url, 'put', @consumer_key, @consumer_secret, @params
+    assert_not_nil request
+    assert_not_nil MessageSupport.create_lti_message_body_from_signed_request request
+    puts MessageSupport.create_lti_message_body_from_signed_request request
+  end
+
+  def test_lti_message_body
+    assert_not_nil MessageSupport.create_lti_message_body @launch_url, @params
+    puts MessageSupport.create_lti_message_body @launch_url, @params
+  end
+
+  def test_break_signature
+    request = Lti2Commons::Signer.create_signed_request @launch_url, @http_method, @consumer_key, @consumer_secret, @params
+    request.parameters['oauth_signature'] = "asdf"
+    assert_equal false, (request.verify_signature? @consumer_secret, @nonce_cache)
+  end
+
+  def test_exception_on_signature_error
+    request = Lti2Commons::Signer.create_signed_request @launch_url, @http_method, @consumer_key, @consumer_secret, @params
+    request.parameters['oauth_signature'] = "asdf"
+    begin
+      request.verify_signature? @consumer_secret, @nonce_cache, false
+      fail "Exception expected here"
+    rescue
+      # expected
+    end
+  end
+
+  def test_timeout_within_margin
+    request = create_stale_request 2
+    assert_equal true, (request.verify_signature? @consumer_secret, @nonce_cache)
+    request = create_stale_request(-2)
+    assert_equal true, (request.verify_signature? @consumer_secret, @nonce_cache)
+  end
+
+  def test_timeout_error
+    request = create_stale_request 10
+    assert_equal false, (request.verify_signature? @consumer_secret, @nonce_cache)
+    request = create_stale_request(-10)
+    assert_equal false, (request.verify_signature? @consumer_secret, @nonce_cache)
+  end
+
+  def test_duplicate_nonce
+    params = @params.dup
+    params['oauth_nonce'] = "1234"
+    request = Lti2Commons::Signer.create_signed_request @launch_url, @http_method, @consumer_key, @consumer_secret, params
+    assert_equal true, (request.verify_signature? @consumer_secret, @nonce_cache)
+    request = Lti2Commons::Signer.create_signed_request @launch_url, @http_method, @consumer_key, @consumer_secret, params
+    assert_equal false, (request.verify_signature? @consumer_secret, @nonce_cache)
+  end
+
+  ARGV = ['', "--name", "test_duplicate_nonce"]
+  Test::Unit::AutoRunner.run(false, nil, ARGV)
+end

data/lib/lti2_commons/test/test_substitution_support.rb

@@ -0,0 +1,71 @@
+require 'test/unit'
+require File.expand_path('../../lib/lti2_commons/substitution_support', __FILE__)
+
+include Lti2Commons
+include SubstitutionSupport
+
+
+class TestObject
+  attr_accessor :user_id, :name
+
+  def initialize
+    @user_id = 'jt'
+    @name = "john.thomas"
+    @code = @name.reverse
+  end
+
+  def to_s
+    @user_id
+  end
+end
+
+class TestSubstitutionSupport < Test::Unit::TestCase
+  def setup
+    @resolver = Resolver.new
+    @resolver.add_resolver "user", {'name' => "jt", 'id' => "1234"}
+    @resolver.add_resolver "user", {'name' => "jt", 'id' => "9876", 'sport' => 'judo'}
+    @resolver.add_resolver "course", lambda { |x| "COURSE-#{x}"}
+    @resolver.add_resolver "resource", self.method(:resource_transform_sample)
+    @resolver.add_resolver "testobject", TestObject.new
+    @resolver.add_resolver "testnest", {'nestlevel' => 'inner'}
+    @resolver.add_resolver "*",  {'ip'=> '192.168.2.177'}
+  end
+
+  def resource_transform_sample(name)
+    name.reverse
+  end
+
+  def test_add_hash
+    assert_equal "jt", @resolver.resolve('user.name')
+    assert_equal "judo", @resolver.resolve('user.sport')
+    assert_equal "192.168.2.177", @resolver.resolve('user.ip')
+    assert_equal "192.168.2.177", @resolver.resolve('foo.ip')
+    assert_equal "user.notfound", @resolver.resolve('user.notfound')
+  end
+
+  def test_add_block
+    assert_equal "COURSE-anything", @resolver.resolve('course.anything')
+  end
+
+  def test_internal_method
+    assert_equal "fdsa", @resolver.resolve('resource.asdf')
+  end
+
+  def test_testobject
+    assert_equal "john.thomas", @resolver.resolve('testobject.name')
+  end
+
+  def test_nested_resolver
+    outer_resolver = Resolver.new
+    outer_resolver.add_resolver "testnest", {'nestlevel' => 'outer'}
+    outer_resolver.add_resolver "inner", @resolver
+
+    assert_equal "inner", @resolver.resolve('testnest.nestlevel')
+    assert_equal "outer", outer_resolver.resolve('testnest.nestlevel')
+    assert_equal "jt", outer_resolver.resolve('user.name')
+    assert_equal "COURSE-anything", outer_resolver.resolve('course.anything')
+  end
+
+  ARGV = ['', "--name", "test_nested_resolver"]
+  # Test::Unit::AutoRunner.run(false, nil, ARGV)
+end

data/lib/lti2_commons/test/test_wire_log.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../../lib/lti2_commons/wire_log', __FILE__)
+require File.expand_path('../../lib/lti2_commons/mock_request', __FILE__)
+
+wl = Lti2Commons::WireLogSupport::WireLog.new 'test', 'test.txt'
+
+wl.clear_log
+wl.log 'test'
+wl.log 'tube'
+
+wl.log <<aa
+hello,
+how are you?
+aa
+
+puts 'done'