canvas_sync 0.22.8 → 0.22.9

data/lib/canvas_sync/processors/model_mappings.yml

@@ -293,6 +293,49 @@ submissions:
       database_column_name: workflow_state
       type: string
 
+assignment_overrides:
+  conflict_target: id
+  report_columns:
+    id:
+      database_column_name: canvas_id
+      type: integer
+    assignment_id:
+      database_column_name: canvas_assignment_id
+      type: integer
+    student_ids:
+      database_column_name: student_ids
+      type: array
+    group_id:
+      database_column_name: canvas_group_id
+      type: integer
+    course_section_id:
+      database_column_name: canvas_section_id
+      type: integer
+    course_id:
+      database_column_name: canvas_course_id
+      type: integer
+    title:
+      database_column_name: title
+      type: string
+    due_at:
+      database_column_name: due_at
+      type: datetime
+    unlock_at:
+      database_column_name: unlock_at
+      type: datetime
+    lock_at:
+      database_column_name: lock_at
+      type: datetime
+    all_day:
+      database_column_name: all_day
+      type: boolean
+    all_day_date:
+      database_column_name: all_day_date
+      type: datetime
+    workflow_state:
+      database_column_name: workflow_state
+      type: string
+
 assignment_groups:
   conflict_target: id
   report_columns:

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.22.8".freeze
+  VERSION = "0.22.9".freeze
 end

data/lib/canvas_sync.rb

@@ -54,6 +54,7 @@ module CanvasSync
     rubric_associations
     rubric_assessments
     course_progresses
+    assignment_overrides
   ].freeze
 
   SUPPORTED_TERM_SCOPE_MODELS = %w[
@@ -66,6 +67,7 @@ module CanvasSync
     rubric_associations
     rubric_assessments
     course_progresses
+    assignment_overrides
   ].freeze
 
   DEFAULT_TERM_SCOPE_MODELS = %w[
@@ -78,6 +80,7 @@ module CanvasSync
     rubric_associations
     rubric_assessments
     course_progresses
+    assignment_overrides
   ].freeze
 
   SUPPORTED_LIVE_EVENTS = %w[
@@ -166,6 +169,7 @@ module CanvasSync
         assignments: CanvasSync::Jobs::SyncAssignmentsJob,
         submissions: CanvasSync::Jobs::SyncSubmissionsJob,
         assignment_groups: CanvasSync::Jobs::SyncAssignmentGroupsJob,
+        assignment_overrides: CanvasSync::Jobs::SyncAssignmentOverridesJob,
         context_modules: CanvasSync::Jobs::SyncContextModulesJob,
         context_module_items: CanvasSync::Jobs::SyncContextModuleItemsJob,
         content_migrations: CanvasSync::Jobs::SyncContentMigrationsJob,

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/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

data/spec/dummy/db/migrate/20241223080202_create_assignment_overrides.rb

@@ -0,0 +1,25 @@
+class CreateAssignmentOverrides < ActiveRecord::Migration[5.1]
+  def change
+    create_table :assignment_overrides do |t|
+      t.bigint :canvas_id, null: false
+      t.bigint :canvas_assignment_id
+      t.bigint :canvas_group_id
+      t.bigint :canvas_course_id
+      t.bigint :canvas_section_id
+      t.bigint :student_ids, array: true
+      t.datetime :due_at
+      t.boolean :all_day
+      t.datetime :all_day_date
+      t.datetime :unlock_at
+      t.datetime :lock_at
+      t.string :title
+      t.string :workflow_state
+
+      t.timestamps
+    end
+
+    add_index :assignment_overrides, :canvas_id, unique: true
+    add_index :assignment_overrides, :canvas_assignment_id
+    add_index :assignment_overrides, :canvas_course_id
+  end
+end