ims-lti 1.2.4 → 2.0.0.beta.1

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

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

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

@@ -0,0 +1,6 @@
+module IMS::LTI::Models
+  module Messages
+    require_relative 'messages/message'
+    require_relative 'messages/registration_request'
+  end
+end

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

@@ -0,0 +1,8 @@
+module IMS::LTI::Models::Messages
+  class BasicLTILaunchRequest < IMS::LTI::Models::LTIModel
+
+    add_attributes :context_id, :context_type, :launch_presentation_return_url, :resource_link_id, :role_scope_mentor,
+                   :tool_consumer_instance_guid, :user_image
+
+  end
+end

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

@@ -0,0 +1,43 @@
+module IMS::LTI::Models::Messages
+  class Message < IMS::LTI::Models::LTIModel
+    LAUNCH_TARGET_IFRAME = 'iframe'
+    LAUNCH_TARGET_WINDOW = 'window'
+
+    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
+
+    def initialize(attrs = {})
+      super(attrs)
+      @custom_params = {}
+      @ext_params = {}
+    end
+
+    def post_params
+      get_custom_params.merge(get_ext_params).merge(attributes)
+    end
+
+    def get_ext_params
+      params = {}
+      @ext_params.each { |k, v| params["ext_#{k}"] = v }
+      params
+    end
+
+    def get_custom_params
+      params = {}
+      @custom_params.each { |k, v| params["custom_#{k}"] = v }
+      params
+    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]
+      else
+        super
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,17 @@
+module IMS::LTI::Models::Messages
+  class RegistrationRequest < Message
+    add_attributes :reg_key, :reg_password, :tc_profile_url, :launch_presentation_return_url
+
+    REGISTRATION_REQUEST_MESSAGE_TYPE = 'ToolProxyRegistrationRequest'
+
+    def initialize(attributes = {})
+      super(attributes)
+      self.lti_message_type = REGISTRATION_REQUEST_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/parameter.rb

@@ -0,0 +1,5 @@
+module IMS::LTI::Models
+  class Parameter < LTIModel
+    add_attributes :name, :variable, :fixed
+  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,19 @@
+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
+
+
+  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 :support, relation:'IMS::LTI::Models::ServiceProvider'
+    add_attribute :service_provider, relation:'IMS::LTI::Models::Contact'
+
+  end
+end

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

@@ -0,0 +1,18 @@
+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
+
+  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,14 @@
+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
+      @type = TYPE
+    end
+
+  end
+end

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

@@ -0,0 +1,7 @@
+module IMS::LTI::Models
+  class RestServiceProfile < LTIModel
+    add_attributes :service, :action
+    add_attribute :type, json_key: '@type'
+
+  end
+end

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

@@ -0,0 +1,9 @@
+module IMS::LTI::Models
+  class SecurityContract < LTIModel
+
+    add_attribute :shared_secret
+    add_attribute :tool_service, relation: 'IMS::LTI::Models::RestServiceProfile'
+    add_attribute :end_user_service, relation: 'IMS::LTI::Models::RestServiceProfile'
+
+  end
+end

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

@@ -0,0 +1,8 @@
+module IMS::LTI::Models
+  class ServiceOwner < LTIModel
+    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'
+
+  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,20 @@
+module IMS::LTI::Models
+  class ToolConsumerProfile < LTIModel
+
+    CONTEXT = "http://purl.imsglobal.org/ctx/lti/v2/ToolConsumerProfile"
+    TYPE = "ToolConsumerProfile"
+
+    add_attributes :lti_version, :guid, :capability_offered
+    add_attribute :id, json_key:'@id'
+    add_attribute :type, json_key:'@type'
+    add_attribute :context, json_key:'@context'
+    add_attribute :product_instance, relation:'IMS::LTI::Models::ProductInstance'
+    add_attribute :service_offered, relation: 'IMS::LTI::Models::RestService'
+
+    def initialize
+      @context = [CONTEXT]
+      @type = TYPE
+    end
+
+  end
+end

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

@@ -0,0 +1,22 @@
+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'
+
+
+    def base_message_url
+      if base_url_choice
+        choice = base_url_choice.find { |choice| choice.default_message_url != '' }
+        choice.default_message_url
+      else
+        ''
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,11 @@
+module IMS::LTI::Models
+  class ToolProxy < LTIModel
+    add_attributes :lti_version, :tool_proxy_guid, :custom, :custom_url, :enabled_capability
+    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'
+  end
+end

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

@@ -0,0 +1,28 @@
+module IMS::LTI::Models
+  class Vendor < LTIModel
+
+    add_attributes :code, :website
+    add_attribute :id, json_key:'@id'
+    add_attribute :contact, relation:'IMS::LTI::Models::Contact'
+    add_attribute :vendor_name, relation:'IMS::LTI::Models::LocalizedName'
+    add_attribute :description, relation:'IMS::LTI::Models::LocalizedText'
+    add_attribute :timestamp, json_converter: 'IMS::LTI::Converters::TimeJSONConverter'
+
+    def create_vendor_name(name, key = 'vendor.name')
+      @vendor_name = LocalizedName.new(name, key)
+    end
+
+    def create_description(name, key = 'vendor.description')
+      @description = LocalizedText.new(name, key)
+    end
+
+    def default_name
+      vendor_name && vendor_name.default_value
+    end
+
+    def default_description
+      description && description.default_value
+    end
+
+  end
+end

data/lib/ims/lti/services.rb

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

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

@@ -0,0 +1,40 @@
+module IMS::LTI::Services
+  class MessageService
+
+    def initialize(key, secret)
+      @key = key
+      @secret = secret
+    end
+
+    def signed_request(url, message)
+      uri = URI.parse(url)
+      oauth_consumer = OAuth::Consumer.new(@key, @secret, {
+          :site => "#{uri.scheme}://#{uri.host}",
+          :scheme => :body
+      })
+      request = oauth_consumer.create_signed_request(:post, uri.request_uri, nil, {}, message.post_params)
+
+      request
+    end
+
+    def signed_params(url, message)
+      signed_request = signed_request(url, message)
+
+      params = {}
+      CGI.parse(signed_request.body).each do |key, value|
+        params[key] = value.first
+      end
+      params
+    end
+
+    def valid_signature?(url, params)
+      request = {
+          'method' => 'POST',
+          'uri' => url,
+          'parameters' => params
+      }
+
+      OAuth::Signature.build(request, :consumer_secret => @secret).verify()
+    end
+  end
+end

data/lib/ims/lti/version.rb

@@ -0,0 +1,5 @@
+module IMS
+  module LTI
+    VERSION = "2.0.0.beta.1"
+  end
+end

metadata

@@ -1,101 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 2.0.0.beta.1
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: json-ld
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 1.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 1.1.4
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.5
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.4.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.5
-    - - "<"
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: 
 email: 
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
+extra_rdoc_files: []
 files:
-- Changelog
-- LICENSE
+- Changelog.txt
+- LICENSE.txt
 - 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
-- lib/ims/lti/extensions/outcome_data.rb
-- lib/ims/lti/launch_params.rb
-- lib/ims/lti/outcome_request.rb
-- lib/ims/lti/outcome_response.rb
-- lib/ims/lti/request_validator.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
-- lib/ims/lti/tool_provider.rb
+- lib/ims/lti/converters.rb
+- lib/ims/lti/converters/time_json_converter.rb
+- lib/ims/lti/models.rb
+- 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/icon_endpoint.rb
+- lib/ims/lti/models/icon_info.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/message.rb
+- lib/ims/lti/models/messages/registration_request.rb
+- lib/ims/lti/models/parameter.rb
+- lib/ims/lti/models/product_family.rb
+- lib/ims/lti/models/product_info.rb
+- lib/ims/lti/models/product_instance.rb
+- lib/ims/lti/models/resource_handler.rb
+- lib/ims/lti/models/resource_type.rb
+- lib/ims/lti/models/rest_service.rb
+- lib/ims/lti/models/rest_service_profile.rb
+- lib/ims/lti/models/security_contract.rb
+- lib/ims/lti/models/service_owner.rb
+- lib/ims/lti/models/service_provider.rb
+- lib/ims/lti/models/tool_consumer_profile.rb
+- lib/ims/lti/models/tool_profile.rb
+- 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/version.rb
 homepage: http://github.com/instructure/ims-lti
 licenses:
 - MIT
@@ -111,11 +126,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers