qalam_ims_lti 0.0.2

data/lib/ims/lti/tool_provider.rb

@@ -0,0 +1,143 @@
+module IMS::LTI
+
+  # Class for implementing an LTI Tool Provider
+  #
+  #     # Initialize TP object with OAuth creds and post parameters
+  #     provider = IMS::LTI::ToolProvider.new(consumer_key, consumer_secret, params)
+  #
+  #     # Verify OAuth signature by passing the request object
+  #     if provider.valid_request?(request)
+  #       # success
+  #     else
+  #       # handle invalid OAuth
+  #     end
+  #
+  #     if provider.outcome_service?
+  #       # ready for grade write-back
+  #     else
+  #       # normal tool launch without grade write-back
+  #     end
+  #
+  # If the tool was launch as an outcome service you can POST a score to the TC.
+  # The POST calls all return an OutcomeResponse object which can be used to
+  # handle the response appropriately.
+  #
+  #     # post the score to the TC, score should be a float >= 0.0 and <= 1.0
+  #     # this returns an OutcomeResponse object
+  #     response = provider.post_replace_result!(score)
+  #     if response.success?
+  #       # grade write worked
+  #     elsif response.processing?
+  #     elsif response.unsupported?
+  #     else
+  #       # failed
+  #     end
+
+  class ToolProvider < ToolBase
+    # List of outcome requests made through this instance
+
+    include DeprecatedRoleChecks
+    include RoleChecks
+    attr_accessor :outcome_requests
+    # Message to be sent back to the ToolConsumer when the user returns
+    attr_accessor :lti_errormsg, :lti_errorlog, :lti_msg, :lti_log
+
+    # Create a new ToolProvider
+    #
+    # @param consumer_key [String] The OAuth consumer key
+    # @param consumer_secret [String] The OAuth consumer secret
+    # @param params [Hash] Set the launch parameters as described in LaunchParams
+    def initialize(consumer_key, consumer_secret, params={})
+      super(consumer_key, consumer_secret, params)
+      @outcome_requests = []
+    end
+
+    # Check if the request was an LTI Launch Request
+    def launch_request?
+      lti_message_type == 'basic-lti-launch-request'
+    end
+
+    # Check if the Tool Launch expects an Outcome Result
+    def outcome_service?
+      !!(lis_outcome_service_url && lis_result_sourcedid)
+    end
+
+    # Return the full, given, or family name if set
+    def username(default=nil)
+      lis_person_name_given || lis_person_name_family || lis_person_name_full || default
+    end
+
+    # POSTs the given score to the Tool Consumer with a replaceResult
+    #
+    # Creates a new OutcomeRequest object and stores it in @outcome_requests
+    #
+    # @return [OutcomeResponse] the response from the Tool Consumer
+    def post_replace_result!(score)
+      new_request.post_replace_result!(score)
+    end
+
+    # POSTs a delete request to the Tool Consumer
+    #
+    # Creates a new OutcomeRequest object and stores it in @outcome_requests
+    #
+    # @return [OutcomeResponse] the response from the Tool Consumer
+    def post_delete_result!
+      new_request.post_delete_result!
+    end
+
+    # POSTs the given score to the Tool Consumer with a replaceResult, the
+    # returned OutcomeResponse will have the score
+    #
+    # Creates a new OutcomeRequest object and stores it in @outcome_requests
+    #
+    # @return [OutcomeResponse] the response from the Tool Consumer
+    def post_read_result!
+      new_request.post_read_result!
+    end
+
+    # Returns the most recent OutcomeRequest
+    def last_outcome_request
+      @outcome_requests.last
+    end
+
+    # Convenience method for whether the last OutcomeRequest was successful
+    def last_outcome_success?
+      last_outcome_request && last_outcome_request.outcome_post_successful?
+    end
+
+    # If the Tool Consumer sent a URL for the user to return to this will add
+    # any set messages to the URL.
+    #
+    # Example:
+    #
+    #    tc = IMS::LTI::tc.new
+    #    tc.launch_presentation_return_url = "http://example.com/return"
+    #    tc.lti_msg = "hi there"
+    #    tc.lti_errorlog = "error happens"
+    #
+    #    tc.build_return_url # => "http://example.com/return?lti_msg=hi%20there&lti_errorlog=error%20happens"
+    def build_return_url
+      return nil unless launch_presentation_return_url
+      messages = []
+      %w{lti_errormsg lti_errorlog lti_msg lti_log}.each do |m|
+        if message = self.send(m)
+          messages << "#{m}=#{URI.escape(message)}"
+        end
+      end
+      q_string = messages.any? ? ("?" + messages.join("&")) : ''
+      launch_presentation_return_url + q_string
+    end
+
+    private
+
+    def new_request
+      @outcome_requests << OutcomeRequest.new(:consumer_key => @consumer_key,
+                         :consumer_secret => @consumer_secret,
+                         :lis_outcome_service_url => lis_outcome_service_url,
+                         :lis_result_sourcedid =>lis_result_sourcedid)
+
+      extend_outcome_request(@outcome_requests.last)
+    end
+
+  end
+end

data/lib/ims/lti/version.rb

@@ -0,0 +1,5 @@
+module IMS
+  module LTI
+    VERSION = "0.0.2"
+  end
+end

data/lib/ims/lti.rb

@@ -0,0 +1,61 @@
+require 'addressable/uri'
+require 'builder'
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'json/jwt'
+require 'rexml/document'
+require 'securerandom'
+require 'simple_oauth'
+require 'oauth'
+require 'cgi'
+
+module IMS
+  module LTI
+    require_relative 'lti/converters'
+    require_relative 'lti/errors'
+    require_relative 'lti/models'
+    require_relative 'lti/serializers'
+    require_relative 'lti/services'
+  end
+
+  # 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
+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

@@ -0,0 +1,4 @@
+module IMS
+  require 'ims/lti'
+  require 'ims/lis'
+end

metadata

@@ -0,0 +1,379 @@
+--- !ruby/object:Gem::Specification
+name: qalam_ims_lti
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Instructure
+- Abdelhamid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- opensource@instructure.com
+- a.hamid@nezam.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changelog.txt
+- LICENSE.txt
+- README.md
+- lib/ims.rb
+- lib/ims/lis.rb
+- lib/ims/lis/context_type/handles.rb
+- lib/ims/lis/context_type/urns.rb
+- lib/ims/lis/roles/context/handles.rb
+- lib/ims/lis/roles/context/urns.rb
+- lib/ims/lis/roles/institution/handles.rb
+- lib/ims/lis/roles/institution/urns.rb
+- lib/ims/lis/roles/system/handles.rb
+- lib/ims/lis/roles/system/urns.rb
+- lib/ims/lis/statuses/simple_names.rb
+- lib/ims/lis/statuses/uris.rb
+- lib/ims/lti.rb
+- lib/ims/lti/converters.rb
+- lib/ims/lti/converters/time_json_converter.rb
+- lib/ims/lti/deprecated_role_checks.rb
+- lib/ims/lti/errors.rb
+- lib/ims/lti/errors/authentication_failed_error.rb
+- lib/ims/lti/errors/invalid_lti_config_error.rb
+- lib/ims/lti/errors/invalid_tool_consumer_profile.rb
+- lib/ims/lti/errors/tool_proxy_registration_error.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/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/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_item.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/membership_service.rb
+- lib/ims/lti/models/membership_service/agent.rb
+- lib/ims/lti/models/membership_service/container.rb
+- lib/ims/lti/models/membership_service/context.rb
+- lib/ims/lti/models/membership_service/lis_membership_container.rb
+- lib/ims/lti/models/membership_service/lis_person.rb
+- lib/ims/lti/models/membership_service/membership.rb
+- lib/ims/lti/models/membership_service/organization.rb
+- lib/ims/lti/models/membership_service/page.rb
+- lib/ims/lti/models/membership_service/person.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/messages/tool_proxy_update_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/security_profile.rb
+- lib/ims/lti/models/serializable.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/tool_setting.rb
+- lib/ims/lti/models/tool_setting_container.rb
+- lib/ims/lti/models/vendor.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/serializers.rb
+- lib/ims/lti/serializers/base.rb
+- lib/ims/lti/serializers/membership_service.rb
+- lib/ims/lti/serializers/membership_service/agent_serializer.rb
+- lib/ims/lti/serializers/membership_service/container_serializer.rb
+- lib/ims/lti/serializers/membership_service/context_serializer.rb
+- lib/ims/lti/serializers/membership_service/lis_membership_container_serializer.rb
+- lib/ims/lti/serializers/membership_service/lis_person_serializer.rb
+- lib/ims/lti/serializers/membership_service/membership_serializer.rb
+- lib/ims/lti/serializers/membership_service/organization_serializer.rb
+- lib/ims/lti/serializers/membership_service/page_serializer.rb
+- lib/ims/lti/serializers/membership_service/person_serializer.rb
+- lib/ims/lti/services.rb
+- lib/ims/lti/services/authentication_service.rb
+- lib/ims/lti/services/message_authenticator.rb
+- lib/ims/lti/services/oauth2_client.rb
+- lib/ims/lti/services/tool_config.rb
+- lib/ims/lti/services/tool_consumer_profile_service.rb
+- lib/ims/lti/services/tool_proxy_registration_service.rb
+- lib/ims/lti/services/tool_proxy_validator.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/version.rb
+homepage: http://github.com/ahmedhamid13/qalam_ims_lti
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.21
+signing_key: 
+specification_version: 4
+summary: Ruby library for creating IMS LTI tool providers and consumers
+test_files: []