strongmind-platform-sdk 3.19.30 → 3.19.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99cb6793a19a83ca3efad9083a259ccf17b15fe1d64f3ac4a824964ac5e0bcc1
-  data.tar.gz: 9765e4699c62939e57e328bebd72316a0eb26102cd3a994f92af7d1ebef253bc
+  metadata.gz: 220721704b3493784c6916cd60d381e82c6c581c0882de3afdce1bfeed4daa09
+  data.tar.gz: 6af5b9ec2711a28f202bcdde4f7b997633cfef6f3a0c500f272bec13d2ceb8a1
 SHA512:
-  metadata.gz: a6490fd12ee607dcad600c9e5098da6561c757a50b9d0ab83be81d112c6d8865d638d8ea32faea512a5bd924b192efa1cdd87a66702acce4e3d8d86275dc9c9f
-  data.tar.gz: 969ac7c437f12e2d91a8e4c5bdbae2a9dc01f2e15f40177d69110c8214cb574edf6dd1992750e955d44affc8aba0f37dee73907d1091720ca9ce14586e42b4d2
+  metadata.gz: eef3bdb74b5b1d66a8db6032017c379cf125b47b3f1e9cbc1ff5398fef3c2548fb87c7cafae85d0f295f96debc8c09351b29827ea4bb3e12b01fe0ab9bb868da
+  data.tar.gz: 6dc5553e6b644e25a0b19e598e08d260e61648a91d5dc3873fcb4d64daa26dd322875808330d76d39d62b076b2948add4204aeb9feb39678adb3ae6ea93ec1d8

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.30)
+    strongmind-platform-sdk (3.19.32)
       activesupport (~> 7.1)
       asset_sync
       aws-sdk-secretsmanager (~> 1.66)
@@ -96,21 +96,21 @@ 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.962.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.3)
+    aws-sdk-core (3.202.2)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.651.0)
-      aws-sigv4 (~> 1.8)
+      aws-sigv4 (~> 1.9)
       jmespath (~> 1, >= 1.6.1)
     aws-sdk-secretsmanager (1.102.0)
       aws-sdk-core (~> 3, >= 3.201.0)
@@ -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)
@@ -192,15 +195,16 @@ GEM
     method_source (1.1.0)
     mime-types (3.5.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2024.0806)
+    mime-types-data (3.2024.0820)
     mini_mime (1.1.5)
     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)
@@ -314,7 +318,7 @@ GEM
     sentry-ruby (5.18.2)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
-    sidekiq (7.3.0)
+    sidekiq (7.3.1)
       concurrent-ruby (< 2)
       connection_pool (>= 2.3.0)
       logger
@@ -341,9 +345,7 @@ GEM
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.9.1)
+    unf (0.2.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
     webmock (3.23.1)
@@ -366,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/active_record/data_pipelineable.rb

@@ -9,7 +9,7 @@ module PlatformSdk
       included do
         after_create :send_pipeline_create
         before_destroy :send_pipeline_destroy
-        after_update :send_pipeline_update
+        after_update :send_pipeline_update, if: -> { saved_changes? }
       end
 
       def send_pipeline_create
@@ -55,9 +55,9 @@ module PlatformSdk
 
       def pipeline_data(action)
         attributes.symbolize_keys
-          .merge(pipeline_additional_attributes)
-          .except(*pipeline_excluded_attributes)
-          .merge(action:)
+                  .merge(pipeline_additional_attributes)
+                  .except(*pipeline_excluded_attributes)
+                  .merge(action:)
       end
 
       def pipeline_additional_attributes

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]
@@ -348,6 +354,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 +452,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/spec_support/shared_examples/data_pipelineable_examples.rb

@@ -1,6 +1,7 @@
 module PlatformSdk
   module SpecSupport
-    RSpec.shared_examples "DataPipelineable" do
+    RSpec.shared_examples 'DataPipelineable' do |params = {}|
+      let(:shared_params) { params }
       let(:record) { build(described_class.to_s.underscore.to_sym) }
       let(:data_pipeline_client) { double(PlatformSdk::DataPipeline::Client) }
 
@@ -12,41 +13,76 @@ module PlatformSdk
 
       after { Timecop.return }
 
-      context 'after_create callbacks' do
-        before { allow(record).to receive(:send_pipeline_create) }
+      context 'create' do
 
-        it "defines an after_create callback" do
+        it 'posts a copy of our data to the data pipeline' do
           record.save!
-          expect(record).to have_received(:send_pipeline_create)
+          expect(data_pipeline_client).to have_received(:post).once.with(hash_including(
+                                                                           noun: described_class.pipeline_noun,
+                                                                           data: record.pipeline_data('created'),
+                                                                           meta: described_class.pipeline_meta,
+                                                                           envelope_version: '1.0.0',
+                                                                           message_timestamp: Time.current.utc.iso8601,
+                                                                           identifiers: { id: record.id },
+                                                                         ))
         end
       end
 
-      context 'before_destroy callbacks' do
-        before do
-          allow(record).to receive(:send_pipeline_create)
-          allow(record).to receive(:send_pipeline_destroy)
-        end
+      context 'destroy' do
 
-        it "defines an after_destroy callback" do
+        it 'posts a copy of our data to the data pipeline' do
           record.save!
           record.destroy
 
-          expect(record).to have_received(:send_pipeline_create)
-          expect(record).to have_received(:send_pipeline_destroy)
+          expect(data_pipeline_client).to have_received(:post).once.with(hash_including(
+                                                                           noun: described_class.pipeline_noun,
+                                                                           data: record.pipeline_data('destroyed'),
+                                                                           meta: described_class.pipeline_meta,
+                                                                           envelope_version: '1.0.0',
+                                                                           message_timestamp: Time.current.utc.iso8601,
+                                                                           identifiers: { id: record.id }
+                                                                         ))
         end
       end
 
-      context 'after_update callbacks' do
+      context 'update' do
         before do
-          allow(record).to receive(:send_pipeline_update)
           record.save!
         end
 
-        it "defines an after_update callback" do
-          column = column_to_update(record)
-          unless column.nil?
+        context 'after an update' do
+          it 'posts a copy of our data to the data pipeline' do
+            column = column_to_update(record)
+            unless column.nil?
+              update_record(record, column)
+              expect(data_pipeline_client).to have_received(:post).once.with(hash_including(
+                                                                               noun: described_class.pipeline_noun,
+                                                                               data: record.pipeline_data('modified'),
+                                                                               meta: described_class.pipeline_meta,
+                                                                               envelope_version: '1.0.0',
+                                                                               message_timestamp: Time.current.utc.iso8601,
+                                                                               identifiers: { id: record.id },
+                                                                             ))
+            end
+          end
+        end
+
+        context 'after an update that does not change data' do
+          let(:action) { 'modified' }
+
+          it 'does not post to the data pipeline' do
+            record.save!
+            column = column_to_update(record)
             update_record(record, column)
-            expect(record).to have_received(:send_pipeline_update)
+            record.save!
+            expect(data_pipeline_client).to have_received(:post).once.with(hash_including(
+                                                                             noun: described_class.pipeline_noun,
+                                                                             data: record.pipeline_data('modified'),
+                                                                             meta: described_class.pipeline_meta,
+                                                                             envelope_version: '1.0.0',
+                                                                             message_timestamp: Time.current.utc.iso8601,
+                                                                             identifiers: { id: record.id }
+                                                                           ))
           end
         end
       end
@@ -60,13 +96,18 @@ module PlatformSdk
       end
 
       def update_record(record, column)
+        if shared_params[:update_method]
+          send(shared_params[:update_method], record)
+          return
+        end
         new_record = build(described_class.to_s.underscore.to_sym)
 
-        column_class = record[column]
-        case column_class
-        when Integer
+        column_value = record[column]
+        column_class = column_value.class
+        case column_class.to_s
+        when 'Integer'
           record.update!(column => 69)
-        when [true, false].include?(column_class)
+        when 'TrueClass', 'FalseClass'
           record.update!(column => !record[column])
         else
           record.update!(column => new_record[column])
@@ -90,9 +131,9 @@ module PlatformSdk
 
             let(:data) do
               record.attributes.symbolize_keys
-                .merge(record.pipeline_additional_attributes)
-                .except(*record.pipeline_excluded_attributes)
-                .merge(action:)
+                    .merge(record.pipeline_additional_attributes)
+                    .except(*record.pipeline_excluded_attributes)
+                    .merge(action:)
             end
 
             it 'returns the expected payload' do

data/lib/platform_sdk/spec_support/shared_examples/one_roster_data_pipelineable_examples.rb

@@ -2,10 +2,10 @@
 
 module PlatformSdk
   module SpecSupport
-    RSpec.shared_examples "OneRosterDataPipelineable" do |record_keys|
+    RSpec.shared_examples 'OneRosterDataPipelineable' do |record_keys|
       let(:data) do
         record_keys.each_with_object({}) do |key, hash|
-          if key == "_type"
+          if key == '_type'
             hash[:type] = record.try(key)
             next
           end
@@ -17,11 +17,11 @@ module PlatformSdk
           "noun": "StrongMind.Platform.OneRoster.#{record.one_roster_data_type.capitalize}",
           "identifiers": { "sourcedId": record.roster_id },
           "meta": {
-            "version": "3",
-            "source": "Central OneRoster API"
+            "version": '3',
+            "source": 'Central OneRoster API'
           },
           "data": one_roster_common_data.merge!(data),
-          "envelope_version": "1.0.0",
+          "envelope_version": '1.0.0',
           "message_timestamp": Time.current.utc.iso8601
         }
       end
@@ -39,27 +39,27 @@ module PlatformSdk
       before do
         allow(PlatformSdk::DataPipeline::Client).to receive(:new).and_return(data_pipeline_client)
         allow(data_pipeline_client).to receive(:post)
-        Timecop.freeze(DateTime.parse("2024-06-09 04:20:00"))
+        Timecop.freeze(DateTime.parse('2024-06-09 04:20:00'))
       end
 
       after do
         Timecop.return
       end
 
-      context "after_create callbacks" do
-        let(:action) { "created" }
+      context 'create' do
+        let(:action) { 'created' }
 
-        it "defines an after_create callback" do
+        it 'posts to the data pipeline' do
           record.save!
           expect(data_pipeline_client).to have_received(:post).with(pipeline_payload)
         end
       end
 
-      context "before_destroy callbacks" do
-        let(:action) { "destroyed" }
+      context 'destroy' do
+        let(:action) { 'destroyed' }
         let(:one_roster_common_data_deleted) do
           one_roster_common_data.merge(
-            "status": "tobedeleted"
+            "status": 'tobedeleted'
           )
         end
 
@@ -67,7 +67,7 @@ module PlatformSdk
           pipeline_payload.merge("data": one_roster_common_data_deleted)
         end
 
-        it "defines an after_destroy callback" do
+        it 'posts to the data pipeline' do
           record.save!
           record.destroy
           expect(data_pipeline_client).to have_received(:post).with(pipeline_payload)
@@ -75,18 +75,33 @@ module PlatformSdk
         end
       end
 
-      context "after_update callbacks" do
-        let(:action) { "modified" }
+      context 'update' do
+        let(:action) { 'modified' }
 
         before do
-          allow(record).to receive(:send_pipeline_create)
           record.save!
         end
 
-        it "defines an after_update callback" do
-          column = column_to_update(record)
-          update_record(record, column)
-          expect(data_pipeline_client).to have_received(:post).with(pipeline_payload)
+        context 'after an update' do
+
+          it 'posts a copy of our data to the data pipeline' do
+            column = column_to_update(record)
+            update_record(record, column)
+            expect(data_pipeline_client).to have_received(:post).with(pipeline_payload)
+          end
+
+        end
+
+        context 'after an update that does not change data' do
+          let(:action) { 'modified' }
+
+          it 'does not post to the data pipeline' do
+            record.save!
+            column = column_to_update(record)
+            update_record(record, column)
+            record.save!
+            expect(data_pipeline_client).to have_received(:post).once.with(pipeline_payload)
+          end
         end
       end
 
@@ -100,11 +115,12 @@ module PlatformSdk
       def update_record(record, column)
         new_record = build(described_class.to_s.underscore.to_sym)
 
-        column_class = record[column]
-        case column_class
-        when Integer
+        column_value = record[column]
+        column_class = column_value.class
+        case column_class.to_s
+        when 'Integer'
           record.update!(column => 69)
-        when [true, false].include?(column_class)
+        when 'TrueClass', 'FalseClass'
           record.update!(column => !record[column])
         else
           record.update!(column => new_record[column])

data/lib/platform_sdk/version.rb

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

metadata

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