strongmind-platform-sdk 3.9.5 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b4fc00d20bef3777e4dcd73f70fc3e62dada68543055d9bb0cd163178eaca35
-  data.tar.gz: 1a1cdfe41e25b06baee0682c6da24c05786962342a2cb90fe1e63172e368c9b8
+  metadata.gz: 2255b872c20eeb033920fa418c2bb7986ca2d4857fc920a61f2d8fd64c9053b6
+  data.tar.gz: 884e3636bc8381f7f083a95875a6596e3f24f9b1152abb2c45ce0613b73dd305
 SHA512:
-  metadata.gz: adbd7f3a16cf4eaa8e62969eeea2dc677b1ea26d5603e95989079405e86452c2a39ed76d8155596ba656fc95ea4e354aea84293da557ecbd493846887ce9c2d6
-  data.tar.gz: f2af566a32ead069f0b33d7b8bb6a1784d995f5e4a912abce0a9eb6dc7b030976622ef5fe6893570493b5b3a588606a14a67279a10f6f5b7e57cd2b721f90ead
+  metadata.gz: 33b930fd8737f76287c5f781f61f27f766156019bbc9dcc4a0cd596dfe28499cb39cb99cd52c04405c8fa0e7fed068786ef47a847c09310174687ea7e2f35abf
+  data.tar.gz: 65e2ed64748ebe2b6c76fb9fa7262a31611384af3d2a2a0c035d1103936e994e24adefdd4409259bb3ae022a6b640ba37f2c0e029acd4516d2b26d94b320d8b5

data/Gemfile

@@ -14,7 +14,10 @@ gem "faraday"
 gem "faraday-retry"
 gem "jwt", "~> 1.5", ">= 1.5.4"
 gem "learnosity-sdk", "~> 0.2.2"
+gem "multi_json"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.6", ">= 3.6.0"
 gem "rubocop"
 gem 'sentry-ruby'
+gem "webmock"
+

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    strongmind-platform-sdk (3.9.5)
+    strongmind-platform-sdk (3.10.0)
       aws-sdk-secretsmanager (~> 1.66)
       devise
       faraday (~> 2.5, >= 2.5.2)
       faraday-retry
       jwt
       learnosity-sdk (~> 0.2.2)
+      multi_json
       omniauth
       omniauth-rails_csrf_protection
       omniauth_openid_connect
@@ -38,15 +39,18 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     aes_key_wrap (1.1.0)
     ast (2.4.2)
     attr_required (1.0.2)
     aws-eventstream (1.3.0)
-    aws-partitions (1.890.0)
-    aws-sdk-core (3.191.1)
+    aws-partitions (1.893.0)
+    aws-sdk-core (3.191.2)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.651.0)
       aws-sigv4 (~> 1.8)
+      base64
       jmespath (~> 1, >= 1.6.1)
     aws-sdk-secretsmanager (1.90.0)
       aws-sdk-core (~> 3, >= 3.191.0)
@@ -55,9 +59,13 @@ GEM
       aws-eventstream (~> 1, >= 1.0.2)
     base64 (0.2.0)
     bcrypt (3.1.20)
-    bindata (2.4.15)
+    bigdecimal (3.1.6)
+    bindata (2.5.0)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
+    crack (1.0.0)
+      bigdecimal
+      rexml
     crass (1.0.6)
     date (3.3.4)
     devise (4.9.3)
@@ -85,6 +93,7 @@ GEM
     faraday-retry (2.1.0)
       faraday (~> 2.0)
     ffi (1.15.5)
+    hashdiff (1.1.0)
     hashie (5.0.0)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
@@ -112,6 +121,7 @@ GEM
     mini_mime (1.1.5)
     mini_portile2 (2.8.5)
     minitest (5.18.0)
+    multi_json (1.15.0)
     net-imap (0.4.10)
       date
       net-protocol
@@ -247,6 +257,10 @@ GEM
       activesupport
       faraday (~> 2.0)
       faraday-follow_redirects
+    webmock (3.22.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     zeitwerk (2.6.13)
 
 PLATFORMS
@@ -261,12 +275,14 @@ DEPENDENCIES
   faraday-retry
   jwt (~> 1.5, >= 1.5.4)
   learnosity-sdk (~> 0.2.2)
+  multi_json
   rake (~> 13.0)
   rspec (~> 3.6, >= 3.6.0)
   rubocop
   sentry-ruby
   strongmind-oneroster-client (~> 2.0.3)
   strongmind-platform-sdk!
+  webmock
 
 BUNDLED WITH
    2.3.16

data/lib/platform_sdk/canvas_api/client.rb

@@ -0,0 +1,412 @@
+# frozen_string_literal: true
+require "faraday"
+
+module PlatformSdk
+  module CanvasApiWrapper
+    # DataPipeline::Client
+    class Client
+      attr_reader :host, :token, :connection
+
+      PAGE_SIZE = 10
+
+      # @param domain [String]
+      # @param token [String]
+      def initialize(domain:, token:)
+        @host = "https://#{domain}"
+        @token = token
+        @connection = Faraday.new(url: host, headers: { 'Authorization' => "Bearer #{token}" })
+      end
+
+      # @param course_id [Integer]
+      # @returns [Array]
+      def course_modules(course_id:)
+        response = @connection.get("/api/v1/courses/#{course_id}/modules")
+        handle_rate_limiting response
+        if success?(response.status)
+          paginated_items headers: response.headers, initial_response: response.body
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting course modules: #{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param module_id [Integer]
+      # @returns [Array]
+      def module_items(course_id:, module_id:)
+        response = @connection.get("/api/v1/courses/#{course_id}/modules/#{module_id}/items?per_page=#{PAGE_SIZE}")
+        handle_rate_limiting response
+        if success?(response.status)
+          paginated_items headers: response.headers, initial_response: response.body
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting module items: #{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param module_id [Integer]
+      # @param user_id [Integer]
+      # @returns [Array]
+      def user_module_items(course_id:, module_id:, user_id:)
+        uri = "/api/v1/courses/#{course_id}/modules/#{module_id}/items?as_user_id=#{user_id}&per_page=#{PAGE_SIZE}"
+        response = @connection.get(uri)
+        handle_rate_limiting response
+        if success?(response.status)
+          paginated_items headers: response.headers, initial_response: response.body
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting module items: #{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param module_id [Integer]
+      # @returns [Array]
+      def assignments(course_id:, module_id:)
+        response = @connection.get("/api/v1/courses/#{course_id}/modules/#{module_id}/items?per_page=#{PAGE_SIZE}")
+        handle_rate_limiting response
+        if success?(response.status)
+          assignments = paginated_items headers: response.headers, initial_response: response.body
+          assignments.select { |item| item[:type] == 'Assignment' }
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting assignments: #{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      def assignment(course_id:, assignment_id:)
+        uri = "api/v1/courses/#{course_id}/assignments/#{assignment_id}"
+        response = @connection.get(uri)
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting quiz submissions#{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param module_id [Integer]
+      # @param module_item_id [Integer]
+      def module_item(course_id:, module_id:, module_item_id:)
+        response = @connection.get("/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}")
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting module item: #{error_messages}"
+        end
+      end
+
+      def user_module_item(course_id:, module_id:, module_item_id:, user_id:)
+        response = @connection.get("/api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}?as_user_id=#{user_id}")
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting module item: #{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param assignment_id [Integer]
+      def submissions(course_id:, assignment_id:)
+        response = @connection.get("/api/v1/courses/#{course_id}/assignments/#{assignment_id}/submissions/")
+        handle_rate_limiting response
+        if success?(response.status)
+          paginated_items headers: response.headers, initial_response: response.body
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting submissions: #{error_messages}"
+        end
+      end
+
+      def update_submission_excused(course_id:, assignment_id:, user_id:)
+        uri = "/api/v1/courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}"
+        response = @connection.put(uri) do |req|
+          req.headers["Content-Type"] = "application/json"
+          req.body = {
+            submission: {
+              excuse: true
+            }
+          }.to_json
+        end
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error update submissions to excused: #{error_messages}"
+        end
+      end
+
+      def update_submission_excused_with_comment(course_id:, assignment_id:, user_id:, comment:)
+        uri = "/api/v1/courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}"
+        response = @connection.put(uri) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = {
+            'comment': {
+              'text_comment': comment
+            },
+            'submission': {
+              'excuse': true
+            }
+          }.to_json
+        end
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error update submissions to excused: #{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      def course_students(course_id:)
+        uri = "/api/v1/courses/#{course_id}/users?per_page=#{PAGE_SIZE}"
+        params = { 'enrollment_type[]' => 'student' }
+        response = @connection.get(uri, params)
+        handle_rate_limiting response
+        if success?(response.status)
+          paginated_items headers: response.headers, initial_response: response.body
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting course students: #{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param quiz_id [Integer]
+      def quiz(course_id:, quiz_id:)
+        uri = "/api/v1/courses/#{course_id}/quizzes/#{quiz_id}"
+        response = @connection.get(uri)
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting quiz: #{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param quiz_id [Integer]
+      # @param user_id [Integer]
+      # @return [Array]
+      def quiz_submissions(course_id:, quiz_id:, user_id:)
+        uri = "api/v1/courses/#{course_id}/quizzes/#{quiz_id}/submissions?user=#{user_id}&per_page=#{PAGE_SIZE}"
+        response = @connection.get(uri)
+        handle_rate_limiting response
+        if success?(response.status)
+          paginated_items headers: response.headers, initial_response: response.body
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting quiz submissions#{error_messages}"
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param quiz_id [Integer]
+      # @param user_id [Integer]
+      def post_create_quiz_submission(course_id:, quiz_id:, user_id:)
+        uri = "api/v1/courses/#{course_id}/quizzes/#{quiz_id}/submissions?as_user_id=#{user_id}"
+        response = @connection.post(uri)
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          message = 'Error creating quiz submission'
+          if response.status == 403
+            raise "#{message}: #{result[:message]}"
+          end
+          if result[:errors]
+            raise parse_response_errors message:, result:
+          end
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param quiz_id [Integer]
+      # @param submission_id [Integer]
+      # @param attempt [Integer]
+      # @param validation_token [String]
+      # @return [Hash]
+      def post_complete_quiz_submission(course_id:, quiz_id:, submission_id:, attempt:, validation_token:)
+        uri = "api/v1/courses/#{course_id}/quizzes/#{quiz_id}/submissions/#{submission_id}/complete"
+        response = @connection.post(uri) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = { attempt:, validation_token: }.to_json
+        end
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          message = 'Error completing quiz submission'
+          if response.status == 403
+            raise "#{message}: #{result[:message]}"
+          end
+          if result[:errors]
+            raise parse_response_errors message:, result:
+          end
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param module_id [Integer]
+      # @param module_item_id [Integer]
+      # @param user_id [Integer]
+      # @return nil
+      def post_mark_module_item_read(course_id:, module_id:, module_item_id:, user_id:)
+        uri = "api/v1/courses/#{course_id}/modules/#{module_id}/items/#{module_item_id}/mark_read?as_user_id=#{user_id}"
+        response = @connection.post(uri)
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          message = 'Error marking module items read'
+          if response.status == 403
+            raise "#{message}: #{result[:message]}"
+          end
+          if result[:errors]
+            raise parse_response_errors message:, result:
+          end
+        end
+      end
+
+      def post_discussion_topic_entry(course_id:, topic_id:, user_id:, message:)
+        uri = "api/v1/courses/#{course_id}/discussion_topics/#{topic_id}/entries?as_user_id=#{user_id}"
+        response = @connection.post(uri) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.body = { 'message': message.to_s }.to_json
+        end
+        handle_rate_limiting response
+        if success?(response.status)
+          MultiJson.load response.body, symbolize_keys: true
+        else
+          result = MultiJson.load response.body, symbolize_keys: true
+          error_messages = ''
+          result[:errors]&.each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error posting a reply: #{error_messages}"
+        end
+      end
+
+      private
+
+      # @param headers [Faraday::Utils::Headers]
+      # @return [Array]
+      def paginated_items(headers:, initial_response:)
+        pages = page_links(headers:)
+        items = []
+        items.append MultiJson.load(initial_response, symbolize_keys: true)
+        while pages[:current] != pages[:last]
+          response = @connection.get(pages[:next][:url])
+          handle_rate_limiting response
+          pages = page_links(headers: response.headers)
+          items.append MultiJson.load(response.body, symbolize_keys: true)
+        end
+        items.flatten
+      end
+
+      # @param headers [Faraday::Utils::Headers]
+      # @return [Hash]
+      def page_links(headers:)
+        parts = headers[:link].split(',')
+        parts.map do |part, _|
+          section = part.split(';')
+          name = section[1][/rel="(.*)"/, 1].to_sym
+          url = section[0][/<(.*)>/, 1]
+          [name, { url: }]
+        end.to_h
+      end
+
+      # @param response_code [Integer]
+      # @return [Boolean]
+      def success?(response_code)
+        !!(response_code.to_s =~ /2[0-9]/)
+      end
+
+      # @param message [String]
+      # @param result [Hash]
+      # @return [String]
+      def parse_response_errors(message:, result:)
+        error_messages = ''
+        result[:errors].each do |error|
+          error_messages << "#{error[:message]} "
+        end
+        "#{message}: {#{error_messages}"
+      end
+
+      def handle_rate_limiting(response)
+        remaining_requests = response.headers["X-Rate-Limit-Remaining"].to_i
+        reset_time = response.headers["X-Rate-Limit-Reset"].to_i
+
+        return unless remaining_requests.zero?
+
+        sleep_time = [reset_time - Time.now.to_i, 0].max + 1
+        sleep(sleep_time)
+      end
+    end
+  end
+end

data/lib/platform_sdk/canvas_api.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/net_http"
+require "faraday/retry"
+require "platform_sdk/canvas_api/client"
+
+module PlatformSdk
+  module CanvasApiWrapper
+    class Error < StandardError; end
+
+
+  end
+end

data/lib/platform_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlatformSdk
-  VERSION = "3.9.5"
+  VERSION = "3.10.0"
 end

data/lib/platform_sdk.rb

@@ -11,6 +11,8 @@ require "platform_sdk/data_pipeline"
 require "platform_sdk/pencil_spaces"
 require "platform_sdk/edfi"
 require "platform_sdk/sentry"
+require "platform_sdk/learnosity_api"
+require "platform_sdk/canvas_api"
 
 module PlatformSdk
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-platform-sdk
 version: !ruby/object:Gem::Version
-  version: 3.9.5
+  version: 3.10.0
 platform: ruby
 authors:
 - Platform Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -184,6 +184,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Includes a wrapper for the swagger generated OneRoster management clients
 email:
 - horseshoes@strongmind.com
@@ -214,6 +228,8 @@ files:
 - lib/platform_sdk.rb
 - lib/platform_sdk/aws.rb
 - lib/platform_sdk/aws/secrets_manager_client.rb
+- lib/platform_sdk/canvas_api.rb
+- lib/platform_sdk/canvas_api/client.rb
 - lib/platform_sdk/data_pipeline.rb
 - lib/platform_sdk/data_pipeline/data_pipeline_client.rb
 - lib/platform_sdk/edfi.rb