ims-lti 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f08cf8db456b71aa74d6c55cecb8e76dc5ae4ad7
-  data.tar.gz: 5f1a47d7a25c957228b9f2bc3038ee5d64bc5b30
+  metadata.gz: 30c0efa0ce7f96bcb4ef189cfd60206dada68fa6
+  data.tar.gz: 1a788b9cef77da96a66b68426fb8ca3c5bbc29f8
 SHA512:
-  metadata.gz: c79e28940abe36bec574f89263f3650948f8e60010061f9799f9c013129d97c13d388ed1eb708f1328a171578db374ccc435e49148849f6e08c6700c9d302728
-  data.tar.gz: 1ed5c8d404daaea3e46177bf5761812a5ae59becc7de4d8e44a736358ee4d991fd71259bfff6c739d05155bd6c8e930bbad104d0719a08a3a6a6a2b1698c9298
+  metadata.gz: fe08421395b4c2de12200c3e981ea0e62a5dac27d6c505360605693b2da7fb7e1a64f48b665136edb1aaec0e1ee31f14c0ce35ac42ad9c3b71d1ed3f88782c6f
+  data.tar.gz: b795c096542903e7306631f97c4d441316db70e13edbec0413c9f3b3d2d8334db8e0bbb6d13488525aae62be65550ed41276e3ba5019fe24e2a3f01d4ac44e0c

data/Changelog

@@ -1,3 +1,6 @@
+2015-01-09 Version 1.1.7
+    * Add support for new outcome extension resultTotalScore
+
 2013-04-24 Version 1.1.3
 
     * Corrected lti_version launch parameter

data/README.md

@@ -16,7 +16,7 @@ To require the library in your project:
 To validate the OAuth signatures you need to require the appropriate request
 proxy for your application. For example:
 
-    # For a Sinatra or a Rails 3 app:
+    # For a Sinatra or a Rails 3 or 4 app:
     require 'oauth/request_proxy/rack_request'
     # You also need to explicitly enable OAuth 1 support in the environment.rb or an initializer:
     OAUTH_10_SUPPORT = true
@@ -32,20 +32,20 @@ very helpful to read the [LTI documentation](http://www.imsglobal.org/lti/index.
 
 In LTI there are Tool Providers (TP) and Tool Consumers (TC), this library is
 useful for implementing both. Here is an overview of the communication process:
-[LTI 1.1 Introduction](http://www.imsglobal.org/lti/v1p1pd/ltiIMGv1p1pd.html#_Toc309649680)
+[LTI 1.1 Introduction](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560461)
 
 This library doesn't help you manage the consumer keys and secrets. The POST
 headers/parameters will contain the `oauth_consumer_key` and your app can use
 that to look up the appropriate `oauth_consumer_secret`.
 
 Your app will also need to manage the OAuth nonce to make sure the same nonce
-isn't used twice with the same timestamp. [Read the LTI documentation on OAuth](http://www.imsglobal.org/LTI/v1p1pd/ltiIMGv1p1pd.html#_Toc309649687).
+isn't used twice with the same timestamp. [Read the LTI documentation on OAuth](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560468).
 
 ### Tool Provider
 As a TP your app will receive a POST request with a bunch of
-[LTI launch data](http://www.imsglobal.org/lti/v1p1pd/ltiIMGv1p1pd.html#_Toc309649684)
+[LTI launch data](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560465)
 and it will be signed with OAuth using a key/secret that both the TP and TC share.
-This is covered in the [LTI security model](http://www.imsglobal.org/lti/v1p1pd/ltiIMGv1p1pd.html#_Toc309649685)
+This is covered in the [LTI security model](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560466)
 
 Here is an example of a simple TP Sinatra app using this gem:
 [LTI Tool Provider](https://github.com/instructure/lti_tool_provider_example)
@@ -66,13 +66,13 @@ end
 ```
 
 Once your TP object is initialized and verified you can load your tool. All of the
-[launch data](http://www.imsglobal.org/lti/v1p1pd/ltiIMGv1p1pd.html#_Toc309649684)
+[launch data](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560465)
 is available in the TP object along with some convenience methods like `provider.username`
 which will try to find the name from the 3 potential name launch data attributes.
 
 #### Returning Results of a Quiz/Assignment
 If your TP provides some kind of assessment service you can write grades back to
-the TC. This is documented in the LTI docs [here](http://www.imsglobal.org/lti/v1p1pd/ltiIMGv1p1pd.html#_Toc309649690).
+the TC. This is documented in the LTI docs [here](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560471).
 
 You can check whether the TC is expecting a grade write-back:
 
@@ -105,8 +105,8 @@ You can see the error code documentation
 
 ### Tool Consumer
 As a Tool Consumer your app will POST an OAuth-signed launch requests to TPs with the necessary
-[LTI launch data](http://www.imsglobal.org/lti/v1p1pd/ltiIMGv1p1pd.html#_Toc309649684).
-This is covered in the [LTI security model](http://www.imsglobal.org/lti/v1p1pd/ltiIMGv1p1pd.html#_Toc309649685)
+[LTI launch data](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560465).
+This is covered in the [LTI security model](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560466)
 
 Here is an example of a simple TC Sinatra app using this gem:
 [LTI Tool Consumer](https://github.com/instructure/lti_tool_consumer_example)

data/lib/ims/lti/extensions/outcome_data.rb

@@ -67,6 +67,10 @@ module IMS::LTI
           accepted_outcome_types.member?("url")
         end
 
+        def accepts_outcome_result_total_score?
+          !!@ext_params["outcome_result_total_score_accepted"]
+        end
+
         # POSTs the given score to the Tool Consumer with a replaceResult and
         # adds the specified data. The data hash can have the keys "text", "cdata_text", or "url"
         #
@@ -77,6 +81,7 @@ module IMS::LTI
         # Creates a new OutcomeRequest object and stores it in @outcome_requests
         #
         # @return [OutcomeResponse] the response from the Tool Consumer
+        # @deprecated Use #post_extended_replace_result! instead
         def post_replace_result_with_data!(score = nil, data={})
           req = new_request
           if data["cdata_text"] 
@@ -87,6 +92,29 @@ module IMS::LTI
           req.outcome_url = data["url"] if data["url"]
           req.post_replace_result!(score)
         end
+
+        # POSTs the given score to the Tool Consumer with a replaceResult and
+        # adds the specified data. The options hash can have the keys
+        # :text, :cdata_text, :url, :score, or :total_score
+        #
+        # If both cdata_text and text are sent, cdata_text will be used
+        # If both total_score and score are sent, total_score will be used
+        # If score is nil, the replace result XML will not contain a resultScore node
+        #
+        # Creates a new OutcomeRequest object and stores it in @outcome_requests
+        #
+        # @return [OutcomeResponse] the response from the Tool Consumer
+        def post_extended_replace_result!(options = {})
+          opts = {}
+          options.each {|k,v| opts[k.to_sym] = v}
+
+          req = new_request
+          req.outcome_cdata_text = opts[:cdata_text]
+          req.outcome_text = opts[:text]
+          req.outcome_url = opts[:url]
+          req.total_score = opts[:total_score]
+          req.post_replace_result!(opts[:score])
+        end
       end
 
       module ToolConsumer
@@ -123,26 +151,38 @@ module IMS::LTI
         include IMS::LTI::Extensions::ExtensionBase
         include Base
 
-        attr_accessor :outcome_text, :outcome_url, :outcome_cdata_text
+        attr_accessor :outcome_text, :outcome_url, :outcome_cdata_text, :total_score
 
         def result_values(node)
           super
-          if @outcome_text || @outcome_url || @outcome_cdata_text
+
+          if total_score
+            node.resultTotalScore do |res_total_score|
+              res_total_score.language "en" # 'en' represents the format of the number
+              res_total_score.textString total_score.to_s
+            end
+          end
+
+          if outcome_text || outcome_url || outcome_cdata_text
             node.resultData do |res_data|
-              if @outcome_cdata_text
+              if outcome_cdata_text
                 res_data.text {
-                  res_data.cdata! @outcome_cdata_text
+                  res_data.cdata! outcome_cdata_text
                 }
-              elsif @outcome_text
-                res_data.text @outcome_text
+              elsif outcome_text
+                res_data.text outcome_text
               end
-              res_data.url @outcome_url if @outcome_url
+              res_data.url outcome_url if outcome_url
             end
           end
         end
 
+        def score
+          total_score ? nil : @score
+        end
+
         def has_result_data?
-          !!@outcome_text || !!@outcome_url || super
+          !!outcome_text || !!outcome_url || !!outcome_cdata_text || !!total_score || super
         end
         
         def extention_process_xml(doc)

data/lib/ims/lti/outcome_request.rb

@@ -154,7 +154,7 @@ module IMS::LTI
     end
     
     def has_result_data?
-      !!@score
+      !!score
     end
     
     def results(node)
@@ -166,10 +166,10 @@ module IMS::LTI
     end
 
     def result_values(node)
-      if @score
+      if score
         node.resultScore do |res_score|
           res_score.language "en" # 'en' represents the format of the number
-          res_score.textString @score.to_s
+          res_score.textString score.to_s
         end
       end
     end
@@ -182,7 +182,7 @@ module IMS::LTI
       builder = Builder::XmlMarkup.new #(:indent=>2)
       builder.instruct!
 
-      builder.imsx_POXEnvelopeRequest("xmlns" => "http://www.imsglobal.org/lis/oms1p0/pox") do |env|
+      builder.imsx_POXEnvelopeRequest("xmlns" => "http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0") do |env|
         env.imsx_POXHeader do |header|
           header.imsx_POXRequestHeaderInfo do |info|
             info.imsx_version "V1.0"

data/lib/ims/lti/outcome_response.rb

@@ -125,7 +125,8 @@ module IMS::LTI
       builder = Builder::XmlMarkup.new
       builder.instruct!
 
-      builder.imsx_POXEnvelopeResponse("xmlns" => "http://www.imsglobal.org/lis/oms1p0/pox") do |env|
+      # builder.imsx_POXEnvelopeResponse("xmlns" => "http://www.imsglobal.org/lis/oms1p0/pox") do |env|
+      builder.imsx_POXEnvelopeResponse("xmlns" => "http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0") do |env|
         env.imsx_POXHeader do |header|
           header.imsx_POXResponseHeaderInfo do |info|
             info.imsx_version "V1.0"

data/lib/ims/lti/tool_base.rb

@@ -1,12 +1,19 @@
 module IMS::LTI
   class ToolBase
+    include IMS::LTI::Extensions::Base
+    include IMS::LTI::LaunchParams
+    include IMS::LTI::RequestValidator
 
     # OAuth credentials
     attr_accessor :consumer_key, :consumer_secret
 
-    def initialize(consumer_key, consumer_secret)
+    def initialize(consumer_key, consumer_secret, params={})
       @consumer_key = consumer_key
       @consumer_secret = consumer_secret
+      @custom_params = {}
+      @ext_params = {}
+      @non_spec_params = {}
+      process_params(params)
     end
 
     # Convenience method for doing oauth signed requests to services that

data/lib/ims/lti/tool_consumer.rb

@@ -1,10 +1,6 @@
 module IMS::LTI
   # Class for implementing an LTI Tool Consumer
   class ToolConsumer < ToolBase
-    include IMS::LTI::Extensions::Base
-    include IMS::LTI::LaunchParams
-    include IMS::LTI::RequestValidator
-
     attr_accessor :launch_url, :timestamp, :nonce
 
     # Create a new ToolConsumer
@@ -13,12 +9,8 @@ module IMS::LTI
     # @param consumer_secret [String] The OAuth consumer secret
     # @param params [Hash] Set the launch parameters as described in LaunchParams
     def initialize(consumer_key, consumer_secret, params={})
-      super(consumer_key, consumer_secret)
-      @custom_params = {}
-      @ext_params = {}
-      @non_spec_params = {}
+      super(consumer_key, consumer_secret, params)
       @launch_url = params['launch_url']
-      process_params(params)
     end
     
     def process_post_request(post_request)

data/lib/ims/lti/tool_provider.rb

@@ -34,10 +34,6 @@ module IMS::LTI
   #     end
 
   class ToolProvider < ToolBase
-    include IMS::LTI::Extensions::Base
-    include IMS::LTI::LaunchParams
-    include IMS::LTI::RequestValidator
-
     # List of outcome requests made through this instance
     attr_accessor :outcome_requests
     # Message to be sent back to the ToolConsumer when the user returns
@@ -49,12 +45,8 @@ module IMS::LTI
     # @param consumer_secret [String] The OAuth consumer secret
     # @param params [Hash] Set the launch parameters as described in LaunchParams
     def initialize(consumer_key, consumer_secret, params={})
-      super(consumer_key, consumer_secret)
-      @custom_params = {}
-      @ext_params = {}
-      @non_spec_params = {}
+      super(consumer_key, consumer_secret, params)
       @outcome_requests = []
-      process_params(params)
     end
 
     # Check whether the Launch Parameters have a role

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.7
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -87,10 +87,15 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
 files:
+- Changelog
+- LICENSE
+- README.md
+- lib/ims.rb
+- lib/ims/lti.rb
+- lib/ims/lti/extensions.rb
 - lib/ims/lti/extensions/canvas.rb
 - lib/ims/lti/extensions/content.rb
 - lib/ims/lti/extensions/outcome_data.rb
-- lib/ims/lti/extensions.rb
 - lib/ims/lti/launch_params.rb
 - lib/ims/lti/outcome_request.rb
 - lib/ims/lti/outcome_response.rb
@@ -99,11 +104,6 @@ files:
 - lib/ims/lti/tool_config.rb
 - lib/ims/lti/tool_consumer.rb
 - lib/ims/lti/tool_provider.rb
-- lib/ims/lti.rb
-- lib/ims.rb
-- LICENSE
-- README.md
-- Changelog
 homepage: http://github.com/instructure/ims-lti
 licenses:
 - MIT
@@ -114,17 +114,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers