ims-lti 1.1.12 → 2.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3519a3ee6fb782c4ed97fcb89652c2011a3bb602
-  data.tar.gz: 495e959fd7bcddd71da5ead3ec88745109aae5c6
+SHA256:
+  metadata.gz: 9899601b123b10eb2feee49196ff7416632bca74d3d447944ce22b69fe72b3c4
+  data.tar.gz: 55862774dae198a76d3d179db2b651e08491a3b03fc2edf4615873270e9c0330
 SHA512:
-  metadata.gz: a046a0db9890831af84705ca31d11d409ee3095b58e56e1bfd1eb458163a9856fbbff51bd7738d87a776d97bc7a88fc74b62980a64a8553437bb66592178499f
-  data.tar.gz: ac7793788cb184c463f10e977dfac0f448c840f99ca4f9a11cc9bd1af6142d6896b9d1a1fa8419afd404b16c4ca6967315e38429cf0c17ccfb719e0273998371
+  metadata.gz: '0972ae6f32083f0386f81b0cf027429c7848edfc0e59a37477c6dfdab17183fd53697298e30944f3c91699b6f1c3a54271dd5c4a891fad0521bbab63d0a65c2b'
+  data.tar.gz: 2750f5c13df1af5faaefcf45bb44107d2194f79250b41e9f37d425c34e852d975fe3364b12dfb3f373b678d0d7837e8b56c26dcacb0afb02ea0db4fbc909afe9

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Instructure
+
+MIT License
+
+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/README.md

@@ -1,116 +1,65 @@
 # IMS LTI
 
-This ruby library is to help create Tool Providers and Tool Consumers for the
-[IMS LTI standard](http://www.imsglobal.org/lti/index.html).
+[![Build Status](https://travis-ci.org/instructure/ims-lti.svg?branch=2.1.x)](https://travis-ci.org/instructure/ims-lti)
 
-## 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:
+LTI ruby implementation
 
-    gem install ims-lti
+## Installation
 
-To require the library in your project:
+Add these lines to your application's Gemfile:
 
-    require 'ims/lti'
+    gem 'ims-lti'
+    # only necessary if using ToolProxyRegistrationService:
+    gem 'faraday-oauth' # or faraday_middleware if using Faraday < 2.0
 
-To validate the OAuth signatures you need to require the appropriate request
-proxy for your application. For example:
+And then execute:
 
-    # For a Sinatra or a Rails 3 or 4 app:
-    require 'oauth/request_proxy/rack_request'
-    # You also need to explicitly enable OAuth 1 support in the environment.rb or an initializer:
-    OAUTH_10_SUPPORT = true
+    $ bundle
 
-    # For a Rails 2.3 app:
-    require 'oauth/request_proxy/action_controller_request'
+Or install it yourself as:
 
-For further information see the [oauth-ruby](https://github.com/oauth-xx/oauth-ruby) project.
+    $ gem install lti
 
-As a quick debugging note, if you forget that step, you'll get an error like:
+## Usage
 
-    OAuth::RequestProxy::UnknownRequestType
 
-## Usage
-This readme won't cover the LTI standard, just how to use the library. It will be
-very helpful to read the [LTI documentation](http://www.imsglobal.org/lti/index.html)
+### LTI 1.x
 
-In LTI there are Tool Providers (TP) and Tool Consumers (TC), this library is
-useful for implementing both. Here is an overview of the communication process:
-[LTI 1.1 Introduction](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560461)
+#### Validating Launches
 
-This library doesn't help you manage the consumer keys and secrets. The POST
-headers/parameters will contain the `oauth_consumer_key` and your app can use
-that to look up the appropriate `oauth_consumer_secret`.
+You can use the classes in the IMS::LTI::Models::Messages module to valdiate Launches
 
-Your app will also need to manage the OAuth nonce to make sure the same nonce
-isn't used twice with the same timestamp. [Read the LTI documentation on OAuth](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560468).
+For example in a rails app you would do the following
+```ruby
+authenticator = IMS::LTI::Services::MessageAuthenticator.new(request.url, request.request_parameters, shared_secret)
 
-### Tool Provider
-As a TP your app will receive a POST request with a bunch of
-[LTI launch data](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560465)
-and it will be signed with OAuth using a key/secret that both the TP and TC share.
-This is covered in the [LTI security model](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560466)
+#Check if the signature is valid
+return false unless authenticator.valid_signature?
 
-Here is an example of a simple TP Sinatra app using this gem:
-[LTI Tool Provider](https://github.com/instructure/lti_tool_provider_example)
+# check if `params['oauth_nonce']` has already been used
 
-Once you find the `oauth_consumer_secret` based on the `oauth_consumer_key` in
-the request, you can initialize a `ToolProvider` object with them and the post parameters:
+#check if the message is too old
+return false if DateTime.strptime(request.request_parameters['oauth_timestamp'],'%s') < 5.minutes.ago
 
-```ruby
-# 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
 ```
 
-Once your TP object is initialized and verified you can load your tool. All of the
-[launch data](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560465)
-is available in the TP object along with some convenience methods like `provider.username`
-which will try to find the name from the 3 potential name launch data attributes.
 
-#### Returning Results of a Quiz/Assignment
-If your TP provides some kind of assessment service you can write grades back to
-the TC. This is documented in the LTI docs [here](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560471).
+```ruby
 
-You can check whether the TC is expecting a grade write-back:
+params = { user_id: '123', lti_message_type: IMS::LTI::Models::Messages::BasicLTILaunchRequest::MESSAGE_TYPE }
 
-```ruby
-if provider.outcome_service?
-  # ready for grade write-back
-else
-  # normal tool launch without grade write-back
-end
-```
+header = SimpleOAuth::Header.new(:post, 'https://yoursite.com', params, consumer_key: oauth_consumer_key, consumer_secret: secret)
 
-To write the grade back to the TC your tool will do a POST directly back to the
-URL the TC passed in the launch data. You can use the TP object to do that for you:
+signed_params = header.signed_attributes.merge(params)
 
-```ruby
-# 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
-```
+IMS::LTI::Services::MessageAuthenticator.new(launch_url, signed_params, secret)
 
-You can see the error code documentation
-[here](http://www.imsglobal.org/gws/gwsv1p0/imsgws_baseProfv1p0.html#1639667).
+```
 
-### Tool Consumer
-As a Tool Consumer your app will POST an OAuth-signed launch requests to TPs with the necessary
-[LTI launch data](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560465).
-This is covered in the [LTI security model](http://www.imsglobal.org/LTI/v1p1/ltiIMGv1p1.html#_Toc319560466)
+## Contributing
 
-Here is an example of a simple TC Sinatra app using this gem:
-[LTI Tool Consumer](https://github.com/instructure/lti_tool_consumer_example)
+1. Fork it ( http://github.com/instructure/ims-lti/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/ims/lis/context_type/handles.rb

@@ -0,0 +1,10 @@
+module IMS::LIS
+  module ContextType
+    module Handles
+      CourseTemplate = "CourseTemplate"
+      CourseOffering = "CourseOffering"
+      CourseSection = "CourseSection"
+      Group = "Group"
+    end
+  end
+end

data/lib/ims/lis/context_type/urns.rb

@@ -0,0 +1,10 @@
+module IMS::LIS
+  module ContextType
+    module URNs
+      CourseTemplate = "urn:lti:context-type:ims/lis/CourseTemplate"
+      CourseOffering = "urn:lti:context-type:ims/lis/CourseOffering"
+      CourseSection = "urn:lti:context-type:ims/lis/CourseSection"
+      Group = "urn:lti:context-type:ims/lis/Group"
+    end
+  end
+end

data/lib/ims/lis/roles/context/handles.rb

@@ -0,0 +1,60 @@
+module IMS::LIS
+  module Roles
+    module Context
+      module Handles
+        Learner = "Learner"
+        Learner_Learner = "Learner/Learner"
+        Learner_NonCreditLearner = "Learner/NonCreditLearner"
+        Learner_GuestLearner = "Learner/GuestLearner"
+        Learner_ExternalLearner = "Learner/ExternalLearner"
+        Learner_Instructor = "Learner/Instructor"
+        Instructor = "Instructor"
+        Instructor_PrimaryInstructor = "Instructor/PrimaryInstructor"
+        Instructor_Lecturer = "Instructor/Lecturer"
+        Instructor_GuestInstructor = "Instructor/GuestInstructor"
+        Instructor_ExternalInstructor = "Instructor/ExternalInstructor"
+        ContentDeveloper = "ContentDeveloper"
+        ContentDeveloper_ContentDeveloper = "ContentDeveloper/ContentDeveloper"
+        ContentDeveloper_Librarian = "ContentDeveloper/Librarian"
+        ContentDeveloper_ContentExpert = "ContentDeveloper/ContentExpert"
+        ContentDeveloper_ExternalContentExpert = "ContentDeveloper/ExternalContentExpert"
+        Member = "Member"
+        Member_Member = "Member/Member"
+        Manager = "Manager"
+        Manager_AreaManager = "Manager/AreaManager"
+        Manager_CourseCoordinator = "Manager/CourseCoordinator"
+        Manager_Observer = "Manager/Observer"
+        Manager_ExternalObserver = "Manager/ExternalObserver"
+        Mentor = "Mentor"
+        Mentor_Mentor = "Mentor/Mentor"
+        Mentor_Reviewer = "Mentor/Reviewer"
+        Mentor_Advisor = "Mentor/Advisor"
+        Mentor_Auditor = "Mentor/Auditor"
+        Mentor_Tutor = "Mentor/Tutor"
+        Mentor_LearningFacilitator = "Mentor/LearningFacilitator"
+        Mentor_ExternalMentor = "Mentor/ExternalMentor"
+        Mentor_ExternalReviewer = "Mentor/ExternalReviewer"
+        Mentor_ExternalAdvisor = "Mentor/ExternalAdvisor"
+        Mentor_ExternalAuditor = "Mentor/ExternalAuditor"
+        Mentor_ExternalTutor = "Mentor/ExternalTutor"
+        Mentor_ExternalLearningFacilitator = "Mentor/ExternalLearningFacilitator"
+        Administrator = "Administrator"
+        Administrator_Administrator = "Administrator/Administrator"
+        Administrator_Support = "Administrator/Support"
+        Administrator_Developer = "Administrator/Developer"
+        Administrator_SystemAdministrator = "Administrator/SystemAdministrator"
+        Administrator_ExternalSystemAdministrator = "Administrator/ExternalSystemAdministrator"
+        Administrator_ExternalDeveloper = "Administrator/ExternalDeveloper"
+        Administrator_ExternalSupport = "Administrator/ExternalSupport"
+        TeachingAssistant = "TeachingAssistant"
+        TeachingAssistant_TeachingAssistant = "TeachingAssistant/TeachingAssistant"
+        TeachingAssistant_TeachingAssistantSection = "TeachingAssistant/TeachingAssistantSection"
+        TeachingAssistant_TeachingAssistantSectionAssociation = "TeachingAssistant/TeachingAssistantSectionAssociation"
+        TeachingAssistant_TeachingAssistantOffering = "TeachingAssistant/TeachingAssistantOffering"
+        TeachingAssistant_TeachingAssistantTemplate = "TeachingAssistant/TeachingAssistantTemplate"
+        TeachingAssistant_TeachingAssistantGroup = "TeachingAssistant/TeachingAssistantGroup"
+        TeachingAssistant_Grader = "TeachingAssistant/Grader"
+      end
+    end
+  end
+end

data/lib/ims/lis/roles/context/urns.rb

@@ -0,0 +1,60 @@
+module IMS::LIS
+  module Roles
+    module Context
+      module URNs
+        Learner = "urn:lti:role:ims/lis/Learner"
+        Learner_Learner = "urn:lti:role:ims/lis/Learner/Learner"
+        Learner_NonCreditLearner = "urn:lti:role:ims/lis/Learner/NonCreditLearner"
+        Learner_GuestLearner = "urn:lti:role:ims/lis/Learner/GuestLearner"
+        Learner_ExternalLearner = "urn:lti:role:ims/lis/Learner/ExternalLearner"
+        Learner_Instructor = "urn:lti:role:ims/lis/Learner/Instructor"
+        Instructor = "urn:lti:role:ims/lis/Instructor"
+        Instructor_PrimaryInstructor = "urn:lti:role:ims/lis/Instructor/PrimaryInstructor"
+        Instructor_Lecturer = "urn:lti:role:ims/lis/Instructor/Lecturer"
+        Instructor_GuestInstructor = "urn:lti:role:ims/lis/Instructor/GuestInstructor"
+        Instructor_ExternalInstructor = "urn:lti:role:ims/lis/Instructor/ExternalInstructor"
+        ContentDeveloper = "urn:lti:role:ims/lis/ContentDeveloper"
+        ContentDeveloper_ContentDeveloper = "urn:lti:role:ims/lis/ContentDeveloper/ContentDeveloper"
+        ContentDeveloper_Librarian = "urn:lti:role:ims/lis/ContentDeveloper/Librarian"
+        ContentDeveloper_ContentExpert = "urn:lti:role:ims/lis/ContentDeveloper/ContentExpert"
+        ContentDeveloper_ExternalContentExpert = "urn:lti:role:ims/lis/ContentDeveloper/ExternalContentExpert"
+        Member = "urn:lti:role:ims/lis/Member"
+        Member_Member = "urn:lti:role:ims/lis/Member/Member"
+        Manager = "urn:lti:role:ims/lis/Manager"
+        Manager_AreaManager = "urn:lti:role:ims/lis/Manager/AreaManager"
+        Manager_CourseCoordinator = "urn:lti:role:ims/lis/Manager/CourseCoordinator"
+        Manager_Observer = "urn:lti:role:ims/lis/Manager/Observer"
+        Manager_ExternalObserver = "urn:lti:role:ims/lis/Manager/ExternalObserver"
+        Mentor = "urn:lti:role:ims/lis/Mentor"
+        Mentor_Mentor = "urn:lti:role:ims/lis/Mentor/Mentor"
+        Mentor_Reviewer = "urn:lti:role:ims/lis/Mentor/Reviewer"
+        Mentor_Advisor = "urn:lti:role:ims/lis/Mentor/Advisor"
+        Mentor_Auditor = "urn:lti:role:ims/lis/Mentor/Auditor"
+        Mentor_Tutor = "urn:lti:role:ims/lis/Mentor/Tutor"
+        Mentor_LearningFacilitator = "urn:lti:role:ims/lis/Mentor/LearningFacilitator"
+        Mentor_ExternalMentor = "urn:lti:role:ims/lis/Mentor/ExternalMentor"
+        Mentor_ExternalReviewer = "urn:lti:role:ims/lis/Mentor/ExternalReviewer"
+        Mentor_ExternalAdvisor = "urn:lti:role:ims/lis/Mentor/ExternalAdvisor"
+        Mentor_ExternalAuditor = "urn:lti:role:ims/lis/Mentor/ExternalAuditor"
+        Mentor_ExternalTutor = "urn:lti:role:ims/lis/Mentor/ExternalTutor"
+        Mentor_ExternalLearningFacilitator = "urn:lti:role:ims/lis/Mentor/ExternalLearningFacilitator"
+        Administrator = "urn:lti:role:ims/lis/Administrator"
+        Administrator_Administrator = "urn:lti:role:ims/lis/Administrator/Administrator"
+        Administrator_Support = "urn:lti:role:ims/lis/Administrator/Support"
+        Administrator_Developer = "urn:lti:role:ims/lis/Administrator/Developer"
+        Administrator_SystemAdministrator = "urn:lti:role:ims/lis/Administrator/SystemAdministrator"
+        Administrator_ExternalSystemAdministrator = "urn:lti:role:ims/lis/Administrator/ExternalSystemAdministrator"
+        Administrator_ExternalDeveloper = "urn:lti:role:ims/lis/Administrator/ExternalDeveloper"
+        Administrator_ExternalSupport = "urn:lti:role:ims/lis/Administrator/ExternalSupport"
+        TeachingAssistant = "urn:lti:role:ims/lis/TeachingAssistant"
+        TeachingAssistant_TeachingAssistant = "urn:lti:role:ims/lis/TeachingAssistant/TeachingAssistant"
+        TeachingAssistant_TeachingAssistantSection = "urn:lti:role:ims/lis/TeachingAssistant/TeachingAssistantSection"
+        TeachingAssistant_TeachingAssistantSectionAssociation = "urn:lti:role:ims/lis/TeachingAssistant/TeachingAssistantSectionAssociation"
+        TeachingAssistant_TeachingAssistantOffering = "urn:lti:role:ims/lis/TeachingAssistant/TeachingAssistantOffering"
+        TeachingAssistant_TeachingAssistantTemplate = "urn:lti:role:ims/lis/TeachingAssistant/TeachingAssistantTemplate"
+        TeachingAssistant_TeachingAssistantGroup = "urn:lti:role:ims/lis/TeachingAssistant/TeachingAssistantGroup"
+        TeachingAssistant_Grader = "urn:lti:role:ims/lis/TeachingAssistant/Grader"
+      end
+    end
+  end
+end

data/lib/ims/lis/roles/institution/handles.rb

@@ -0,0 +1,22 @@
+module IMS::LIS
+  module Roles
+    module Institution
+      module Handles
+        Student = "Student"
+        Faculty = "Faculty"
+        Member = "Member"
+        Learner = "Learner"
+        Instructor = "Instructor"
+        Mentor = "Mentor"
+        Staff = "Staff"
+        Alumni = "Alumni"
+        ProspectiveStudent = "ProspectiveStudent"
+        Guest = "Guest"
+        Other = "Other"
+        Administrator = "Administrator"
+        Observer = "Observer"
+        None = "None"
+      end
+    end
+  end
+end

data/lib/ims/lis/roles/institution/urns.rb

@@ -0,0 +1,22 @@
+module IMS::LIS
+  module Roles
+    module Institution
+      module URNs
+        Student = "urn:lti:instrole:ims/lis/Student"
+        Faculty = "urn:lti:instrole:ims/lis/Faculty"
+        Member = "urn:lti:instrole:ims/lis/Member"
+        Learner = "urn:lti:instrole:ims/lis/Learner"
+        Instructor = "urn:lti:instrole:ims/lis/Instructor"
+        Mentor = "urn:lti:instrole:ims/lis/Mentor"
+        Staff = "urn:lti:instrole:ims/lis/Staff"
+        Alumni = "urn:lti:instrole:ims/lis/Alumni"
+        ProspectiveStudent = "urn:lti:instrole:ims/lis/ProspectiveStudent"
+        Guest = "urn:lti:instrole:ims/lis/Guest"
+        Other = "urn:lti:instrole:ims/lis/Other"
+        Administrator = "urn:lti:instrole:ims/lis/Administrator"
+        Observer = "urn:lti:instrole:ims/lis/Observer"
+        None = "urn:lti:instrole:ims/lis/None"
+      end
+    end
+  end
+end

data/lib/ims/lis/roles/system/handles.rb

@@ -0,0 +1,15 @@
+module IMS::LIS
+  module Roles
+    module System
+      module Handles
+        SysAdmin = "SysAdmin"
+        SysSupport = "SysSupport"
+        Creator = "Creator"
+        AccountAdmin = "AccountAdmin"
+        User = "User"
+        Administrator = "Administrator"
+        None = "None"
+      end
+    end
+  end
+end

data/lib/ims/lis/roles/system/urns.rb

@@ -0,0 +1,15 @@
+module IMS::LIS
+  module Roles
+    module System
+      module URNs
+        SysAdmin = "urn:lti:sysrole:ims/lis/SysAdmin"
+        SysSupport = "urn:lti:sysrole:ims/lis/SysSupport"
+        Creator = "urn:lti:sysrole:ims/lis/Creator"
+        AccountAdmin = "urn:lti:sysrole:ims/lis/AccountAdmin"
+        User = "urn:lti:sysrole:ims/lis/User"
+        Administrator = "urn:lti:sysrole:ims/lis/Administrator"
+        None = "urn:lti:sysrole:ims/lis/None"
+      end
+    end
+  end
+end

data/lib/ims/lis/statuses/simple_names.rb

@@ -0,0 +1,9 @@
+module IMS::LIS
+  module Statuses
+    module SimpleNames
+      Active = 'Active'
+      Deleted = 'Deleted'
+      Inactive = 'Inactive'
+    end
+  end
+end

data/lib/ims/lis/statuses/uris.rb

@@ -0,0 +1,9 @@
+module IMS::LIS
+  module Statuses
+    module URIs
+      Active = 'http://purl.imsglobal.org/vocab/lis/v2/status#Active'
+      Deleted = 'http://purl.imsglobal.org/vocab/lis/v2/status#Deleted'
+      Inactive = 'http://purl.imsglobal.org/vocab/lis/v2/status#Inactive'
+    end
+  end
+end

data/lib/ims/lis.rb

@@ -0,0 +1,14 @@
+module IMS
+  module LIS
+    require_relative 'lis/context_type/handles'
+    require_relative 'lis/context_type/urns'
+    require_relative 'lis/roles/institution/handles'
+    require_relative 'lis/roles/institution/urns'
+    require_relative 'lis/roles/system/handles'
+    require_relative 'lis/roles/system/urns'
+    require_relative 'lis/roles/context/handles'
+    require_relative 'lis/roles/context/urns'
+    require_relative 'lis/statuses/simple_names'
+    require_relative 'lis/statuses/uris'
+  end
+end

data/lib/ims/lti/converters/time_json_converter.rb

@@ -0,0 +1,13 @@
+module IMS::LTI::Converters
+  class TimeJSONConverter
+
+    def self.to_json_value(time)
+      time
+    end
+
+    def self.from_json_value(json_val)
+      Time.parse(json_val)
+    end
+
+  end
+end

data/lib/ims/lti/converters.rb

@@ -0,0 +1,5 @@
+module IMS::LTI
+  module Converters
+    require_relative 'converters/time_json_converter'
+  end
+end

data/lib/ims/lti/errors/authentication_failed_error.rb

@@ -0,0 +1,11 @@
+module IMS::LTI::Errors
+  class AuthenticationFailedError < StandardError
+
+    attr_reader :response
+
+    def initialize(response: nil)
+      @response = response
+    end
+
+  end
+end

data/lib/ims/lti/errors/invalid_lti_config_error.rb

@@ -0,0 +1,4 @@
+module IMS::LTI::Errors
+  class InvalidLTIConfigError < StandardError
+  end
+end

data/lib/ims/lti/errors/invalid_tool_consumer_profile.rb

@@ -0,0 +1,4 @@
+module IMS::LTI::Errors
+  class InvalidToolConsumerProfile < StandardError
+  end
+end

data/lib/ims/lti/errors/tool_proxy_registration_error.rb

@@ -0,0 +1,15 @@
+module IMS::LTI::Errors
+  class ToolProxyRegistrationError < StandardError
+    attr_reader :response_status, :response_body
+
+    def initialize(response_status, response_body = nil)
+      @response_status = response_status
+      @response_body = response_body
+      super <<-EOF
+Unexpected response for tool proxy registration.
+HTTP Response Status: #{response_status}
+HTTP Response Body: #{response_body}
+EOF
+    end
+  end
+end

data/lib/ims/lti/errors.rb

@@ -0,0 +1,8 @@
+module IMS::LTI
+  module Errors
+    require_relative 'errors/invalid_lti_config_error'
+    require_relative 'errors/tool_proxy_registration_error'
+    require_relative 'errors/invalid_tool_consumer_profile'
+    require_relative 'errors/authentication_failed_error'
+  end
+end

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

@@ -0,0 +1,15 @@
+module IMS::LTI::Models
+  class BaseUrlChoice < LTIModel
+    add_attributes :default_base_url, :secure_base_url
+    add_attribute :selector, relation:'IMS::LTI::Models::BaseUrlSelector'
+
+    def default_message_url
+      if selector.nil? || (selector.applies_to && selector.applies_to.include?('MessageHandler'))
+        secure_base_url || default_base_url || ''
+      else
+        ''
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,5 @@
+module IMS::LTI::Models
+  class BaseUrlSelector < LTIModel
+    add_attribute :applies_to
+  end
+end

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

@@ -0,0 +1,5 @@
+module IMS::LTI::Models
+  class Contact < LTIModel
+    add_attributes :email
+  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,20 @@
+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_attribute :display_height, json_key: 'displayHeight'
+    add_attribute :display_width, json_key: 'displayWidth'
+    add_attribute :window_target, json_key: 'windowTarget'
+    add_attribute :presentation_document_target, json_key: 'presentationDocumentTarget'
+
+  end
+end

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

@@ -0,0 +1,32 @@
+module IMS::LTI::Models::ContentItems
+  class ContentItem < IMS::LTI::Models::LTIModel
+
+    add_attributes :text, :title, :url, :confirmUrl
+    add_attribute :media_type, json_key: 'mediaType'
+    add_attribute :type, json_key: '@type'
+    add_attribute :id, json_key: '@id'
+    add_attribute :icon, relation: 'IMS::LTI::Models::Image'
+    add_attribute :placement_advice, json_key:'placementAdvice', relation: 'IMS::LTI::Models::ContentItemPlacement'
+    add_attribute :thumbnail, relation: 'IMS::LTI::Models::Image'
+
+    TYPE = "ContentItem"
+
+    def initialize(attributes = {})
+      super(attributes)
+      self.type = TYPE
+    end
+
+    def self.from_json(json)
+      data = json.is_a?(String) ? JSON.parse(json) : json
+      case data['@type']
+      when 'FileItem'
+        FileItem.new.from_json(data)
+      when 'LtiLinkItem', 'LtiLink'
+        LtiLinkItem.new.from_json(data)
+      else
+        ContentItem.new.from_json(data)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+module IMS::LTI::Models::ContentItems
+  class FileItem < ContentItem
+
+    add_attribute :copy_advice, json_key: 'copyAdvice'
+    add_attribute :expires_at, json_key: 'expiresAt'
+
+    TYPE = "FileItem"
+
+    def initialize(attributes = {})
+      super(attributes)
+      self.type = TYPE
+    end
+
+  end
+end