atomic_lti 1.9.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8b38d2b638688e1308e60601a9586a6d4f44c973bfe82aa3d94c7941f1f3f79
-  data.tar.gz: b280f79bab178696f88dfb2bb34af9cf1a4cf8b0c2835a2c8040890d7c994b2b
+  metadata.gz: aac6096f2a93856e8186ad6dfa5cd43856a0ac2ffd16d2e9a1353d404742c69a
+  data.tar.gz: 64b8ffeeb7d74e020ae63fa8c42d2401e4632a4fb4a311fdf06cb177069e801a
 SHA512:
-  metadata.gz: 8a117f214fe877902d629474a237edcae89f7635b5028534010e64925a0c845b20066cca8694fa8350e3018f1e1713ec1f25667801216230a1a2f755d6639a8c
-  data.tar.gz: a20d30b4094c1344fb45fbcb440319182626b08e0ef968dcf80e0a610184c35a71f6f5690322b7f168b39925929ce8f7da47652e5b588fee697fdf7c5c43e2b4
+  metadata.gz: d1ad65c60634d64306683166dffbf5cb2fb72a79b5db177c76c720cfa98859e3b5db6e30951f92a198be6c232f0a2ffc84be8449e38bb55279cd90d62de54ee3
+  data.tar.gz: 8b1df93f772d15b9e20482928bdcd8f766fe00769818c1217bf98e3a3ff111a80793ad2ee2d005992175bc147ccad024fc2fe3f453f49ceb0b85589c3009d336

data/app/lib/atomic_lti/definitions.rb

@@ -31,6 +31,12 @@ module AtomicLti
 
     NAMES_AND_ROLES_SERVICE_VERSIONS = ["2.0"].freeze
 
+    PLATFORM_NOTIFICATION_SERVICE_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/platformnotificationservice".freeze
+    PLATFORM_NOTIFICATION_SERVICE_VERSIONS = ["1.0".freeze].freeze
+    NOTICE_TYPE_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/notice_type".freeze
+    PLATFORM_NOTIFICATION_CONTEXT_COPY_NOTICE = "LtiContextCopyNotice".freeze
+    PLATFORM_NOTIFICATION_CONTEXT_COPY_ORIGINS_CLAIM = "https://purl.imsglobal.org/spec/lti/claim/origin_contexts".freeze
+
     CALIPER_CLAIM = "https://purl.imsglobal.org/spec/lti-ces/claim/caliper-endpoint-service".freeze
 
     TOOL_LAUNCH_CALIPER_CONTEXT = "http://purl.imsglobal.org/ctx/caliper/v1p1/ToolLaunchProfile-extension".freeze
@@ -43,6 +49,7 @@ module AtomicLti
     AGS_SCOPE_SCORE = "https://purl.imsglobal.org/spec/lti-ags/scope/score".freeze
     NAMES_AND_ROLES_SCOPE = "https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly".freeze
     CALIPER_SCOPE = "https://purl.imsglobal.org/spec/lti-ces/v1p0/scope/send".freeze
+    PNS_SCOPE_NOTICEHANDLERS = "https://purl.imsglobal.org/spec/lti/scope/noticehandlers".freeze
 
     STUDENT_SCOPE = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student".freeze
     INSTRUCTOR_SCOPE = "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Instructor".freeze
@@ -167,6 +174,7 @@ module AtomicLti
 
     OBSERVER_ROLES = [
       MENTOR_INSTITUTION_ROLE,
+      MENTOR_CONTEXT_ROLE,
       # NON_CREDIT_LEARNER,
     ].freeze
 

data/app/lib/atomic_lti/exceptions.rb

@@ -14,6 +14,8 @@ module AtomicLti
     class NamesAndRolesError < AtomicLtiException
     end
 
+    class PlatformNotificationsError < AtomicLtiException; end
+
     class ScoreError < AtomicLtiException
     end
 
@@ -98,5 +100,7 @@ module AtomicLti
 
     class PaginationLimitExceeded < AtomicLtiException
     end
+
+    class InvalidPlatformNotification < AtomicLtiException; end
   end
 end

data/app/lib/atomic_lti/services/platform_notifications.rb

@@ -0,0 +1,100 @@
+module AtomicLti
+  module Services
+    class PlatformNotifications < AtomicLti::Services::Base
+      def scopes
+        [AtomicLti::Definitions::PNS_SCOPE_NOTICEHANDLERS]
+      end
+
+      def endpoint
+        url = @id_token_decoded.dig(AtomicLti::Definitions::PLATFORM_NOTIFICATION_SERVICE_CLAIM, "platform_notification_service_url")
+        raise AtomicLti::Exceptions::PlatformNotificationsError, "Unable to access platform notifications" if url.blank?
+
+        url
+      end
+
+      def url_for(query = nil)
+        url = endpoint.dup
+        url << "?#{query}" if query.present?
+        url
+      end
+
+      def self.enabled?(id_token_decoded)
+        return false unless id_token_decoded&.dig(AtomicLti::Definitions::PLATFORM_NOTIFICATION_SERVICE_CLAIM)
+
+        (AtomicLti::Definitions::PLATFORM_NOTIFICATION_SERVICE_VERSIONS &
+          (id_token_decoded.dig(AtomicLti::Definitions::PLATFORM_NOTIFICATION_SERVICE_CLAIM, "service_versions") || [])).present?
+      end
+
+      def valid?
+        self.class.enabled?(@id_token_decoded)
+      end
+
+      # Get platform notifications
+      def get(query: {})
+        uri = Addressable::URI.parse(endpoint)
+        uri.query_values = (uri.query_values || {}).merge(query)
+        url = uri.to_str
+
+        response, = service_get(url, headers:)
+        response.parsed_response
+      end
+
+      def update(notice_type, handler)
+        content_type = { "Content-Type" => "application/json" }
+        payload = { notice_type:, handler: }
+        response, = service_put(endpoint, body: JSON.dump(payload), headers: headers(content_type))
+        response
+      end
+
+      def self.validate_notification(notification)
+        decoded_token = AtomicLti::Authorization.validate_token(notification)
+        if decoded_token.blank?
+          raise AtomicLti::Exceptions::InvalidPlatformNotification
+        end
+
+        errors = []
+
+        if decoded_token["iss"].blank?
+          errors.push("LTI token is missing required field iss")
+        end
+
+        if decoded_token["aud"].blank?
+          errors.push("LTI token is missing required field aud")
+        end
+
+        if decoded_token["aud"].is_a?(Array) && decoded_token["aud"].length > 1
+          # OpenID Connect spec specifies the AZP should exist and be an AUD
+          if decoded_token["azp"].blank?
+            errors.push("LTI token has multiple aud and is missing required field azp")
+          elsif decoded_token["aud"].exclude?(decoded_token["azp"])
+            errors.push("LTI token azp is not one of the aud's")
+          end
+        end
+
+        if decoded_token[AtomicLti::Definitions::DEPLOYMENT_ID].blank?
+          errors.push(
+            "LTI token is missing required field #{AtomicLti::Definitions::DEPLOYMENT_ID}",
+          )
+        end
+
+        if decoded_token[AtomicLti::Definitions::NOTICE_TYPE_CLAIM].blank?
+          errors.push(
+            "LTI token is missing required claim #{AtomicLti::Definitions::NOTICE_TYPE_CLAIM}",
+          )
+        end
+
+        if errors.present?
+          raise Exceptions::InvalidPlatformNotification.new(errors.join(" "))
+        end
+
+        if decoded_token[AtomicLti::Definitions::LTI_VERSION].blank?
+          raise AtomicLti::Exceptions::NoLTIVersion
+        end
+
+        raise AtomicLti::Exceptions::InvalidLTIVersion unless AtomicLti::Lti.valid_version?(decoded_token)
+
+        decoded_token
+      end
+    end
+  end
+end

data/app/models/atomic_lti/context.rb

@@ -1,7 +1,8 @@
 module AtomicLti
   class Context < ApplicationRecord
+    query_constraints :context_id, :deployment_id, :iss
     belongs_to :platform, primary_key: :iss, foreign_key: :iss
-    # belongs_to :deployment, primary_key: [:iss, :deployment_id], foreign_key: [:iss, :deployment_id] # TODO: this breaks rspec
+    belongs_to :deployment, query_constraints: [:iss, :deployment_id], optional: true
 
     validates :context_id, presence: true
     validates :deployment_id, presence: true

data/app/models/atomic_lti/deployment.rb

@@ -1,7 +1,9 @@
 module AtomicLti
   class Deployment < ApplicationRecord
+    query_constraints :deployment_id, :iss
     belongs_to :platform, primary_key: :iss, foreign_key: :iss
-    belongs_to :install, primary_key: [:iss, :client_id], foreign_key: [:iss, :client_id],  optional: true
+    belongs_to :install, query_constraints: [:client_id, :iss], optional: true
+    has_many :contexts, query_constraints: [:deployment_id, :iss]
 
     # we won't have platform_guid during dynamic registration
     # belongs_to :platform_instance, primary_key: :guid, foreign_key: :platform_guid, optional: true

data/app/models/atomic_lti/install.rb

@@ -1,11 +1,10 @@
 module AtomicLti
   class Install < ApplicationRecord
+    query_constraints :client_id, :iss
     belongs_to :platform, primary_key: :iss, foreign_key: :iss
+    has_many :deployments, query_constraints: [:client_id, :iss]
 
     validates :client_id, presence: true
     validates :iss, presence: true
-    def deployments
-      AtomicLti::Deployment.where("iss = ? AND client_id = ?", iss, client_id)
-    end
   end
 end

data/app/models/atomic_lti/platform.rb

@@ -1,5 +1,9 @@
 module AtomicLti
   class Platform < ApplicationRecord
+    query_constraints :iss
     validates :iss, presence: true
+    has_many :platform_instances, foreign_key: :iss, primary_key: :iss
+    has_many :deployments, foreign_key: :iss, primary_key: :iss
+    has_many :contexts, foreign_key: :iss, primary_key: :iss
   end
 end

data/lib/atomic_lti/version.rb

@@ -1,3 +1,3 @@
 module AtomicLti
-  VERSION = "1.9.0".freeze
+  VERSION = "2.0.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic_lti
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Matt Petro
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 description: AtomicLti implements the LTI Advantage specification. This gem does contain
   source code specific to other Atomic Jolt products
 email:
@@ -77,6 +77,7 @@ files:
 - app/lib/atomic_lti/services/base.rb
 - app/lib/atomic_lti/services/line_items.rb
 - app/lib/atomic_lti/services/names_and_roles.rb
+- app/lib/atomic_lti/services/platform_notifications.rb
 - app/lib/atomic_lti/services/results.rb
 - app/lib/atomic_lti/services/score.rb
 - app/lib/atomic_lti/services/score_canvas.rb
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: AtomicLti implements the LTI Advantage specification.