canvas_sync 0.22.8 → 0.22.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0882011929080b4e55e1798ae3639c4431a583dd2a31634b2b9c2ba5f450fcb4'
-  data.tar.gz: 7a339eef193de9b640b3d68d5474a7771d363f7dee723be49da33cf319afe610
+  metadata.gz: 0537b456eab7c4816125ddf995d80bb0afbd49a5d2f197fba4367e9753a85de7
+  data.tar.gz: e8789634293ef5517faba77d4c654036d45fc42f5aad69b836736dea2cd5f1dd
 SHA512:
-  metadata.gz: a54b1779112dce3d106a503cc720b74d5b54ed2688c95c9d2c3523024813a0ac34d144417a8959bc81561dc4f78a7cf9914dd124037c85376a8a35b455bd5be1
-  data.tar.gz: 74e8b3e7d9317bbc2bbd7f902cfbedeabfd826ddbfd70aa4c8bf57c6f05dc2f4176f7bf2c0cc0352adae4ecaa4978f57f02fc3dcbbed8d1d8130df58bbaea51d
+  metadata.gz: 83fc5373c5bb541d163e4c5bcfee7adf43c2f5c70a6957a879d657b03a48a7ef5b96adde4b28fefadf913533942a538d7b014a0409ed41b6fed694191ec9d2ac
+  data.tar.gz: 5b212e20447e8a743e276407e7251ede63bdf1df2650d1378c60a40fedff6ef29efe716d25f1ec6a6c0ca1e7f6938c2b3b012d677189c5b158c876209ae5f48f

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