ims-lti 1.1.8 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34b3da04f7e5e1c7941d6893214771331318d9a3
-  data.tar.gz: ce52c75bb0fe4b2fb50d4ddedb21cbe6e94e12d7
+  metadata.gz: 60aadf51a888ea3b20d4e01db315fa516b2391d5
+  data.tar.gz: a2de5ab6dc06de39360cc798d1eb084390cde810
 SHA512:
-  metadata.gz: 9f8b44578db4a9c163145e3079be90dc653bd66f3da21cce0ecc2d095ec2e29f60ee6af4875879a9ce72119a9e88ae19e1580f9279964f635412e25c5e1d8ceb
-  data.tar.gz: 33a78df08798018b999b0093ccea8dfa39e517db8a25da45256fe016f9197d6dc0d0eaffdc74ebb7e6326cf45e5d00e4e34f9e157d4f79d8302addac65b2e5a6
+  metadata.gz: 0b81bc2d944853f4aea17886035dd9c157fa5f98de1b33f6e24f4bc0b515ab3504df6542bdafe7345153816b008ece1ac92cf40686bb672e4afcd1acc46fa90c
+  data.tar.gz: c57d082100c2493e07d7d5a426303a6f7ea541f4b57b303febba34513ada770d7d37e639b78f241b31ef4703f1a331c4d04274ae111ac811819432a9fc83d18c

data/lib/ims/lti.rb

@@ -56,6 +56,8 @@ require 'ims/lti/extensions'
 require 'ims/lti/launch_params'
 require 'ims/lti/request_validator'
 require 'ims/lti/tool_base'
+require 'ims/lti/deprecated_role_checks'
+require 'ims/lti/role_checks'
 require 'ims/lti/tool_provider'
 require 'ims/lti/tool_consumer'
 require 'ims/lti/outcome_request'

data/lib/ims/lti/deprecated_role_checks.rb

@@ -0,0 +1,52 @@
+# 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.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/launch_params.rb

@@ -7,6 +7,12 @@ module IMS::LTI
 
     # List of the standard launch parameters for an LTI launch
     LAUNCH_DATA_PARAMETERS = %w{
+      accept_media_types
+      accept_multiple
+      accept_presentation_document_targets
+      accept_unsigned
+      auto_create
+      content_item_return_url
       context_id
       context_label
       context_title
@@ -39,6 +45,7 @@ module IMS::LTI
       resource_link_id
       resource_link_title
       roles
+      role_scope_mentor
       tool_consumer_info_product_family_code
       tool_consumer_info_version
       tool_consumer_instance_contact_email

data/lib/ims/lti/outcome_response.rb

@@ -125,7 +125,6 @@ module IMS::LTI
       builder = Builder::XmlMarkup.new
       builder.instruct!
 
-      # builder.imsx_POXEnvelopeResponse("xmlns" => "http://www.imsglobal.org/lis/oms1p0/pox") do |env|
       builder.imsx_POXEnvelopeResponse("xmlns" => "http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0") do |env|
         env.imsx_POXHeader do |header|
           header.imsx_POXResponseHeaderInfo do |info|
@@ -142,8 +141,8 @@ module IMS::LTI
         end #/header
         env.imsx_POXBody do |body|
           unless unsupported?
-            body.tag!(@operation + 'Response') do |request|
-              if @operation == OutcomeRequest::READ_REQUEST
+            if @operation == OutcomeRequest::READ_REQUEST
+              body.tag!(@operation + 'Response') do |request|
                 request.result do |res|
                   res.resultScore do |res_score|
                     res_score.language "en" # 'en' represents the format of the number
@@ -151,6 +150,8 @@ module IMS::LTI
                   end
                 end #/result
               end
+            else
+              body.tag!(@operation + 'Response')
             end #/operationResponse
           end
         end #/body

data/lib/ims/lti/role_checks.rb

@@ -0,0 +1,96 @@
+module IMS::LTI
+  # Some convenience methods for the most used roles
+  # Take care when using context_ helpers, as the context of an LTI launch
+  # determines the meaning of that role. For example, if the context is an
+  # institution context instead of a course context, then the short role of
+  # "Instructor" means they are a teacher at the institution, but not necessarily
+  # of the course you're working in.
+  #
+  # Also note that these only check for the base roles. So, asking context_student?
+  # only matches `urn:lti:role:ims/lis/Learner`, not `urn:lti:role:ims/lis/Learner/NonCreditLearner`
+  # If you make use of the more specific roles you'll need to ask specifically for those:
+  # @tool_provider.has_exact_role?("urn:lti:role:ims/lis/Learner/NonCreditLearner")
+  # Or you can use `has_base_role?`
+  module RoleChecks
+
+    # Check whether the Launch Parameters have a given role
+    def has_exact_role?(role)
+      role = role.downcase
+      @roles && @roles.any? { |r| r == role }
+    end
+
+    # Check whether the Launch Parameters have a given role ignoring
+    # sub roles. So asking:
+    # @tool_provider.has_base_role?("urn:lti:role:ims/lis/Instructor/")
+    # 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) }
+    end
+
+    # Convenience method for checking if the user is the system administrator of the TC
+    def system_administrator?
+      has_exact_role?('urn:lti:sysrole:ims/lis/SysAdmin') ||
+              has_exact_role?('SysAdmin') ||
+              has_exact_role?('urn:lti:sysrole:ims/lis/Administrator')
+    end
+
+    ### Institution-level roles
+    # Note, these only check if the role is explicitely an institution level role
+    # if the context of the LTI launch is the institution, the short names
+    # will apply, and you should use the context_x? helpers.
+
+    # Convenience method for checking if the user has 'student' or 'learner' roles at the institution
+    def institution_student?
+      has_exact_role?('urn:lti:instrole:ims/lis/Student') || has_exact_role?('urn:lti:instrole:ims/lis/Learner')
+    end
+
+    # Convenience method for checking if the user has 'Instructor' role at the institution
+    def institution_instructor?
+      has_exact_role?('urn:lti:instrole:ims/lis/Instructor')
+    end
+
+    # Convenience method for checking if the user has 'Administrator' role at the institution
+    def institution_admin?
+      has_exact_role?('urn:lti:instrole:ims/lis/Administrator')
+    end
+
+
+    ### Context-level roles
+    # Note, the most common LTI context is a course, but that is not always the
+    # case. You should be aware of the context when using these helpers.
+    # The difference for the context_ helpers is that they check for the
+    # short version of the roles. So `Learner` and `urn:lti:role:ims/lis/Learner`
+    # are both valid.
+
+    # Convenience method for checking if the user has 'learner' role in the current launch context
+    def context_student?
+      has_exact_role?('Learner') || has_exact_role?('urn:lti:role:ims/lis/Learner')
+    end
+
+    # Convenience method for checking if the user has 'instructor' role in the current launch context
+    def context_instructor?
+      has_exact_role?('instructor') || has_exact_role?('urn:lti:role:ims/lis/Instructor')
+    end
+
+    # Convenience method for checking if the user has 'contentdeveloper' role in the current launch context
+    def context_content_developer?
+      has_exact_role?('ContentDeveloper') || has_exact_role?('urn:lti:role:ims/lis/ContentDeveloper')
+    end
+
+    # Convenience method for checking if the user has 'Mentor' role in the current launch context
+    def context_mentor?
+      has_exact_role?('Mentor') || has_exact_role?('urn:lti:role:ims/lis/Mentor')
+    end
+
+    # Convenience method for checking if the user has 'administrator' role in the current launch context
+    def context_admin?
+      has_exact_role?('Administrator') || has_exact_role?('urn:lti:role:ims/lis/Administrator')
+    end
+
+    # Convenience method for checking if the user has 'TeachingAssistant' role in the current launch context
+    def context_ta?
+      has_exact_role?('TeachingAssistant') || has_exact_role?('urn:lti:role:ims/lis/TeachingAssistant')
+    end
+  end
+end

data/lib/ims/lti/tool_provider.rb

@@ -35,6 +35,9 @@ module IMS::LTI
 
   class ToolProvider < ToolBase
     # List of outcome requests made through this instance
+
+    include DeprecatedRoleChecks
+    include RoleChecks
     attr_accessor :outcome_requests
     # Message to be sent back to the ToolConsumer when the user returns
     attr_accessor :lti_errormsg, :lti_errorlog, :lti_msg, :lti_log
@@ -49,52 +52,6 @@ module IMS::LTI
       @outcome_requests = []
     end
 
-    # Check whether the Launch Parameters have a role
-    def has_role?(role)
-      role = role.downcase
-      @roles && @roles.any?{|r| r.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
-    
     # Check if the request was an LTI Launch Request
     def launch_request?
       lti_message_type == 'basic-lti-launch-request'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.9
 platform: ruby
 authors:
 - Instructure
@@ -78,6 +78,7 @@ files:
 - README.md
 - lib/ims.rb
 - lib/ims/lti.rb
+- lib/ims/lti/deprecated_role_checks.rb
 - lib/ims/lti/extensions.rb
 - lib/ims/lti/extensions/canvas.rb
 - lib/ims/lti/extensions/content.rb
@@ -86,8 +87,7 @@ files:
 - lib/ims/lti/outcome_request.rb
 - lib/ims/lti/outcome_response.rb
 - lib/ims/lti/request_validator.rb
-- lib/ims/lti/services/service_definition.rb
-- lib/ims/lti/services/service_lookup.rb
+- lib/ims/lti/role_checks.rb
 - lib/ims/lti/tool_base.rb
 - lib/ims/lti/tool_config.rb
 - lib/ims/lti/tool_consumer.rb
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers

data/lib/ims/lti/services/service_definition.rb

@@ -1,10 +0,0 @@
-class ServiceDefinition
-  attr_reader :name, :formats, :paramater_variables
-
-  def initialize(name, formats, parameter_variables = [])
-    @name = name
-    @formats = formats
-    @parameter_variables = parameter_variables
-  end
-
-end

data/lib/ims/lti/services/service_lookup.rb

@@ -1,30 +0,0 @@
-class ServiceLookup
-
-  TOOL_SETTING_SERVICE = ServiceDefinition.new(
-    'ToolSettingsContainer Service',
-    %w(application/vnd.ims.lti.v2.toolsettings+json application/vnd.ims.lti.v2.toolsettings.simple+json),
-    %w(LtiLink.custom.url ToolProxyBinding.custom.url ToolProxy.custom.url)
-  )
-
-  TOOL_CONSUMER_PROFILE_SERVICE = ServiceDefinition.new(
-    'ToolConsumerProfile Service',
-    %w(application/vnd.ims.lti.v2.toolconsumerprofile+json),
-    []
-  )
-
-  TOOL_PROXY_SERVICE = ServiceDefinition.new(
-    'ToolProxy Service',
-    %w(application/vnd.ims.lti.v2.toolproxy+json),
-    []
-  )
-
-  def self.services
-    [TOOL_SETTING_SERVICE, TOOL_CONSUMER_PROFILE_SERVICE, TOOL_PROXY_SERVICE]
-  end
-
-  def self.lookup(format)
-    services.select { |service| service.formats.include? format }
-  end
-
-
-end