atomic_lti 1.5.7 → 1.6.0

data/app/lib/atomic_lti/exceptions.rb

@@ -93,5 +93,8 @@ module AtomicLti
         super(msg)
       end
     end
+
+    class PaginationLimitExceeded < AtomicLtiException
+    end
   end
 end

data/app/lib/atomic_lti/paging_helper.rb

@@ -0,0 +1,36 @@
+module AtomicLti
+  module PagingHelper
+    MAX_PAGES = 200
+
+    def self.response_link_urls(response, *rels)
+      links = response.headers["link"]&.split(",") || []
+      urls = {}
+      rels.each do |rel|
+        urls[rel] = link_url(links, rel)
+      end
+      urls.values_at(*rels)
+    end
+
+    def self.link_url(links, rel)
+      matching_link = links.detect { |link| link.include?("rel=\"#{rel}\"") }
+
+      return unless matching_link
+
+      matching_link.split(";")[0].gsub(/[<>\s]/, "")
+    end
+
+    def self.paginate_request
+      all = []
+      next_link = nil
+      loop do
+        result, next_link = yield(next_link)
+        all << result
+
+        break if next_link.blank? || result.blank?
+
+        raise AtomicLti::Exceptions::PaginationLimitExceeded if all.count > MAX_PAGES
+      end
+      all.compact.flatten
+    end
+  end
+end

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

@@ -26,14 +26,57 @@ module AtomicLti
       end
 
       def get_next_url(response)
-        link = response.headers["link"]
-        return nil if link.blank?
+        next_url, = AtomicLti::PagingHelper.response_link_urls(response, "next")
+        next_url
+      end
 
-        if url = link.split(",").detect { |l| l.split(";")[1].strip == 'rel="next"' }
-          url.split(";")[0].gsub(/[\<\>\s]/, "")
-        end
+      def service_get(*args)
+        logged_service_call(:get, *args)
+      end
+
+      def service_put(*args)
+        logged_service_call(:put, *args)
+      end
+
+      def service_post(*args)
+        logged_service_call(:post, *args)
+      end
+
+      def service_delete(*args)
+        logged_service_call(:delete, *args)
       end
 
+      def logged_service_call(method, *args)
+        Rails.logger.debug("Making service call #{method} #{args}")
+        response = HTTParty.send(method, *args)
+        Rails.logger.debug("Got status #{response.code} for service call #{method} #{args}")
+
+        if response.body.present? && response.success?
+          parsed_body = JSON.parse(response.body)
+        end
+
+        if !response.success? && response.code != 404
+          Rails.logger.error("Encountered an error while making service request #{method} #{args}")
+          Rails.logger.error("Got code #{response.code}")
+          Rails.logger.error(response.body)
+        end
+
+        [response, parsed_body]
+      rescue JSON::ParserError => e
+        # We do not reraise this error as previously we did not check at all for valid json. This is purely for
+        # logging purposes.
+        Rails.logger.error("Encountered an error while parsing response for service request #{method} #{args}")
+        Rails.logger.error(response.body)
+        Rails.logger.error(e)
+
+        [response, nil]
+      rescue StandardError => e
+        Rails.logger.error("Encountered an error while making service request #{method} #{args}")
+        Rails.logger.error(response&.body)
+        Rails.logger.error(e)
+
+        raise e
+      end
     end
   end
 end

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

@@ -60,16 +60,33 @@ module AtomicLti
 
       # List line items
       # Canvas: https://canvas.beta.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.index
-      def list(query = {})
+      def list(query = {}, page_url: nil)
+        url = if page_url.present?
+                page_url
+              else
+                uri = Addressable::URI.parse(endpoint(@id_token_decoded))
+                uri.query_values = (uri.query_values || {}).merge(query)
+                uri.to_str
+              end
+
         accept = { "Accept" => "application/vnd.ims.lis.v2.lineitemcontainer+json" }
-        HTTParty.get(endpoint(@id_token_decoded), headers: headers(accept), query: query)
+        response, = service_get(url, headers: headers(accept))
+        response
+      end
+
+      def list_all(query = {})
+        AtomicLti::PagingHelper.paginate_request do |next_link|
+          result_page = list(query, page_url: next_link)
+          [JSON.parse(result_page.body), get_next_url(result_page)]
+        end
       end
 
       # Get a specific line item
       # https://canvas.beta.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.show
       def show(line_item_url)
         accept = { "Accept" => "application/vnd.ims.lis.v2.lineitem+json" }
-        HTTParty.get(line_item_url, headers: headers(accept))
+        response, = service_get(line_item_url, headers: headers(accept))
+        response
       end
 
       # Create a line item
@@ -77,18 +94,21 @@ module AtomicLti
       # Canvas: https://canvas.beta.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.create
       def create(attrs = nil)
         content_type = { "Content-Type" => "application/vnd.ims.lis.v2.lineitem+json" }
-        HTTParty.post(endpoint(@id_token_decoded), body: JSON.dump(attrs), headers: headers(content_type))
+        response, = service_post(endpoint(@id_token_decoded), body: JSON.dump(attrs), headers: headers(content_type))
+        response
       end
 
       # Update a line item
       # Canvas: https://canvas.beta.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.update
       def update(line_item_url, attrs)
         content_type = { "Content-Type" => "application/vnd.ims.lis.v2.lineitem+json" }
-        HTTParty.put(line_item_url, body: JSON.dump(attrs), headers: headers(content_type))
+        response, = service_put(line_item_url, body: JSON.dump(attrs), headers: headers(content_type))
+        response
       end
 
       def delete(line_item_url)
-        HTTParty.delete(line_item_url, headers: headers)
+        response, = service_delete(line_item_url, headers: headers)
+        response
       end
     end
   end

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

@@ -49,16 +49,29 @@ module AtomicLti
                 uri.query_values = (uri.query_values || {}).merge(query)
                 uri.to_str
               end
-        verify_received_user_names(
-          HTTParty.get(
-            url,
-            headers: headers(
-              {
-                "Accept" => "application/vnd.ims.lti-nrps.v2.membershipcontainer+json",
-              },
-            ),
+        response, = service_get(
+          url,
+          headers: headers(
+            {
+              "Accept" => "application/vnd.ims.lti-nrps.v2.membershipcontainer+json",
+            },
           ),
         )
+
+        verify_received_user_names(response)
+      end
+
+      def list_all(query: {})
+        page_body = nil
+
+        members = AtomicLti::PagingHelper.paginate_request do |next_link|
+          result_page = list(query: query, page_url: next_link)
+          page_body = JSON.parse(result_page.body)
+          [page_body["members"], get_next_url(result_page)]
+        end
+
+        page_body["members"] = members
+        page_body
       end
 
       def verify_received_user_names(names_and_roles_memberships)

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

@@ -7,14 +7,30 @@ module AtomicLti
         [AtomicLti::Definitions::AGS_SCOPE_RESULT]
       end
 
-      def list(line_item_id)
-        url = "#{line_item_id}/results"
-        HTTParty.get(url, headers: headers)
+      def list(line_item_id, query: {}, page_url: nil)
+        url = if page_url.present?
+                page_url
+              else
+                uri = Addressable::URI.parse("#{line_item_id}/results")
+                uri.query_values = (uri.query_values || {}).merge(query)
+                uri.to_str
+              end
+
+        accept = { "Accept" => "application/vnd.ims.lis.v2.resultcontainer+json" }
+        response, = service_get(url, headers: headers(accept))
+        response
+      end
+
+      def list_all(line_item_id, query: {})
+        AtomicLti::PagingHelper.paginate_request do |next_link|
+          result_page = list(line_item_id, query: query, page_url: next_link)
+          [JSON.parse(result_page.body), get_next_url(result_page)]
+        end
       end
 
-      def show(line_item_id, result_id)
-        url = "#{line_item_id}/results/#{result_id}"
-        HTTParty.get(url, headers: headers)
+      def show(result_id)
+        response, = service_get(result_id, headers: headers)
+        response
       end
 
     end

data/lib/atomic_lti/open_id_middleware.rb

@@ -190,7 +190,7 @@ module AtomicLti
         state_verified: state_verified,
       }
 
-      if !state_verified && request.params["lti_storage_target"].present? && AtomicLti.use_post_message_storage
+      if !state_verified && AtomicLti.use_post_message_storage
         env["atomic.validated.state_validation"][:lti_storage_params] =
           build_lti_storage_params(request, platform)
       end
@@ -361,7 +361,7 @@ module AtomicLti
         target: request.params["lti_storage_target"],
         originSupportBroken: !AtomicLti.set_post_message_origin,
         platformOIDCUrl: platform.oidc_url,
-      }
+      }.compact
     end
   end
 end

data/lib/atomic_lti/version.rb

@@ -1,3 +1,3 @@
 module AtomicLti
-  VERSION = "1.5.7".freeze
+  VERSION = "1.6.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic_lti
 version: !ruby/object:Gem::Version
-  version: 1.5.7
+  version: 1.6.0
 platform: ruby
 authors:
 - Matt Petro
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -71,6 +71,7 @@ files:
 - app/lib/atomic_lti/exceptions.rb
 - app/lib/atomic_lti/lti.rb
 - app/lib/atomic_lti/open_id.rb
+- app/lib/atomic_lti/paging_helper.rb
 - app/lib/atomic_lti/params.rb
 - app/lib/atomic_lti/role_enforcement_mode.rb
 - app/lib/atomic_lti/services/base.rb
@@ -132,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: AtomicLti implements the LTI Advantage specification.