strongmind-platform-sdk 3.19.31 → 3.19.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 743bf8f25edcef7c341af1d9598f40ac368e986cb93392f84f03b6424543c256
-  data.tar.gz: 502e70faec7680e7dcb701c1db36e1d5f9be1327b3c672adb7d517538074ce09
+  metadata.gz: e802eae6706b8b1575aea870fa85dc1f4d8d230ee76c7c4346168838f669ddfc
+  data.tar.gz: de43fb4b077de0eb7360f541d3c146f4c53102ac30337bf6591b4b76c7af3a85
 SHA512:
-  metadata.gz: a78544838ee3e0f0af687a97c39e200fe931e54199fa338bdaa0fbebbf3893e0caf64f21fa37c39b7b27473eb6a17dd2eedf3a69fd43658485ad6c97bc328f75
-  data.tar.gz: 6342ec70213b1416ed58134d5c6049064e58f6780dfc7cffeb5b8c6d3cdf0479e66e07caba4d630a3569baae6e8f71d9a920a3ce70628ba491292494b88db6ae
+  metadata.gz: ff125a6616567e8a2f03d66e49ecc90b776d1a38602a6dd233b70722abc63b5abd0d1d834e47dd2dc9890a00cf7f7b6aa27f66b90d68635d8ae5907e41944ff6
+  data.tar.gz: 80593443c2106b6db3c18792472a8292fe19b3bea3a2a1049ca2377083ff722fe1ac4a621adfc32a01f18807c2b886b22348d9e5f55cdc35da204a9bf848d7ea

data/Gemfile

@@ -10,6 +10,7 @@ gemspec
 
 gem "faraday"
 gem "faraday-retry"
+gem "faraday-multipart"
 gem "jwt", "~> 1.5", ">= 1.5.4"
 gem "learnosity-sdk", "~> 0.2.2"
 gem "multi_json"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strongmind-platform-sdk (3.19.31)
+    strongmind-platform-sdk (3.19.33)
       activesupport (~> 7.1)
       asset_sync
       aws-sdk-secretsmanager (~> 1.66)
@@ -96,18 +96,18 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    asset_sync (2.19.1)
+    asset_sync (2.19.2)
       activemodel (>= 4.1.0)
       fog-core
       mime-types (>= 2.99)
       unf
     ast (2.4.2)
     aws-eventstream (1.3.0)
-    aws-partitions (1.968.0)
+    aws-partitions (1.970.0)
     aws-sdk-cloudwatch (1.97.0)
       aws-sdk-core (~> 3, >= 3.201.0)
       aws-sigv4 (~> 1.5)
-    aws-sdk-core (3.201.5)
+    aws-sdk-core (3.202.2)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.651.0)
       aws-sigv4 (~> 1.9)
@@ -141,6 +141,8 @@ GEM
     faraday (2.10.0)
       faraday-net_http (>= 2.0, < 3.2)
       logger
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (3.1.1)
       net-http
     faraday-retry (2.2.1)
@@ -148,7 +150,8 @@ GEM
     ffi (1.17.0)
     ffi (1.17.0-x86_64-darwin)
     ffi (1.17.0-x86_64-linux-gnu)
-    fog-aws (3.24.0)
+    fog-aws (3.25.0)
+      base64 (~> 0.2.0)
       fog-core (~> 2.1)
       fog-json (~> 1.1)
       fog-xml (~> 0.1)
@@ -197,10 +200,11 @@ GEM
     mini_portile2 (2.8.7)
     minitest (5.24.1)
     multi_json (1.15.0)
+    multipart-post (2.4.1)
     mutex_m (0.2.0)
     net-http (0.4.1)
       uri
-    net-imap (0.4.14)
+    net-imap (0.4.15)
       date
       net-protocol
     net-pop (0.1.2)
@@ -364,6 +368,7 @@ DEPENDENCIES
   factory_bot
   faker
   faraday
+  faraday-multipart
   faraday-retry
   jwt (~> 1.5, >= 1.5.4)
   learnosity-sdk (~> 0.2.2)

data/lib/platform_sdk/canvas_api/client.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "faraday/multipart"
+
 
 module PlatformSdk
   module CanvasApiWrapper
     # DataPipeline::Client
     class Client
-      attr_reader :host, :token, :connection
+      attr_reader :host, :token, :connection, :multipart_connection
 
       PAGE_SIZE = 10
 
@@ -16,6 +18,10 @@ module PlatformSdk
         @host = "https://#{domain}"
         @token = token
         @connection = Faraday.new(url: host, headers: { 'Authorization' => "Bearer #{token}" })
+        @multipart_connection = Faraday.new(url: host, headers: { 'Authorization' => "Bearer #{token}" }) do |f|
+          f.request :multipart
+          f.adapter :net_http
+        end
       end
 
       # @param course_id [Integer]
@@ -209,9 +215,8 @@ module PlatformSdk
 
       # @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)
+        uri = "/api/v1/courses/#{course_id}/students?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
@@ -225,6 +230,23 @@ module PlatformSdk
         end
       end
 
+      # @param course_id [Integer]
+      def course_users(course_id:)
+        uri = "/api/v1/courses/#{course_id}/users?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 = String.new
+          result[:errors].each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error getting course users: #{error_messages}"
+        end
+      end
+
       # @param course_id [Integer]
       # @param quiz_id [Integer]
       def quiz(course_id:, quiz_id:)
@@ -348,6 +370,44 @@ module PlatformSdk
         end
       end
 
+      # @param course_id [Integer]
+      # @param module_id [Integer]
+      def put_relock_module(course_id:, module_id:)
+        uri = "api/v1/courses/#{course_id}/modules/#{module_id}/relock"
+        response = @connection.put(uri)
+        result = MultiJson.load response.body, symbolize_keys: true
+        handle_rate_limiting response
+        if success?(response.status)
+          result
+        else
+          error_message = parse_response_errors(result:, message: 'Error re-locking module')
+          raise CanvasClientError, error_message
+        end
+      end
+
+      # @param course_id [Integer]
+      # @param module_id [Integer]
+      # @param prerequisite_ids [Array<Integer>]
+      # @note prerequisite_ids should be a valid module_id, sending and empty array removes all prerequisites.
+      def put_module_prerequesites(course_id:, module_id:, prerequisite_ids:)
+        uri = "/api/v1/courses/#{course_id}/modules/#{module_id}"
+        response = @multipart_connection.put(uri) do |req|
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.body = { 'module[prerequisite_module_ids]' => prerequisite_ids }
+        end
+        handle_rate_limiting response
+        result = MultiJson.load response.body, symbolize_keys: true
+        if success?(response.status)
+          result
+        else
+          error_messages = String.new
+          result[:errors]&.each do |error|
+            error_messages << "#{error[:message]} "
+          end
+          raise "Error updating module prerequisite: #{error_messages}"
+        end
+      end
+
       private
 
       # @param headers [Faraday::Utils::Headers]
@@ -408,14 +468,14 @@ module PlatformSdk
       # @param message [String]
       def handle_post_response_errors(response, message)
         result = MultiJson.load response.body, symbolize_keys: true
-        raise PlatformSdk::CanvasApiWrapper::Client::LockedModuleItemError, "#{message}: #{result[:message]}" if response.status == 403
-        raise PlatformSdk::CanvasApiWrapper::Client::MissingModuleItemError, "#{message}: #{result[:message]}" if response.status == 404
-        raise PlatformSdk::CanvasApiWrapper::Client::CanvasClientError, parse_response_errors(message:, result:)
+        raise LockedModuleItemError, "#{message}: #{result[:message]}" if response.status == 403
+        raise MissingModuleItemError, "#{message}: #{result[:message]}" if response.status == 404
+        raise CanvasClientError, parse_response_errors(message:, result:)
       end
     end
 
-    class Client::CanvasClientError < StandardError; end
-    class Client::LockedModuleItemError < Client::CanvasClientError; end
-    class Client::MissingModuleItemError < Client::CanvasClientError; end
+    class CanvasClientError < StandardError; end
+    class LockedModuleItemError < CanvasClientError; end
+    class MissingModuleItemError < CanvasClientError; end
   end
 end

data/lib/platform_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlatformSdk
-  VERSION = '3.19.31'
+  VERSION = '3.19.33'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-platform-sdk
 version: !ruby/object:Gem::Version
-  version: 3.19.31
+  version: 3.19.33
 platform: ruby
 authors:
 - Platform Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday