canvas_sync 0.22.6 → 0.22.9

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -2,6 +2,18 @@ require 'spec_helper'
 
 RSpec.describe CanvasSync do
   describe '.provisioning_sync' do
+    it 'invokes the first job in the queue and passes on the rest of the job chain' do
+      expected_job_chain = CanvasSync.default_provisioning_report_chain(['courses'], term_scope: nil).normalize![:args][0]
+
+      expect(CanvasSync::Jobs::BeginSyncChainJob).to receive(:perform_later)
+        .with(
+          expected_job_chain,
+          anything
+        )
+
+      CanvasSync.provisioning_sync(['courses'])
+    end
+
     context 'an invalid model is passed in' do
       it 'raises a helpful exception' do
         expect {
@@ -18,25 +30,22 @@ RSpec.describe CanvasSync do
           provisioning: { c: 3 },
           global: { d: 4 },
         })
-        expect(chain.normalize!).to match({
+        expect(chain.normalize!).to eq({
           :job => "CanvasSync::Jobs::BeginSyncChainJob",
-          :chain_link=>String,
           :args => [
             [
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[
                   [
-                    {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users"], :b=>2}},
+                    {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users"], :b=>2}},
                     {
                       :job=>"CanvasSync::Jobs::SyncTermsJob",
-                      :chain_link=>String,
                       :args=>[],
                       :kwargs=>{
                         :term_scope=>"active",
                         :sub_jobs=>[
-                          {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"], :c=>3}},
+                          {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"], :c=>3}},
                         ],
                       },
                     },
@@ -53,23 +62,20 @@ RSpec.describe CanvasSync do
       context 'we are syncing users with a term scope' do
         it 'syncs the users in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['users', 'courses'], term_scope: :active)
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[
                   [
-                    {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users"]}},
+                    {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users"]}},
                     {
                       :job=>"CanvasSync::Jobs::SyncTermsJob",
-                      :chain_link=>String,
                       :args=>[],
                       :kwargs=>{
                         :sub_jobs=>[
-                          {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}
+                          {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}
                         ],
                         :term_scope=>"active",
                       }
@@ -87,20 +93,17 @@ RSpec.describe CanvasSync do
       context 'we are syncing users without a term scope' do
         it 'syncs users along with the rest of the provisioning report' do
           chain = CanvasSync.default_provisioning_report_chain(['users', 'courses'])
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users", "courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users", "courses"]}}],
                       :term_scope=>nil,
                     }
                   }
@@ -116,21 +119,18 @@ RSpec.describe CanvasSync do
       context 'we are syncing roles with a term scope' do
         it 'syncs the roles in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['roles', 'courses'], term_scope: :active)
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
-                  {:job=>"CanvasSync::Jobs::SyncRolesJob", :chain_link=>String, :options=>{}},
+                  {:job=>"CanvasSync::Jobs::SyncRolesJob", :options=>{}},
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}],
                       :term_scope=>"active",
                     }
                   },
@@ -146,21 +146,18 @@ RSpec.describe CanvasSync do
       context 'we are syncing roles without a term scope' do
         it 'syncs roles separately even with no term scope' do
           chain = CanvasSync.default_provisioning_report_chain(['roles', 'courses'])
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
-                  {:job=>"CanvasSync::Jobs::SyncRolesJob", :chain_link=>String, :options=>{}},
+                  {:job=>"CanvasSync::Jobs::SyncRolesJob", :options=>{}},
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}],
                       :term_scope=>nil,
                     }
                   }
@@ -176,21 +173,18 @@ RSpec.describe CanvasSync do
       context 'we are syncing admins with a term scope' do
         it 'syncs the admins in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['admins', 'courses'], term_scope: :active)
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
-                  {:job=>"CanvasSync::Jobs::SyncAdminsJob", :chain_link=>String, :options=>{}},
+                  {:job=>"CanvasSync::Jobs::SyncAdminsJob", :options=>{}},
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}],
                       :term_scope=>"active"
                     }
                   }
@@ -206,21 +200,18 @@ RSpec.describe CanvasSync do
       context 'we are syncing admins without a term scope' do
         it 'syncs admins separately even with no term scope' do
           chain = CanvasSync.default_provisioning_report_chain(['admins', 'courses'])
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
-                  {:job=>"CanvasSync::Jobs::SyncAdminsJob", :chain_link=>String, :options=>{}},
+                  {:job=>"CanvasSync::Jobs::SyncAdminsJob", :options=>{}},
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
-                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["courses"]}}],
+                      :sub_jobs=>[{:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["courses"]}}],
                       :term_scope=>nil
                     }
                   }
@@ -237,22 +228,19 @@ RSpec.describe CanvasSync do
         it "appends the SyncAssignmentsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments assignments])
 
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
                       :sub_jobs=>[
-                        {:job=>"CanvasSync::Jobs::SyncAssignmentsJob", :chain_link=>String, :options=>{}},
-                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users", "enrollments"]}}
+                        {:job=>"CanvasSync::Jobs::SyncAssignmentsJob", :options=>{}},
+                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users", "enrollments"]}}
                       ],
                       :term_scope=>nil
                     }
@@ -270,22 +258,19 @@ RSpec.describe CanvasSync do
         it "appends the SyncSubmissionsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments submissions])
 
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
                       :sub_jobs=>[
-                        {:job=>"CanvasSync::Jobs::SyncSubmissionsJob", :chain_link=>String, :options=>{}},
-                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users", "enrollments"]}}
+                        {:job=>"CanvasSync::Jobs::SyncSubmissionsJob", :options=>{}},
+                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users", "enrollments"]}}
                       ],
                       :term_scope=>nil
                     }
@@ -303,22 +288,19 @@ RSpec.describe CanvasSync do
         it "appends the SyncAssignmentGroupsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments assignment_groups])
 
-          expect(chain.normalize!).to match({
+          expect(chain.normalize!).to eq({
             :job => "CanvasSync::Jobs::BeginSyncChainJob",
-            :chain_link=>String,
             :args => [[
               {
                 :job=>"CanvasSync::JobBatches::ConcurrentBatchJob",
-                :chain_link=>String,
                 :args=>[[
                   {
                     :job=>"CanvasSync::Jobs::SyncTermsJob",
-                    :chain_link=>String,
                     :args=>[],
                     :kwargs=>{
                       :sub_jobs=>[
-                        {:job=>"CanvasSync::Jobs::SyncAssignmentGroupsJob", :chain_link=>String, :options=>{}},
-                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :chain_link=>String, :options=>{:models=>["users", "enrollments"]}}
+                        {:job=>"CanvasSync::Jobs::SyncAssignmentGroupsJob", :options=>{}},
+                        {:job=>"CanvasSync::Jobs::SyncProvisioningReportJob", :options=>{:models=>["users", "enrollments"]}}
                       ],
                       :term_scope=>nil
                     }

data/spec/canvas_sync/processors/assignment_overrides_processor_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Processors::AssignmentOverridesProcessor do
+  describe '#process' do
+    it 'inserts assignment overrides' do
+      expect {
+        described_class.process('spec/support/fixtures/reports/assignment_overrides.csv', {}, 1)
+      }.to change { AssignmentOverride.count }.by(2)
+
+      override = AssignmentOverride.first
+      expect(override).to have_attributes(
+        canvas_id: 1,
+        canvas_assignment_id: 1,
+        student_ids: [1, 2],
+        canvas_group_id: nil,
+        canvas_section_id: nil,
+        canvas_course_id: 1,
+        title: "Override 1",
+        workflow_state: "active"
+      )
+      expect(override.due_at.strftime('%Y-%m-%d %H:%M:%S')).to eq('2024-05-01 09:00:00')
+    end
+
+    context 'record already present in the database' do
+      before do
+        described_class.process('spec/support/fixtures/reports/assignment_overrides.csv', {}, 1)
+      end
+
+      it 'updates the override' do
+        expect {
+          described_class.process('spec/support/fixtures/reports/assignment_overrides_conflict.csv', {}, 1)
+        }.to change { AssignmentOverride.count }.by(0)
+
+        override = AssignmentOverride.first
+        expect(override).to have_attributes(
+          canvas_id: 1,
+          student_ids: [1, 2, 3],
+          title: "Override 1 Updated",
+          workflow_state: "active"
+        )
+        expect(override.due_at.strftime('%Y-%m-%d %H:%M:%S')).to eq('2024-06-01 09:00:00')
+      end
+    end
+  end
+end

data/spec/canvas_sync/processors/provisioning_report_processor_spec.rb

@@ -12,6 +12,10 @@ RSpec.describe CanvasSync::Processors::ProvisioningReportProcessor do
 
     context "with User#sis_id column" do
       before do
+        # this could be refactored into a method that prevents caching the variables unless the environment is prod
+        CanvasSync::Concerns::SyncMapping::Mapping.instance_variable_set(:@mappings, nil)
+        CanvasSync::Concerns::SyncMapping::Mapping.instance_variable_set(:@legacy_mappings, nil)
+
         self.use_transactional_tests = false
         ActiveRecord::Migration.add_column :users, :sis_id, :string
         User.reset_column_information

data/spec/dummy/app/models/assignment_override.rb

@@ -0,0 +1,34 @@
+# #
+# AUTO GENERATED MODEL
+# This model was auto generated by the CanvasSync Gem.
+# You can customize it as needed, but make sure you test
+# any changes you make to the auto generated methods.
+#
+
+
+class AssignmentOverride < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  canvas_sync_features :defaults
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :assignment, primary_key: :canvas_id, foreign_key: :canvas_assignment_id, optional: true
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
+
+  api_syncable({
+    canvas_id: :id,
+    canvas_assignment_id: :assignment_id,
+    title: :title,
+    workflow_state: :workflow_state,
+    due_at: :due_at,
+    all_day: :all_day,
+    all_day_date: :all_day_date,
+    unlock_at: :unlock_at,
+    lock_at: :lock_at,
+    student_ids: ->(r) { JSON.parse(r[:student_ids]) if r[:student_ids].present? },
+    canvas_group_id: :group_id,
+    canvas_section_id: :course_section_id,
+    canvas_course_id: -> (r) { r.dig(:assignment, :course_id) }
+  }, -> (api) { api.assignment_override(canvas_assignment_id, canvas_id) })
+end