ims-lti 1.2.4 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 224820ab40ce08a13bfda880f3107740a2b46cd31f672719b72d1d8e8cf3cc50
-  data.tar.gz: b0c4c73930312bd6a27c7d6c8ea74b9dd33d83fd8cf8d240db14ea2b3e27e29f
+  metadata.gz: 29574604b1d50bb3ad7a18357c73989e650cc7eaee9693115661f4b1fba01369
+  data.tar.gz: 7d3ce283cf78880097a4803f35ef96f0e2cdea74d49e17a6b45982b9f5171390
 SHA512:
-  metadata.gz: 4d787b098d9fe7b9dba586cf77eff9d3a76cb31697685f29d5cd9f8add1d2950a8ac55385d1419a27559e688f1629f11ce33e394bb24191e447d6876a3b692fd
-  data.tar.gz: 4f0b4d72b52cd2ad3b936da67d64709734194c6dd321f4883b91131a8625e33193b40ed804d3ea1d633bf254fb3c9656829d04450ad26ca250899dfaf43799de
+  metadata.gz: 8effe8dd1fe14c17dd01a41c4f3c719a0201717d72b244b5d181df53df0de9ec13bec6bed53f1f9aa873c2cb9ada99dfad4eadc94818003610a287a56d8884f1
+  data.tar.gz: a738260e51baa9a6a61db871ad3807e73dbf3918e1fd45da1cf27d6be0fd61bdf8e597579f8ac68c639936c848bb5d676dddacd7d592f784e1051bc9db2aa7d0

data/Changelog

@@ -1,4 +1,4 @@
-2020-02-03 Version 1.2.3
+2020-02-03 Version 1.2.4
     * Add support for submittedAt date
 
 2017-03-08 Version 1.2.0

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

@@ -69,7 +69,8 @@ module IMS::LTI
 
         # check if the consumer accepts a submitted at date as outcome data
         def accepts_submitted_at?
-          accepted_outcome_types.member?("submitted_at")
+          accepted_outcome_types.member?("submitted_at") ||
+            @ext_params["ext_outcome_submission_submitted_at_accepted"] == "true"
         end
 
         def accepts_outcome_lti_launch_url?
@@ -80,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", "submitted_at" 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
         #
@@ -98,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, :submitted_at, :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
@@ -116,6 +129,8 @@ module IMS::LTI
           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])
@@ -156,7 +171,14 @@ module IMS::LTI
         include IMS::LTI::Extensions::ExtensionBase
         include Base
 
-        attr_accessor :outcome_text, :outcome_url, :submitted_at, :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
@@ -188,7 +210,9 @@ module IMS::LTI
           super
           return unless has_details_data?
 
-          node.submittedAt submitted_at
+          node.submittedAt submitted_at if submitted_at
+          node.needsAdditionalReview if needs_additional_review
+          node.prioritizeNonToolGrade if prioritize_non_tool_grade
         end
 
         def score
@@ -200,7 +224,7 @@ module IMS::LTI
         end
 
         def has_details_data?
-          !!submitted_at
+          !!submitted_at || !!needs_additional_review || !!prioritize_non_tool_grade
         end
 
         def extention_process_xml(doc)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.7
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -54,20 +54,20 @@ dependencies:
   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: 
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers