ims-lti 2.0.0.beta.4 → 2.0.0.beta.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed76063b4d873fb5c4a6eea89c1da7aab0ccef25
-  data.tar.gz: a2bc4269ce259274dbae7efca5f8f5113a76c5ec
+  metadata.gz: 38d11793d219aeeb78b863805a6330f15fc7d14b
+  data.tar.gz: 602686761cd45823ea59a209708afbdd17e2045c
 SHA512:
-  metadata.gz: c5584c164f6aa8dad8c913eedb46cf957e139278890b2dbae7c28494584f2583d3e754d7827fcd028e94a55900576eee53bc21456600bceec4f0cc86c800929c
-  data.tar.gz: ae554d8cb1ede05cb8f79a04e9bc5d77c3a9ecdd86686588e795b4075d9c90c3575c4728384d96215530eca309f77ea18dad667f445206a48b63eddbe80540cb
+  metadata.gz: 4a026706243f8e3748fbb14233f81b14ad6a4aea839bf66ba77eb099249485ae1bb7f58767507a5b6f629a5a01f495d79804349688db3199218cb186225627fe
+  data.tar.gz: 5f636b4a4b7c8155d7ef37449272f8353e6033fe5cabefb3818686a4aca50952e0706a45f6fd9d52ede72b2ea3f48af5bacdac49765398cfec29a583c7ef5573

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

@@ -31,6 +31,10 @@ module IMS::LTI::Models
       subclass.inherit_attributes(self.attributes)
     end
 
+    def self.from_json(json)
+      new.from_json(json)
+    end
+
     def attributes
       attrs = {}
       self.class.attributes.each do |a|
@@ -67,7 +71,7 @@ module IMS::LTI::Models
     end
 
     def from_json(json)
-      data = JSON.parse(json)
+      data = json.is_a?(String) ? JSON.parse(json) : json
       if data.is_a? Array
         data.map { |hash| self.class.new.from_json(hash.to_json) }
       else

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

@@ -1,6 +1,6 @@
 module IMS::LTI::Models
   class MessageHandler < LTIModel
-    add_attributes :message_type, :path, :enabled_capability, :parameter
+    add_attributes :message_type, :path, :enabled_capability
     add_attribute :parameter, relation:'IMS::LTI::Models::Parameter'
   end
 end

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

@@ -1,8 +1,16 @@
 module IMS::LTI::Models::Messages
   class BasicLTILaunchRequest < IMS::LTI::Models::Messages::Message
 
-    add_attributes :context_id, :context_type, :launch_presentation_return_url, :resource_link_id, :role_scope_mentor,
-                   :tool_consumer_instance_guid, :user_image
+    required_params :resource_link_id
+    recommended_params :context_id, :launch_presentation_return_url, :tool_consumer_instance_guid
+    optional_params :context_type, :role_scope_mentor, :user_image
+    deprecated_params :context_title, :context_label, :resource_link_title, :resource_link_description,
+                      :lis_person_name_given, :lis_person_name_family, :lis_person_name_full,
+                      :lis_person_contact_email_primary, :user_image, :lis_person_sourcedid,
+                      :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
 
     MESSAGE_TYPE = 'basic-lti-launch-request'
 

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

@@ -1,60 +1,135 @@
 module IMS::LTI::Models::Messages
-  class Message < IMS::LTI::Models::LTIModel
+  class Message
+    class << self
+
+      def required_params(param, *params)
+        add_params(param, *params)
+      end
+
+      def recommended_params(param, *params)
+        add_params(param, *params)
+      end
+
+      def optional_params(param, *params)
+        add_params(param, *params)
+      end
+
+      def deprecated_params(param, *params)
+        add_params(param, *params)
+      end
+
+      private
+
+      def add_params(param, *params)
+        params.unshift(param)
+        @parameters ||= []
+        @parameters += params
+        attr_accessor(params.shift, *params)
+      end
+
+      def parameters
+        @parameters ||= []
+      end
+
+    end
+
     LAUNCH_TARGET_IFRAME = 'iframe'
     LAUNCH_TARGET_WINDOW = 'window'
 
     EXTENSION_PREFIX = 'ext_'
     CUSTOM_PREFIX = 'custom_'
 
-    add_attributes :lti_message_type, :lti_version, :user_id, :roles, :launch_presentation_local,
-                   :launch_presentation_document_target, :launch_presentation_css_url, :launch_presentation_width,
-                   :launch_presentation_height
+    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, *OAUTH_KEYS
+
+    required_params :lti_message_type, :lti_version
+    recommended_params :user_id, :roles, :launch_presentation_document_target, :launch_presentation_width, :launch_presentation_height
+    optional_params :launch_presentation_local, :launch_presentation_css_url
+
 
     def initialize(attrs = {})
       @custom_params = {}
       @ext_params = {}
-      attributes = {}
 
-      attrs.each do |k,v|
+      attrs.each do |k, v|
         str_key = k.to_s
         if str_key.start_with?(EXTENSION_PREFIX)
-          @ext_params[str_key.sub(EXTENSION_PREFIX, '')] = v
+          @ext_params[str_key] = v
         elsif str_key.start_with?(CUSTOM_PREFIX)
-          @custom_params[str_key.sub(CUSTOM_PREFIX, '')] = v
+          @custom_params[str_key] = v
+        elsif !v.nil? && self.respond_to?(k.to_sym)
+          instance_variable_set("@#{k}", v)
         else
-          attributes[k] = v
+          warn "Unknown parameter #{k}"
         end
       end
+    end
 
-      super(attributes)
+    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 post_params
-      get_custom_params.merge(get_ext_params).merge(attributes)
+      @custom_params.merge(@ext_params).merge(parameters)
     end
 
-    def get_ext_params
-      params = {}
-      @ext_params.each { |k, v| params["#{EXTENSION_PREFIX}#{k}"] = v }
-      params
+    def signed_post_params(secret)
+      params = post_params
+      header = SimpleOAuth::Header.new(:post, launch_url, params, consumer_key: oauth_consumer_key, consumer_secret: secret)
+      header.signed_attributes.merge(params)
     end
 
-    def get_custom_params
-      params = {}
-      @custom_params.each { |k, v| params["#{CUSTOM_PREFIX}#{k}"] = v }
-      params
+    def valid_signature?(secret)
+      params = OAUTH_KEYS.inject({}) do |hash, k|
+        value = instance_variable_get("@#{k}")
+        hash[k] = value if value
+        hash
+      end
+      options, parsed_params = parse_params(params)
+      signature = parsed_params.delete(:oauth_signature)
+      consumer_key = oauth_consumer_key
+      header = SimpleOAuth::Header.new(:post, launch_url, parsed_params, options.merge({consumer_key: consumer_key, consumer_secret: secret}))
+      header.valid?(signature: signature)
     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[key] = args[0] : param_hash[key]
+        meth =~ /=$/ ? param_hash[match.to_s] = args[0] : param_hash[match.to_s]
       else
         super
       end
     end
 
     private
+
+    def parameters
+
+      self.class.instance_variable_get("@parameters").inject({}) do |h, param|
+        value = instance_variable_get("@#{param.to_s}")
+        h[param.to_s] = value unless value.nil?
+        h
+      end
+    end
+
+    def parse_params(params)
+      params.inject([{}, {}]) do |array, (k, v)|
+        attr = k.to_s.sub('oauth_', '').to_sym
+        if SimpleOAuth::Header::ATTRIBUTE_KEYS.include?(attr)
+          array[0][attr] = v
+        else
+          array[1][k] = v
+        end
+        array
+      end
+    end
+
   end
 end

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

@@ -1,6 +1,7 @@
 module IMS::LTI::Models::Messages
   class RegistrationRequest < Message
-    add_attributes :reg_key, :reg_password, :tc_profile_url, :launch_presentation_return_url
+
+    required_params :reg_key, :reg_password, :tc_profile_url, :launch_presentation_return_url
 
     MESSAGE_TYPE = 'ToolProxyRegistrationRequest'
 

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

@@ -1,5 +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/tool_consumer_profile.rb

@@ -4,6 +4,9 @@ module IMS::LTI::Models
     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
     add_attribute :id, json_key:'@id'
     add_attribute :type, json_key:'@type'

data/lib/ims/lti/services.rb

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

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

@@ -17,7 +17,7 @@ module IMS::LTI::Services
     end
 
     def register_tool_proxy(tool_proxy)
-      service = tool_consumer_profile.services_offered.find{|s| s.formats.include?('application/vnd.ims.lti.v2.toolproxy+json') && s.actions.include?('POST')}
+      service = tool_consumer_profile.services_offered.find { |s| s.formats.include?('application/vnd.ims.lti.v2.toolproxy+json') && s.actions.include?('POST') }
 
       conn = Faraday.new do |conn|
         conn.request :oauth, {:consumer_key => @registration_request.reg_key, :consumer_secret => @registration_request.reg_password}
@@ -35,5 +35,32 @@ module IMS::LTI::Services
       end
     end
 
+
+    def remove_invalid_capabilities!(message_handler)
+      {
+        invalid_capabilities: remove_capabilites!(message_handler),
+        invalid_parameters: remove_params!(message_handler)
+      }
+    end
+
+    private
+
+    def remove_params!(message_handler)
+      orig_parameters = message_handler.parameter || []
+      parameters = orig_parameters.select {|p| p.fixed? || tool_consumer_profile.capability_offered.include?(p.variable)}
+      message_handler.parameter = parameters
+      orig_parameters - parameters
+    end
+
+    def remove_capabilites!(message_handler)
+      orig_capabilities = message_handler.enabled_capability || []
+      capabilites = orig_capabilities & tool_consumer_profile.capability_offered
+      capabilites.reject! { |cap| IMS::LTI::Models::ToolConsumerProfile::MESSAGING_CAPABILITIES.include? cap }
+      message_handler.enabled_capability = capabilites
+      orig_capabilities - capabilites
+    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.4
+  version: 2.0.0.beta.5
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_oauth
@@ -137,7 +137,6 @@ files:
 - lib/ims/lti/models/tool_proxy.rb
 - lib/ims/lti/models/vendor.rb
 - lib/ims/lti/services.rb
-- lib/ims/lti/services/message_service.rb
 - lib/ims/lti/services/tool_proxy_registration_service.rb
 - lib/ims/lti/version.rb
 homepage: http://github.com/instructure/ims-lti

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

@@ -1,37 +0,0 @@
-module IMS::LTI::Services
-  class MessageService
-
-    def initialize(key, secret)
-      @credentials = {consumer_key: key, consumer_secret: secret}
-    end
-
-    def signed_params(url, message)
-      params = message.post_params
-      header = SimpleOAuth::Header.new(:post, url, params, @credentials)
-      params = header.signed_attributes.merge(params)
-      params
-    end
-
-    def valid_signature?(url, params)
-      options, parsed_params = parse_params(params)
-      signature = parsed_params.delete(:oauth_signature)
-      header = SimpleOAuth::Header.new(:post, url, parsed_params, options.merge(@credentials))
-      header.valid?(signature: signature)
-    end
-
-    private
-
-    def parse_params(params)
-      params.inject([{}, {}]) do |array, (k, v)|
-        attr = k.to_s.sub('oauth_', '').to_sym
-        if SimpleOAuth::Header::ATTRIBUTE_KEYS.include?(attr)
-          array[0][attr] = v
-        else
-          array[1][k] = v
-        end
-        array
-      end
-    end
-
-  end
-end