canvas_sync 0.17.20 → 0.17.23.beta5

data/lib/canvas_sync/processors/normal_processor.rb

@@ -13,12 +13,12 @@ module CanvasSync
       end
 
       def initialize(report_file_path, options)
-        conflict_target =  mapping[options[:mapping].to_sym][:conflict_target]
+        m = mapping[options[:mapping].to_sym]
         CanvasSync::Importers::BulkImporter.import(
           report_file_path,
-          mapping[options[:mapping].to_sym][:report_columns],
+          m[:report_columns],
           options[:klass].constantize,
-          conflict_target ? conflict_target.to_sym : conflict_target,
+          m[:conflict_target],
           import_args: options
         )
       end

data/lib/canvas_sync/processors/provisioning_report_processor.rb

@@ -69,94 +69,52 @@ module CanvasSync
       end
 
       def bulk_process_users(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:users][:report_columns],
-          User,
-          mapping[:users][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, User, options: @options)
+      end
+
+      def bulk_process_user_observers(report_file_path)
+        do_bulk_import(report_file_path, UserObserver, options: @options)
       end
 
       def bulk_process_pseudonyms(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:pseudonyms][:report_columns],
-          Pseudonym,
-          mapping[:pseudonyms][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, Pseudonym, options: @options)
       end
 
       def bulk_process_accounts(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:accounts][:report_columns],
-          Account,
-          mapping[:accounts][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, Account, options: @options)
       end
 
       def bulk_process_courses(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:courses][:report_columns],
-          Course,
-          mapping[:courses][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, Course, options: @options)
       end
 
       def bulk_process_enrollments(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:enrollments][:report_columns],
-          Enrollment,
-          mapping[:enrollments][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, Enrollment, options: @options)
       end
 
       def bulk_process_sections(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:sections][:report_columns],
-          Section,
-          mapping[:sections][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, Section, options: @options)
       end
 
       def bulk_process_xlist(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:xlist][:report_columns],
-          Section,
-          mapping[:xlist][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, Section, options: @options, mapping_key: :xlist)
       end
 
       def bulk_process_groups(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:groups][:report_columns],
-          Group,
-          mapping[:groups][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, Group, options: @options)
+      end
+
+      def bulk_process_grading_periods(report_file_path)
+        do_bulk_import(report_file_path, GradingPeriod, options: @options)
+      end
+
+      def bulk_process_grading_period_groups(report_file_path)
+        do_bulk_import(report_file_path, GradingPeriodGroup, options: @options)
       end
 
       # Note that group membership is singular because we override the model name param in sync_provisioning_report_job
       def bulk_process_group_membership(report_file_path)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:group_memberships][:report_columns],
-          GroupMembership,
-          mapping[:group_memberships][:conflict_target].to_sym,
-          import_args: @options
-        )
+        do_bulk_import(report_file_path, GroupMembership, options: @options)
       end
     end
   end

data/lib/canvas_sync/processors/report_processor.rb

@@ -5,17 +5,22 @@ module CanvasSync
     # Base report processing class
     class ReportProcessor
       def mapping
-        @mapping ||= begin
-          mapping = YAML.load_file(File.join(__dir__, "model_mappings.yml")).deep_symbolize_keys!
-          override_filepath = Rails.root.join("config/canvas_sync_provisioning_mapping.yml")
+        CanvasSync::Concerns::SyncMapping::Mapping.default_mappings
+      end
 
-          if File.file?(override_filepath)
-            override = YAML.load_file(override_filepath).deep_symbolize_keys!
-            mapping = mapping.merge(override)
-          end
+      def mapping_for(model, key = nil)
+        model.try(:get_sync_mapping, key) || mapping[key || CanvasSync::Concerns::SyncMapping::Mapping.normalize_model_name(model)]
+      end
 
-          mapping
-        end
+      def do_bulk_import(report_file_path, model, options: {}, mapping_key: nil)
+        m = mapping_for(model, mapping_key)
+        CanvasSync::Importers::BulkImporter.import(
+          report_file_path,
+          m[:report_columns],
+          model,
+          m[:conflict_target],
+          import_args: options
+        )
       end
     end
   end

data/lib/canvas_sync/processors/submissions_processor.rb

@@ -12,13 +12,7 @@ module CanvasSync
       end
 
       def initialize(report_file_path, options)
-        CanvasSync::Importers::BulkImporter.import(
-          report_file_path,
-          mapping[:submissions][:report_columns],
-          Submission,
-          mapping[:submissions][:conflict_target].to_sym,
-          import_args: options
-        )
+        do_bulk_import(report_file_path, Submission, options: options)
       end
     end
   end

data/lib/canvas_sync/record.rb

@@ -1,6 +1,10 @@
+
+require_relative 'concerns/sync_mapping'
+
 module CanvasSync
   module Record
     extend ActiveSupport::Concern
+    include CanvasSync::Concerns::SyncMapping
 
     included do
       define_model_callbacks :sync_import

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.17.20".freeze
+  VERSION = "0.17.23.beta5".freeze
 end

data/lib/canvas_sync.rb

@@ -41,6 +41,9 @@ module CanvasSync
     context_modules
     context_module_items
     xlist
+    user_observers
+    grading_periods
+    grading_period_groups
   ].freeze
 
   SUPPORTED_TERM_SCOPE_MODELS = %w[
@@ -176,7 +179,7 @@ module CanvasSync
       # These Models use the provisioning report, but are not term-scoped,
       # so we sync them outside of the term scoping to ensure work is not duplicated
       if term_scope.present?
-        models -= (first_provisioning_models = models & ['users', 'pseudonyms'])
+        models -= (first_provisioning_models = models & ['users', 'pseudonyms', 'user_observers', 'grading_periods', 'grading_period_groups'])
         current_chain.insert(generate_provisioning_jobs(first_provisioning_models, options))
       end
 

data/spec/canvas_sync/processors/provisioning_report_processor_spec.rb

@@ -62,6 +62,46 @@ RSpec.describe CanvasSync::Processors::ProvisioningReportProcessor do
       expect(group.canvas_user_id).to eq 10
     end
 
+    it 'processes user_observers' do
+      expect {
+        subject.process('spec/support/fixtures/reports/user_observers.csv', { models: ['user_observers'] }, 1)
+      }.to change { UserObserver.count }.by(2)
+      obj = UserObserver.find_by(observed_user_id: 3)
+      expect(obj.workflow_state).to eq 'active'
+      expect(obj.observing_user_id).to eq 21
+    end
+
+    it 'processes grading_periods' do
+      expect {
+        subject.process('spec/support/fixtures/reports/grading_periods.csv', { models: ['grading_periods'] }, 1)
+      }.to change { GradingPeriod.count }.by(2)
+      obj = GradingPeriod.find_by(canvas_id: 1)
+      puts obj.inspect
+      expect(obj.title).to eq 'Period 1'
+      expect(obj.weight).to eq 0.2
+      expect(obj.workflow_state).to eq 'active'
+    end
+
+    it 'processes grading_period_groups' do
+      expect {
+        subject.process('spec/support/fixtures/reports/grading_period_groups.csv', { models: ['grading_period_groups'] }, 1)
+      }.to change { GradingPeriodGroup.count }.by(1)
+      obj = GradingPeriodGroup.find_by(canvas_id: 1)
+      puts obj.inspect
+      expect(obj.title).to eq 'Test Group'
+      expect(obj.workflow_state).to eq 'active'
+    end
+
+    it 'model with composite key behaves as expected' do
+      expect {
+        subject.process('spec/support/fixtures/reports/user_observers.csv', { models: ['user_observers'] }, 1)
+      }.to change { UserObserver.count }.by(2)
+
+      expect {
+        subject.process('spec/support/fixtures/reports/user_observers.csv', { models: ['user_observers'] }, 1)
+      }.to change { UserObserver.count }.by(0)
+    end
+
     context 'options[:models] is multiple models' do
       it 'extracts the ZIP and processes each model' do
         user_count = User.count

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

@@ -0,0 +1,14 @@
+# #
+# 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 GradingPeriod < ApplicationRecord
+  include CanvasSync::Record
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :grading_period_group, primary_key: :canvas_id, foreign_key: :canvas_grading_period_group_id, optional: true
+end

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

@@ -0,0 +1,15 @@
+# #
+# 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 GradingPeriodGroup < ApplicationRecord
+  include CanvasSync::Record
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
+  belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true
+end

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

@@ -0,0 +1,17 @@
+# #
+# 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 UserObserver < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  validates :canvas_id, uniqueness: true, presence: true
+
+  belongs_to :observing_user, primary_key: :canvas_id, foreign_key: :observing_user_id, class_name: 'User', optional: true
+  belongs_to :observed_user, primary_key: :canvas_id, foreign_key: :observed_user_id, class_name: 'User', optional: true
+end

data/spec/dummy/db/migrate/20210907233329_create_user_observers.rb

@@ -0,0 +1,23 @@
+# #
+# 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.
+#
+
+
+class CreateUserObservers < ActiveRecord::Migration[5.1]
+  def change
+    create_table :user_observers do |t|
+      t.bigint :observing_user_id
+      t.bigint :observed_user_id
+      t.string :workflow_state
+
+      t.timestamps
+    end
+
+    add_index :user_observers, [:observed_user_id, :observing_user_id], unique: true
+    add_index :user_observers, :observing_user_id
+    add_index :user_observers, :observed_user_id
+  end
+end

data/spec/dummy/db/migrate/20210907233330_create_grading_periods.rb

@@ -0,0 +1,28 @@
+# #
+# 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.
+#
+
+
+class CreateGradingPeriods < ActiveRecord::Migration[5.1]
+  def change
+    create_table :grading_periods do |t|
+      t.bigint :canvas_id, null: false
+      t.string :title
+      t.float :weight
+      t.datetime :start_date
+      t.datetime :end_date
+      t.datetime :close_date
+      t.bigint :canvas_grading_period_group_id
+
+      t.string :workflow_state
+
+      t.timestamps
+    end
+
+    add_index :grading_periods, :canvas_id, unique: true
+    add_index :grading_periods, :canvas_grading_period_group_id
+  end
+end

data/spec/dummy/db/migrate/20210907233331_create_grading_period_groups.rb

@@ -0,0 +1,28 @@
+# #
+# 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.
+#
+
+
+class CreateGradingPeriodGroups < ActiveRecord::Migration[5.1]
+  def change
+    create_table :grading_period_groups do |t|
+      t.bigint :canvas_id, null: false
+      t.bigint :canvas_course_id
+      t.bigint :canvas_account_id
+      t.string :title
+      t.boolean :weighted
+      t.boolean :display_totals_for_all_grading_periods
+
+      t.string :workflow_state
+
+      t.timestamps
+    end
+
+    add_index :grading_period_groups, :canvas_id, unique: true
+    add_index :grading_period_groups, :canvas_course_id
+    add_index :grading_period_groups, :canvas_account_id
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2020_10_30_210836) do
+ActiveRecord::Schema.define(version: 2021_09_07_233331) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -173,6 +173,36 @@ ActiveRecord::Schema.define(version: 2020_10_30_210836) do
     t.index ["canvas_user_id"], name: "index_enrollments_on_canvas_user_id"
   end
 
+  create_table "grading_period_groups", force: :cascade do |t|
+    t.bigint "canvas_id", null: false
+    t.bigint "canvas_course_id"
+    t.bigint "canvas_account_id"
+    t.string "title"
+    t.boolean "weighted"
+    t.boolean "display_totals_for_all_grading_periods"
+    t.string "workflow_state"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_account_id"], name: "index_grading_period_groups_on_canvas_account_id"
+    t.index ["canvas_course_id"], name: "index_grading_period_groups_on_canvas_course_id"
+    t.index ["canvas_id"], name: "index_grading_period_groups_on_canvas_id", unique: true
+  end
+
+  create_table "grading_periods", force: :cascade do |t|
+    t.bigint "canvas_id", null: false
+    t.string "title"
+    t.float "weight"
+    t.datetime "start_date"
+    t.datetime "end_date"
+    t.datetime "close_date"
+    t.bigint "canvas_grading_period_group_id"
+    t.string "workflow_state"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_grading_period_group_id"], name: "index_grading_periods_on_canvas_grading_period_group_id"
+    t.index ["canvas_id"], name: "index_grading_periods_on_canvas_id", unique: true
+  end
+
   create_table "group_memberships", force: :cascade do |t|
     t.bigint "canvas_id", null: false
     t.bigint "canvas_user_id", null: false
@@ -275,6 +305,17 @@ ActiveRecord::Schema.define(version: 2020_10_30_210836) do
     t.index ["canvas_id"], name: "index_terms_on_canvas_id", unique: true
   end
 
+  create_table "user_observers", force: :cascade do |t|
+    t.bigint "observing_user_id"
+    t.bigint "observed_user_id"
+    t.string "workflow_state"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["observed_user_id", "observing_user_id"], name: "index_user_observers_on_observed_user_id_and_observing_user_id", unique: true
+    t.index ["observed_user_id"], name: "index_user_observers_on_observed_user_id"
+    t.index ["observing_user_id"], name: "index_user_observers_on_observing_user_id"
+  end
+
   create_table "users", force: :cascade do |t|
     t.bigint "canvas_id", null: false
     t.string "sis_id"