ims-lti 1.1.13 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 349045d52db72ab3885b106c5874f5e6c217fed2
-  data.tar.gz: 3dd49abc26a739d0c313f8bdb477317a79c2598d
+SHA256:
+  metadata.gz: 801e423357504d51cc0289e45e364d026abd4bbad20dfca90107725796cd258f
+  data.tar.gz: cfdcb37216eef088886486f951af05f719b086f7f32f7d8d83dc04f3020b563e
 SHA512:
-  metadata.gz: 14f47290fd89679b75b5e5b4957b08c9431e50b69632a313f89a194454b61126c8ee801b5329b246b8c64d7458698629bb289de1c66450498f20051be803506c
-  data.tar.gz: befc124ca8958e2912466f3a79dd8f20a9105cba6614a3bfe96d374d6dcffa2634493138a08727ef7ffc1d1a929624ee8d3b40e92cfe6f69b5d53f1f984172d0
+  metadata.gz: fcc31ec46d3fccb7585bbe3d6dff5ab88227ccea12b4c056a2f8c588a864b26bb9d74d13601e2b08f7bcc404d215b4b0be14a3b96b613b79e795edfeb8ad2d0c
+  data.tar.gz: 0bfa98f889d2b848e03200a22f76447bab3df748c9b6a351d42d5ec9218838ba749f5751af59efd5ae8f7db701a28fcf5b8b92cecb253ebfc097cce3cfb7ff59

data/Changelog

@@ -1,3 +1,31 @@
+2023-05-30 Version 1.2.9
+    * Loosen version requirement for OAuth gem
+
+2023-01-03 Version 1.2.8
+    * Add Ruby 3.0 support by requiring rexml
+    * Fix URI encoding bug for queries with an ampersand `&`
+
+2022-12-13 Version 1.2.7
+    * Fix content return parameter encoding
+
+2022-04-26 Version 1.2.6
+    * Add support for prioritizeNonToolGrade
+    * Add support for needsAdditionalReview
+
+2020-02-03 Version 1.2.4
+    * Add support for submittedAt date
+
+2020-02-03 Version 1.2.3 -- yanked
+
+2017-06-19 Version 1.2.2
+    * Explicitly require 'oauth' gem and specify version range
+
+2017-04-13 Version 1.2.1
+    * Remove date field from gemspec
+
+2017-03-08 Version 1.2.0
+    * Don't downcase roles
+
 2016-10-05 Version 1.1.13
     * Fix Oauth::Unauthorized initialization bug
     * Relax oauth dependency

data/README.md

@@ -52,7 +52,7 @@ and it will be signed with OAuth using a key/secret that both the TP and TC shar
 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)
+[LTI Tool Provider](https://github.com/instructure/lti1_tool_provider_example)
 
 Once you find the `oauth_consumer_secret` based on the `oauth_consumer_key` in
 the request, you can initialize a `ToolProvider` object with them and the post parameters:
@@ -112,5 +112,18 @@ As a Tool Consumer your app will POST an OAuth-signed launch requests to TPs wit
 [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)
 
+```ruby
+
+params = { user_id: '123', lti_message_type: IMS::LTI::Models::Messages::BasicLTILaunchRequest::MESSAGE_TYPE }
+
+header = SimpleOAuth::Header.new(:post, 'https://yoursite.com', params, consumer_key: oauth_consumer_key, consumer_secret: secret)
+
+signed_params = header.signed_attributes.merge(params)
+
+IMS::LTI::Services::MessageAuthenticator.new(launch_url, signed_params, secret)
+
+```
+
+## Contributing
 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/deprecated_role_checks.rb

@@ -6,7 +6,7 @@ module DeprecatedRoleChecks
   # Check whether the Launch Parameters have a role
     def has_role?(role)
       role = role.downcase
-      @roles && @roles.any?{|r| r.index(role)}
+      @roles && @roles.any?{|r| r.downcase.index(role)}
     end
 
     # Convenience method for checking if the user has 'learner' or 'student' role

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

@@ -96,67 +96,116 @@ module IMS::LTI
 
         #generates the return url for file submissions
         def file_content_return_url(url, text, content_type = nil)
-          url = CGI::escape(url)
-          text = CGI::escape(text)
-          content_type = CGI::escape(content_type) if content_type
 
-          return_url = "#{content_return_url}?return_type=file&url=#{url}&text=#{text}"
-          return_url = "#{return_url}&content_type=#{content_type}" if content_type
+          return_url = add_parameters(content_return_url, {
+            return_type: 'file',
+            url: url,
+            text: text
+          })
+
+          if content_type
+            return_url = add_parameters(return_url, {
+              content_type: content_type
+            })
+          end
 
           return return_url
         end
 
         #generates the return url for url submissions
         def url_content_return_url(url, title = nil, text = 'link', target = '_blank')
-          url = CGI::escape(url)
-          text = CGI::escape(text)
-          target = CGI::escape(target)
 
-          return_url = "#{content_return_url}?return_type=url&url=#{url}&text=#{text}&target=#{target}"
-          return_url = "#{return_url}&title=#{CGI::escape(title)}" if title
+          return_url = add_parameters(content_return_url, {
+            return_type: 'url',
+            url: url,
+            text: text,
+            target: target
+          })
+
+          if title
+            return_url = add_parameters(return_url, {
+              title:title
+            })
+          end
 
           return return_url
         end
 
         #generates the return url for lti launch submissions
         def lti_launch_content_return_url(url, text='link', title=nil)
-          url = CGI::escape(url)
-          text = CGI::escape(text)
 
-          return_url = "#{content_return_url}?return_type=lti_launch_url&url=#{url}&text=#{text}"
-          return_url = "#{return_url}&title=#{CGI::escape(title)}" if title
+          return_url = add_parameters(content_return_url, {
+            return_type: 'lti_launch_url',
+            url: url,
+            text: text
+          })
+
+          if title
+            return_url = add_parameters(return_url, {
+              title:title
+            })
+          end
 
           return return_url
         end
 
         #generates the return url for image submissions
         def image_content_return_url(url, width, height, alt = '')
-          url = CGI::escape(url)
-          width = CGI::escape(width.to_s)
-          height = CGI::escape(height.to_s)
-          alt = CGI::escape(alt)
 
-          "#{content_return_url}?return_type=image_url&url=#{url}&width=#{width}&height=#{height}&alt=#{alt}"
+          add_parameters(content_return_url, {
+            return_type: 'image_url',
+            url: url,
+            width: width.to_s,
+            height: height.to_s,
+            alt: alt
+          })
         end
 
         #generates the return url for iframe submissions
         def iframe_content_return_url(url, width, height, title = nil)
-          url = CGI::escape(url)
-          width = CGI::escape(width.to_s)
-          height = CGI::escape(height.to_s)
 
-          return_url = "#{content_return_url}?return_type=iframe&url=#{url}&width=#{width}&height=#{height}"
-          return_url = "#{return_url}&title=#{CGI::escape(title)}" if title
+          return_url = add_parameters(content_return_url, {
+            return_type: 'iframe',
+            url: url,
+            width: width.to_s,
+            height: height.to_s
+          })
+
+          if title
+            return_url = add_parameters(return_url, {
+              title:title
+            })
+          end
 
           return return_url
         end
 
         #generates the return url for oembed submissions
         def oembed_content_return_url(url, endpoint)
-          url = CGI::escape(url)
-          endpoint = CGI::escape(endpoint)
 
-          "#{content_return_url}?return_type=oembed&url=#{url}&endpoint=#{endpoint}"
+          add_parameters(content_return_url, {
+            return_type: 'oembed',
+            url: url,
+            endpoint: endpoint
+          })
+        end
+
+        private
+
+        # adds parameters to a url, with consideration for
+        # already existing parameters
+        def add_parameters(url, params)
+          parsed = URI.parse(url)
+          query = if parsed.query
+                    CGI.parse(parsed.query)
+                  else
+                    {}
+                  end
+
+          query = query.merge(params)
+
+          parsed.query = URI.encode_www_form(query)
+          parsed.to_s
         end
       end
 

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

@@ -67,6 +67,12 @@ module IMS::LTI
           accepted_outcome_types.member?("url")
         end
 
+        # check if the consumer accepts a submitted at date as outcome data
+        def accepts_submitted_at?
+          accepted_outcome_types.member?("submitted_at") ||
+            @ext_params["ext_outcome_submission_submitted_at_accepted"] == "true"
+        end
+
         def accepts_outcome_lti_launch_url?
           accepted_outcome_types.member?("lti_launch_url")
         end
@@ -75,8 +81,19 @@ module IMS::LTI
           !!@ext_params["outcome_result_total_score_accepted"]
         end
 
+        def accepts_needs_additional_review?
+          @ext_params["ext_outcome_submission_needs_additional_review_accepted"] == "true"
+        end
+
+        def accepts_prioritize_non_tool_grade?
+          @ext_params["ext_outcome_submission_prioritize_non_tool_grade_accepted"] == "true"
+        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", "url", or "lti_launch_url"
+        # adds the specified data.
+        #
+        # The data hash can have the keys "text", "cdata_text", "url", "submitted_at"
+        # "needs_additional_review", "prioritize_non_tool_grade", or "lti_launch_url"
         #
         # If both cdata_text and text are sent, cdata_text will be used
         #
@@ -93,7 +110,8 @@ module IMS::LTI
 
         # 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, :lti_launch_url, :score, or :total_score
+        # :text, :cdata_text, :url, :submitted_at, :lti_launch_url, :score,
+        # :needs_additional_review, 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
@@ -110,6 +128,9 @@ module IMS::LTI
           req.outcome_cdata_text = opts[:cdata_text]
           req.outcome_text = opts[:text]
           req.outcome_url = opts[:url]
+          req.submitted_at = opts[:submitted_at]
+          req.needs_additional_review = opts[:needs_additional_review]
+          req.prioritize_non_tool_grade = opts[:prioritize_non_tool_grade]
           req.outcome_lti_launch_url = opts[:lti_launch_url]
           req.total_score = opts[:total_score]
           req.post_replace_result!(opts[:score])
@@ -120,9 +141,9 @@ module IMS::LTI
         include IMS::LTI::Extensions::ExtensionBase
         include Base
 
-        OUTCOME_DATA_TYPES = %w{text url lti_launch_url}
+        OUTCOME_DATA_TYPES = %w{text url lti_launch_url submitted_at}
 
-        # a list of the outcome data types accepted, currently only 'url' and
+        # a list of the outcome data types accepted, currently only 'url', 'submitted_at' and
         # 'text' are valid
         #
         #    tc.outcome_data_values_accepted(['url', 'text'])
@@ -150,7 +171,14 @@ module IMS::LTI
         include IMS::LTI::Extensions::ExtensionBase
         include Base
 
-        attr_accessor :outcome_text, :outcome_url, :outcome_lti_launch_url, :outcome_cdata_text, :total_score
+        attr_accessor :outcome_text,
+                      :outcome_url,
+                      :submitted_at,
+                      :outcome_lti_launch_url,
+                      :outcome_cdata_text,
+                      :total_score,
+                      :needs_additional_review,
+                      :prioritize_non_tool_grade
 
         def result_values(node)
           super
@@ -178,6 +206,15 @@ module IMS::LTI
           end
         end
 
+        def details(node)
+          super
+          return unless has_details_data?
+
+          node.submittedAt submitted_at if submitted_at
+          node.needsAdditionalReview if needs_additional_review
+          node.prioritizeNonToolGrade if prioritize_non_tool_grade
+        end
+
         def score
           total_score ? nil : @score
         end
@@ -186,6 +223,10 @@ module IMS::LTI
           !!outcome_text || !!outcome_url || !!outcome_lti_launch_url || !!outcome_cdata_text || !!total_score || super
         end
 
+        def has_details_data?
+          !!submitted_at || !!needs_additional_review || !!prioritize_non_tool_grade
+        end
+
         def extention_process_xml(doc)
           super
           @outcome_text = doc.get_text("//resultRecord/result/resultData/text")
@@ -196,4 +237,4 @@ module IMS::LTI
 
     end
   end
-end
+end

data/lib/ims/lti/launch_params.rb

@@ -96,7 +96,7 @@ module IMS::LTI
         if roles_list.is_a?(Array)
           @roles = roles_list
         else
-          @roles = roles_list.split(",").map(&:downcase)
+          @roles = roles_list.split(",")
         end
       else
         @roles = nil

data/lib/ims/lti/outcome_request.rb

@@ -168,6 +168,7 @@ module IMS::LTI
               end
               results(record)
             end
+            submission_details(request)
           end
         end
       end
@@ -182,6 +183,10 @@ module IMS::LTI
       !!score
     end
 
+    def has_details_data?
+      false
+    end
+
     def results(node)
       return unless has_result_data?
 
@@ -190,6 +195,16 @@ module IMS::LTI
       end
     end
 
+    def submission_details(request)
+      return unless has_details_data?
+      request.submissionDetails do |record|
+        details(record)
+      end
+    end
+
+    def details(record)
+    end
+
     def result_values(node)
       if score
         node.resultScore do |res_score|

data/lib/ims/lti/outcome_response.rb

@@ -46,7 +46,7 @@ module IMS::LTI
   #
   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
@@ -70,7 +70,7 @@ module IMS::LTI
       response = OutcomeResponse.new
       response.process_post_response(post_response)
     end
-    
+
     def process_post_response(post_response)
       self.post_response = post_response
       self.response_code = post_response.code
@@ -105,7 +105,11 @@ module IMS::LTI
 
     # Parse Outcome Response data from XML
     def process_xml(xml)
-      doc = REXML::Document.new xml
+      begin
+        doc = REXML::Document.new xml
+      rescue => e
+        raise IMS::LTI::XMLParseError, "#{e}\nOriginal xml: '#{xml}'"
+      end
       @message_identifier = doc.text("//imsx_statusInfo/imsx_messageIdentifier").to_s
       @code_major = doc.text("//imsx_statusInfo/imsx_codeMajor")
       @code_major.downcase! if @code_major

data/lib/ims/lti/role_checks.rb

@@ -16,7 +16,7 @@ module IMS::LTI
     # Check whether the Launch Parameters have a given role
     def has_exact_role?(role)
       role = role.downcase
-      @roles && @roles.any? { |r| r == role }
+      @roles && @roles.any? { |r| r.downcase == role }
     end
 
     # Check whether the Launch Parameters have a given role ignoring
@@ -25,7 +25,7 @@ module IMS::LTI
     # will return true if the role is `urn:lti:role:ims/lis/Instructor/GuestInstructor`
     def has_base_role?(role)
       role = role.downcase
-      @roles && @roles.any? { |r| r.start_with?(role) }
+      @roles && @roles.any? { |r| r.downcase.start_with?(role) }
     end
 
     # Convenience method for checking if the user is the system administrator of the TC

data/lib/ims/lti/tool_provider.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module IMS::LTI
 
   # Class for implementing an LTI Tool Provider
@@ -121,7 +123,7 @@ module IMS::LTI
       messages = []
       %w{lti_errormsg lti_errorlog lti_msg lti_log}.each do |m|
         if message = self.send(m)
-          messages << "#{m}=#{URI.escape(message)}"
+          messages << "#{m}=#{CGI.escape(message)}"
         end
       end
       q_string = messages.any? ? ("?" + messages.join("&")) : ''
@@ -135,9 +137,9 @@ module IMS::LTI
                          :consumer_secret => @consumer_secret,
                          :lis_outcome_service_url => lis_outcome_service_url,
                          :lis_result_sourcedid =>lis_result_sourcedid)
-      
+
       extend_outcome_request(@outcome_requests.last)
     end
-    
+
   end
 end

data/lib/ims/lti/version.rb

@@ -0,0 +1,5 @@
+module IMS
+  module LTI
+    VERSION = '1.2.9'.freeze
+  end
+end

data/lib/ims/lti.rb

@@ -2,6 +2,7 @@ require 'oauth'
 require 'builder'
 require "rexml/document"
 require 'cgi'
+require 'securerandom'
 
 module IMS # :nodoc:
 
@@ -25,13 +26,16 @@ module IMS # :nodoc:
   #
   #    require 'ims/lti'
   module LTI
-    
+
     # The versions of LTI this library supports
     VERSIONS = %w{1.0 1.1}
-    
+
     class InvalidLTIConfigError < StandardError
     end
 
+    class XMLParseError < StandardError
+    end
+
     # POST a signed oauth request with the given key/secret/data
     def self.post_service_request(key, secret, url, content_type, body)
       raise IMS::LTI::InvalidLTIConfigError, "" unless key && secret

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 1.1.13
+  version: 1.2.9
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
@@ -31,9 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,23 +44,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  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: '3.0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email: 
 executables: []
@@ -84,6 +104,7 @@ files:
 - lib/ims/lti/tool_config.rb
 - lib/ims/lti/tool_consumer.rb
 - lib/ims/lti/tool_provider.rb
+- lib/ims/lti/version.rb
 homepage: http://github.com/instructure/ims-lti
 licenses:
 - MIT
@@ -103,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers