mil-ims-lti 1.1.3 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd669611923a7aeccccb86825e265d149e05eccf
-  data.tar.gz: 20ebf881f4bf4079b9afa5cd51bdea5a5a930a2f
+  metadata.gz: d0e7fd0b27926f659e84907e606c6b07cfd3e037
+  data.tar.gz: 0d4c14c1aff274db63d64b2e232d41e28c54da3f
 SHA512:
-  metadata.gz: 6e15d7a0c9868b900e929c02b504728d5f6b12daa095661bc18231ad092a280535c706a862090bd56c62a8dd1c57e38717089b24a26e9c7ff94985cc16d8bc41
-  data.tar.gz: aae5e5120cc560f6ff5c28373f46ebbc30705202ee1eb8b719ec6d5eb80169905c31a1d77afa8ce39827be05ac9365c73a1a21a0caa9a1af3ec1d9f5cae8e482
+  metadata.gz: 2319b59c2e8f72fcc9e0a014fb7ea71763b6e01b3ea131083a3503ebcda3028510f10fab95dc692f807e4d898a40e14196e5e90dd4b3d2de93a4524500484680
+  data.tar.gz: 28d7d2ca6f9dff2e4f9658e4b725887710afd0e4bdb65647e4d62d56b4287f8318457fe38504a6d1fa77d1e588674ae25f151094651fda0b35b01eaaf845f55f

data/Changelog

@@ -1,3 +1,7 @@
+2013-04-24 Version 1.1.3
+
+    * Corrected lti_version launch parameter
+
 2012-09-05 Version 1.1.2
 
     * Added better role checking and convenience methods

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

@@ -0,0 +1,109 @@
+module IMS::LTI
+  module Extensions
+    # Module that adds Canvas specific LTI extensions
+    #
+    # It adds convenience methods for generating common canvas use case LTI configurations
+    #
+    # == Usage
+    # To generate an XML configuration:
+    #
+    #    # Create a config object and set some options
+    #    tc = IMS::LTI::ToolConfig.new(:title => "Example Sinatra Tool Provider", :launch_url => url)
+    #    tc.description = "This example LTI Tool Provider supports LIS Outcome pass-back."
+    #
+    #    # Extend the Canvas Tool config and add canvas related extensions
+    #    tc.extend IMS::LTI::Extensions::Canvas::ToolConfig
+    #    tc.homework_submission! 'http://someplace.com/homework', 'Find Homework'
+    #
+    #    # generate the XML
+    #    tc.to_xml
+    #
+    # Or to create a config object from an XML String:
+    #
+    #    tc = IMS::LTI::ToolConfig.create_from_xml(xml)
+
+    module Canvas
+      module ToolConfig
+        PLATFORM = 'canvas.instructure.com'
+
+        # Canvas extension defaults
+        # These properties will cascade down to any options that are configured
+
+        def canvas_privacy_public!()
+          set_ext_param(PLATFORM, :privacy_level, 'public')
+        end
+
+        def canvas_privacy_name_only!()
+          set_ext_param(PLATFORM, :privacy_level, 'name_only')
+        end
+
+        def canvas_privacy_anonymous!()
+          set_ext_param(PLATFORM, :privacy_level, 'anonymous')
+        end
+
+        def canvas_domain!(domain)
+          set_ext_param(PLATFORM, :domain, domain)
+        end
+
+        def canvas_text!(text)
+          set_ext_param(PLATFORM, :text, text)
+        end
+
+        def canvas_icon_url!(icon_url)
+          set_ext_param(PLATFORM, :icon_url, icon_url)
+        end
+
+        def canvas_selector_dimensions!(width, height)
+          set_ext_param(PLATFORM, :selection_width, width)
+          set_ext_param(PLATFORM, :selection_height, height)
+        end
+
+        # Canvas options
+        # These configure canvas to expose the tool in various locations.  Any properties that are set
+        # at this level will override the defaults for this launch of the tool
+
+        # Enables homework submissions via the tool
+        # Valid properties are url, text, selection_width, selection_height, enabled
+        def canvas_homework_submission!(params = {})
+          set_ext_param(PLATFORM, :homework_submission, params)
+        end
+
+        # Adds the tool to canvas' rich text editor
+        # Valid properties are url, icon_url, text, selection_width, selection_height, enabled
+        def canvas_editor_button!(params = {})
+          set_ext_param(PLATFORM, :editor_button, params)
+        end
+
+        # Adds the tool to canvas' rich text editor
+        # Valid properties are url, icon_url, text, selection_width, selection_height, enabled
+        def canvas_resource_selection!(params = {})
+          set_ext_param(PLATFORM, :resource_selection, params)
+        end
+
+        # Adds the tool to account level navigation in canvas
+        # Valid properties are url, text, enabled
+        def canvas_account_navigation!(params = {})
+          set_ext_param(PLATFORM, :account_navigation, params)
+        end
+
+        # Adds the tool to course level navigation in canvas
+        # Valid properties are url, text, visibility, default, enabled
+        # Visibility describes who will see the navigation element.  Possible values are "admins", "members", and nil
+        # Default determines if it is on or off by default.  Possible values are "admins", "members", and nil
+        def canvas_course_navigation!(params = {})
+          set_ext_param(PLATFORM, :course_navigation, params)
+        end
+
+        # Adds the tool to user level navigation in canvas
+        # Valid properties are url, text, enabled
+        def canvas_user_navigation!(params = {})
+          set_ext_param(PLATFORM, :user_navigation, params)
+        end
+
+        def get_canvas_param(param_key)
+          get_ext_param PLATFORM, param_key
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,209 @@
+module IMS::LTI
+  module Extensions
+
+    # An LTI extension that adds support for content back to the consumer
+    #
+    #     # 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::Content::ToolProvider
+    #
+    # If the tool was launched as an content request and it supports the content extension
+    # you can redirect the user to the tool consumer using the return url helper methods.
+    # The tool consumer is then responsible for consuming the content.
+    #
+    #     #Check if a certain response type is available
+    #     if provider.accepts_url? do
+    #       #Generate the URL for the user
+    #       redirect provider.url_content_return_url(url)
+    #     end
+    #
+    module Content
+      module ToolProvider
+        include IMS::LTI::Extensions::ExtensionBase
+        include Base
+
+        # a list of the supported outcome data types
+        def accepted_content_types
+          return @content_types if @content_types
+          @content_types = []
+          if val = @ext_params["content_return_types"]
+            @content_types = val.split(',').map {|i| i.to_sym}
+          end
+
+          @content_types
+        end
+
+        def accepted_file_extensions
+          return @file_extensions if @file_extensions
+          @file_extensions = []
+          if val = @ext_params["content_file_extensions"]
+            @file_extensions = val.split(',').map {|i| i.downcase.strip}
+          end
+
+          @file_extensions
+        end
+
+        def accepts_file?(file_name = nil)
+          accepted_content_types.include?(:file) &&
+            ( file_name.nil? ||
+              accepted_file_extensions.empty? ||
+              accepted_file_extensions.any?{|ext| file_name.downcase[/#{ext}$/]} )
+        end
+
+        def accepts_url?
+          accepted_content_types.include?(:url)
+        end
+
+        def accepts_lti_launch_url?
+          accepted_content_types.include?(:lti_launch_url)
+        end
+
+        def accepts_image_url?
+          accepted_content_types.include?(:image_url)
+        end
+
+        def accepts_iframe?
+          accepted_content_types.include?(:iframe)
+        end
+
+        def accepts_oembed?
+          accepted_content_types.include?(:oembed)
+        end
+
+        def content_intended_use
+          @ext_params["content_intended_use"].to_sym if  @ext_params["content_intended_use"]
+        end
+
+        # check if the content extension is supported
+        def accepts_content?
+          !!@ext_params["content_return_types"]
+        end
+
+        # check if the consumer accepts a given type of content
+        def accepts_content_type?(content_type)
+          accepted_content_types.include? content_type.to_sym
+        end
+
+        #check the use of the content
+        def is_content_for? (intended_use)
+          content_intended_use == intended_use
+        end
+
+        def content_return_url
+          @ext_params["content_return_url"]
+        end
+
+        #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 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 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 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}"
+        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 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}"
+        end
+      end
+
+      module ToolConsumer
+        include IMS::LTI::Extensions::ExtensionBase
+        include Base
+        
+        # a list of the content types accepted
+        #
+        #    tc.add_content_return_types=(['url', 'text'])
+        #    tc.add_content_return_types=("url,text")
+        def content_return_types=(val)
+          val = val.join(',') if val.is_a? Array
+          set_ext_param('content_return_types', val)
+        end
+
+        # a comma-separated string of the supported outcome data types
+        def content_return_types
+          get_ext_param('content_return_types')
+        end
+
+        def content_intended_use=(val)
+          set_ext_param('content_intended_use', val)
+        end
+
+        def content_intended_use
+          get_ext_param('content_intended_use')
+        end
+
+        # convenience method for setting support for homework content
+        def support_homework_content!
+          self.content_intended_use = 'homework'
+          self.content_return_types = 'file,url'
+        end
+
+        # convenience method for setting support for embed content
+        def support_embed_content!
+          self.content_intended_use = 'embed'
+          self.content_return_types = 'oembed,lti_launch_url,url,image_url,iframe'
+        end
+
+        # convenience method for setting support for navigation content
+        def support_navigation_content!
+          self.content_intended_use = 'navigation'
+          self.content_return_types = 'lti_launch_url'
+        end
+      end
+    end
+  end
+end

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

@@ -28,6 +28,14 @@ module IMS::LTI
     #     else
     #       # failed
     #     end
+    #
+    # Graded outcome +outcome_graded+ is a flag to specify whether the submission should be graded by the teacher
+    # It expects a 'true' or 'false' value graded by teacher or not, should set 'needs grading' in LMS if true.
+    #
+    #     provider.post_replace_result_with_data!(score,'graded' => 'true','url' => outcome_url)
+    #
+    # Can also be used in conjunction with outcome_url to show url to a students state for grading
+    #
     module OutcomeData
 
       #IMS::LTI::Extensions::OutcomeData::ToolProvider
@@ -45,7 +53,7 @@ module IMS::LTI
         def accepted_outcome_types
           return @outcome_types if @outcome_types
           @outcome_types = []
-          if val = @ext_params["outcome_data_values_accepted"]
+          if val = @ext_params['outcome_data_values_accepted']
             @outcome_types = val.split(',')
           end
 
@@ -54,21 +62,27 @@ module IMS::LTI
 
         # check if the outcome data extension is supported
         def accepts_outcome_data?
-          !!@ext_params["outcome_data_values_accepted"]
+          !!@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")
+          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")
+          accepted_outcome_types.member?('url')
+        end
+
+        # check if the consumer accepts a graded as outcome data
+        def accepts_outcome_graded?
+          accepted_outcome_types.member?('graded')
         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"
+        # adds the specified data. The data hash can have the keys "text", "cdata_text",
+        # "url" or "graded" (Graded expects a true/false value)
         #
         # If  both cdata_text and text are sent, cdata_text will be used
         #
@@ -77,12 +91,13 @@ module IMS::LTI
         # @return [OutcomeResponse] the response from the Tool Consumer
         def post_replace_result_with_data!(score, data={})
           req = new_request
-          if data["cdata_text"] 
-            req.outcome_cdata_text = data["cdata_text"] 
-          elsif data["text"]
-            req.outcome_text = data["text"]
+          if data['cdata_text']
+            req.outcome_cdata_text = data['cdata_text']
+          elsif data['text']
+            req.outcome_text = data['text']
           end
-          req.outcome_url = data["url"] if data["url"]
+          req.outcome_url = data['url'] if data['url']
+          req.outcome_graded = data['graded'] if data['graded']
           req.post_replace_result!(score)
         end
 
@@ -92,10 +107,10 @@ module IMS::LTI
         include IMS::LTI::Extensions::ExtensionBase
         include Base
         
-        OUTCOME_DATA_TYPES = %w{text url}
+        OUTCOME_DATA_TYPES = %w{text url graded}
 
-        # a list of the outcome data types accepted, currently only 'url' and
-        # 'text' are valid
+        # a list of the outcome data types accepted, currently only 'url',
+        # 'text' and 'graded' are valid
         #
         #    tc.outcome_data_values_accepted(['url', 'text'])
         #    tc.outcome_data_valued_accepted("url,text")
@@ -122,11 +137,11 @@ 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_graded, :outcome_cdata_text
 
         def result_values(node)
           super
-          if @outcome_text || @outcome_url || @outcome_cdata_text
+          if @outcome_text || @outcome_url || @outcome_graded || @outcome_cdata_text
             node.resultData do |res_data|
               if @outcome_cdata_text
                 res_data.text {
@@ -136,18 +151,20 @@ module IMS::LTI
                 res_data.text @outcome_text
               end
               res_data.url @outcome_url if @outcome_url
+              res_data.graded @outcome_graded if @outcome_graded
             end
           end
         end
 
         def has_result_data?
-          !!@outcome_text || !!@outcome_url || super
+          !!@outcome_text || !!@outcome_url || !!@outcome_graded || 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")
+          @outcome_text   = doc.get_text('//resultRecord/result/resultData/text')
+          @outcome_url    = doc.get_text('//resultRecord/result/resultData/url')
+          @outcome_graded = doc.get_text('//resultRecord/result/resultData/graded')
         end
       end
 

data/lib/ims/lti/extensions.rb

@@ -41,3 +41,5 @@ module IMS::LTI
 end
 
 require 'ims/lti/extensions/outcome_data'
+require 'ims/lti/extensions/content'
+require 'ims/lti/extensions/canvas'

data/lib/ims/lti/outcome_response.rb

@@ -105,28 +105,21 @@ module IMS::LTI
 
     # Parse Outcome Response data from XML
     def process_xml(xml)
-      begin
-        doc = REXML::Document.new xml
-        @message_identifier = doc.text("//imsx_statusInfo/imsx_messageIdentifier").to_s
-        @code_major = doc.text("//imsx_statusInfo/imsx_codeMajor")
-        @code_major.downcase! if @code_major
-        @severity = doc.text("//imsx_statusInfo/imsx_severity")
-        @severity.downcase! if @severity
-        @description = doc.text("//imsx_statusInfo/imsx_description")
-        @description = @description.to_s if @description
-        @message_ref_identifier = doc.text("//imsx_statusInfo/imsx_messageRefIdentifier")
-        @operation = doc.text("//imsx_statusInfo/imsx_operationRefIdentifier")
-        @score = doc.text("//readResultResponse//resultScore/textString")
-      rescue REXML::ParseException => e
-        @message_identifier = ''
-        @code_major = 'failure'
-        @severity = 'status'
-        @description = "#{e}"
-        @message_ref_identifier = '123456789'
-        @operation = 'replaceResult'
-        @score = ''
-      end
+      doc = REXML::Document.new xml
+      @message_identifier = doc.text('//imsx_statusInfo/imsx_messageIdentifier').to_s
+      @code_major = doc.text('//imsx_statusInfo/imsx_codeMajor')
+      @code_major.downcase! if @code_major
+      @severity = doc.text('//imsx_statusInfo/imsx_severity')
+      @severity.downcase! if @severity
+      @description = doc.text('//imsx_statusInfo/imsx_description')
+      @description = @description.to_s if @description
+      @message_ref_identifier = doc.text('//imsx_statusInfo/imsx_messageRefIdentifier')
+      @operation = doc.text('//imsx_statusInfo/imsx_operationRefIdentifier')
+      @score = doc.text('//readResultResponse//resultScore/textString')
+
       @score = @score.to_s if @score
+    rescue
+      raise IMS::LTI::InvalidLTIResponseData, ''
     end
 
     # Generate XML based on the current configuration

data/lib/ims/lti/tool_consumer.rb

@@ -49,7 +49,7 @@ module IMS::LTI
       raise IMS::LTI::InvalidLTIConfigError, "Not all required params set for tool launch" unless has_required_params?
 
       params = self.to_params
-      params['lti_version'] ||= 'LTI-1.0'
+      params['lti_version'] ||= 'LTI-1p0'
       params['lti_message_type'] ||= 'basic-lti-launch-request'
       uri = URI.parse(@launch_url)
 

data/lib/ims/lti.rb

@@ -32,6 +32,8 @@ module IMS # :nodoc:
     
     class InvalidLTIConfigError < StandardError
     end
+    class InvalidLTIResponseData < StandardError
+    end
 
     # Generates a unique identifier
     def self.generate_identifier

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mil-ims-lti
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.5
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -87,13 +87,10 @@ 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
@@ -101,7 +98,11 @@ files:
 - lib/ims/lti/tool_config.rb
 - lib/ims/lti/tool_consumer.rb
 - lib/ims/lti/tool_provider.rb
-- ims-lti.gemspec
+- lib/ims/lti.rb
+- lib/ims.rb
+- LICENSE
+- README.md
+- Changelog
 homepage: http://github.com/instructure/ims-lti
 licenses: []
 metadata: {}
@@ -126,3 +127,4 @@ signing_key:
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers
 test_files: []
+has_rdoc: 

data/ims-lti.gemspec

@@ -1,35 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = %q{ims-lti}
-  s.version = "1.1.3"
-
-  s.add_dependency 'builder'
-  s.add_dependency 'oauth', '~> 0.4.5'
-  s.add_dependency 'uuid'
-
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'ruby-deug'
-
-  s.authors = ["Instructure"]
-  s.date = %q{2012-09-05}
-  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
-          lib/ims/lti/request_validator.rb
-          lib/ims/lti/tool_config.rb
-          lib/ims/lti/tool_consumer.rb
-          lib/ims/lti/tool_provider.rb
-          ims-lti.gemspec
-  )
-  s.homepage = %q{http://github.com/instructure/ims-lti}
-  s.require_paths = %W(lib)
-  s.summary = %q{Ruby library for creating IMS LTI tool providers and consumers}
-end