ims-lti 1.0.2 → 1.1.0

data/Changelog

@@ -0,0 +1,22 @@
+2012-08-14 Version 1.1.0
+
+    * Added framework for LTI extensions
+    * Added LTI outcome data extension
+    * Fix tests reliant on random ordering
+    * Add rails 3 note to readme install docs
+    * Create Changelog
+    
+
+2012-03-14 Version 1.0.2
+
+    * Refactor OAuth validation into its own module
+    
+    
+2012-03-13 Version 1.0.1
+
+    * Add gem dependencies to gemspec
+
+
+2012-03-11 Version 1.0.0
+
+    * Publish fully functional and operational IMS LTI library

data/README.md

@@ -16,10 +16,12 @@ 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 app:
+    # For a Sinatra or a Rails 3 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
 
-    # For a rails app:
+    # For a Rails 2.3 app:
     require 'oauth/request_proxy/action_controller_request'
 
 For further information see the [oauth-ruby](https://github.com/oauth/oauth-ruby) project.

data/ims-lti.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{ims-lti}
-  s.version = "1.0.2"
+  s.version = "1.1.0"
 
   s.add_dependency 'builder'
   s.add_dependency 'oauth', '~> 0.4.5'
@@ -10,13 +10,16 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'ruby-deug'
 
   s.authors = ["Instructure"]
-  s.date = %q{2012-03-14}
+  s.date = %q{2012-08-14}
   s.extra_rdoc_files = %W(LICENSE)
   s.files = %W(
+          Changelog
           LICENSE
           README.md
           lib/ims.rb
           lib/ims/lti.rb
+          lib/ims/lti/extensions.rb
+          lib/ims/lti/extensions/outcome_data.rb
           lib/ims/lti/launch_params.rb
           lib/ims/lti/outcome_request.rb
           lib/ims/lti/outcome_response.rb

data/lib/ims/lti.rb

@@ -26,6 +26,8 @@ module IMS # :nodoc:
   #
   #    require 'ims/lti'
   module LTI
+    
+    # The versions of LTI this library supports
     VERSIONS = %w{1.0 1.1}
     
     class InvalidLTIConfigError < StandardError
@@ -38,6 +40,7 @@ module IMS # :nodoc:
   end
 end
 
+require 'ims/lti/extensions'
 require 'ims/lti/launch_params'
 require 'ims/lti/request_validator'
 require 'ims/lti/tool_provider'

data/lib/ims/lti/extensions.rb

@@ -0,0 +1,43 @@
+
+module IMS::LTI
+  module Extensions
+    
+    # Base functionality for creating LTI extension modules
+    # See the test for this class for a simple example of how to create an extension module
+    module Base
+      def outcome_request_extensions
+        []
+      end
+      
+      def outcome_response_extensions
+        []
+      end
+      
+      def extend_outcome_request(request)
+        outcome_request_extensions.each do |ext|
+          request.extend(ext)
+        end
+        request
+      end
+      
+      def extend_outcome_response(response)
+        outcome_response_extensions.each do |ext|
+          response.extend(ext)
+        end
+        response
+      end
+    end
+
+    module ExtensionBase
+      def outcome_request_extensions
+        super
+      end
+
+      def outcome_response_extensions
+        super
+      end
+    end
+  end
+end
+
+require 'ims/lti/extensions/outcome_data'

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

@@ -0,0 +1,144 @@
+module IMS::LTI
+  module Extensions
+
+    # An LTI extension that adds support for sending data back to the consumer
+    # in addition to the score.
+    #
+    #     # Initialize TP object with OAuth creds and post parameters
+    #     provider = IMS::LTI::ToolProvider.new(consumer_key, consumer_secret, params)
+    #     # add extension
+    #     provider.extend IMS::LTI::Extensions::OutcomeData::ToolProvider
+    #
+    # If the tool was launch as an outcome service and it supports the data extension
+    # you can POST a score to the TC.
+    # The POST calls all return an OutcomeResponse object which can be used to
+    # handle the response appropriately.
+    #
+    #     # post the score to the TC, score should be a float >= 0.0 and <= 1.0
+    #     # this returns an OutcomeResponse object
+    #     if provider.accepts_outcome_text?
+    #       response = provider.post_replace_result_with_data!(score, "text" => "submission text")
+    #     else
+    #       response = provider.post_replace_result!(score)
+    #     end
+    #     if response.success?
+    #       # grade write worked
+    #     elsif response.processing?
+    #     elsif response.unsupported?
+    #     else
+    #       # failed
+    #     end
+    module OutcomeData
+
+      #IMS::LTI::Extensions::OutcomeData::ToolProvider
+      module Base
+        def outcome_request_extensions
+          super + [IMS::LTI::Extensions::OutcomeData::OutcomeRequest]
+        end
+      end
+
+      module ToolProvider
+        include IMS::LTI::Extensions::ExtensionBase
+        include Base
+
+        # a list of the supported outcome data types
+        def accepted_outcome_types
+          return @outcome_types if @outcome_types
+          @outcome_types = []
+          if val = @ext_params["outcome_data_values_accepted"]
+            @outcome_types = val.split(',')
+          end
+
+          @outcome_types
+        end
+
+        # check if the outcome data extension is supported
+        def accepts_outcome_data?
+          !!@ext_params["outcome_data_values_accepted"]
+        end
+
+        # check if the consumer accepts text as outcome data
+        def accepts_outcome_text?
+          accepted_outcome_types.member?("text")
+        end
+
+        # check if the consumer accepts a url as outcome data
+        def accepts_outcome_url?
+          accepted_outcome_types.member?("url")
+        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" or "url"
+        #
+        # Creates a new OutcomeRequest object and stores it in @outcome_requests
+        #
+        # @return [OutcomeResponse] the response from the Tool Consumer
+        def post_replace_result_with_data!(score, data={})
+          req = new_request
+          req.outcome_text = data["text"] if data["text"]
+          req.outcome_url = data["url"] if data["url"]
+          req.post_replace_result!(score)
+        end
+
+      end
+
+      module ToolConsumer
+        include IMS::LTI::Extensions::ExtensionBase
+        include Base
+        
+        OUTCOME_DATA_TYPES = %w{text url}
+
+        # a list of the outcome data types accepted, currently only 'url' and
+        # 'text' are valid
+        #
+        #    tc.outcome_data_values_accepted(['url', 'text'])
+        #    tc.outcome_data_valued_accepted("url,text")
+        def outcome_data_values_accepted=(val)
+          if val.is_a? Array
+            val = val.join(',')
+          end
+          
+          set_ext_param('outcome_data_values_accepted', val)
+        end
+
+        # a comma-separated string of the supported outcome data types
+        def outcome_data_values_accepted
+          get_ext_param('outcome_data_values_accepted')
+        end
+        
+        # convenience method for setting support for all current outcome data types
+        def support_outcome_data!
+          self.outcome_data_values_accepted = OUTCOME_DATA_TYPES
+        end
+      end
+
+      module OutcomeRequest
+        include IMS::LTI::Extensions::ExtensionBase
+        include Base
+
+        attr_accessor :outcome_text, :outcome_url
+
+        def result_values(node)
+          super
+          if @outcome_text || @outcome_url
+            node.resultData do |res_data|
+              res_data.text @outcome_text if @outcome_text
+              res_data.url @outcome_url if @outcome_url
+            end
+          end
+        end
+
+        def has_result_data?
+          !!@outcome_text || !!@outcome_url || super
+        end
+        
+        def extention_process_xml(doc)
+          super
+          @outcome_text = doc.get_text("//resultRecord/result/resultData/text")
+          @outcome_url = doc.get_text("//resultRecord/result/resultData/url")
+        end
+      end
+
+    end
+  end
+end

data/lib/ims/lti/outcome_request.rb

@@ -33,6 +33,7 @@ module IMS::LTI
   #      # return an unsupported OutcomeResponse
   #    end
   class OutcomeRequest
+    include IMS::LTI::Extensions::Base
 
     REPLACE_REQUEST = 'replaceResult'
     DELETE_REQUEST = 'deleteResult'
@@ -56,15 +57,19 @@ module IMS::LTI
     #    req = IMS::LTI::OutcomeRequest.from_post_request(request)
     def self.from_post_request(post_request)
       request = OutcomeRequest.new
-      request.post_request = post_request
+      request.process_post_request(post_request)
+    end
+
+    def process_post_request(post_request)
+      self.post_request = post_request
       if post_request.body.respond_to?(:read)
-        xml =  post_request.body.read
+        xml = post_request.body.read
         post_request.body.rewind
       else
-        xml =   post_request.body
+        xml = post_request.body
       end
-      request.process_xml(xml)
-      request
+      self.process_xml(xml)
+      self
     end
 
     # POSTs the given score to the Tool Consumer with a replaceResult
@@ -125,7 +130,8 @@ module IMS::LTI
               generate_request_xml,
               'Content-Type' => 'application/xml'
       )
-      @outcome_response = OutcomeResponse.from_post_response(res)
+      @outcome_response = extend_outcome_response(OutcomeResponse.new)
+      @outcome_response.process_post_response(res)
     end
 
     # Parse Outcome Request data from XML
@@ -142,9 +148,34 @@ module IMS::LTI
         @operation = REPLACE_REQUEST
         @score = doc.get_text("//resultRecord/result/resultScore/textString")
       end
+      extention_process_xml(doc)
     end
 
     private
+    
+    def extention_process_xml(doc)
+    end
+    
+    def has_result_data?
+      !!@score
+    end
+    
+    def results(node)
+      return unless has_result_data?
+      
+      node.result do |res|
+        result_values(res)
+      end
+    end
+
+    def result_values(node)
+      if @score
+        node.resultScore do |res_score|
+          res_score.language "en" # 'en' represents the format of the number
+          res_score.textString @score.to_s
+        end
+      end
+    end
 
     def has_required_attributes?
       @consumer_key && @consumer_secret && @lis_outcome_service_url && @lis_result_sourcedid && @operation
@@ -167,14 +198,7 @@ module IMS::LTI
               record.sourcedGUID do |guid|
                 guid.sourcedId @lis_result_sourcedid
               end
-              if @score
-                record.result do |res|
-                  res.resultScore do |res_score|
-                    res_score.language "en" # 'en' represents the format of the number
-                    res_score.textString @score.to_s
-                  end
-                end
-              end
+              results(record)
             end
           end
         end

data/lib/ims/lti/outcome_response.rb

@@ -45,7 +45,8 @@ module IMS::LTI
   #    res.generate_response_xml
   #
   class OutcomeResponse
-
+    include IMS::LTI::Extensions::Base
+    
     attr_accessor :request_type, :score, :message_identifier, :response_code,
             :post_response, :code_major, :severity, :description, :operation,
             :message_ref_identifier
@@ -67,11 +68,15 @@ module IMS::LTI
     #    req = IMS::LTI::OutcomeResponse.from_post_response(response)
     def self.from_post_response(post_response)
       response = OutcomeResponse.new
-      response.post_response = post_response
-      response.response_code = post_response.code
+      response.process_post_response(post_response)
+    end
+    
+    def process_post_response(post_response)
+      self.post_response = post_response
+      self.response_code = post_response.code
       xml = post_response.body
-      response.process_xml(xml)
-      response
+      self.process_xml(xml)
+      self
     end
 
     def success?

data/lib/ims/lti/tool_config.rb

@@ -163,19 +163,23 @@ module IMS::LTI
 
         if !@custom_params.empty?
           blti_node.tag!("blti:custom") do |custom_node|
-            @custom_params.each_pair do |key, val|
+            @custom_params.keys.sort.each do |key|
+              val = @custom_params[key]
               custom_node.lticm :property, val, 'name' => key
             end
           end
         end
 
         if !@extensions.empty?
-          @extensions.each_pair do |ext_platform, ext_params|
+          @extensions.keys.sort.each do |ext_platform|
+            ext_params = @extensions[ext_platform]
             blti_node.blti(:extensions, :platform => ext_platform) do |ext_node|
-              ext_params.each_pair do |key, val|
+              ext_params.keys.sort.each do |key|
+                val = ext_params[key]
                 if val.is_a?(Hash)
                   ext_node.lticm(:options, :name => key) do |type_node|
-                    val.each_pair do |p_key, p_val|
+                    val.keys.sort.each do |p_key|
+                      p_val = val[p_key]
                       type_node.lticm :property, p_val, 'name' => p_key
                     end
                   end

data/lib/ims/lti/tool_consumer.rb

@@ -1,6 +1,7 @@
 module IMS::LTI
   # Class for implementing an LTI Tool Consumer
   class ToolConsumer
+    include IMS::LTI::Extensions::Base
     include IMS::LTI::LaunchParams
     include IMS::LTI::RequestValidator
 
@@ -20,6 +21,11 @@ module IMS::LTI
       @launch_url = params['launch_url']
       process_params(params)
     end
+    
+    def process_post_request(post_request)
+      request = extend_outcome_request(OutcomeRequest.new)
+      request.process_post_request(post_request)
+    end
 
     # Set launch data from a ToolConfig
     #

data/lib/ims/lti/tool_provider.rb

@@ -34,6 +34,7 @@ module IMS::LTI
   #     end
 
   class ToolProvider
+    include IMS::LTI::Extensions::Base
     include IMS::LTI::LaunchParams
     include IMS::LTI::RequestValidator
 
@@ -157,7 +158,8 @@ module IMS::LTI
                          :consumer_secret => @consumer_secret,
                          :lis_outcome_service_url => lis_outcome_service_url,
                          :lis_result_sourcedid =>lis_result_sourcedid)
-      @outcome_requests.last
+      
+      extend_outcome_request(@outcome_requests.last)
     end
     
   end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 2
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Instructure
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-14 00:00:00 Z
+date: 2012-08-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -98,10 +98,13 @@ 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/outcome_data.rb
 - lib/ims/lti/launch_params.rb
 - lib/ims/lti/outcome_request.rb
 - lib/ims/lti/outcome_response.rb
@@ -145,3 +148,4 @@ specification_version: 3
 summary: Ruby library for creating IMS LTI tool providers and consumers
 test_files: []
 
+has_rdoc: