ims-lti 1.2.4 → 2.0.0.beta.1

data/Changelog

@@ -1,54 +0,0 @@
-2020-02-03 Version 1.2.3
-    * 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
-
-2015-02-20 Version 1.1.8
-    * Replace usage of the 'uuid' gem with SecureRandom
-    * Update the outcome extension doc example
-
-2015-01-09 Version 1.1.7
-    * Add support for new outcome extension resultTotalScore
-
-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
-
-2012-09-04 Version 1.1.1
-
-    * Added cdata value for outcome data extension
-
-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/LICENSE

@@ -1,18 +0,0 @@
-Copyright (c) 2012 Instructure
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ims/lti/deprecated_role_checks.rb

@@ -1,52 +0,0 @@
-# These are here for backwards-compatibility
-# But they are deprecated and the new ones in
-# role_checks.rb should be used
-module IMS::LTI
-module DeprecatedRoleChecks
-  # Check whether the Launch Parameters have a role
-    def has_role?(role)
-      role = role.downcase
-      @roles && @roles.any?{|r| r.downcase.index(role)}
-    end
-
-    # Convenience method for checking if the user has 'learner' or 'student' role
-    def student?
-      has_role?('learner') || has_role?('student')
-    end
-
-    # Convenience method for checking if the user has 'instructor' or 'faculty' or 'staff' role
-    def instructor?
-      has_role?('instructor') || has_role?('faculty') || has_role?('staff')
-    end
-
-    # Convenience method for checking if the user has 'contentdeveloper' role
-    def content_developer?
-      has_role?('ContentDeveloper')
-    end
-
-    # Convenience method for checking if the user has 'Member' role
-    def member?
-      has_role?('Member')
-    end
-
-    # Convenience method for checking if the user has 'Manager' role
-    def manager?
-      has_role?('Manager')
-    end
-
-    # Convenience method for checking if the user has 'Mentor' role
-    def mentor?
-      has_role?('Mentor')
-    end
-
-    # Convenience method for checking if the user has 'administrator' role
-    def admin?
-      has_role?('administrator')
-    end
-
-    # Convenience method for checking if the user has 'TeachingAssistant' role
-    def ta?
-      has_role?('TeachingAssistant')
-    end
-end
-end

data/lib/ims/lti/extensions.rb

@@ -1,45 +0,0 @@
-
-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'
-require 'ims/lti/extensions/content'
-require 'ims/lti/extensions/canvas'

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

@@ -1,122 +0,0 @@
-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 set_canvas_ext_param(key, value)
-          set_ext_param(PLATFORM, key, value)
-        end
-
-        def get_canvas_param(param_key)
-          get_ext_param PLATFORM, param_key
-        end
-
-        def canvas_privacy_public!()
-          set_canvas_ext_param(:privacy_level, 'public')
-        end
-
-        def canvas_privacy_name_only!()
-          set_canvas_ext_param(:privacy_level, 'name_only')
-        end
-
-        def canvas_privacy_anonymous!()
-          set_canvas_ext_param(:privacy_level, 'anonymous')
-        end
-
-        def canvas_domain!(domain)
-          set_canvas_ext_param(:domain, domain)
-        end
-
-        def canvas_text!(text)
-          set_canvas_ext_param(:text, text)
-        end
-
-        def canvas_icon_url!(icon_url)
-          set_canvas_ext_param(:icon_url, icon_url)
-        end
-
-        def canvas_tool_id!(tool_id)
-          set_canvas_ext_param(:tool_id, tool_id)
-        end
-
-        def canvas_selector_dimensions!(width, height)
-          set_canvas_ext_param(:selection_width, width)
-          set_canvas_ext_param(: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_canvas_ext_param(: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_canvas_ext_param(:editor_button, params)
-        end
-
-        # Adds the tool to canvas' resource selector
-        # Valid properties are url, text, selection_width, selection_height, enabled
-        def canvas_resource_selection!(params = {})
-          set_canvas_ext_param(: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_canvas_ext_param(: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_canvas_ext_param(: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_canvas_ext_param(:user_navigation, params)
-        end
-
-        # Adds canvas environment configurations options
-        # Valid properties are launch_url, domain, test_launch_url, test_domain, beta_launch_url, beta_domain
-        def canvas_environments!(params = {})
-          set_canvas_ext_param(:environments, params)
-        end
-      end
-    end
-  end
-end

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

@@ -1,209 +0,0 @@
-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