Module: CanvasSync
- Defined in:
- lib/canvas_sync.rb,
lib/canvas_sync/job.rb,
lib/canvas_sync/config.rb,
lib/canvas_sync/engine.rb,
lib/canvas_sync/record.rb,
lib/canvas_sync/version.rb,
lib/canvas_sync/job_chain.rb,
lib/canvas_sync/misc_helper.rb,
lib/canvas_sync/sidekiq_job.rb,
app/models/canvas_sync/job_log.rb,
lib/canvas_sync/jobs/fork_gather.rb,
lib/canvas_sync/jobs/report_checker.rb,
lib/canvas_sync/jobs/report_starter.rb,
lib/canvas_sync/jobs/sync_roles_job.rb,
lib/canvas_sync/jobs/sync_terms_job.rb,
lib/canvas_sync/jobs/sync_admins_job.rb,
lib/canvas_sync/jobs/sync_accounts_job.rb,
lib/canvas_sync/class_callback_executor.rb,
lib/canvas_sync/importers/bulk_importer.rb,
lib/canvas_sync/importers/legacy_importer.rb,
lib/canvas_sync/jobs/report_processor_job.rb,
lib/canvas_sync/jobs/sync_assignments_job.rb,
lib/canvas_sync/jobs/sync_submissions_job.rb,
lib/canvas_sync/jobs/sync_simple_table_job.rb,
lib/canvas_sync/processors/normal_processor.rb,
lib/canvas_sync/processors/report_processor.rb,
lib/canvas_sync/generators/install_generator.rb,
lib/canvas_sync/jobs/sync_context_modules_job.rb,
lib/canvas_sync/jobs/sync_assignment_groups_job.rb,
lib/canvas_sync/processors/assignments_processor.rb,
lib/canvas_sync/processors/submissions_processor.rb,
lib/canvas_sync/jobs/sync_provisioning_report_job.rb,
lib/canvas_sync/jobs/sync_context_module_items_job.rb,
lib/canvas_sync/processors/context_modules_processor.rb,
lib/canvas_sync/processors/assignment_groups_processor.rb,
lib/canvas_sync/generators/install_live_events_generator.rb,
lib/canvas_sync/processors/provisioning_report_processor.rb,
lib/canvas_sync/processors/context_module_items_processor.rb
Defined Under Namespace
Modules: ApiSyncable, Concerns, Importers, Jobs, MiscHelper, Processors, Record, Sidekiq Classes: ClassCallbackExecutor, Config, Engine, InstallGenerator, InstallLiveEventsGenerator, Job, JobChain, JobLog
Constant Summary collapse
- SUPPORTED_MODELS =
%w[ users pseudonyms courses groups group_memberships 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 module module_item course_section ].freeze
- SUPPORTED_NON_PROV_REPORTS =
%w[ graded_submissions ].freeze
- VERSION =
"0.16.5".freeze
Class Method Summary collapse
-
.config ⇒ Object
Returns the CanvasSync config.
-
.configure {|config| ... } ⇒ Object
Configure options for CanvasSync.
-
.default_provisioning_report_chain(models, term_scope = nil, legacy_support = false, account_id = nil, options: {}) ⇒ Hash
Syncs terms, users/roles/admins if necessary, then the rest of the specified models.
- .duplicate_chain(job_chain) ⇒ Object deprecated Deprecated.
- .fork(job_log, job_chain, keys: [], &blk) ⇒ Object
- .generate_provisioning_jobs(model_list, options_hash, job_options: {}, only_split: nil, default_key: :provisioning) ⇒ Object
-
.get_canvas_sync_client(options) ⇒ Object
Calls the canvas_sync_client in your app.
- .group_by_job_options(model_list, options_hash, only_split: nil, default_key: :provisioning) ⇒ Object
-
.invoke_next(job_chain, extra_options: {}) ⇒ Object
Invokes the next job in a chain of jobs.
-
.process_jobs(job_chain) ⇒ Object
Runs a chain of ordered jobs.
-
.provisioning_sync(models, term_scope: nil, legacy_support: false, account_id: nil) ⇒ Object
Runs a standard provisioning sync job with no extra report types.
-
.simple_report_chain(reports_mapping, term_scope = nil, account_id = nil) ⇒ Object
Syn any report to an specific set of models.
-
.simple_report_sync(reports_mapping, term_scope: nil, account_id: nil) ⇒ Object
Runs a report different from provisioning sync job with no extra report types.
-
.sync_scope(scope) ⇒ Object
Given a Model or Relation, scope it down to items that should be synced.
- .validate_live_events!(events) ⇒ Object
- .validate_models!(models) ⇒ Object
Class Method Details
.config ⇒ Object
Returns the CanvasSync config
320 321 322 |
# File 'lib/canvas_sync.rb', line 320 def config @config ||= CanvasSync::Config.new end |
.configure {|config| ... } ⇒ Object
Configure options for CanvasSync. See config.rb for valid configuration options.
Example:
CanvasSync.configure do |config|
config.classes_to_only_log_errors_on << "Blah"
end
314 315 316 317 |
# File 'lib/canvas_sync.rb', line 314 def configure yield config config end |
.default_provisioning_report_chain(models, term_scope = nil, legacy_support = false, account_id = nil, options: {}) ⇒ Hash
Syncs terms, users/roles/admins if necessary, then the rest of the specified models.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/canvas_sync.rb', line 174 def default_provisioning_report_chain(models, term_scope=nil, legacy_support=false, account_id=nil, options: {}) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength return unless models.present? models.map! &:to_s term_scope = term_scope.to_s if term_scope = .deep_symbolize_keys! model_job_map = { terms: CanvasSync::Jobs::SyncTermsJob, accounts: CanvasSync::Jobs::SyncAccountsJob, roles: CanvasSync::Jobs::SyncRolesJob, admins: CanvasSync::Jobs::SyncAdminsJob, assignments: CanvasSync::Jobs::SyncAssignmentsJob, submissions: CanvasSync::Jobs::SyncSubmissionsJob, assignment_groups: CanvasSync::Jobs::SyncAssignmentGroupsJob, context_modules: CanvasSync::Jobs::SyncContextModulesJob, context_module_items: CanvasSync::Jobs::SyncContextModuleItemsJob, }.with_indifferent_access jobs = [] try_add_model_job = ->(model) { return unless models.include?(model) jobs.push(job: model_job_map[model].to_s, options: [model.to_sym] || {}) models -= [model] } ############################## # Pre provisioning report jobs ############################## # Always sync Terms first models.unshift('terms') unless models.include?('terms') try_add_model_job.call('terms') # Accounts, users, roles, and admins are synced before provisioning because they cannot be scoped to term try_add_model_job.call('accounts') # These Models use the provisioning report, but are not term-scoped, # so we sync them before to ensure work is not duplicated if term_scope.present? models -= (first_provisioning_models = models & ['users', 'pseudonyms']) jobs.concat( generate_provisioning_jobs(first_provisioning_models, ) ) end try_add_model_job.call('roles') try_add_model_job.call('admins') pre_provisioning_jobs = jobs ############################### # Post provisioning report jobs ############################### jobs = [] try_add_model_job.call('assignments') try_add_model_job.call('submissions') try_add_model_job.call('assignment_groups') try_add_model_job.call('context_modules') try_add_model_job.call('context_module_items') post_provisioning_jobs = jobs ############################### # Main provisioning job and queueing ############################### jobs = [ *pre_provisioning_jobs, *generate_provisioning_jobs(models, , job_options: { term_scope: term_scope }, only_split: ['users']), *post_provisioning_jobs, ] = { legacy_support: legacy_support } [:account_id] = account_id if account_id.present? .merge!([:global]) if [:global].present? JobChain.new(jobs: jobs, global_options: ) end |
.duplicate_chain(job_chain) ⇒ Object
104 105 106 |
# File 'lib/canvas_sync.rb', line 104 def duplicate_chain(job_chain) Marshal.load(Marshal.dump(job_chain)) end |
.fork(job_log, job_chain, keys: [], &blk) ⇒ Object
118 119 120 121 |
# File 'lib/canvas_sync.rb', line 118 def fork(job_log, job_chain, keys: [], &blk) job_chain = JobChain.new(job_chain) unless job_chain.is_a?(JobChain) job_chain.fork(job_log, keys: keys, &blk) end |
.generate_provisioning_jobs(model_list, options_hash, job_options: {}, only_split: nil, default_key: :provisioning) ⇒ Object
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/canvas_sync.rb', line 274 def generate_provisioning_jobs(model_list, , job_options: {}, only_split: nil, default_key: :provisioning) # Group the model options as best we can. # This is mainly for backwards compatibility, since 'users' was previously it's own job unique_option_models = ( model_list, , only_split: only_split, default_key: default_key, ) unique_option_models.map do |mopts, models| opts = { models: models } opts.merge!() opts.merge!(mopts) if mopts.present? { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: opts, } end end |
.get_canvas_sync_client(options) ⇒ Object
Calls the canvas_sync_client in your app. If you have specified an account ID when starting the job it will pass the account ID to your canvas_sync_client method.
299 300 301 302 303 304 305 |
# File 'lib/canvas_sync.rb', line 299 def get_canvas_sync_client() if [:account_id] canvas_sync_client([:account_id]) else canvas_sync_client end end |
.group_by_job_options(model_list, options_hash, only_split: nil, default_key: :provisioning) ⇒ Object
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/canvas_sync.rb', line 253 def (model_list, , only_split: nil, default_key: :provisioning) dup_models = [ *model_list ] unique_option_models = {} filtered_models = only_split ? (only_split & model_list) : model_list filtered_models.each do |m| mopts = [m.to_sym] || [default_key] unique_option_models[mopts] ||= [] unique_option_models[mopts] << m dup_models.delete(m) end if dup_models.present? mopts = [default_key] unique_option_models[mopts] ||= [] unique_option_models[mopts].concat(dup_models) end unique_option_models end |
.invoke_next(job_chain, extra_options: {}) ⇒ Object
Invokes the next job in a chain of jobs.
This should typically be called automatically by the gem where necessary.
113 114 115 116 |
# File 'lib/canvas_sync.rb', line 113 def invoke_next(job_chain, extra_options: {}) job_chain = JobChain.new(job_chain) unless job_chain.is_a?(JobChain) job_chain.perform_next() end |
.process_jobs(job_chain) ⇒ Object
Runs a chain of ordered jobs
See the README for usage and examples
99 100 101 |
# File 'lib/canvas_sync.rb', line 99 def process_jobs(job_chain) invoke_next(job_chain) end |
.provisioning_sync(models, term_scope: nil, legacy_support: false, account_id: nil) ⇒ Object
Runs a standard provisioning sync job with no extra report types. Terms will be synced first using the API. If you are syncing users/roles/admins and have also specified a Term scope, Users/Roles/Admins will by synced first, before every other model (as Users/Roles/Admins are never scoped to Term).
76 77 78 79 |
# File 'lib/canvas_sync.rb', line 76 def provisioning_sync(models, term_scope: nil, legacy_support: false, account_id: nil) validate_models!(models) invoke_next(default_provisioning_report_chain(models, term_scope, legacy_support, account_id)) end |
.simple_report_chain(reports_mapping, term_scope = nil, account_id = nil) ⇒ Object
Syn any report to an specific set of models
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/canvas_sync.rb', line 143 def simple_report_chain(reports_mapping, term_scope=nil, account_id=nil) jobs = reports_mapping.map do |report| { job: CanvasSync::Jobs::SyncSimpleTableJob.to_s, options: { report_name: report[:report_name], model: report[:model], mapping: report[:model], klass: report[:model].singularize.capitalize.to_s, term_scope: term_scope, params: report[:params] } } end = {} [:account_id] = account_id if account_id.present? JobChain.new(jobs: jobs, global_options: ) end |
.simple_report_sync(reports_mapping, term_scope: nil, account_id: nil) ⇒ Object
Runs a report different from provisioning sync job with no extra report types.
90 91 92 |
# File 'lib/canvas_sync.rb', line 90 def simple_report_sync(reports_mapping, term_scope: nil, account_id: nil) invoke_next(simple_report_chain(reports_mapping, term_scope, account_id)) end |
.sync_scope(scope) ⇒ Object
Given a Model or Relation, scope it down to items that should be synced
124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/canvas_sync.rb', line 124 def sync_scope(scope) terms = %i[should_canvas_sync active_for_canvas_sync should_sync active_for_sync active] terms.each do |t| return scope.send(t) if scope.respond_to?(t) end model = scope.try(:model) || scope if model.try(:column_names)&.include?(:workflow_state) return scope.where.not(workflow_state: %w[deleted]) end Rails.logger.warn("Could not filter Syncable Scope for model '#{scope.try(:model)&.name || scope.name}'") scope end |
.validate_live_events!(events) ⇒ Object
330 331 332 333 334 |
# File 'lib/canvas_sync.rb', line 330 def validate_live_events!(events) invalid = events - SUPPORTED_LIVE_EVENTS return if invalid.empty? raise "Invalid live event(s) specified: #{invalid.join(', ')}. Only #{SUPPORTED_LIVE_EVENTS.join(', ')} are supported." end |
.validate_models!(models) ⇒ Object
324 325 326 327 328 |
# File 'lib/canvas_sync.rb', line 324 def validate_models!(models) invalid = models - SUPPORTED_MODELS return if invalid.empty? raise "Invalid model(s) specified: #{invalid.join(', ')}. Only #{SUPPORTED_MODELS.join(', ')} are supported." end |