canvas_sync 0.17.27 → 0.17.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b85b5374a289fbab25718bb03812c9623065dc5c8b4e35fff67c79d220d7fda9
-  data.tar.gz: 9a8d01f7a45bfe58339c8ba8a808a29d655711945ec7cf27a8e8fcd02205f343
+  metadata.gz: 8359f6a5054489357a480d15019981f0ade50a145f714bcbd2274c6570689316
+  data.tar.gz: c98c3d8ecda4291e162e31d7c4dfdf9ddff65763f0bb7c345006585f53894cf4
 SHA512:
-  metadata.gz: 73bf2bd012676ff339ccb3f2c7a2802e0752bc5623ccd301fc808d15ce139673be955ae4aee2b9ee842b18c2235cdbc843f197090c00b4caf6f57c6975d5c81a
-  data.tar.gz: eed6e24b8f30396a2f09751d2b786527a7b039c8b6fa6fbdcc9bdf695449f6e90ca76e138aec9fefb3a905abdbefd45ca092a1e1b85b0f706f6ca0fc35ff9fde
+  metadata.gz: 4ce90338e8e3751fd5767a09eaaf89e733532ffa59df5569bf908930929f34d5167bc01e2637a5eef6ba5ef515c2e6410cc17ce757542b4d0620bb08bd03fd38
+  data.tar.gz: e4456ad37bbf87b63a495d041f038ad6ece797b59c11d19cd7028a030aef452281105f2c53ab56bef3b4cf515f838366874b56838c87936d113c3cacf5570771

data/README.md

@@ -34,6 +34,7 @@ The following custom reports are required for the specified models:
 - assignment_groups = "Assignment Group Export" (proserv_assignment_group_export_csv)
 - context_modules = "Professional Services Context Modules Report" (proserv_context_modules_csv)
 - context_module_items = "Professional Services Context Module Items Report" (proserv_context_module_items_csv)
+- content_migrations = "Professional Services Content Migrations Report" (proserv_content_migrations_csv)
 
 ## Prerequisites
 

data/lib/canvas_sync/generators/templates/migrations/create_content_migrations.rb

@@ -0,0 +1,24 @@
+# <%= autogenerated_migration_warning %>
+
+class CreateContentMigrations < ActiveRecord::Migration[5.1]
+  def change
+    create_table :content_migrations do |t|
+      t.bigint :canvas_id
+      t.bigint :canvas_context_id
+      t.string :canvas_context_type
+      t.string :workflow_state
+      t.text :migration_settings
+      t.datetime :started_at
+      t.datetime :finished_at
+      t.float :progress
+      t.bigint :canvas_source_course_id
+      t.string :migration_type
+      t.bigint :canvas_child_subscription_id
+      t.bigint :canvas_root_account_id
+
+      t.timestamps
+    end
+
+    add_index :content_migrations, :canvas_id, unique: true
+  end
+end

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

@@ -0,0 +1,10 @@
+# <%= autogenerated_model_warning %>
+
+class ContentMigration < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
+
+end

data/lib/canvas_sync/jobs/sync_content_migrations_job.rb

@@ -0,0 +1,20 @@
+module CanvasSync
+  module Jobs
+    class SyncContentMigrationsJob < ReportStarter
+      # Syncs ContentMigrations
+      #
+      # Starts a report processor for the content migrations report
+      # (the proserv_content_migrations_csv report must be enabled)
+      #
+      # @param options [Hash]
+      def perform(options)
+        super(
+          "proserv_content_migrations_csv",
+          merge_report_params(options),
+          CanvasSync::Processors::ContentMigrationsProcessor.to_s,
+          {},
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/content_migrations_processor.rb

@@ -0,0 +1,19 @@
+require_relative "./report_processor"
+
+module CanvasSync
+  module Processors
+    # Processes a content migrations report using the bulk importer.
+    #
+    # @param report_file_path [String]
+    # @param options [Hash]
+    class ContentMigrationsProcessor < ReportProcessor
+      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, ContentMigration, options: options)
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/model_mappings.yml

@@ -469,3 +469,43 @@ grading_period_groups:
     status:
       database_column_name: workflow_state
       type: string
+
+content_migrations:
+  conflict_target: canvas_migration_id
+  report_columns:
+    canvas_migration_id:
+      database_column_name: canvas_id
+      type: integer
+    canvas_context_id:
+      database_column_name: canvas_context_id
+      type: integer
+    canvas_context_type:
+      database_column_name: canvas_context_type
+      type: string
+    workflow_state:
+      database_column_name: workflow_state
+      type: string
+    migration_settings:
+      database_column_name: migration_settings
+      type: text
+    started_at:
+      database_column_name: started_at
+      type: datetime
+    finished_at:
+      database_column_name: finished_at
+      type: datetime
+    progress:
+      database_column_name: progress
+      type: float
+    canvas_source_course_id:
+      database_column_name: canvas_source_course_id
+      type: integer
+    migration_type:
+      database_column_name: migration_type
+      type: string
+    canvas_child_subscription_id:
+      database_column_name: canvas_child_subscription_id
+      type: integer
+    canvas_root_account_id:
+      database_column_name: canvas_root_account_id
+      type: integer

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.17.27".freeze
+  VERSION = "0.17.28".freeze
 end

data/lib/canvas_sync.rb

@@ -44,6 +44,7 @@ module CanvasSync
     user_observers
     grading_periods
     grading_period_groups
+    content_migrations
   ].freeze
 
   SUPPORTED_TERM_SCOPE_MODELS = %w[
@@ -150,6 +151,7 @@ module CanvasSync
         assignment_groups: CanvasSync::Jobs::SyncAssignmentGroupsJob,
         context_modules: CanvasSync::Jobs::SyncContextModulesJob,
         context_module_items: CanvasSync::Jobs::SyncContextModuleItemsJob,
+        content_migrations: CanvasSync::Jobs::SyncContentMigrationsJob,
       }.with_indifferent_access
 
       root_chain = base_canvas_sync_chain(**kwargs, globals: options[:global] || kwargs[:globals])

data/spec/canvas_sync/jobs/sync_content_migrations_job_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Jobs::SyncContentMigrationsJob do
+  describe "#perform" do
+    context "no parameters is specified" do
+      it "enqueues a ReportStarter for the proserv_content_migrations_csv" do
+        expect_any_instance_of(Bearcat::Client).to receive(:start_report)
+          .with("self", "proserv_content_migrations_csv", { parameters: { } })
+          .and_return("id" => 1)
+
+        expect(CanvasSync::Jobs::ReportChecker).to receive(:set).and_call_original
+
+        CanvasSync::Jobs::SyncContentMigrationsJob.perform_now({})
+      end
+    end
+
+    context "updated_after parameters is specified" do
+      it "enqueues a ReportStarter for the proserv_content_migrations_csv and get data from given date" do
+        expect_any_instance_of(Bearcat::Client).to receive(:start_report)
+          .with("self", "proserv_content_migrations_csv", { parameters: { updated_after: 6.hours.ago.to_s } })
+          .and_return("id" => 1)
+
+        expect(CanvasSync::Jobs::ReportChecker).to receive(:set).and_call_original
+
+        set_batch_context(updated_after: 6.hours.ago.to_s)
+        CanvasSync::Jobs::SyncContentMigrationsJob.perform_now({})
+      end
+    end
+  end
+end

data/spec/canvas_sync/processors/content_migrations_processor_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Processors::ContentMigrationsProcessor do
+  let(:subject) { CanvasSync::Processors::ContentMigrationsProcessor }
+
+  describe "#process" do
+    it "inserts content migrations" do
+      expect {
+        subject.process("spec/support/fixtures/reports/content_migrations.csv", {}, 1)
+      }.to change { ContentMigration.count }.by(2)
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# #
+# 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 ContentMigration < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
+
+end

data/spec/dummy/db/migrate/20220308072643_create_content_migrations.rb

@@ -0,0 +1,30 @@
+# #
+# 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 CreateContentMigrations < ActiveRecord::Migration[5.1]
+  def change
+    create_table :content_migrations do |t|
+      t.bigint :canvas_id
+      t.bigint :canvas_context_id
+      t.string :canvas_context_type
+      t.string :workflow_state
+      t.text :migration_settings
+      t.datetime :started_at
+      t.datetime :finished_at
+      t.float :progress
+      t.bigint :canvas_source_course_id
+      t.string :migration_type
+      t.bigint :canvas_child_subscription_id
+      t.bigint :canvas_root_account_id
+
+      t.timestamps
+    end
+
+    add_index :content_migrations, :canvas_id, unique: true
+  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: 2021_10_01_184920) do
+ActiveRecord::Schema.define(version: 2022_03_08_072643) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -110,6 +110,24 @@ ActiveRecord::Schema.define(version: 2021_10_01_184920) do
     t.string "batch_bid"
   end
 
+  create_table "content_migrations", force: :cascade do |t|
+    t.bigint "canvas_id"
+    t.bigint "canvas_context_id"
+    t.string "canvas_context_type"
+    t.string "workflow_state"
+    t.text "migration_settings"
+    t.datetime "started_at"
+    t.datetime "finished_at"
+    t.float "progress"
+    t.bigint "canvas_source_course_id"
+    t.string "migration_type"
+    t.bigint "canvas_child_subscription_id"
+    t.bigint "canvas_root_account_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_id"], name: "index_content_migrations_on_canvas_id", unique: true
+  end
+
   create_table "context_module_items", force: :cascade do |t|
     t.bigint "canvas_id"
     t.bigint "canvas_context_module_id"

data/spec/support/fixtures/reports/content_migrations.csv

@@ -0,0 +1,3 @@
+canvas_migration_id,canvas_context_id,canvas_context_type,workflow_state,migration_settings,started_at,finished_at,progress,canvas_source_course_id,migration_type,canvas_child_subscription_id,canvas_root_account_id
+101,1250,Course,imported,,2022-02-18 10:10:40,2022-02-18 10:11:40,100,1200,course_copy_importer,,1
+102,1251,Course,imported,,2022-02-18 10:10:40,2022-02-18 10:11:40,100,1120,master_course_import,3,1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.17.27
+  version: 0.17.28
 platform: ruby
 authors:
 - Nate Collings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-11 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -381,6 +381,7 @@ files:
 - lib/canvas_sync/generators/templates/migrations/create_admins.rb
 - lib/canvas_sync/generators/templates/migrations/create_assignment_groups.rb
 - lib/canvas_sync/generators/templates/migrations/create_assignments.rb
+- lib/canvas_sync/generators/templates/migrations/create_content_migrations.rb
 - lib/canvas_sync/generators/templates/migrations/create_context_module_items.rb
 - lib/canvas_sync/generators/templates/migrations/create_context_modules.rb
 - lib/canvas_sync/generators/templates/migrations/create_courses.rb
@@ -400,6 +401,7 @@ files:
 - lib/canvas_sync/generators/templates/models/admin.rb
 - lib/canvas_sync/generators/templates/models/assignment.rb
 - lib/canvas_sync/generators/templates/models/assignment_group.rb
+- lib/canvas_sync/generators/templates/models/content_migration.rb
 - lib/canvas_sync/generators/templates/models/context_module.rb
 - lib/canvas_sync/generators/templates/models/context_module_item.rb
 - lib/canvas_sync/generators/templates/models/course.rb
@@ -469,6 +471,7 @@ files:
 - lib/canvas_sync/jobs/sync_admins_job.rb
 - lib/canvas_sync/jobs/sync_assignment_groups_job.rb
 - lib/canvas_sync/jobs/sync_assignments_job.rb
+- lib/canvas_sync/jobs/sync_content_migrations_job.rb
 - lib/canvas_sync/jobs/sync_context_module_items_job.rb
 - lib/canvas_sync/jobs/sync_context_modules_job.rb
 - lib/canvas_sync/jobs/sync_provisioning_report_job.rb
@@ -480,6 +483,7 @@ files:
 - lib/canvas_sync/misc_helper.rb
 - lib/canvas_sync/processors/assignment_groups_processor.rb
 - lib/canvas_sync/processors/assignments_processor.rb
+- lib/canvas_sync/processors/content_migrations_processor.rb
 - lib/canvas_sync/processors/context_module_items_processor.rb
 - lib/canvas_sync/processors/context_modules_processor.rb
 - lib/canvas_sync/processors/model_mappings.yml
@@ -498,6 +502,7 @@ files:
 - spec/canvas_sync/jobs/sync_admins_job_spec.rb
 - spec/canvas_sync/jobs/sync_assignment_groups_job_spec.rb
 - spec/canvas_sync/jobs/sync_assignments_job_spec.rb
+- spec/canvas_sync/jobs/sync_content_migrations_job_spec.rb
 - spec/canvas_sync/jobs/sync_context_module_items_job_spec.rb
 - spec/canvas_sync/jobs/sync_context_modules_job_spec.rb
 - spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb
@@ -522,6 +527,7 @@ files:
 - spec/canvas_sync/models/user_spec.rb
 - spec/canvas_sync/processors/assignment_groups_processor_spec.rb
 - spec/canvas_sync/processors/assignments_processor_spec.rb
+- spec/canvas_sync/processors/content_migrations_processor_spec.rb
 - spec/canvas_sync/processors/context_module_items_processor_spec.rb
 - spec/canvas_sync/processors/context_modules_processor_spec.rb
 - spec/canvas_sync/processors/normal_processor_spec.rb
@@ -536,6 +542,7 @@ files:
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/assignment.rb
 - spec/dummy/app/models/assignment_group.rb
+- spec/dummy/app/models/content_migration.rb
 - spec/dummy/app/models/context_module.rb
 - spec/dummy/app/models/context_module_item.rb
 - spec/dummy/app/models/course.rb
@@ -612,9 +619,8 @@ files:
 - spec/dummy/db/migrate/20210907233329_create_user_observers.rb
 - spec/dummy/db/migrate/20210907233330_create_grading_periods.rb
 - spec/dummy/db/migrate/20211001184920_create_grading_period_groups.rb
+- spec/dummy/db/migrate/20220308072643_create_content_migrations.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/factories/account_factory.rb
 - spec/factories/admin_factory.rb
 - spec/factories/assignment_factory.rb
@@ -654,6 +660,7 @@ files:
 - spec/support/fixtures/canvas_responses/terms.json
 - spec/support/fixtures/reports/assignment_groups.csv
 - spec/support/fixtures/reports/assignments.csv
+- spec/support/fixtures/reports/content_migrations.csv
 - spec/support/fixtures/reports/context_module_items.csv
 - spec/support/fixtures/reports/context_modules.csv
 - spec/support/fixtures/reports/courses.csv
@@ -663,8 +670,6 @@ files:
 - spec/support/fixtures/reports/group_memberships.csv
 - spec/support/fixtures/reports/groups.csv
 - spec/support/fixtures/reports/provisioning_csv
-- spec/support/fixtures/reports/provisioning_csv_unzipped/courses.csv
-- spec/support/fixtures/reports/provisioning_csv_unzipped/users.csv
 - spec/support/fixtures/reports/sections.csv
 - spec/support/fixtures/reports/submissions.csv
 - spec/support/fixtures/reports/user_observers.csv
@@ -688,7 +693,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Gem for generating Canvas models and migrations and syncing data from Canvas
@@ -701,6 +706,7 @@ test_files:
 - spec/canvas_sync/jobs/sync_admins_job_spec.rb
 - spec/canvas_sync/jobs/sync_assignment_groups_job_spec.rb
 - spec/canvas_sync/jobs/sync_assignments_job_spec.rb
+- spec/canvas_sync/jobs/sync_content_migrations_job_spec.rb
 - spec/canvas_sync/jobs/sync_context_module_items_job_spec.rb
 - spec/canvas_sync/jobs/sync_context_modules_job_spec.rb
 - spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb
@@ -725,6 +731,7 @@ test_files:
 - spec/canvas_sync/models/user_spec.rb
 - spec/canvas_sync/processors/assignment_groups_processor_spec.rb
 - spec/canvas_sync/processors/assignments_processor_spec.rb
+- spec/canvas_sync/processors/content_migrations_processor_spec.rb
 - spec/canvas_sync/processors/context_module_items_processor_spec.rb
 - spec/canvas_sync/processors/context_modules_processor_spec.rb
 - spec/canvas_sync/processors/normal_processor_spec.rb
@@ -739,6 +746,7 @@ test_files:
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/assignment.rb
 - spec/dummy/app/models/assignment_group.rb
+- spec/dummy/app/models/content_migration.rb
 - spec/dummy/app/models/context_module.rb
 - spec/dummy/app/models/context_module_item.rb
 - spec/dummy/app/models/course.rb
@@ -815,9 +823,8 @@ test_files:
 - spec/dummy/db/migrate/20210907233329_create_user_observers.rb
 - spec/dummy/db/migrate/20210907233330_create_grading_periods.rb
 - spec/dummy/db/migrate/20211001184920_create_grading_period_groups.rb
+- spec/dummy/db/migrate/20220308072643_create_content_migrations.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/factories/account_factory.rb
 - spec/factories/admin_factory.rb
 - spec/factories/assignment_factory.rb
@@ -857,6 +864,7 @@ test_files:
 - spec/support/fixtures/canvas_responses/terms.json
 - spec/support/fixtures/reports/assignment_groups.csv
 - spec/support/fixtures/reports/assignments.csv
+- spec/support/fixtures/reports/content_migrations.csv
 - spec/support/fixtures/reports/context_module_items.csv
 - spec/support/fixtures/reports/context_modules.csv
 - spec/support/fixtures/reports/courses.csv
@@ -866,8 +874,6 @@ test_files:
 - spec/support/fixtures/reports/group_memberships.csv
 - spec/support/fixtures/reports/groups.csv
 - spec/support/fixtures/reports/provisioning_csv
-- spec/support/fixtures/reports/provisioning_csv_unzipped/courses.csv
-- spec/support/fixtures/reports/provisioning_csv_unzipped/users.csv
 - spec/support/fixtures/reports/sections.csv
 - spec/support/fixtures/reports/submissions.csv
 - spec/support/fixtures/reports/user_observers.csv