canvas_sync 0.22.8 → 0.22.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0882011929080b4e55e1798ae3639c4431a583dd2a31634b2b9c2ba5f450fcb4'
-  data.tar.gz: 7a339eef193de9b640b3d68d5474a7771d363f7dee723be49da33cf319afe610
+  metadata.gz: 2bbd02c6460435a1bb3bc0c33c997d60c09c8f0fffbc8afe8292cbc855d51306
+  data.tar.gz: 99f488b171bb99dd51b1f20b4d39963f0f94624a5decf96b9e8d270355efe5b4
 SHA512:
-  metadata.gz: a54b1779112dce3d106a503cc720b74d5b54ed2688c95c9d2c3523024813a0ac34d144417a8959bc81561dc4f78a7cf9914dd124037c85376a8a35b455bd5be1
-  data.tar.gz: 74e8b3e7d9317bbc2bbd7f902cfbedeabfd826ddbfd70aa4c8bf57c6f05dc2f4176f7bf2c0cc0352adae4ecaa4978f57f02fc3dcbbed8d1d8130df58bbaea51d
+  metadata.gz: eed8224aa09c93c4d95db72db479edd40e3a75faa5f548e208b99afffb43b453de8b4a00202ffe01f1c7c8b2c6a2c11b978f203e5a406760e61236a0bfa7e372
+  data.tar.gz: 58e2541a97e2885bea180b30ad9ae8af85c074c635dc12ec309985685dd74de48ccadca81d87ec8791d0b4b5691b11eb198e47a2c9ad18e6b64c4f7fdf126320

data/lib/canvas_sync/concerns/auto_relations.rb

@@ -0,0 +1,11 @@
+module CanvasSync::Concerns
+  module AutoRelations
+    extend ActiveSupport::Concern
+
+    # CanvasSync::Record.define_feature self, default: true
+
+    included do
+
+    end
+  end
+end

data/lib/canvas_sync/concerns/live_event_sync.rb

@@ -12,9 +12,9 @@ module CanvasSync::Concerns
         meta = event[:metadata]
         payload = event[:payload] || event[:body]
 
-        canvas_id = payload[:id] || payload[:"#{name.underscore}_id"]
-        inst = self.find_or_initialize_by(canvas_id: canvas_id)
         model, _, subtype = meta[:event_name].rpartition('_')
+        canvas_id = payload[:id] || payload[:"#{model}_id"] || payload[:"#{name.underscore}_id"]
+        inst = self.find_or_initialize_by(canvas_id: canvas_id)
 
         result = inst.run_callbacks(:process_live_event) do
           inst.process_live_event(subtype.to_sym, payload, meta)

data/lib/canvas_sync/concerns/user/sharded.rb

@@ -0,0 +1,18 @@
+module CanvasSync::Concerns
+  module User
+    module CanvasSharded
+      extend ActiveSupport::Concern
+
+      CanvasSync::Record.define_feature self, default: false
+
+      included do
+
+      end
+
+      class_methods do
+
+      end
+
+    end
+  end
+end

data/lib/canvas_sync/generators/templates/migrations/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

data/lib/canvas_sync/generators/templates/models/assignment_override.rb

@@ -0,0 +1,28 @@
+# <%= autogenerated_model_warning %>
+
+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/lib/canvas_sync/jobs/sync_assignment_overrides_job.rb

@@ -0,0 +1,20 @@
+module CanvasSync
+  module Jobs
+    class SyncAssignmentOverridesJob < ReportStarter
+      # Syncs SyncAssignmentOverrides
+      #
+      # Starts a report processor for the assignment overrides report
+      # (the proserv_assignment_overrides_csv report must be enabled)
+      #
+      # @param options [Hash]
+      def perform(options)
+        super(
+          "proserv_assignment_overrides_csv",
+          merge_report_params(options),
+          CanvasSync::Processors::AssignmentOverridesProcessor.to_s,
+          {},
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/assignment_overrides_processor.rb

@@ -0,0 +1,41 @@
+require_relative "./report_processor"
+
+module CanvasSync
+  module Processors
+    # Processes a assignment overrides report using the bulk importer.
+    #
+    # @param report_file_path [String]
+    # @param options [Hash]
+    class AssignmentOverridesProcessor < ReportProcessor
+      # Class method that starts processing (for consistent interface with other processors).
+      def self.process(report_file_path, options, report_id)
+        new(report_file_path, options)
+      end
+
+      def initialize(report_file_path, options)
+        do_bulk_import(report_file_path, AssignmentOverride, options: options) do |row|
+          # Handle transforms here instead of in mappings
+          row[:student_ids]       = parse_student_ids(row[:student_ids])
+
+          # Convert empty/null/'0' values to nil
+          # For Ruby 2.7
+          row[:group_id]          = parse_nil_value(row[:group_id])
+          row[:course_section_id] = parse_nil_value(row[:course_section_id])
+          row
+        end
+      end
+
+      private
+
+      def parse_student_ids(value)
+        value.present? ? JSON.parse(value) : nil
+      end
+
+      def parse_nil_value(value)
+        # Convert "0", "null", or empty string to nil
+        return nil if %w[0 null].include?(value) || value == ''
+        value
+      end
+    end
+  end
+end

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.11".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/app/models/learning_outcome_result.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # # #
-# AUTO GENERATED MIGRATION
-# This migration was auto generated by the CanvasSync Gem.
-# You can add new columns to this table, but removing or
-# re-naming ones created here may break Canvas Syncing.
+# 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.
 #
 
 

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

@@ -13,9 +13,9 @@ class Rubric < ApplicationRecord
   canvas_sync_features :defaults
 
   validates :canvas_id, uniqueness: true, presence: true
-  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
-  belongs_to :rubric, primary_key: :canvas_id, foreign_key: :canvas_rubric_id , optional: true # based on another rubric
-  belongs_to :context, polymorphic: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type, optional: true
+  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id
+  belongs_to :rubric, primary_key: :canvas_id, foreign_key: :canvas_rubric_id  # based on another rubric
+  belongs_to :context, polymorphic: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
 
   has_many :rubric_assessments, through: :rubric_associations, dependent: :destroy
   has_many :rubric_associations, primary_key: :canvas_id, foreign_key: :canvas_rubric_id
@@ -32,5 +32,5 @@ class Rubric < ApplicationRecord
     free_form_criterion_comments: :free_form_criterion_comments,
     hide_score_total: :hide_score_total,
     data: :data,
-  }, -> (api) { api.get("api/v1/accounts/#{canvas_root_account_id}/rubrics/#{canvas_id}") })
+  }, -> (api) { api.rubrics("self", canvas_id) })
 end

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

@@ -8,6 +8,7 @@
 
 class RubricAssessment < ApplicationRecord
   include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   canvas_sync_features :defaults
 

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

@@ -8,13 +8,13 @@
 
 class RubricAssociation < ApplicationRecord
   include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   canvas_sync_features :defaults
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :rubric, primary_key: :canvas_id, foreign_key: :canvas_rubric_id, optional: true
-  belongs_to :association_object, polymorphic: true, primary_key: :canvas_id, foreign_type: :canvas_association_type, foreign_key: :canvas_association_id, optional: true
-  belongs_to :context, polymorphic: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type, optional: true
-
+  belongs_to :association_object, polymorphic: true, primary_key: :canvas_id, foreign_type: :canvas_association_type, optional: true
+  belongs_to :context, polymorphic: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, optional: true
   has_many :rubric_assessments
 end

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

@@ -27,6 +27,7 @@ class User < ApplicationRecord
   has_many :admin_roles, through: :admins, source: :role
   has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_user_id
   has_many :group_memberships, primary_key: :canvas_id, foreign_key: :canvas_user_id
+  has_many :rubrics, primary_key: :canvas_id, foreign_key: :canvas_user_id
 
   api_syncable({
     sis_id: :sis_user_id,

data/spec/dummy/config/application.rb

@@ -1,5 +1,7 @@
 require File.expand_path('../boot', __FILE__)
 
+require 'logger'
+
 require 'rails'
 require 'active_record/railtie'
 # require 'active_storage/engine'

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

data/spec/dummy/db/migrate/{20240408223326_create_course_nicknames.rb → 20250319194134_create_course_nicknames.rb}

@@ -9,7 +9,7 @@
 class CreateCourseNicknames < ActiveRecord::Migration[5.1]
   def change
     create_table :course_nicknames do |t|
-      t.bigint :canvas_user_preference_value_id, null: false
+      t.bigint :canvas_user_preference_value_id, null: true
       t.integer :canvas_user_id
       t.integer :canvas_course_id
       t.string :nickname

data/spec/dummy/db/migrate/{20240509105100_create_rubrics.rb → 20250319194135_create_rubrics.rb}

@@ -1,8 +1,8 @@
 # #
-# AUTO GENERATED MIGRATION
-# This migration was auto generated by the CanvasSync Gem.
-# You can add new columns to this table, but removing or
-# re-naming ones created here may break Canvas Syncing.
+# 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.
 #