ims-lti 1.1.12 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3519a3ee6fb782c4ed97fcb89652c2011a3bb602
-  data.tar.gz: 495e959fd7bcddd71da5ead3ec88745109aae5c6
+SHA256:
+  metadata.gz: a7fb650dcdd9fad408934d47de72f8f2e11a55605d10f23ee04944976c900cd4
+  data.tar.gz: 2835e4925ea33ebd4f4aac6ea8c0b47d3696a67ae548addd6f1aad5adf4f12ef
 SHA512:
-  metadata.gz: a046a0db9890831af84705ca31d11d409ee3095b58e56e1bfd1eb458163a9856fbbff51bd7738d87a776d97bc7a88fc74b62980a64a8553437bb66592178499f
-  data.tar.gz: ac7793788cb184c463f10e977dfac0f448c840f99ca4f9a11cc9bd1af6142d6896b9d1a1fa8419afd404b16c4ca6967315e38429cf0c17ccfb719e0273998371
+  metadata.gz: 98469e50f9bb313fc90facdc65c309ec286e3b71b410226d390ffa0d25b6b78ed4c1d3ca7bfec31baf27c8f949a7c83f8525dc66c313968eb8af333dd514637d
+  data.tar.gz: 8ab0abecf8f0f7038f91f006a1a82ddf7a3717f5532a7bfa52ba9ae2a0379fd260e6f07cdb5074cfd283ed33a4a8b692b79c99fd487aad40394586052b32733b

data/Changelog

@@ -1,3 +1,13 @@
+2020-02-03 Version 1.2.4
+    * Add support for submittedAt date
+
+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
+
 2016-06-16 Version 1.1.12
     * Add support for detecting observer role
 

data/README.md

@@ -16,14 +16,14 @@ 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 Rails 5 (and 2.3) app:
+    require 'oauth/request_proxy/action_controller_request'
+
     # 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
 
-    # For a Rails 2.3 app:
-    require 'oauth/request_proxy/action_controller_request'
-
 For further information see the [oauth-ruby](https://github.com/oauth-xx/oauth-ruby) project.
 
 As a quick debugging note, if you forget that step, you'll get an error like:
@@ -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:

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/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

@@ -148,23 +148,63 @@ module IMS::LTI
       extention_process_xml(doc)
     end
 
+    def generate_request_xml
+      raise IMS::LTI::InvalidLTIConfigError, "`@operation` and `@lis_result_sourcedid` are required" unless has_request_xml_attributes?
+      builder = Builder::XmlMarkup.new #(:indent=>2)
+      builder.instruct!
+
+      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"
+            info.imsx_messageIdentifier @message_identifier || IMS::LTI::generate_identifier
+          end
+        end
+        env.imsx_POXBody do |body|
+          body.tag!(@operation + 'Request') do |request|
+            request.resultRecord do |record|
+              record.sourcedGUID do |guid|
+                guid.sourcedId @lis_result_sourcedid
+              end
+              results(record)
+            end
+            submission_details(request)
+          end
+        end
+      end
+    end
+
     private
-    
+
     def extention_process_xml(doc)
     end
-    
+
     def has_result_data?
       !!score
     end
-    
+
+    def has_details_data?
+      false
+    end
+
     def results(node)
       return unless has_result_data?
-      
+
       node.result do |res|
         result_values(res)
       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|
@@ -178,29 +218,8 @@ module IMS::LTI
       @consumer_key && @consumer_secret && @lis_outcome_service_url && @lis_result_sourcedid && @operation
     end
 
-    def generate_request_xml
-      builder = Builder::XmlMarkup.new #(:indent=>2)
-      builder.instruct!
-
-      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"
-            info.imsx_messageIdentifier @message_identifier || IMS::LTI::generate_identifier
-          end
-        end
-        env.imsx_POXBody do |body|
-          body.tag!(@operation + 'Request') do |request|
-            request.resultRecord do |record|
-              record.sourcedGUID do |guid|
-                guid.sourcedId @lis_result_sourcedid
-              end
-              results(record)
-            end
-          end
-        end
-      end
+    def has_request_xml_attributes?
+      @operation && @lis_result_sourcedid
     end
-
   end
 end

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/request_validator.rb

@@ -18,14 +18,20 @@ module IMS::LTI
     def valid_request?(request, handle_error=true)
       begin
         @oauth_signature_validator = OAuth::Signature.build(request, :consumer_secret => @consumer_secret)
-        @oauth_signature_validator.verify() or raise OAuth::Unauthorized
+        @oauth_signature_validator.verify() or raise OAuth::Unauthorized.new(request)
         true
-      rescue OAuth::Signature::UnknownSignatureMethod, OAuth::Unauthorized
+      rescue OAuth::Signature::UnknownSignatureMethod
         if handle_error
           false
         else
           raise $!
         end
+      rescue OAuth::Unauthorized
+        if handle_error
+          false
+        else
+          raise OAuth::Unauthorized.new(request)
+        end
       end
     end
 

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

@@ -135,9 +135,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.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.12
+  version: 1.2.6
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -16,56 +16,60 @@ 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
     requirements:
-    - - "~>"
+    - - ">="
       - !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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !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:
-    - - ">="
+        version: '3.0'
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        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: '0'
+        version: '3.0'
 description: 
 email: 
 executables: []
@@ -111,10 +115,8 @@ 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
 test_files: []
-has_rdoc: