ims-lti 1.1.12 → 2.3.5

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

@@ -0,0 +1,239 @@
+module IMS::LTI::Models::Messages
+  class Message
+
+    attr_reader :message_authenticator
+
+    class << self
+
+      def required_params
+        supers_params('@required_params') | (@required_params || [])
+      end
+
+      def add_required_params(param, *params)
+        add_params('@required_params', param, *params)
+      end
+
+      def recommended_params
+        supers_params('@recommended_params') | (@recommended_params || [])
+      end
+
+      def add_recommended_params(param, *params)
+        add_params('@recommended_params', param, *params)
+      end
+
+      def optional_params
+        supers_params('@optional_params') | (@optional_params || [])
+      end
+
+      def add_optional_params(param, *params)
+        add_params('@optional_params', param, *params)
+      end
+
+      def deprecated_params
+        supers_params('@deprecated_params') | (@deprecated_params || [])
+      end
+
+      def add_deprecated_params(param, *params)
+        add_params('@deprecated_params', param, *params)
+      end
+
+      def inherited(klass)
+        @descendants ||= Set.new
+        @descendants << klass
+        superclass.inherited(klass) unless (self == Message)
+      end
+
+      def descendants
+        @descendants || Set.new
+      end
+
+      # For signature generation -- see usage in signed_post_params
+      def convert_param_values_to_crlf_endings(hash)
+        hash.transform_values do |val|
+          if val.is_a?(String)
+            # Convert to all newlines first, for consistency, just in case there
+            # is some weird mix of newlines & carriage returns in input
+            val.encode(universal_newline: true).encode(crlf_newline: true)
+          else
+            val
+          end
+        end
+      end
+
+      private
+
+      def add_params(instance_variable, param, *params)
+        instance_var = self.instance_variable_get(instance_variable) || []
+        instance_var |= params.unshift(param)
+        self.instance_variable_set(instance_variable, instance_var)
+        attr_accessor(params.shift, *params)
+      end
+
+      def parameters
+        required_params + recommended_params + optional_params + deprecated_params
+      end
+
+      def supers_params(instance_variable)
+        if name == "IMS::LTI::Models::Messages::Message"
+          []
+        else
+          (superclass.instance_variable_get(instance_variable) || []) | superclass.send(:supers_params, instance_variable)
+        end
+      end
+
+    end
+
+    MESSAGE_TYPE = "".freeze
+
+    LAUNCH_TARGET_IFRAME = 'iframe'
+    LAUNCH_TARGET_WINDOW = 'window'
+
+    EXTENSION_PREFIX = 'ext_'
+    CUSTOM_PREFIX = 'custom_'
+
+    OAUTH_KEYS = :oauth_callback, :oauth_consumer_key, :oauth_nonce, :oauth_signature, :oauth_signature_method,
+      :oauth_timestamp, :oauth_token, :oauth_verifier, :oauth_version
+
+    attr_accessor :launch_url, :jwt, *OAUTH_KEYS
+    attr_reader :unknown_params, :custom_params, :ext_params
+
+    add_required_params :lti_message_type, :lti_version
+
+    def self.generate(launch_params)
+      params = launch_params.key?('jwt') ? parse_jwt(jwt: launch_params['jwt']) : launch_params
+      klass = self.descendants.select {|d| d::MESSAGE_TYPE == params['lti_message_type']}.first
+      message = klass ? klass.new(params) : Message.new(params)
+      message.jwt = launch_params['jwt'] if launch_params.key?('jwt')
+      message
+    end
+
+    def self.parse_jwt(jwt:)
+      decoded_jwt = JSON::JWT.decode(jwt, :skip_verification)
+      params = decoded_jwt['org.imsglobal.lti.message'] || {}
+      custom = params.delete(:custom)
+      custom.each {|k,v| params["custom_#{k}"] = v }
+      params['consumer_key'] = decoded_jwt[:sub]
+      ext = params.delete(:ext)
+      ext.each {|k,v| params["ext_#{k}"] = v }
+      params
+    end
+
+    def initialize(attrs = {}, custom_params = {}, ext_params = {})
+
+      @custom_params = custom_params
+      @ext_params = ext_params
+      @unknown_params = {}
+
+      attrs.each do |k, v|
+        str_key = k.to_s
+        if str_key.start_with?(EXTENSION_PREFIX)
+          @ext_params[str_key] = v
+        elsif str_key.start_with?(CUSTOM_PREFIX)
+          @custom_params[str_key] = v
+        elsif !v.nil? && self.respond_to?(k.to_sym)
+          send(("#{k}=").to_sym, v)
+
+        else
+          warn "Unknown parameter #{k}"
+          @unknown_params[str_key] = v
+        end
+      end
+    end
+
+    def add_custom_params(params)
+      params.each {|k, v| k.to_s.start_with?('custom_') ? @custom_params[k.to_s] = v : @custom_params["custom_#{k.to_s}"] = v}
+    end
+
+    def get_custom_params
+      @custom_params.inject({}) {|hash, (k, v)| hash[k.gsub(/\Acustom_/, '')] = v; hash}
+    end
+
+    def get_ext_params
+      @ext_params.inject({}) {|hash, (k, v)| hash[k.gsub(/\Aext_/, '')] = v; hash}
+    end
+
+    def post_params
+      unknown_params.merge(@custom_params).merge(@ext_params).merge(parameters)
+    end
+
+    def jwt_params(private_key:, originating_domain:, algorithm: :HS256)
+      { 'jwt' => to_jwt(private_key: private_key, originating_domain: originating_domain, algorithm: algorithm) }
+    end
+
+    def signed_post_params(secret)
+      # The params will be used in an HTML form, and browsers will always use
+      # newlines+carriage return line endings for submitted form data. The
+      # signature needs to match, and signature generation does not add carriage
+      # returns, so we ensure CRLF endings here.
+      message_params = self.class.convert_param_values_to_crlf_endings(oauth_params.merge(post_params))
+      @message_authenticator = IMS::LTI::Services::MessageAuthenticator.new(launch_url, message_params, secret)
+      @message_authenticator.signed_params
+    end
+
+    def parameters
+      collect_attributes(self.class.send("parameters"))
+    end
+
+    def required_params
+      collect_attributes(self.class.required_params)
+    end
+
+    def recommended_params
+      collect_attributes(self.class.recommended_params)
+    end
+
+    def optional_params
+      collect_attributes(self.class.optional_params)
+    end
+
+    def deprecated_params
+      collect_attributes(self.class.deprecated_params)
+    end
+
+    def oauth_params
+      collect_attributes(OAUTH_KEYS)
+    end
+
+    def method_missing(meth, *args, &block)
+      if match = /^(custom|ext)_([^=$]*)/.match(meth)
+        param_type, key = match.captures
+        param_hash = instance_variable_get("@#{param_type}_params".to_sym)
+        meth =~ /=$/ ? param_hash[match.to_s] = args[0] : param_hash[match.to_s]
+      else
+        super
+      end
+    end
+
+    def to_jwt(private_key:, originating_domain:, algorithm: :HS256)
+      now = Time.now
+      exp = now + 60 * 5
+      ims = unknown_params.merge(parameters)
+      ims[:custom] = get_custom_params
+      ims[:ext] = get_ext_params
+      claim = {
+        iss: originating_domain,
+        sub: consumer_key,
+        aud: launch_url,
+        iat: now,
+        exp: exp,
+        jti: SecureRandom.uuid,
+        "org.imsglobal.lti.message" => ims
+      }
+      jwt = JSON::JWT.new(claim).sign(private_key, algorithm)
+      jwt.to_s
+    end
+
+    alias_attribute :consumer_key, :oauth_consumer_key
+
+    private
+
+    def collect_attributes(attributes)
+      attributes.inject({}) do |h, param|
+        value = instance_variable_get("@#{param}")
+        h[param.to_s] = value if value
+        h
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,20 @@
+module IMS::LTI::Models::Messages
+  class RegistrationRequest < RequestMessage
+
+    add_required_params :reg_key, :reg_password, :tc_profile_url, :launch_presentation_return_url, :tool_proxy_guid,
+                        :tool_proxy_url
+
+
+    MESSAGE_TYPE = 'ToolProxyRegistrationRequest'
+
+    def initialize(attrs = {})
+      super(attrs)
+      self.lti_message_type = MESSAGE_TYPE
+    end
+
+    def generate_key_and_password
+      self.reg_key, self.reg_password = 2.times.map { SecureRandom.uuid }
+    end
+
+  end
+end

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

@@ -0,0 +1,12 @@
+module IMS::LTI::Models::Messages
+  class RequestMessage < Message
+
+    add_recommended_params :user_id, :roles, :launch_presentation_document_target, :launch_presentation_width, :launch_presentation_height
+    add_optional_params :launch_presentation_locale, :launch_presentation_css_url
+
+    def initialize(attrs = {})
+      super(attrs)
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+module IMS::LTI::Models::Messages
+  class ToolProxyUpdateRequest < RequestMessage
+
+    add_required_params :tc_profile_url, :launch_presentation_return_url
+
+
+    MESSAGE_TYPE = 'ToolProxyUpdateRequest'
+
+    def initialize(attrs = {})
+      super(attrs)
+      self.lti_message_type = MESSAGE_TYPE
+    end
+
+  end
+end

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

@@ -0,0 +1,11 @@
+module IMS::LTI::Models
+  module Messages
+    require_relative 'messages/message'
+    require_relative 'messages/request_message'
+    require_relative 'messages/registration_request'
+    require_relative 'messages/basic_lti_launch_request'
+    require_relative 'messages/content_item_selection_request'
+    require_relative 'messages/content_item_selection'
+    require_relative 'messages/tool_proxy_update_request'
+  end
+end

data/lib/ims/lti/models/parameter.rb

@@ -0,0 +1,28 @@
+module IMS::LTI::Models
+  class Parameter < LTIModel
+
+    add_attributes :name, :variable, :fixed
+
+    def fixed?
+      !fixed.nil? && fixed.to_s.strip != ''
+    end
+
+    def self.process_params(parameters, lookup_hash)
+      [*parameters].inject({}) do |hash, param|
+        hash[param.name] = param.fixed? ? param.fixed : expand_variable(lookup_hash[param.variable]) || '$' + param.variable
+        hash
+      end
+    end
+
+    def ==(obj)
+      self.fixed? == obj.fixed? && self.name == obj.name && self.fixed == obj.fixed
+    end
+
+    private
+
+    def self.expand_variable(value)
+      value.respond_to?(:call) ? value.call : value
+    end
+
+  end
+end

data/lib/ims/lti/models/product_family.rb

@@ -0,0 +1,8 @@
+module IMS::LTI::Models
+  class ProductFamily < LTIModel
+    add_attributes :code
+    add_attribute :id, json_key: '@id'
+    add_attribute :vendor, relation: 'IMS::LTI::Models::Vendor'
+
+  end
+end

data/lib/ims/lti/models/product_info.rb

@@ -0,0 +1,26 @@
+module IMS::LTI::Models
+  class ProductInfo < LTIModel
+    add_attribute :product_version
+    add_attribute :product_family, relation: 'IMS::LTI::Models::ProductFamily'
+    add_attribute :description, relation: 'IMS::LTI::Models::LocalizedText'
+    add_attribute :product_name, relation: 'IMS::LTI::Models::LocalizedName'
+    add_attribute :technical_description, relation: 'IMS::LTI::Models::LocalizedText'
+
+    def create_product_name(name, key = 'product.name')
+      @product_name = LocalizedName.new(name, key)
+    end
+
+    def create_description(name, key = 'product.description')
+      @description = LocalizedText.new(name, key)
+    end
+
+    def default_description
+      description && description.default_value
+    end
+
+    def default_name
+      product_name && product_name.default_value
+    end
+
+  end
+end

data/lib/ims/lti/models/product_instance.rb

@@ -0,0 +1,10 @@
+module IMS::LTI::Models
+  class ProductInstance < LTIModel
+    add_attributes :guid
+    add_attribute :product_info, relation:'IMS::LTI::Models::ProductInfo'
+    add_attribute :service_owner, relation:'IMS::LTI::Models::ServiceOwner'
+    add_attribute :service_provider, relation:'IMS::LTI::Models::ServiceProvider'
+    add_attribute :support, relation:'IMS::LTI::Models::Contact'
+
+  end
+end

data/lib/ims/lti/models/resource_handler.rb

@@ -0,0 +1,22 @@
+module IMS::LTI::Models
+  class ResourceHandler < LTIModel
+    add_attribute :resource_type, relation: 'IMS::LTI::Models::ResourceType'
+    add_attribute :resource_name, relation: 'IMS::LTI::Models::LocalizedName'
+    add_attribute :description, relation: 'IMS::LTI::Models::LocalizedText'
+    add_attribute :message, relation: 'IMS::LTI::Models::MessageHandler'
+    add_attribute :icon_info, relation: 'IMS::LTI::Models::IconInfo'
+
+    def default_name
+      resource_name && resource_name.default_value
+    end
+
+    def default_description
+      description && description.default_value
+    end
+
+    def messages
+      [*message]
+    end
+
+  end
+end

data/lib/ims/lti/models/resource_type.rb

@@ -0,0 +1,6 @@
+module IMS::LTI::Models
+  class ResourceType < LTIModel
+    add_attribute :code
+
+  end
+end

data/lib/ims/lti/models/rest_service.rb

@@ -0,0 +1,30 @@
+module IMS::LTI::Models
+  class RestService < LTIModel
+    TYPE = 'RestService'
+
+    add_attributes :endpoint, :format, :action
+    add_attribute :id, json_key:'@id'
+    add_attribute :type, json_key: '@type'
+
+    def initialize(attributes = {})
+      @type = TYPE
+      super(attributes)
+    end
+
+    def profile
+      RestServiceProfile.new(
+          service: endpoint,
+          action: action
+      )
+    end
+
+    def actions
+      [*action]
+    end
+
+    def formats
+      [*format]
+    end
+
+  end
+end

data/lib/ims/lti/models/rest_service_profile.rb

@@ -0,0 +1,15 @@
+module IMS::LTI::Models
+  class RestServiceProfile < LTIModel
+    add_attributes :service, :action
+    add_attribute :type, json_key: '@type'
+
+    def initialize(attributes = {})
+      @type = "RestServiceProfile"
+      super(attributes)
+    end
+
+    def actions
+      [*action]
+    end
+  end
+end

data/lib/ims/lti/models/security_contract.rb

@@ -0,0 +1,21 @@
+module IMS::LTI::Models
+  class SecurityContract < LTIModel
+
+    add_attributes :shared_secret, :tp_half_shared_secret
+    add_attribute :tool_service, relation: 'IMS::LTI::Models::RestServiceProfile'
+    add_attribute :end_user_service, relation: 'IMS::LTI::Models::RestServiceProfile'
+
+    def tool_services
+      [*tool_service]
+    end
+
+    def end_user_services
+      [*end_user_service]
+    end
+
+    def services
+      tool_services + end_user_services
+    end
+
+  end
+end

data/lib/ims/lti/models/security_profile.rb

@@ -0,0 +1,10 @@
+module IMS::LTI::Models
+  class SecurityProfile < LTIModel
+    add_attributes :security_profile_name, :digest_algorithm
+
+    def digest_algorithms
+      [*@digest_algorithm]
+    end
+
+  end
+end

data/lib/ims/lti/models/serializable.rb

@@ -0,0 +1,12 @@
+module IMS::LTI::Models
+  module Serializable
+    def as_json(opts={})
+      class_name = self.class.name.gsub(/^IMS::LTI::Models/, 'IMS::LTI::Serializers') + 'Serializer'
+      Object.const_get(class_name).as_json(self)
+    end
+
+    def to_json
+      as_json.to_json
+    end
+  end
+end

data/lib/ims/lti/models/service_owner.rb

@@ -0,0 +1,26 @@
+module IMS::LTI::Models
+  class ServiceOwner < LTIModel
+    add_attribute :id, json_key:'@id'
+    add_attribute :description, relation: 'IMS::LTI::Models::LocalizedText'
+    add_attribute :timestamp, json_converter:'IMS::LTI::Converters::TimeJSONConverter'
+    add_attribute :service_owner_name, relation: 'IMS::LTI::Models::LocalizedName'
+    add_attribute :support, relation:'IMS::LTI::Models::Contact'
+
+    def create_service_owner_name(name, key = 'service_owner.name')
+      @service_owner_name = LocalizedName.new(name, key)
+    end
+
+    def create_description(name, key = 'service_owner.description')
+      @description = LocalizedText.new(name, key)
+    end
+
+    def default_name
+      service_owner_name && service_owner_name.default_value
+    end
+
+    def default_description
+      description && description.default_value
+    end
+
+  end
+end

data/lib/ims/lti/models/service_provider.rb

@@ -0,0 +1,11 @@
+module IMS::LTI::Models
+  class ServiceProvider < LTIModel
+    add_attribute :guid
+    add_attribute :id, json_key:'@id'
+    add_attribute :service_provider_name, relation:'IMS::LTI::Models::LocalizedName'
+    add_attribute :description, relation:'IMS::LTI::Models::LocalizedText'
+    add_attribute :support, relation:'IMS::LTI::Models::Contact'
+    add_attribute :timestamp, json_converter: 'IMS::LTI::Converters::TimeJSONConverter'
+
+  end
+end

data/lib/ims/lti/models/tool_consumer_profile.rb

@@ -0,0 +1,45 @@
+module IMS::LTI::Models
+  class ToolConsumerProfile < LTIModel
+
+    CONTEXT = "http://purl.imsglobal.org/ctx/lti/v2/ToolConsumerProfile"
+    TYPE = "ToolConsumerProfile"
+
+    MESSAGING_CAPABILITIES = %w(basic-lti-launch-request)
+    OUTCOMES_CAPABILITIES = %w(Result.autocreate)
+
+    add_attributes :lti_version, :guid, :capability_offered, :security_profile
+    add_attribute :id, json_key:'@id'
+    add_attribute :type, json_key:'@type'
+    add_attribute :context, json_key:'@context'
+    add_attribute :security_profile, relation: 'IMS::LTI::Models::SecurityProfile'
+    add_attribute :product_instance, relation:'IMS::LTI::Models::ProductInstance'
+    add_attribute :service_offered, relation: 'IMS::LTI::Models::RestService'
+
+    def initialize(attr = {})
+      @context = [CONTEXT]
+      @type = TYPE
+      super(attr)
+    end
+
+    def services_offered
+      [*@service_offered]
+    end
+
+    def capabilities_offered
+      [*@capability_offered]
+    end
+
+    def security_profiles
+      [*@security_profile]
+    end
+
+    def reregistration_capable?
+      @capability_offered.include?(Messages::ToolProxyUpdateRequest::MESSAGE_TYPE)
+    end
+
+    def security_profile_by_name(security_profile_name:)
+      security_profiles.find { |sp| sp.security_profile_name == security_profile_name}
+    end
+
+  end
+end

data/lib/ims/lti/models/tool_profile.rb

@@ -0,0 +1,35 @@
+module IMS::LTI::Models
+  class ToolProfile < LTIModel
+    add_attributes :lti_version
+    add_attribute :id, json_key: '@id'
+    add_attribute :product_instance, relation:'IMS::LTI::Models::ProductInstance'
+    add_attribute :base_url_choice, relation: 'IMS::LTI::Models::BaseUrlChoice'
+    add_attribute :resource_handler, relation:'IMS::LTI::Models::ResourceHandler'
+    add_attribute :message, relation:'IMS::LTI::Models::MessageHandler'
+    add_attribute :service_offered, relation:'IMS::LTI::Models::RestService'
+    add_attribute :security_profile, relation:'IMS::LTI::Models::SecurityProfile'
+
+
+    def base_message_url
+      if base_url_choice
+        choice = base_url_choice.find { |choice| choice.default_message_url != '' }
+        choice ? choice.default_message_url : ''
+      else
+        ''
+      end
+    end
+
+    def resource_handlers
+      [*@resource_handler]
+    end
+
+    def messages
+      [*@message]
+    end
+
+    def security_profiles
+      [*@security_profile]
+    end
+
+  end
+end

data/lib/ims/lti/models/tool_proxy.rb

@@ -0,0 +1,21 @@
+module IMS::LTI::Models
+  class ToolProxy < LTIModel
+    add_attributes :lti_version, :tool_proxy_guid, :custom, :custom_url, :enabled_capability, :tc_half_shared_secret
+    add_attribute :context, json_key:'@context'
+    add_attribute :type, json_key:'@type'
+    add_attribute :id, json_key:'@id'
+    add_attribute :tool_consumer_profile
+    add_attribute :tool_profile, relation:'IMS::LTI::Models::ToolProfile'
+    add_attribute :security_contract, relation:'IMS::LTI::Models::SecurityContract'
+
+    def initialize(attr = {})
+      @context = ['http://purl.imsglobal.org/ctx/lti/v2/ToolProxy']
+      super(attr)
+      @type = 'ToolProxy'
+    end
+
+    def enabled_capabilities
+      [*enabled_capability]
+    end
+  end
+end

data/lib/ims/lti/models/tool_setting.rb

@@ -0,0 +1,12 @@
+module IMS::LTI::Models
+  class ToolSetting < LTIModel
+    add_attribute :type, json_key: '@type'
+    add_attribute :id, json_key: '@id'
+    add_attributes :custom, :custom_url
+
+    TOOL_PROXY_BINDING_TYPE = 'ToolProxyBinding'
+    TOOL_PROXY_TYPE = 'ToolProxy'
+    LTI_LINK_TYPE = 'LtiLink'
+
+  end
+end

data/lib/ims/lti/models/tool_setting_container.rb

@@ -0,0 +1,14 @@
+module IMS::LTI::Models
+  class ToolSettingContainer < LTIModel
+    add_attribute :context, json_key: '@context'
+    add_attribute :graph, json_key: '@graph', relation: 'IMS::LTI::Models::ToolSetting'
+
+    TOOL_SETTING_CONTAINER_CONTEXT = 'http://purl.imsglobal.org/ctx/lti/v2/ToolSettings'
+
+    def initialize(opts = {})
+      super(opts)
+      self.context = TOOL_SETTING_CONTAINER_CONTEXT
+    end
+
+  end
+end