ims-lti 2.2.3 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1ecba7e383b26f256f513d977ce7a1a5ddc6cf4d
-  data.tar.gz: cbb2dcd2d373cb968b72d8ec689d6d1bb4e1b8df
+SHA256:
+  metadata.gz: 573467a4a8bcafd316db27afd42ad7672c23aed334635c73aac5fbedf1bb0580
+  data.tar.gz: 0cc5b9cc51e4b9c95f1d92952712c5c0e4911862c65efd8e18064f424e228b19
 SHA512:
-  metadata.gz: 1eee3ca7972a1c446be5e4a0abb85eba9c6aed471af0891c6cfad4999a876393349a89adbf84865e401b77732bd8da7bec9803adbb4e7d6fd054675a7f99bb49
-  data.tar.gz: ef39d166b973161e51f2b91f01e39a26e26fe71fdde1ecee3d4f37f178db9bc5a9bdbf8b04afe9923385862bcea0b162a6ef23ce967778b11792ea0ea773108e
+  metadata.gz: 31e9e42eb6ca32c3c7927f17ee73b23be2df9c3d1b1a9f0b602d79faa0b7c794868ee6ec336b376c29dcc9aad6ac5a96bea8d851c8e3b55f3e35195d604b5158
+  data.tar.gz: b4d67645a2e744e04bb63bbf6901972739666596592224b4fd6868e2b96edf858e87d204a83c8ca8205546649748cb83514b83ec50b1ac51cc1a87924b1c61d3

data/README.md

@@ -6,9 +6,11 @@ LTI ruby implementation
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add these lines to your application's Gemfile:
 
     gem 'ims-lti'
+    # only necessary if using ToolProxyRegistrationService:
+    gem 'faraday-oauth' # or faraday_middleware if using Faraday < 2.0
 
 And then execute:
 
@@ -41,6 +43,19 @@ return false if DateTime.strptime(request.request_parameters['oauth_timestamp'],
 
 ```
 
+
+```ruby
+
+params = { user_id: '123', lti_message_type: IMS::LTI::Models::Messages::BasicLTILaunchRequest::MESSAGE_TYPE }
+
+header = SimpleOAuth::Header.new(:post, 'https://yoursite.com', params, consumer_key: oauth_consumer_key, consumer_secret: secret)
+
+signed_params = header.signed_attributes.merge(params)
+
+IMS::LTI::Services::MessageAuthenticator.new(launch_url, signed_params, secret)
+
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/instructure/ims-lti/fork )

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

@@ -1,6 +1,6 @@
+require 'uri'
+
 module IMS::LTI::Models
-    require 'uri'
-  
   class LTIModel
     LTI_VERSION_2P0 = 'LTI-2p0'.freeze
     LTI_VERSION_2P1 = 'LTI-2p1'.freeze
@@ -96,7 +96,7 @@ module IMS::LTI::Models
       begin
         data = JSON.parse(json)
       rescue
-        data = JSON.parse(URI.unescape(json))
+        data = JSON.parse(URI::DEFAULT_PARSER.unescape(json))
       end
 
       if data.is_a? Array

data/lib/ims/lti/models/membership_service/lis_person.rb

@@ -1,6 +1,6 @@
 module IMS::LTI::Models::MembershipService
   class LISPerson < Person
-    attr_reader :email, :result_sourced_id, :sourced_id, :user_id
+    attr_reader :email, :result_sourced_id, :sourced_id, :user_id, :sis_id
 
     def initialize(opts={})
       super(opts)
@@ -8,6 +8,7 @@ module IMS::LTI::Models::MembershipService
       @result_sourced_id = opts[:result_sourced_id]
       @sourced_id = opts[:sourced_id]
       @user_id = opts[:user_id]
+      @sis_id = opts[:sis_id]
     end
   end
 end

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

@@ -47,6 +47,19 @@ module IMS::LTI::Models::Messages
         @descendants || Set.new
       end
 
+      # For signature generation -- see usage in signed_post_params
+      def convert_param_values_to_crlf_endings(hash)
+        hash.transform_values do |val|
+          if val.is_a?(String)
+            # Convert to all newlines first, for consistency, just in case there
+            # is some weird mix of newlines & carriage returns in input
+            val.encode(universal_newline: true).encode(crlf_newline: true)
+          else
+            val
+          end
+        end
+      end
+
       private
 
       def add_params(instance_variable, param, *params)
@@ -148,7 +161,11 @@ module IMS::LTI::Models::Messages
     end
 
     def signed_post_params(secret)
-      message_params = oauth_params.merge(post_params)
+      # The params will be used in an HTML form, and browsers will always use
+      # newlines+carriage return line endings for submitted form data. The
+      # signature needs to match, and signature generation does not add carriage
+      # returns, so we ensure CRLF endings here.
+      message_params = self.class.convert_param_values_to_crlf_endings(oauth_params.merge(post_params))
       @message_authenticator = IMS::LTI::Services::MessageAuthenticator.new(launch_url, message_params, secret)
       @message_authenticator.signed_params
     end
@@ -219,4 +236,4 @@ module IMS::LTI::Models::Messages
     end
 
   end
-end
+end

data/lib/ims/lti/serializers/membership_service/lis_person_serializer.rb

@@ -7,5 +7,6 @@ module IMS::LTI::Serializers::MembershipService
     set_attribute :result_sourced_id, key: :resultSourcedId
     set_attribute :sourced_id, key: :sourcedId
     set_attribute :user_id, key: :userId
+    set_attribute :sis_id, key: :sisId, optional: true
   end
 end

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

@@ -11,7 +11,11 @@ module IMS::LTI::Services
 
     def connection
       @connection ||= Faraday.new base_url do |conn|
-        conn.authorization :Bearer, token
+        if Gem::Version.new(Faraday::VERSION) < Gem::Version.new('1.0')
+          conn.authorization :Bearer, token
+        else
+          conn.request :authorization, 'Bearer', token
+        end
       end
     end
   end

data/lib/ims/lti/version.rb

@@ -1,5 +1,5 @@
 module IMS
   module LTI
-    VERSION = "2.2.3"
+    VERSION = "2.3.4"
   end
 end

data/lib/ims/lti.rb

@@ -1,7 +1,6 @@
 require 'addressable/uri'
 require 'builder'
 require 'faraday'
-require 'faraday_middleware'
 require 'json'
 require 'json/jwt'
 require 'rexml/document'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ims-lti
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.4
 platform: ruby
 authors:
 - Instructure
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -48,30 +48,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: json-jwt
   requirement: !ruby/object:Gem::Requirement
@@ -101,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.1
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -212,7 +198,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: 
+description:
 email: opensource@instructure.com
 executables: []
 extensions: []
@@ -320,7 +306,7 @@ homepage: http://github.com/instructure/ims-lti
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -335,10 +321,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Ruby library for creating IMS LTI tool providers and consumers
 test_files: []
-has_rdoc: