ims-lti 2.0.0.beta.20 → 2.0.0.beta.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bcf94db095c67ba98ec3812f19f8c8c31a8a86d
-  data.tar.gz: 98f29e780c98723f7ad66c87bb242de83e3f41e4
+  metadata.gz: f9efa243962781962b68c7d0fff8fd999ced4968
+  data.tar.gz: 5c219ef0195c7dcb97540f97500bf176a2307445
 SHA512:
-  metadata.gz: bf3b2ec04f3537773b4a3c4c4591a416920b35017fe2485cf2ccafd1641c23a4370a092024203ff0b010e3334a67d06fb7dc04bfacc5b02bb6e3be639ec5eb2a
-  data.tar.gz: 06912f014181ce1d03277864abc6c22440c84ff9f521b64da5a49ce8fb9864352a30223af7186d7d3d6f073bfc9036ccdbd4556d9cd0c3b3b9fa25537f852195
+  metadata.gz: c8137fa5cd4f7170773094e8b533c79701a97ef58555a84f9b033c5998c7a3d735c5bd99e31b3d052420641888b322af9ff6a245f85901f08a5a07319187407f
+  data.tar.gz: a01f74beb1a0b3db1c588b9f2bf321354d40860289ea06cc59c7b7f2236dac98f1b20f97dc4a0735f962d7f4f86e4fc6bee192142700d477e5d14ea656778383

data/README.md

@@ -1,5 +1,7 @@
 # IMS LTI
 
+[![Build Status](https://travis-ci.org/instructure/ims-lti.svg?branch=2.0.x)](https://travis-ci.org/instructure/ims-lti)
+
 #Version 2.x is currently BETA
 
 LTI ruby implementation

data/lib/ims/lti/models.rb

@@ -27,5 +27,9 @@ module IMS::LTI
     require_relative 'models/base_url_selector'
     require_relative 'models/tool_setting'
     require_relative 'models/tool_setting_container'
+    require_relative 'models/content_items'
+    require_relative 'models/content_item_placement'
+    require_relative 'models/content_item_container'
+    require_relative 'models/image'
   end
 end

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

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

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

@@ -0,0 +1,18 @@
+module IMS::LTI::Models
+  class ContentItemPlacement < LTIModel
+
+    DOCUMENT_TARGETS = {
+      embed: 'http://purl.imsglobal.org/vocab/lti/v2/lti#embed',
+      frame: 'http://purl.imsglobal.org/vocab/lti/v2/lti#frame',
+      iframe: 'http://purl.imsglobal.org/vocab/lti/v2/lti#iframe',
+      none: 'http://purl.imsglobal.org/vocab/lti/v2/lti#none',
+      overlay: 'http://purl.imsglobal.org/vocab/lti/v2/lti#overlay',
+      popup: 'http://purl.imsglobal.org/vocab/lti/v2/lti#popup',
+      window: 'http://purl.imsglobal.org/vocab/lti/v2/lti#window'
+    }
+
+    add_attributes :display_height, :display_width, :window_target
+    add_attribute :presentation_document_target
+
+  end
+end

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

@@ -0,0 +1,7 @@
+module IMS::LTI::Models
+  module ContentItems
+    require_relative 'content_items/content_item'
+    require_relative 'content_items/file_item'
+    require_relative 'content_items/lti_link'
+  end
+end

data/lib/ims/lti/models/content_items/content_item.rb

@@ -0,0 +1,25 @@
+module IMS::LTI::Models::ContentItems
+  class ContentItem < IMS::LTI::Models::LTIModel
+
+    add_attributes :media_type, :text, :title, :url
+    add_attribute :type, json_key: '@type'
+    add_attribute :id, json_key: '@id'
+    add_attribute :icon, relation: 'IMS::LTI::Models::Image'
+    add_attribute :placement_advice, relation: 'IMS::LTI::Models::ContentItemPlacement'
+    add_attribute :thumbnail, relation: 'IMS::LTI::Models::Image'
+
+
+    def self.from_json(json)
+      data = json.is_a?(String) ? JSON.parse(json) : json
+      case data['@type']
+        when 'ContentItem'
+          ContentItem.new.from_json(data)
+        when 'FileItem'
+          FileItem.new.from_json(data)
+        when 'LtiLink'
+          LtiLink.new.from_json(data)
+      end
+    end
+
+  end
+end

data/lib/ims/lti/models/content_items/file_item.rb

@@ -0,0 +1,7 @@
+module IMS::LTI::Models::ContentItems
+  class FileItem < ContentItem
+
+    add_attributes :copyAdvice, :expires_at
+
+  end
+end

data/lib/ims/lti/models/content_items/lti_link.rb

@@ -0,0 +1,7 @@
+module IMS::LTI::Models::ContentItems
+  class LtiLink < ContentItem
+
+    add_attributes :custom
+
+  end
+end

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

@@ -0,0 +1,7 @@
+module IMS::LTI::Models
+  class Image < LTIModel
+    add_attribute :id, json_key: '@id'
+    add_attributes :height, :width
+
+  end
+end

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

@@ -48,7 +48,7 @@ module IMS::LTI::Models
     def attributes=(attrs)
       attrs.each do |k, v|
         if self.class.attributes.include?(k.to_sym)
-          instance_variable_set("@#{k.to_s}", v)
+          send(("#{k}=").to_sym, v)
         elsif k.to_s =~ /^ext_/
           @ext_attributes[k.to_sym] = v
         else
@@ -62,7 +62,11 @@ module IMS::LTI::Models
       serialization_attrs_for(:json_key).each { |attr| json_hash.delete(attr.to_s) }
       serialization_attrs_for(:relation).each do |attr|
         val = attributes[attr.to_s]
-        json_hash[json_key(attr)] = val.as_json if val
+        if val && val.is_a?(Array)
+          json_hash[json_key(attr)] = val.map {|v| v.as_json }
+        elsif val
+          json_hash[json_key(attr)] = val.as_json
+        end
       end
       json_hash = @ext_attributes.merge(json_hash)
       json_hash.merge! to_json_conversions
@@ -120,7 +124,8 @@ module IMS::LTI::Models
       result = {}
       if attrs = serialization_attrs_for(:json_key)
         conversion_attrs = serialization_attrs_for(:json_converter)
-        attrs.each { |attr| result[json_key(attr)] = attributes[attr.to_s] unless conversion_attrs.include?(attr) || attributes[attr.to_s].nil? }
+        relation_attrs = serialization_attrs_for(:relation)
+        attrs.each { |attr| result[json_key(attr)] = attributes[attr.to_s] unless (conversion_attrs | relation_attrs).include?(attr) || attributes[attr.to_s].nil? }
       end
       result
     end
@@ -171,8 +176,12 @@ module IMS::LTI::Models
       @attributes = attribs
     end
 
-    def self.serialization_options
-      @serialization_options ||= {}
+    def self.serialization_options()
+      if name == "IMS::LTI::Models::LTIModel"
+        @serialization_options || {}
+      else
+        superclass.send(:serialization_options).merge(@serialization_options || {})
+      end
     end
 
     def serialization_options

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

@@ -1,7 +1,10 @@
 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'
   end
 end

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

@@ -1,5 +1,5 @@
 module IMS::LTI::Models::Messages
-  class BasicLTILaunchRequest < Message
+  class BasicLTILaunchRequest < RequestMessage
 
     add_required_params :resource_link_id
     add_recommended_params :context_id, :launch_presentation_return_url, :tool_consumer_instance_guid

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

@@ -0,0 +1,25 @@
+module IMS::LTI::Models::Messages
+  class ContentItemSelection < Message
+    add_optional_params :content_items, :data, :lti_msg, :lti_log, :lti_errormsg, :lti_errorlog
+
+    def content_items=(ci)
+      if ci.instance_of? String
+        container = IMS::LTI::Models::ContentItemContainer.from_json ci
+        @content_items = container.graph
+      else
+        @content_items = ci
+      end
+    end
+
+    def parameters
+      if content_items
+        params = self.class.send("parameters")
+        params.delete('content_items')
+        collect_attributes(params).merge({'content_items' => IMS::LTI::Models::ContentItemContainer.new(graph: content_items).to_json})
+      else
+        super
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,26 @@
+module IMS::LTI::Models::Messages
+  class ContentItemSelectionRequest < RequestMessage
+
+    add_required_params :accept_media_types, :accept_presentation_document_targets, :content_item_return_url
+    add_recommended_params :context_id,  :tool_consumer_instance_guid
+    add_optional_params :context_type, :role_scope_mentor, :user_image, :accept_unsigned, :accept_multiple,
+                        :accept_copy_advice, :text, :title, :data
+    add_deprecated_params :context_title, :context_label,
+                          :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,
+                          :tool_consumer_info_version
+
+    MESSAGE_TYPE = 'ContentItemSelectionRequest'
+
+    def initialize(attrs = {})
+      super(attrs)
+      self.lti_message_type = MESSAGE_TYPE
+    end
+
+
+  end
+end

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

@@ -1,5 +1,6 @@
 module IMS::LTI::Models::Messages
   class Message
+
     class << self
 
       def required_params
@@ -48,7 +49,11 @@ module IMS::LTI::Models::Messages
       end
 
       def supers_params(instance_variable)
-        superclass == Object ? [] : superclass.instance_variable_get(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
@@ -66,8 +71,6 @@ module IMS::LTI::Models::Messages
     attr_reader :unknown_params, :custom_params, :ext_params
 
     add_required_params :lti_message_type, :lti_version
-    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 self.generate(params)
       case params['lti_message_type']
@@ -75,6 +78,8 @@ module IMS::LTI::Models::Messages
           BasicLTILaunchRequest.new(params)
         when RegistrationRequest::MESSAGE_TYPE
           RegistrationRequest.new(params)
+        when ContentItemSelectionRequest::MESSAGE_TYPE
+          ContentItemSelectionRequest.new(params)
         else
           self.new(params)
       end
@@ -93,7 +98,8 @@ module IMS::LTI::Models::Messages
         elsif str_key.start_with?(CUSTOM_PREFIX)
           @custom_params[str_key] = v
         elsif !v.nil? && self.respond_to?(k.to_sym)
-          instance_variable_set("@#{k}", v)
+          send(("#{k}=").to_sym, v)
+
         else
           warn "Unknown parameter #{k}"
           @unknown_params[str_key] = v
@@ -120,6 +126,7 @@ module IMS::LTI::Models::Messages
     end
 
     def valid_signature?(secret)
+      params = collect_attributes(OAUTH_KEYS)
       params = OAUTH_KEYS.inject({}) do |hash, k|
         value = instance_variable_get("@#{k}")
         hash[k] = value if value
@@ -152,6 +159,10 @@ module IMS::LTI::Models::Messages
       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
@@ -178,8 +189,8 @@ module IMS::LTI::Models::Messages
 
     def collect_attributes(attributes)
       attributes.inject({}) do |h, param|
-        value = instance_variable_get("@#{param.to_s}")
-        h[param.to_s] = value unless value.nil?
+        value = instance_variable_get("@#{param}")
+        h[param.to_s] = value if value
         h
       end
     end

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

@@ -1,5 +1,5 @@
 module IMS::LTI::Models::Messages
-  class RegistrationRequest < Message
+  class RegistrationRequest < RequestMessage
 
     add_required_params :reg_key, :reg_password, :tc_profile_url, :launch_presentation_return_url
 

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/tool_setting_container.rb

@@ -6,8 +6,8 @@ module IMS::LTI::Models
     TOOL_SETTING_CONTAINER_CONTEXT = 'http://purl.imsglobal.org/ctx/lti/v2/ToolSettings'
 
     def initialize(opts = {})
-      self.context = TOOL_SETTING_CONTAINER_CONTEXT
       super(opts)
+      self.context = TOOL_SETTING_CONTAINER_CONTEXT
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.20
+  version: 2.0.0.beta.21
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_oauth
@@ -72,42 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 description: 
 email: 
 executables: []
@@ -127,16 +113,26 @@ files:
 - lib/ims/lti/models/base_url_choice.rb
 - lib/ims/lti/models/base_url_selector.rb
 - lib/ims/lti/models/contact.rb
+- lib/ims/lti/models/content_item_container.rb
+- lib/ims/lti/models/content_item_placement.rb
+- lib/ims/lti/models/content_items.rb
+- lib/ims/lti/models/content_items/content_item.rb
+- lib/ims/lti/models/content_items/file_item.rb
+- lib/ims/lti/models/content_items/lti_link.rb
 - lib/ims/lti/models/icon_endpoint.rb
 - lib/ims/lti/models/icon_info.rb
+- lib/ims/lti/models/image.rb
 - lib/ims/lti/models/localized_name.rb
 - lib/ims/lti/models/localized_text.rb
 - lib/ims/lti/models/lti_model.rb
 - lib/ims/lti/models/message_handler.rb
 - lib/ims/lti/models/messages.rb
 - lib/ims/lti/models/messages/basic_lti_launch_request.rb
+- lib/ims/lti/models/messages/content_item_selection.rb
+- lib/ims/lti/models/messages/content_item_selection_request.rb
 - lib/ims/lti/models/messages/message.rb
 - lib/ims/lti/models/messages/registration_request.rb
+- lib/ims/lti/models/messages/request_message.rb
 - lib/ims/lti/models/parameter.rb
 - lib/ims/lti/models/product_family.rb
 - lib/ims/lti/models/product_info.rb