ims-lti 2.0.0.beta.18 → 2.0.0.beta.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 469b57f391256431763f04ca1187ae5a7769367a
-  data.tar.gz: 0be379c6ea503a5503b9319aaaec4a0cc3c89f38
+  metadata.gz: abb31c30499a793de7682bdd02c9e1e8a71f1500
+  data.tar.gz: a4ed57fa69bf00c8128ec2986d47d9d3ef2c7c7b
 SHA512:
-  metadata.gz: e16ab1448cc60ae4a895d0d21eb5f9d9a09ac65efcf211c50a84adb01fbbb43105b261e15da74fe9e9fe69b7e1a7d84f18306c5f4fe8073b527c897059e151da
-  data.tar.gz: f5b3797ab367c341275611dfc31434673cc73c94916036d02471fe570e499f5e5cfdc343b7252da33777c72b6e4ede92d452a1977bfefd2de25aaa6a856c280b
+  metadata.gz: 473cafa07eada8291040ecc68b7b5ee5815914f72522576fdd442fbce7ed91bbbfed19d150a55f9178aaef3564d9ec53dce72c4a48214102b7c079c5cc2eeb6e
+  data.tar.gz: 70e79ca8a862600a05508314b99a281a4800600038f4e106d92bf1aebc140df14ccf1d4d6011fc2aea8ad5e6ff3b2228ffab29cef6268762a4cdf8a074be1300

data/lib/ims/lti.rb

@@ -3,11 +3,14 @@ require 'securerandom'
 require 'simple_oauth'
 require 'faraday'
 require 'faraday_middleware'
+require 'builder'
+require 'rexml/document'
 
 module IMS
   module LTI
     require_relative 'lti/models'
     require_relative 'lti/converters'
     require_relative 'lti/services'
+    require_relative 'lti/errors'
   end
 end

data/lib/ims/lti/errors.rb

@@ -0,0 +1,5 @@
+module IMS::LTI
+  module Errors
+    require_relative 'errors/invalid_lti_config_error'
+  end
+end

data/lib/ims/lti/errors/invalid_lti_config_error.rb

@@ -0,0 +1,4 @@
+module IMS::LTI::Errors
+  class InvalidLTIConfigError < StandardError
+  end
+end

data/lib/ims/lti/models/messages/basic_lti_launch_request.rb

@@ -10,7 +10,7 @@ module IMS::LTI::Models::Messages
                       :lis_course_offering_sourcedid, :lis_course_section_sourcedid,
                       :tool_consumer_info_product_family_code, :tool_consumer_info_product_family_version,
                       :tool_consumer_instance_name, :tool_consumer_instance_description, :tool_consumer_instance_url,
-                      :tool_consumer_instance_contact_email
+                      :tool_consumer_instance_contact_email, :tool_consumer_info_version
 
     MESSAGE_TYPE = 'basic-lti-launch-request'
 

data/lib/ims/lti/services.rb

@@ -1,5 +1,6 @@
 module IMS::LTI
   module Services
     require_relative 'services/tool_proxy_registration_service'
+    require_relative 'services/tool_config'
   end
 end

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

@@ -1,10 +1,12 @@
-class ServiceDefinition
-  attr_reader :name, :formats, :paramater_variables
+module IMS::LTI::Services
+  class ServiceDefinition
+    attr_reader :name, :formats, :paramater_variables
 
-  def initialize(name, formats, parameter_variables = [])
-    @name = name
-    @formats = formats
-    @parameter_variables = parameter_variables
-  end
+    def initialize(name, formats, parameter_variables = [])
+      @name = name
+      @formats = formats
+      @parameter_variables = parameter_variables
+    end
 
-end
+  end
+end

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

@@ -1,30 +1,32 @@
-class ServiceLookup
+module IMS::LTI::Services
+  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_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_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),
-    []
-  )
+    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.services
+      [TOOL_SETTING_SERVICE, TOOL_CONSUMER_PROFILE_SERVICE, TOOL_PROXY_SERVICE]
+    end
 
-  def self.lookup(format)
-    services.select { |service| service.formats.include? format }
-  end
+    def self.lookup(format)
+      services.select { |service| service.formats.include? format }
+    end
 
 
-end
+  end
+end

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

@@ -0,0 +1,225 @@
+module IMS::LTI::Services
+  # Class used to represent an LTI configuration
+  #
+  # It can create and read the Common Cartridge XML representation of LTI links
+  # as described here: http://www.imsglobal.org/LTI/v1p1pd/ltiIMGv1p1pd.html#_Toc309649689
+  #
+  # == Usage
+  # To generate an XML configuration:
+  #
+  #    # Create a config object and set some options
+  #    tc = IMS::LTI::Services::ToolConfig.new(:title => "Example Sinatra Tool Provider", :launch_url => url)
+  #    tc.description = "This example LTI Tool Provider supports LIS Outcome pass-back."
+  #
+  #    # generate the XML
+  #    tc.to_xml
+  #
+  # Or to create a config object from an XML String:
+  #
+  #    tc = IMS::LTI::Services::ToolConfig.create_from_xml(xml)
+  class ToolConfig
+    attr_reader :custom_params, :extensions
+
+    attr_accessor :title, :description, :launch_url, :secure_launch_url,
+                  :icon, :secure_icon, :cartridge_bundle, :cartridge_icon,
+                  :vendor_code, :vendor_name, :vendor_description, :vendor_url,
+                  :vendor_contact_email, :vendor_contact_name
+
+    # Create a new ToolConfig with the given options
+    #
+    # @param opts [Hash] The initial options for the ToolConfig
+    def initialize(opts={})
+      @custom_params = opts.delete("custom_params") || {}
+      @extensions = opts.delete("extensions") || {}
+
+      opts.each_pair do |key, val|
+        self.send("#{key}=", val) if self.respond_to?("#{key}=")
+      end
+    end
+
+    # Create a ToolConfig from the given XML
+    #
+    # @param xml [String]
+    def self.create_from_xml(xml)
+      tc = ToolConfig.new
+      tc.process_xml(xml)
+
+      tc
+    end
+
+    def set_custom_param(key, val)
+      @custom_params[key] = val
+    end
+
+    def get_custom_param(key)
+      @custom_params[key]
+    end
+
+    # Set the extension parameters for a specific vendor
+    #
+    # @param ext_key [String] The identifier for the vendor-specific parameters
+    # @param ext_params [Hash] The parameters, this is allowed to be two-levels deep
+    def set_ext_params(ext_key, ext_params)
+      raise ArgumentError unless ext_params.is_a?(Hash)
+      @extensions[ext_key] = ext_params
+    end
+
+    def get_ext_params(ext_key)
+      @extensions[ext_key]
+    end
+
+    def set_ext_param(ext_key, param_key, val)
+      @extensions[ext_key] ||= {}
+      @extensions[ext_key][param_key] = val
+    end
+
+    def get_ext_param(ext_key, param_key)
+      @extensions[ext_key] && @extensions[ext_key][param_key]
+    end
+
+    # Namespaces used for parsing configuration XML
+    LTI_NAMESPACES = {
+      "xmlns" => 'http://www.imsglobal.org/xsd/imslticc_v1p0',
+      "blti" => 'http://www.imsglobal.org/xsd/imsbasiclti_v1p0',
+      "lticm" => 'http://www.imsglobal.org/xsd/imslticm_v1p0',
+      "lticp" => 'http://www.imsglobal.org/xsd/imslticp_v1p0',
+    }
+
+    # Parse tool configuration data out of the Common Cartridge LTI link XML
+    def process_xml(xml)
+      doc = REXML::Document.new xml
+      if root = REXML::XPath.first(doc, 'xmlns:cartridge_basiclti_link')
+        @title = get_node_text(root, 'blti:title')
+        @description = get_node_text(root, 'blti:description')
+        @launch_url = get_node_text(root, 'blti:launch_url')
+        @secure_launch_url = get_node_text(root, 'blti:secure_launch_url')
+        @icon = get_node_text(root, 'blti:icon')
+        @secure_icon = get_node_text(root, 'blti:secure_icon')
+        @cartridge_bundle = get_node_att(root, 'xmlns:cartridge_bundle', 'identifierref')
+        @cartridge_icon = get_node_att(root, 'xmlns:cartridge_icon', 'identifierref')
+
+        if vendor = REXML::XPath.first(root, 'blti:vendor')
+          @vendor_code = get_node_text(vendor, 'lticp:code')
+          @vendor_description = get_node_text(vendor, 'lticp:description')
+          @vendor_name = get_node_text(vendor, 'lticp:name')
+          @vendor_url = get_node_text(vendor, 'lticp:url')
+          @vendor_contact_email = get_node_text(vendor, '//lticp:contact/lticp:email')
+          @vendor_contact_name = get_node_text(vendor, '//lticp:contact/lticp:name')
+        end
+
+        if custom = REXML::XPath.first(root, 'blti:custom', LTI_NAMESPACES)
+          set_properties(@custom_params, custom)
+        end
+
+        REXML::XPath.each(root, 'blti:extensions', LTI_NAMESPACES) do |vendor_ext_node|
+          platform = vendor_ext_node.attributes['platform']
+          properties = {}
+          set_properties(properties, vendor_ext_node)
+          REXML::XPath.each(vendor_ext_node, 'lticm:options', LTI_NAMESPACES) do |options_node|
+            opt_name = options_node.attributes['name']
+            options = {}
+            set_properties(options, options_node)
+            properties[opt_name] = options
+          end
+
+          self.set_ext_params(platform, properties)
+        end
+
+      end
+    end
+
+    # Generate XML from the current settings
+    def to_xml(opts = {})
+      raise IMS::LTI::Errors::InvalidLTIConfigError, "A launch url is required for an LTI configuration." unless self.launch_url || self.secure_launch_url
+
+      builder = Builder::XmlMarkup.new(:indent => opts[:indent] || 0)
+      builder.instruct!
+      builder.cartridge_basiclti_link("xmlns" => "http://www.imsglobal.org/xsd/imslticc_v1p0",
+                                      "xmlns:blti" => 'http://www.imsglobal.org/xsd/imsbasiclti_v1p0',
+                                      "xmlns:lticm" => 'http://www.imsglobal.org/xsd/imslticm_v1p0',
+                                      "xmlns:lticp" => 'http://www.imsglobal.org/xsd/imslticp_v1p0',
+                                      "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+                                      "xsi:schemaLocation" => "http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0p1.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd"
+      ) do |blti_node|
+
+        %w{title description launch_url secure_launch_url icon secure_icon}.each do |key|
+          blti_node.blti key.to_sym, self.send(key) if self.send(key)
+        end
+
+        vendor_keys = %w{name code description url}
+        if vendor_keys.any? { |k| self.send("vendor_#{k}") } || vendor_contact_email
+          blti_node.blti :vendor do |v_node|
+            vendor_keys.each do |key|
+              v_node.lticp key.to_sym, self.send("vendor_#{key}") if self.send("vendor_#{key}")
+            end
+            if vendor_contact_email
+              v_node.lticp :contact do |c_node|
+                c_node.lticp :name, vendor_contact_name
+                c_node.lticp :email, vendor_contact_email
+              end
+            end
+          end
+        end
+
+        if !@custom_params.empty?
+          blti_node.tag!("blti:custom") do |custom_node|
+            @custom_params.keys.sort.each do |key|
+              val = @custom_params[key]
+              custom_node.lticm :property, val, 'name' => key
+            end
+          end
+        end
+
+        if !@extensions.empty?
+          @extensions.keys.sort.each do |ext_platform|
+            ext_params = @extensions[ext_platform]
+            blti_node.blti(:extensions, :platform => ext_platform) do |ext_node|
+              ext_params.keys.sort.each do |key|
+                val = ext_params[key]
+                if val.is_a?(Hash)
+                  ext_node.lticm(:options, :name => key) do |type_node|
+                    val.keys.sort.each do |p_key|
+                      p_val = val[p_key]
+                      type_node.lticm :property, p_val, 'name' => p_key
+                    end
+                  end
+                else
+                  ext_node.lticm :property, val, 'name' => key
+                end
+              end
+            end
+          end
+        end
+
+        blti_node.cartridge_bundle(:identifierref => @cartridge_bundle) if @cartridge_bundle
+        blti_node.cartridge_icon(:identifierref => @cartridge_icon) if @cartridge_icon
+
+      end
+    end
+
+    private
+
+    def get_node_text(node, path)
+      if val = REXML::XPath.first(node, path, LTI_NAMESPACES)
+        val.text
+      else
+        nil
+      end
+    end
+
+    def get_node_att(node, path, att)
+      if val = REXML::XPath.first(node, path, LTI_NAMESPACES)
+        val.attributes[att]
+      else
+        nil
+      end
+    end
+
+    def set_properties(hash, node)
+      REXML::XPath.each(node, 'lticm:property', LTI_NAMESPACES) do |prop|
+        hash[prop.attributes['name']] = prop.text
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.18
+  version: 2.0.0.beta.19
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_oauth
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +121,8 @@ files:
 - lib/ims/lti.rb
 - lib/ims/lti/converters.rb
 - lib/ims/lti/converters/time_json_converter.rb
+- lib/ims/lti/errors.rb
+- lib/ims/lti/errors/invalid_lti_config_error.rb
 - lib/ims/lti/models.rb
 - lib/ims/lti/models/base_url_choice.rb
 - lib/ims/lti/models/base_url_selector.rb
@@ -141,6 +157,7 @@ files:
 - lib/ims/lti/services.rb
 - lib/ims/lti/services/service_definition.rb
 - lib/ims/lti/services/service_lookup.rb
+- lib/ims/lti/services/tool_config.rb
 - lib/ims/lti/services/tool_proxy_registration_service.rb
 - lib/ims/lti/version.rb
 homepage: http://github.com/instructure/ims-lti