ims-lti 1.2.6 → 2.0.0.beta.1

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

@@ -0,0 +1,29 @@
+module IMS::LTI
+  module Models
+    require_relative 'models/lti_model'
+    require_relative 'models/contact'
+    require_relative 'models/localized_name'
+    require_relative 'models/localized_text'
+    require_relative 'models/product_family'
+    require_relative 'models/product_info'
+    require_relative 'models/product_instance'
+    require_relative 'models/rest_service'
+    require_relative 'models/service_owner'
+    require_relative 'models/service_provider'
+    require_relative 'models/tool_consumer_profile'
+    require_relative 'models/vendor'
+    require_relative 'models/messages'
+    require_relative 'models/tool_proxy'
+    require_relative 'models/tool_profile'
+    require_relative 'models/resource_handler'
+    require_relative 'models/resource_type'
+    require_relative 'models/message_handler'
+    require_relative 'models/parameter'
+    require_relative 'models/icon_info'
+    require_relative 'models/icon_endpoint'
+    require_relative 'models/security_contract'
+    require_relative 'models/rest_service_profile'
+    require_relative 'models/base_url_choice'
+    require_relative 'models/base_url_selector'
+  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/services.rb

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

data/lib/ims/lti/version.rb

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

data/lib/ims/lti.rb

@@ -1,69 +1,11 @@
-require 'oauth'
-require 'builder'
-require "rexml/document"
-require 'cgi'
+require 'json'
 require 'securerandom'
+require 'oauth'
 
-module IMS # :nodoc:
-
-  # :main:IMS::LTI
-  # LTI is a standard defined by IMS for creating eduction Tool Consumers/Providers.
-  # LTI documentation: http://www.imsglobal.org/lti/index.html
-  #
-  # When creating these tools you will work primarily with the ToolProvider and
-  # ToolConsumer classes.
-  #
-  # For validating OAuth request be sure to require the necessary proxy request
-  # object. See IMS::LTI::RequestValidator#valid_request? for more documentation.
-  #
-  # == Installation
-  # This is packaged as the `ims-lti` rubygem, so you can just add the dependency to
-  # your Gemfile or install the gem on your system:
-  #
-  #    gem install ims-lti
-  #
-  # To require the library in your project:
-  #
-  #    require 'ims/lti'
+module IMS
   module LTI
-
-    # The versions of LTI this library supports
-    VERSIONS = %w{1.0 1.1}
-
-    class InvalidLTIConfigError < StandardError
-    end
-
-    class XMLParseError < StandardError
-    end
-
-    # POST a signed oauth request with the given key/secret/data
-    def self.post_service_request(key, secret, url, content_type, body)
-      raise IMS::LTI::InvalidLTIConfigError, "" unless key && secret
-
-      consumer = OAuth::Consumer.new(key, secret)
-      token = OAuth::AccessToken.new(consumer)
-      token.post(
-              url,
-              body,
-              'Content-Type' => content_type
-      )
-    end
-
-    # Generates a unique identifier
-    def self.generate_identifier
-      SecureRandom.uuid
-    end
+    require_relative 'lti/models'
+    require_relative 'lti/converters'
+    require_relative 'lti/services'
   end
 end
-
-require 'ims/lti/extensions'
-require 'ims/lti/launch_params'
-require 'ims/lti/request_validator'
-require 'ims/lti/tool_base'
-require 'ims/lti/deprecated_role_checks'
-require 'ims/lti/role_checks'
-require 'ims/lti/tool_provider'
-require 'ims/lti/tool_consumer'
-require 'ims/lti/outcome_request'
-require 'ims/lti/outcome_response'
-require 'ims/lti/tool_config'

data/lib/ims.rb

@@ -1 +1,3 @@
-require 'ims/lti'
+module IMS
+  require 'ims/lti'
+end

metadata

@@ -1,101 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 2.0.0.beta.1
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-26 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.6
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers

data/Changelog

@@ -1,54 +0,0 @@
-2020-02-03 Version 1.2.4
-    * Add support for submittedAt date
-
-2017-03-08 Version 1.2.0
-    * Don't downcase roles
-
-2016-10-05 Version 1.1.13
-    * Fix Oauth::Unauthorized initialization bug
-    * Relax oauth dependency
-
-2016-06-16 Version 1.1.12
-    * Add support for detecting observer role
-
-2015-02-20 Version 1.1.8
-    * Replace usage of the 'uuid' gem with SecureRandom
-    * Update the outcome extension doc example
-
-2015-01-09 Version 1.1.7
-    * Add support for new outcome extension resultTotalScore
-
-2013-04-24 Version 1.1.3
-
-    * Corrected lti_version launch parameter
-
-2012-09-05 Version 1.1.2
-
-    * Added better role checking and convenience methods
-
-2012-09-04 Version 1.1.1
-
-    * Added cdata value for outcome data extension
-
-2012-08-14 Version 1.1.0
-
-    * Added framework for LTI extensions
-    * Added LTI outcome data extension
-    * Fix tests reliant on random ordering
-    * Add rails 3 note to readme install docs
-    * Create Changelog
-
-
-2012-03-14 Version 1.0.2
-
-    * Refactor OAuth validation into its own module
-
-
-2012-03-13 Version 1.0.1
-
-    * Add gem dependencies to gemspec
-
-
-2012-03-11 Version 1.0.0
-
-    * Publish fully functional and operational IMS LTI library

data/LICENSE

@@ -1,18 +0,0 @@
-Copyright (c) 2012 Instructure
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ims/lti/deprecated_role_checks.rb

@@ -1,52 +0,0 @@
-# These are here for backwards-compatibility
-# But they are deprecated and the new ones in
-# role_checks.rb should be used
-module IMS::LTI
-module DeprecatedRoleChecks
-  # Check whether the Launch Parameters have a role
-    def has_role?(role)
-      role = role.downcase
-      @roles && @roles.any?{|r| r.downcase.index(role)}
-    end
-
-    # Convenience method for checking if the user has 'learner' or 'student' role
-    def student?
-      has_role?('learner') || has_role?('student')
-    end
-
-    # Convenience method for checking if the user has 'instructor' or 'faculty' or 'staff' role
-    def instructor?
-      has_role?('instructor') || has_role?('faculty') || has_role?('staff')
-    end
-
-    # Convenience method for checking if the user has 'contentdeveloper' role
-    def content_developer?
-      has_role?('ContentDeveloper')
-    end
-
-    # Convenience method for checking if the user has 'Member' role
-    def member?
-      has_role?('Member')
-    end
-
-    # Convenience method for checking if the user has 'Manager' role
-    def manager?
-      has_role?('Manager')
-    end
-
-    # Convenience method for checking if the user has 'Mentor' role
-    def mentor?
-      has_role?('Mentor')
-    end
-
-    # Convenience method for checking if the user has 'administrator' role
-    def admin?
-      has_role?('administrator')
-    end
-
-    # Convenience method for checking if the user has 'TeachingAssistant' role
-    def ta?
-      has_role?('TeachingAssistant')
-    end
-end
-end

data/lib/ims/lti/extensions/canvas.rb

@@ -1,122 +0,0 @@
-module IMS::LTI
-  module Extensions
-    # Module that adds Canvas specific LTI extensions
-    #
-    # It adds convenience methods for generating common canvas use case LTI configurations
-    #
-    # == Usage
-    # To generate an XML configuration:
-    #
-    #    # Create a config object and set some options
-    #    tc = IMS::LTI::ToolConfig.new(:title => "Example Sinatra Tool Provider", :launch_url => url)
-    #    tc.description = "This example LTI Tool Provider supports LIS Outcome pass-back."
-    #
-    #    # Extend the Canvas Tool config and add canvas related extensions
-    #    tc.extend IMS::LTI::Extensions::Canvas::ToolConfig
-    #    tc.homework_submission! 'http://someplace.com/homework', 'Find Homework'
-    #
-    #    # generate the XML
-    #    tc.to_xml
-    #
-    # Or to create a config object from an XML String:
-    #
-    #    tc = IMS::LTI::ToolConfig.create_from_xml(xml)
-
-    module Canvas
-      module ToolConfig
-        PLATFORM = 'canvas.instructure.com'
-
-        # Canvas extension defaults
-        # These properties will cascade down to any options that are configured
-        def set_canvas_ext_param(key, value)
-          set_ext_param(PLATFORM, key, value)
-        end
-
-        def get_canvas_param(param_key)
-          get_ext_param PLATFORM, param_key
-        end
-
-        def canvas_privacy_public!()
-          set_canvas_ext_param(:privacy_level, 'public')
-        end
-
-        def canvas_privacy_name_only!()
-          set_canvas_ext_param(:privacy_level, 'name_only')
-        end
-
-        def canvas_privacy_anonymous!()
-          set_canvas_ext_param(:privacy_level, 'anonymous')
-        end
-
-        def canvas_domain!(domain)
-          set_canvas_ext_param(:domain, domain)
-        end
-
-        def canvas_text!(text)
-          set_canvas_ext_param(:text, text)
-        end
-
-        def canvas_icon_url!(icon_url)
-          set_canvas_ext_param(:icon_url, icon_url)
-        end
-
-        def canvas_tool_id!(tool_id)
-          set_canvas_ext_param(:tool_id, tool_id)
-        end
-
-        def canvas_selector_dimensions!(width, height)
-          set_canvas_ext_param(:selection_width, width)
-          set_canvas_ext_param(:selection_height, height)
-        end
-
-        # Canvas options
-        # These configure canvas to expose the tool in various locations.  Any properties that are set
-        # at this level will override the defaults for this launch of the tool
-
-        # Enables homework submissions via the tool
-        # Valid properties are url, text, selection_width, selection_height, enabled
-        def canvas_homework_submission!(params = {})
-          set_canvas_ext_param(:homework_submission, params)
-        end
-
-        # Adds the tool to canvas' rich text editor
-        # Valid properties are url, icon_url, text, selection_width, selection_height, enabled
-        def canvas_editor_button!(params = {})
-          set_canvas_ext_param(:editor_button, params)
-        end
-
-        # Adds the tool to canvas' resource selector
-        # Valid properties are url, text, selection_width, selection_height, enabled
-        def canvas_resource_selection!(params = {})
-          set_canvas_ext_param(:resource_selection, params)
-        end
-
-        # Adds the tool to account level navigation in canvas
-        # Valid properties are url, text, enabled
-        def canvas_account_navigation!(params = {})
-          set_canvas_ext_param(:account_navigation, params)
-        end
-
-        # Adds the tool to course level navigation in canvas
-        # Valid properties are url, text, visibility, default, enabled
-        # Visibility describes who will see the navigation element.  Possible values are "admins", "members", and nil
-        # Default determines if it is on or off by default.  Possible values are "admins", "members", and nil
-        def canvas_course_navigation!(params = {})
-          set_canvas_ext_param(:course_navigation, params)
-        end
-
-        # Adds the tool to user level navigation in canvas
-        # Valid properties are url, text, enabled
-        def canvas_user_navigation!(params = {})
-          set_canvas_ext_param(:user_navigation, params)
-        end
-
-        # Adds canvas environment configurations options
-        # Valid properties are launch_url, domain, test_launch_url, test_domain, beta_launch_url, beta_domain
-        def canvas_environments!(params = {})
-          set_canvas_ext_param(:environments, params)
-        end
-      end
-    end
-  end
-end