canvas_sync 0.3.22 → 0.3.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 304b93956a2e4a40531c28aa515acd34b14d9efcab6d29ab02408b7347251229
-  data.tar.gz: 36ab39420cd2ea998d7f5725fdbb70a8319a809e5296bb01764c7308aec28a30
+  metadata.gz: ccdb328d97ea616a2a39b64ba9850567fefb03ae271306645fe878f82dbdf77d
+  data.tar.gz: dca87f606c8c5f4cede335ea725e8b18240592a2464a54295bc96c1812aaf373
 SHA512:
-  metadata.gz: ea1aa7b409b498a8609e49f9527555ff5c370c3b84d4c25c265e6a1aad12d86b3492395a1c9da3444a50ea1ef19b2cf62af872736e66ba2ad0fa9a3a9468a7ee
-  data.tar.gz: 231e24c9a70aa1c3fe1439991e4cf648938839a9dd2cff86d1cba1875c67a59d794ceca6d7f66b8fcde956fb2492c1c579899c94a852a29a3f4ea693be7efd13
+  metadata.gz: 2ccfc2afaa8a06b8ba6dde376c12354910ecd9116341168d900b13ad67218d7480fd74485ea11dcf7d2d1c8478c65cb78d28090f7025024a485e5a1682b1a994
+  data.tar.gz: 402f8066f80bbd3c0858492ffc6afb91f32b1006d7d46c89368a589b50ed8c720eaaa617a18323fec3fe582b7deec3ef4edb4760c0658123048e781b44236faf

data/README.md

@@ -32,6 +32,8 @@ The following custom reports are required for the specified models:
 - assignments = "Assignments Report" (proserv_assignment_export_csv)
 - submissions = "Student Submissions" (proserv_student_submissions_csv)
 - 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)
 
 ## Prerequisites
 

data/lib/canvas_sync.rb

@@ -9,6 +9,8 @@ require "canvas_sync/jobs/sync_provisioning_report_job"
 require "canvas_sync/jobs/sync_assignments_job"
 require "canvas_sync/jobs/sync_submissions_job"
 require "canvas_sync/jobs/sync_assignment_groups_job"
+require "canvas_sync/jobs/sync_context_modules_job"
+require "canvas_sync/jobs/sync_context_module_items_job"
 require "canvas_sync/jobs/sync_terms_job"
 require "canvas_sync/jobs/sync_users_job"
 require "canvas_sync/jobs/sync_roles_job"
@@ -18,7 +20,22 @@ Dir[File.dirname(__FILE__) +  "/canvas_sync/importers/*.rb"].each { |file| requi
 Dir[File.dirname(__FILE__) +  "/canvas_sync/generators/*.rb"].each { |file| require file }
 
 module CanvasSync
-  SUPPORTED_MODELS = %w[users courses accounts terms enrollments sections assignments submissions roles admins assignment_groups xlist].freeze
+  SUPPORTED_MODELS = %w[
+    users
+    courses
+    accounts
+    terms
+    enrollments
+    sections
+    assignments
+    submissions
+    roles
+    admins
+    assignment_groups
+    context_modules
+    context_module_items
+    xlist
+  ].freeze
   SUPPORTED_LIVE_EVENTS = %w[course enrollment submission assignment user syllabus grade].freeze
 
   # Runs a standard provisioning sync job with no extra report types.
@@ -80,33 +97,66 @@ module CanvasSync
   def self.default_provisioning_report_chain(models, term_scope=nil, legacy_support=false, account_id=nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength
     term_scope = term_scope.to_s if term_scope
 
+    ##############################
+    # Pre provisioning report jobs
+    ##############################
+
     # Always sync Terms first
-    jobs = [{ job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} }]
+    pre_provisioning_jobs = [{ job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} }]
 
     # Users, roles, and admins are synced before provisioning because they cannot be scoped to term
     if models.include?("users") && term_scope.present?
-      jobs.push(job: CanvasSync::Jobs::SyncUsersJob.to_s, options: {})
+      pre_provisioning_jobs.push(job: CanvasSync::Jobs::SyncUsersJob.to_s, options: {})
       models -= ["users"]
     end
 
     if models.include?("roles")
-      jobs.push(job: CanvasSync::Jobs::SyncRolesJob.to_s, options: {})
+      pre_provisioning_jobs.push(job: CanvasSync::Jobs::SyncRolesJob.to_s, options: {})
       models -= ["roles"]
     end
 
     if models.include?("admins")
-      jobs.push(job: CanvasSync::Jobs::SyncAdminsJob.to_s, options: {})
+      pre_provisioning_jobs.push(job: CanvasSync::Jobs::SyncAdminsJob.to_s, options: {})
       models -= ["admins"]
     end
 
-    jobs.push(
+    ###############################
+    # Post provisioning report jobs
+    ###############################
+
+    post_provisioning_jobs = []
+
+    if models.include?("assignments")
+      post_provisioning_jobs.push(job: CanvasSync::Jobs::SyncAssignmentsJob.to_s, options: {})
+      models -= ["assignments"]
+    end
+
+    if models.include?("submissions")
+      post_provisioning_jobs.push(job: CanvasSync::Jobs::SyncSubmissionsJob.to_s, options: {})
+      models -= ["submissions"]
+    end
+
+    if models.include?("assignment_groups")
+      post_provisioning_jobs.push(job: CanvasSync::Jobs::SyncAssignmentGroupsJob.to_s, options: {})
+      models -= ["assignment_groups"]
+    end
+
+    if models.include?("context_modules")
+      post_provisioning_jobs.push(job: CanvasSync::Jobs::SyncContextModulesJob.to_s, options: {})
+      models -= ["context_modules"]
+    end
+
+    if models.include?("context_module_items")
+      post_provisioning_jobs.push(job: CanvasSync::Jobs::SyncContextModuleItemsJob.to_s, options: {})
+      models -= ["context_module_items"]
+    end
+
+    provisioning_job = {
       job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s,
-      options: { term_scope: term_scope, models: models },
-    )
+      options: { term_scope: term_scope, models: models }
+    }
 
-    jobs.push(job: CanvasSync::Jobs::SyncAssignmentsJob.to_s, options: {}) if models.include?("assignments")
-    jobs.push(job: CanvasSync::Jobs::SyncSubmissionsJob.to_s, options: {}) if models.include?("submissions")
-    jobs.push(job: CanvasSync::Jobs::SyncAssignmentGroupsJob.to_s, options: {}) if models.include?("assignment_groups")
+    jobs = pre_provisioning_jobs + Array.wrap(provisioning_job) + post_provisioning_jobs
 
     global_options = { legacy_support: legacy_support }
     global_options[:account_id] = account_id if account_id.present?

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

@@ -5,4 +5,6 @@ class Assignment < ApplicationRecord
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_course_id
   belongs_to :assignment_group, optional: true, primary_key: :canvas_assignment_group_id, foreign_key: :canvas_assignment_group_id
   has_many :submissions, primary_key: :canvas_assignment_id, foreign_key: :canvas_assignment_id
+  has_many :context_module_items, primary_key: :canvas_assignment_id, foreign_key: :content_id, dependent: :destroy
+  has_many :context_modules, through: :context_module_items
 end

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

@@ -0,0 +1,10 @@
+<%= autogenerated_migration_warning %>
+
+# A ContextModule is the same as a Canvas Module. They're called ContextModules for 2 reasons:
+#   1 - Module is a reserved word in Rails and you can't call a model a Module
+#   2 - Canvas calls them ContextModules
+class ContextModule < ApplicationRecord
+  belongs_to :canvas_context, polymorphic: true, optional: true
+  has_many :context_module_items, primary_key: :canvas_context_module_id, foreign_key: :canvas_context_module_id
+  has_many :assignments, through: :context_module_items
+end

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

@@ -0,0 +1,6 @@
+<%= autogenerated_migration_warning %>
+
+class ContextModuleItem < ApplicationRecord
+  belongs_to :context_module, primary_key: :canvas_context_module_id, foreign_key: :canvas_context_module_id, optional: true
+  belongs_to :assignment, foreign_key: :content_id, primary_key: :canvas_assignment_id
+end

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

@@ -0,0 +1,19 @@
+<%= autogenerated_migration_warning %>
+
+class CreateContextModuleItems < ActiveRecord::Migration[5.1]
+  def change
+    create_table :context_module_items do |t|
+      t.bigint :canvas_context_module_item_id
+      t.bigint :canvas_context_module_id
+      t.integer :position
+      t.string :content_type
+      t.bigint :content_id
+      t.string :workflow_state
+
+      t.timestamps
+    end
+
+    add_index :context_module_items, :canvas_context_module_item_id, unique: true
+    add_index :context_module_items, :canvas_context_module_id
+  end
+end

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

@@ -0,0 +1,20 @@
+<%= autogenerated_migration_warning %>
+
+class CreateContextModules < ActiveRecord::Migration[5.1]
+  def change
+    create_table :context_modules do |t|
+      t.bigint :canvas_context_module_id
+      t.bigint :canvas_context_id
+      t.string :canvas_context_type
+      t.integer :position
+      t.string :name
+      t.string :workflow_state
+      t.datetime :deleted_at
+      t.datetime :unlock_at
+      t.timestamps
+    end
+
+    add_index :context_modules, :canvas_context_module_id, unique: true
+    add_index :context_modules, [:canvas_context_id, :canvas_context_type], name: "index_context_modules_on_context"
+  end
+end

data/lib/canvas_sync/jobs/sync_context_module_items_job.rb

@@ -0,0 +1,28 @@
+module CanvasSync
+  module Jobs
+    class SyncContextModuleItemsJob < ReportStarter
+      # Syncs ContextModuleItems
+      #
+      # Starts a report processor for the context modules report
+      # (the proserv_context_module_items_csv report must be enabled)
+      #
+      # @param job_chain [Hash]
+      # @param options [Hash]
+      def perform(job_chain, _options)
+        report_params = if job_chain[:global_options][:canvas_term_id].present?
+                          { "parameters[enrollment_term_id]" => job_chain[:global_options][:canvas_term_id] }
+                        else
+                          {}
+                        end
+
+        super(
+          job_chain,
+          "proserv_context_module_items_csv",
+          report_params,
+          CanvasSync::Processors::ContextModuleItemsProcessor.to_s,
+          {},
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/jobs/sync_context_modules_job.rb

@@ -0,0 +1,28 @@
+module CanvasSync
+  module Jobs
+    class SyncContextModulesJob < ReportStarter
+      # Syncs ContextModules
+      #
+      # Starts a report processor for the context modules report
+      # (the proserv_context_modules_csv report must be enabled)
+      #
+      # @param job_chain [Hash]
+      # @param options [Hash]
+      def perform(job_chain, _options)
+        report_params = if job_chain[:global_options][:canvas_term_id].present?
+                          { "parameters[enrollment_term_id]" => job_chain[:global_options][:canvas_term_id] }
+                        else
+                          {}
+                        end
+
+        super(
+          job_chain,
+          "proserv_context_modules_csv",
+          report_params,
+          CanvasSync::Processors::ContextModulesProcessor.to_s,
+          {},
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/context_module_items_processor.rb

@@ -0,0 +1,24 @@
+require_relative "./report_processor"
+
+module CanvasSync
+  module Processors
+    # Processes a context modules report using the bulk importer.
+    #
+    # @param report_file_path [String]
+    # @param options [Hash]
+    class ContextModuleItemsProcessor < ReportProcessor
+      def self.process(report_file_path, _options)
+        new(report_file_path)
+      end
+
+      def initialize(report_file_path)
+        CanvasSync::Importers::BulkImporter.import(
+          report_file_path,
+          mapping[:context_module_items][:report_columns],
+          ContextModuleItem,
+          mapping[:context_module_items][:conflict_target].to_sym,
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/context_modules_processor.rb

@@ -0,0 +1,24 @@
+require_relative "./report_processor"
+
+module CanvasSync
+  module Processors
+    # Processes a context modules report using the bulk importer.
+    #
+    # @param report_file_path [String]
+    # @param options [Hash]
+    class ContextModulesProcessor < ReportProcessor
+      def self.process(report_file_path, _options)
+        new(report_file_path)
+      end
+
+      def initialize(report_file_path)
+        CanvasSync::Importers::BulkImporter.import(
+          report_file_path,
+          mapping[:context_modules][:report_columns],
+          ContextModule,
+          mapping[:context_modules][:conflict_target].to_sym,
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/model_mappings.yml

@@ -273,3 +273,50 @@ assignment_groups:
     updated_at:
       database_column_name: canvas_updated_at
       type: datetime
+
+context_modules:
+  conflict_target: canvas_context_module_id
+  report_columns:
+    canvas_context_module_id:
+      database_column_name: canvas_context_module_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
+    position:
+      database_column_name: position
+      type: integer
+    name:
+      database_column_name: name
+      type: string
+    workflow_state:
+      database_column_name: workflow_state
+      type: string
+    deleted_at:
+      database_column_name: deleted_at
+      type: datetime
+
+context_module_items:
+  conflict_target: canvas_context_module_item_id
+  report_columns:
+    canvas_context_module_item_id:
+      database_column_name: canvas_context_module_item_id
+      type: integer
+    context_module_id:
+      database_column_name: canvas_context_module_id
+      type: integer
+    position:
+      database_column_name: position
+      type: integer
+    content_type:
+      database_column_name: content_type
+      type: string
+    content_id:
+      database_column_name: content_id
+      type: integer
+    workflow_state:
+      database_column_name: workflow_state
+      type: string

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.3.22".freeze
+  VERSION = "0.3.23".freeze
 end

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -114,7 +114,7 @@ RSpec.describe CanvasSync do
           expect(chain).to eq(
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
-              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments assignments] } },
+              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments] } },
               { job: CanvasSync::Jobs::SyncAssignmentsJob.to_s, options: {} },
             ],
             global_options: { legacy_support: false },
@@ -129,7 +129,7 @@ RSpec.describe CanvasSync do
           expect(chain).to eq(
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
-              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments submissions] } },
+              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments] } },
               { job: CanvasSync::Jobs::SyncSubmissionsJob.to_s, options: {} },
             ],
             global_options: { legacy_support: false },
@@ -144,7 +144,7 @@ RSpec.describe CanvasSync do
           expect(chain).to eq(
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
-              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments assignment_groups] } },
+              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments] } },
               { job: CanvasSync::Jobs::SyncAssignmentGroupsJob.to_s, options: {} },
             ],
             global_options: { legacy_support: false },

data/spec/canvas_sync/jobs/sync_context_module_items_job_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Jobs::SyncContextModuleItemsJob do
+  describe "#perform" do
+    context "a term id is in the global_options" do
+      it "enqueues a ReportStarter for the proserv_context_module_items_csv for the given term" do
+        expect_any_instance_of(Bearcat::Client).to receive(:start_report)
+          .with("self", "proserv_context_module_items_csv", "parameters[enrollment_term_id]" => 1)
+          .and_return("id" => 1)
+
+        expect(CanvasSync::Jobs::ReportChecker).to receive(:set).and_call_original
+
+        CanvasSync::Jobs::SyncContextModuleItemsJob.perform_now({ jobs: [], global_options: { canvas_term_id: 1 } }, {})
+      end
+    end
+
+    context "no term id is specified" do
+      it "enqueues a ReportStarter for the proserv_context_module_items_csv for all terms" do
+        expect_any_instance_of(Bearcat::Client).to receive(:start_report)
+          .with("self", "proserv_context_module_items_csv", {})
+          .and_return("id" => 1)
+
+        expect(CanvasSync::Jobs::ReportChecker).to receive(:set).and_call_original
+
+        CanvasSync::Jobs::SyncContextModuleItemsJob.perform_now({ jobs: [], global_options: {} }, {})
+      end
+    end
+  end
+end

data/spec/canvas_sync/jobs/sync_context_modules_job_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Jobs::SyncContextModulesJob do
+  describe "#perform" do
+    context "a term id is in the global_options" do
+      it "enqueues a ReportStarter for the proserv_context_modules_csv for the given term" do
+        expect_any_instance_of(Bearcat::Client).to receive(:start_report)
+          .with("self", "proserv_context_modules_csv", "parameters[enrollment_term_id]" => 1)
+          .and_return("id" => 1)
+
+        expect(CanvasSync::Jobs::ReportChecker).to receive(:set).and_call_original
+
+        CanvasSync::Jobs::SyncContextModulesJob.perform_now({ jobs: [], global_options: { canvas_term_id: 1 } }, {})
+      end
+    end
+
+    context "no term id is specified" do
+      it "enqueues a ReportStarter for the proserv_context_modules_csv for all terms" do
+        expect_any_instance_of(Bearcat::Client).to receive(:start_report)
+          .with("self", "proserv_context_modules_csv", {})
+          .and_return("id" => 1)
+
+        expect(CanvasSync::Jobs::ReportChecker).to receive(:set).and_call_original
+
+        CanvasSync::Jobs::SyncContextModulesJob.perform_now({ jobs: [], global_options: {} }, {})
+      end
+    end
+  end
+end