canvas_sync 0.12.0 → 0.13.0

data/lib/canvas_sync/concerns/legacy_columns.rb

@@ -0,0 +1,34 @@
+# Concern that can be used when dealing with Legacy code.
+#
+# It automatically aliases `canvas_id` -> `canvas_<model>_id` or vice-versa.
+module CanvasSync::Concerns
+  module LegacyColumns
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def inherited(subclass)
+        super.tap do
+          legacy_column_apply(subclass)
+        end
+      end
+
+      private
+
+      def legacy_column_apply(cls)
+        cid_column = "canvas_#{subclass.name.downcase}_id"
+        column_names = subclass.columns.map(&:name)
+        return if column_names.include?('canvas_id') && column_names.include?(cid_column)
+        if column_names.include?('canvas_id')
+          subclass.alias_attribute(cid_column.to_sym, :canvas_id)
+        elsif column_names.include?(cid_column)
+          subclass.alias_attribute(:canvas_id, cid_column.to_sym)
+        end
+      rescue ActiveRecord::StatementInvalid
+      end
+    end
+
+    included do
+      legacy_column_apply(self)
+    end
+  end
+end

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

@@ -1,11 +1,17 @@
 # <%= autogenerated_model_warning %>
 
 class Account < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+  # include CanvasSync::Concerns::Account::Ancestry # Add support for the ancestry Gem
 
   validates :canvas_id, uniqueness: true, presence: true
 
   has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_account_id
+  belongs_to :canvas_parent, class_name: 'Account', optional: true,
+                             primary_key: :canvas_id, foreign_key: :canvas_parent_account_id
+  has_many :sub_accounts, class_name: 'Account',
+                          primary_key: :canvas_id, foreign_key: :canvas_parent_account_id
 
   api_syncable({
     name: :name,

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class Admin < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class Assignment < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  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

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class AssignmentGroup < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true

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

@@ -4,7 +4,8 @@
 #   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
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
   has_many :context_module_items, primary_key: :canvas_id, foreign_key: :canvas_context_module_id

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

@@ -1,7 +1,8 @@
 # # <%= autogenerated_migration_warning %>
 
 class ContextModuleItem < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   belongs_to :context_module, primary_key: :canvas_id, foreign_key: :canvas_context_module_id, optional: true
   belongs_to :content, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_content_id, foreign_type: :canvas_content_type

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class Course < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_id, optional: true
@@ -10,7 +11,7 @@ class Course < ApplicationRecord
   has_many :assignments, as: :context, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
   has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_course_id
   has_many :assignment_groups, primary_key: :canvas_id, foreign_key: :canvas_course_id
-  
+
   api_syncable({
     sis_id: :sis_course_id,
     course_code: :course_code,

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class Enrollment < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class Role < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_id

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class Section < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class Submission < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :assignment, primary_key: :canvas_id, foreign_key: :canvas_assignment_id, optional: true

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class Term < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   has_many :courses, foreign_key: :canvas_term_id, primary_key: :canvas_id

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

@@ -1,7 +1,8 @@
 # <%= autogenerated_model_warning %>
 
 class User < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_user_id

data/lib/canvas_sync/importers/bulk_importer.rb

@@ -17,7 +17,13 @@ module CanvasSync
       #        Note: passing the key [:on_duplicate_key_ignore] will override the default behavior of [:on_duplicate_key_update]
       # @yieldparam [Array] row if a block is passed in it will yield the current row from the CSV.
       #   This can be used if you need to filter or massage the data in any way.
-      def self.import(report_file_path, mapping, klass, conflict_target, import_args: {}) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength
+      def self.import(report_file_path, mapping, klass, conflict_target, import_args: {}, &blk) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength
+        ClassCallbackExecutor.run_if_defined(klass, :sync_import) do
+          perform_in_batches(report_file_path, mapping, klass, conflict_target, import_args: import_args, &blk)
+        end
+      end
+
+      def self.perform_in_batches(report_file_path, mapping, klass, conflict_target, import_args: {})
         csv_column_names = mapping.keys
         database_column_names = mapping.values.map { |value| value[:database_column_name] }
         rows = []

data/lib/canvas_sync/importers/legacy_importer.rb

@@ -8,8 +8,10 @@ module CanvasSync
       # @param report_file_path [String]
       # @param klass [Object]
       def self.import(report_file_path, klass, account_id, options)
-        CSV.foreach(report_file_path, headers: true, header_converters: :symbol) do |row|
-          klass.create_or_update_from_csv(row, account_id, options)
+        ClassCallbackExecutor.run_if_defined(klass, :sync_import) do
+          CSV.foreach(report_file_path, headers: true, header_converters: :symbol) do |row|
+            klass.create_or_update_from_csv(row, account_id, options)
+          end
         end
       end
     end

data/lib/canvas_sync/job.rb

@@ -61,7 +61,9 @@ module CanvasSync
       if model.respond_to? :create_or_update
         model.create_or_update(params)
       elsif model.method_defined? :update_from_api_params!
-        model.find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params)
+        instance = model.find_or_initialize_by(canvas_id: params['id'])
+        instance.update_from_api_params!(params)
+        instance
       else
         raise "Could not create/update #{model.name}. It must have a create_or_update(params) ClassMethod or implement ApiSyncable."
       end

data/lib/canvas_sync/job_chain.rb

@@ -0,0 +1,57 @@
+module CanvasSync
+  class JobChain
+    attr_reader :chain_data
+
+    delegate_missing_to :chain_data
+
+    VALID_PLACEMENT_PARAMETERS = %i[before after].freeze
+
+    def initialize(chain_data)
+      @chain_data = chain_data
+    end
+
+    def jobs
+      chain_data[:jobs]
+    end
+
+    def global_options
+      chain_data[:global_options]
+    end
+
+    def merge_options(job, options)
+      jobs.each do |j|
+        j[:options].deep_merge!(options) if job_matches_pattern(j, job)
+      end
+    end
+
+    def insert(new_job, **kwargs)
+      invalid_params = kwargs.keys - VALID_PLACEMENT_PARAMETERS
+      raise "Invalid placement parameters: #{invalid_params.map(&:to_s).join(', ')}" if invalid_params.present?
+      raise "Exactly one placement parameter may be provided" if kwargs.values.compact!.length > 1
+
+      if !kwargs.present?
+        jobs << new_job
+      else
+        placement = kwargs.keys[0]
+        relative_to = kwargs.values[0]
+
+        index = jobs.index { |job| job_matches_pattern(job, relative_to) }
+        raise "Could not find a \"#{relative_to}\" job in the chain" if index.nil?
+
+        index += 1 if placement == :after
+        new_job[:job] = new_job[:job].to_s
+        jobs.insert(index, new_job)
+      end
+    end
+
+    def process!(extra_options: {})
+      CanvasSync::invoke_next(self, extra_options: extra_options)
+    end
+
+    private
+
+    def job_matches_pattern(job_entry, pattern)
+      job_entry[:job].to_s == pattern.to_s
+    end
+  end
+end

data/lib/canvas_sync/jobs/sync_accounts_job.rb

@@ -0,0 +1,31 @@
+module CanvasSync
+  module Jobs
+    class SyncAccountsJob < ReportStarter
+      # Starts a provisioning report for just accounts.
+      #
+      # Provisioning reports do not scope accounts by term, so when we are
+      # running provisioning by term we sync users first so we don't duplicate
+      # the work of syncing all accounts for each term.
+      #
+      # @param job_chain [Hash]
+      # @param options [Hash]
+      def perform(job_chain, options)
+        unless options[:root_account] == false
+          acc_params = CanvasSync.get_canvas_sync_client(job_chain[:global_options]).account("self")
+          update_or_create_model(Account, acc_params)
+        end
+
+        super(
+          job_chain,
+          "proservices_provisioning_csv",
+          merge_report_params(job_chain, options, {
+            accounts: true,
+            include_deleted: true,
+          }, term_scope: false),
+          CanvasSync::Processors::ProvisioningReportProcessor.to_s,
+          { models: ["accounts"] },
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/record.rb

@@ -0,0 +1,9 @@
+module CanvasSync
+  module Record
+    extend ActiveSupport::Concern
+
+    included do
+      define_model_callbacks :sync_import
+    end
+  end
+end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.12.0".freeze
+  VERSION = "0.13.0".freeze
 end

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 RSpec.describe CanvasSync do
   describe '.provisioning_sync' do
     it 'invokes the first job in the queue and passes on the rest of the job chain' do
-      expected_job_chain = CanvasSync.default_provisioning_report_chain(['courses'], nil)
+      expected_job_chain = CanvasSync.default_provisioning_report_chain(['courses'], nil).chain_data
       first_job = expected_job_chain[:jobs].shift
 
       expect(CanvasSync::Jobs::SyncTermsJob).to receive(:perform_later)
@@ -31,7 +31,7 @@ RSpec.describe CanvasSync do
           provisioning: { c: 3 },
           global: { d: 4 },
         })
-        expect(chain).to eq({
+        expect(chain.chain_data).to eq({
           jobs: [
             { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: { a: 1 } },
             { job: CanvasSync::Jobs::SyncUsersJob.to_s, options: { b: 2 } },
@@ -44,7 +44,7 @@ RSpec.describe CanvasSync do
       context 'we are syncing users with a term scope' do
         it 'syncs the users in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['users', 'courses'], :active)
-          expect(chain).to eq({
+          expect(chain.chain_data).to eq({
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncUsersJob.to_s, options: {} },
@@ -58,7 +58,7 @@ RSpec.describe CanvasSync do
       context 'we are syncing users without a term scope' do
         it 'syncs users along with the rest of the provisioning report' do
           chain = CanvasSync.default_provisioning_report_chain(['users', 'courses'])
-          expect(chain).to eq({
+          expect(chain.chain_data).to eq({
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: ['users', 'courses'] } }
@@ -71,7 +71,7 @@ RSpec.describe CanvasSync do
       context 'we are syncing roles with a term scope' do
         it 'syncs the roles in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['roles', 'courses'], :active)
-          expect(chain).to eq({
+          expect(chain.chain_data).to eq({
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncRolesJob.to_s, options: {} },
@@ -85,7 +85,7 @@ RSpec.describe CanvasSync do
       context 'we are syncing roles without a term scope' do
         it 'syncs roles separately even with no term scope' do
           chain = CanvasSync.default_provisioning_report_chain(['roles', 'courses'])
-          expect(chain).to eq({
+          expect(chain.chain_data).to eq({
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncRolesJob.to_s, options: {} },
@@ -99,7 +99,7 @@ RSpec.describe CanvasSync do
       context 'we are syncing admins with a term scope' do
         it 'syncs the admins in a separate job that runs first' do
           chain = CanvasSync.default_provisioning_report_chain(['admins', 'courses'], :active)
-          expect(chain).to eq({
+          expect(chain.chain_data).to eq({
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncAdminsJob.to_s, options: {} },
@@ -113,7 +113,7 @@ RSpec.describe CanvasSync do
       context 'we are syncing admins without a term scope' do
         it 'syncs admins separately even with no term scope' do
           chain = CanvasSync.default_provisioning_report_chain(['admins', 'courses'])
-          expect(chain).to eq({
+          expect(chain.chain_data).to eq({
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncAdminsJob.to_s, options: {} },
@@ -128,7 +128,7 @@ RSpec.describe CanvasSync do
         it "appends the SyncAssignmentsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments assignments])
 
-          expect(chain).to eq(
+          expect(chain.chain_data).to eq(
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments] } },
@@ -143,7 +143,7 @@ RSpec.describe CanvasSync do
         it "appends the SyncSubmissionsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments submissions])
 
-          expect(chain).to eq(
+          expect(chain.chain_data).to eq(
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments] } },
@@ -158,7 +158,7 @@ RSpec.describe CanvasSync do
         it "appends the SyncAssignmentGroupsJob" do
           chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments assignment_groups])
 
-          expect(chain).to eq(
+          expect(chain.chain_data).to eq(
             jobs: [
               { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
               { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments] } },
@@ -185,7 +185,7 @@ RSpec.describe CanvasSync do
             }
           }
         ]
-      )
+      ).chain_data
       first_job = expected_job_chain[:jobs].shift
 
       expect(CanvasSync::Jobs::SyncSimpleTableJob).to receive(:perform_later)
@@ -242,9 +242,9 @@ RSpec.describe CanvasSync do
         global_options: {}
       }
 
-      expect(chain).to eq(expected_job_chain)
+      expect(chain.chain_data).to eq(expected_job_chain)
 
     end
   end
-  
+
 end