canvas_sync 0.27.12 → 0.27.14

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.27.12
+  version: 0.27.14
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -413,14 +413,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 email:
 - pseng@instructure.com
 executables: []
@@ -569,6 +569,7 @@ files:
 - lib/canvas_sync/version.rb
 - lib/tasks/canvas_sync_tasks.rake
 - spec/canvas_sync/canvas_sync_spec.rb
+- spec/canvas_sync/concerns/ability_helper_spec.rb
 - spec/canvas_sync/concerns/deleted_scoping_spec.rb
 - spec/canvas_sync/concerns/legacy_columns_spec.rb
 - spec/canvas_sync/engine_spec.rb
@@ -636,79 +637,11 @@ files:
 - spec/factories/submission_factory.rb
 - spec/factories/term_factory.rb
 - spec/factories/user_factory.rb
-- spec/internal/app/models/account.rb
-- spec/internal/app/models/admin.rb
 - spec/internal/app/models/application_record.rb
-- spec/internal/app/models/assignment.rb
-- spec/internal/app/models/assignment_group.rb
-- spec/internal/app/models/assignment_override.rb
-- spec/internal/app/models/content_migration.rb
-- spec/internal/app/models/context_module.rb
-- spec/internal/app/models/context_module_item.rb
-- spec/internal/app/models/course.rb
-- spec/internal/app/models/course_nickname.rb
-- spec/internal/app/models/course_progress.rb
-- spec/internal/app/models/enrollment.rb
-- spec/internal/app/models/grading_period.rb
-- spec/internal/app/models/grading_period_group.rb
-- spec/internal/app/models/group.rb
-- spec/internal/app/models/group_membership.rb
-- spec/internal/app/models/learning_outcome.rb
-- spec/internal/app/models/learning_outcome_result.rb
-- spec/internal/app/models/pseudonym.rb
-- spec/internal/app/models/role.rb
-- spec/internal/app/models/rubric.rb
-- spec/internal/app/models/rubric_assessment.rb
-- spec/internal/app/models/rubric_association.rb
-- spec/internal/app/models/score.rb
-- spec/internal/app/models/section.rb
-- spec/internal/app/models/submission.rb
-- spec/internal/app/models/term.rb
-- spec/internal/app/models/user.rb
-- spec/internal/app/models/user_observer.rb
-- spec/internal/app/services/live_events/assignment_event.rb
-- spec/internal/app/services/live_events/course_event.rb
-- spec/internal/app/services/live_events/course_section_event.rb
-- spec/internal/app/services/live_events/enrollment_event.rb
-- spec/internal/app/services/live_events/grade_event.rb
-- spec/internal/app/services/live_events/module_event.rb
-- spec/internal/app/services/live_events/module_item_event.rb
-- spec/internal/app/services/live_events/submission_event.rb
-- spec/internal/app/services/live_events/syllabus_event.rb
-- spec/internal/app/services/live_events/user_event.rb
 - spec/internal/bin/rails
 - spec/internal/config/database.yml
 - spec/internal/config/routes.rb
 - spec/internal/config/storage.yml
-- spec/internal/db/migrate/20251029222307_create_users.rb
-- spec/internal/db/migrate/20251029222308_create_pseudonyms.rb
-- spec/internal/db/migrate/20251029222309_create_courses.rb
-- spec/internal/db/migrate/20251029222310_create_groups.rb
-- spec/internal/db/migrate/20251029222311_create_group_memberships.rb
-- spec/internal/db/migrate/20251029222312_create_accounts.rb
-- spec/internal/db/migrate/20251029222313_create_terms.rb
-- spec/internal/db/migrate/20251029222314_create_enrollments.rb
-- spec/internal/db/migrate/20251029222315_create_sections.rb
-- spec/internal/db/migrate/20251029222316_create_assignments.rb
-- spec/internal/db/migrate/20251029222317_create_submissions.rb
-- spec/internal/db/migrate/20251029222318_create_roles.rb
-- spec/internal/db/migrate/20251029222319_create_admins.rb
-- spec/internal/db/migrate/20251029222320_create_assignment_groups.rb
-- spec/internal/db/migrate/20251029222321_create_context_modules.rb
-- spec/internal/db/migrate/20251029222322_create_context_module_items.rb
-- spec/internal/db/migrate/20251029222324_create_grading_periods.rb
-- spec/internal/db/migrate/20251029222325_create_grading_period_groups.rb
-- spec/internal/db/migrate/20251029222326_create_content_migrations.rb
-- spec/internal/db/migrate/20251029222327_create_learning_outcomes.rb
-- spec/internal/db/migrate/20251029222328_create_learning_outcome_results.rb
-- spec/internal/db/migrate/20251029222330_create_rubrics.rb
-- spec/internal/db/migrate/20251029222331_create_rubric_associations.rb
-- spec/internal/db/migrate/20251029222332_create_rubric_assessments.rb
-- spec/internal/db/migrate/20251029222334_create_assignment_overrides.rb
-- spec/internal/db/migrate/20251029222335_create_scores.rb
-- spec/internal/db/migrate/20251029223411_create_user_observers.rb
-- spec/internal/db/migrate/20251029224009_create_course_nicknames.rb
-- spec/internal/db/migrate/20251029224010_create_course_progresses.rb
 - spec/internal/db/schema.rb
 - spec/spec_helper.rb
 - spec/support/fake_canvas.rb
@@ -737,8 +670,6 @@ files:
 - spec/support/fixtures/reports/learning_outcome_results.csv
 - spec/support/fixtures/reports/learning_outcomes.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/rubric_assessments.csv
 - spec/support/fixtures/reports/rubric_associations.csv
 - spec/support/fixtures/reports/rubrics.csv
@@ -770,6 +701,7 @@ specification_version: 4
 summary: Gem for generating Canvas models and migrations and syncing data from Canvas
 test_files:
 - spec/canvas_sync/canvas_sync_spec.rb
+- spec/canvas_sync/concerns/ability_helper_spec.rb
 - spec/canvas_sync/concerns/deleted_scoping_spec.rb
 - spec/canvas_sync/concerns/legacy_columns_spec.rb
 - spec/canvas_sync/engine_spec.rb
@@ -837,79 +769,11 @@ test_files:
 - spec/factories/submission_factory.rb
 - spec/factories/term_factory.rb
 - spec/factories/user_factory.rb
-- spec/internal/app/models/account.rb
-- spec/internal/app/models/admin.rb
 - spec/internal/app/models/application_record.rb
-- spec/internal/app/models/assignment.rb
-- spec/internal/app/models/assignment_group.rb
-- spec/internal/app/models/assignment_override.rb
-- spec/internal/app/models/content_migration.rb
-- spec/internal/app/models/context_module.rb
-- spec/internal/app/models/context_module_item.rb
-- spec/internal/app/models/course.rb
-- spec/internal/app/models/course_nickname.rb
-- spec/internal/app/models/course_progress.rb
-- spec/internal/app/models/enrollment.rb
-- spec/internal/app/models/grading_period.rb
-- spec/internal/app/models/grading_period_group.rb
-- spec/internal/app/models/group.rb
-- spec/internal/app/models/group_membership.rb
-- spec/internal/app/models/learning_outcome.rb
-- spec/internal/app/models/learning_outcome_result.rb
-- spec/internal/app/models/pseudonym.rb
-- spec/internal/app/models/role.rb
-- spec/internal/app/models/rubric.rb
-- spec/internal/app/models/rubric_assessment.rb
-- spec/internal/app/models/rubric_association.rb
-- spec/internal/app/models/score.rb
-- spec/internal/app/models/section.rb
-- spec/internal/app/models/submission.rb
-- spec/internal/app/models/term.rb
-- spec/internal/app/models/user.rb
-- spec/internal/app/models/user_observer.rb
-- spec/internal/app/services/live_events/assignment_event.rb
-- spec/internal/app/services/live_events/course_event.rb
-- spec/internal/app/services/live_events/course_section_event.rb
-- spec/internal/app/services/live_events/enrollment_event.rb
-- spec/internal/app/services/live_events/grade_event.rb
-- spec/internal/app/services/live_events/module_event.rb
-- spec/internal/app/services/live_events/module_item_event.rb
-- spec/internal/app/services/live_events/submission_event.rb
-- spec/internal/app/services/live_events/syllabus_event.rb
-- spec/internal/app/services/live_events/user_event.rb
 - spec/internal/bin/rails
 - spec/internal/config/database.yml
 - spec/internal/config/routes.rb
 - spec/internal/config/storage.yml
-- spec/internal/db/migrate/20251029222307_create_users.rb
-- spec/internal/db/migrate/20251029222308_create_pseudonyms.rb
-- spec/internal/db/migrate/20251029222309_create_courses.rb
-- spec/internal/db/migrate/20251029222310_create_groups.rb
-- spec/internal/db/migrate/20251029222311_create_group_memberships.rb
-- spec/internal/db/migrate/20251029222312_create_accounts.rb
-- spec/internal/db/migrate/20251029222313_create_terms.rb
-- spec/internal/db/migrate/20251029222314_create_enrollments.rb
-- spec/internal/db/migrate/20251029222315_create_sections.rb
-- spec/internal/db/migrate/20251029222316_create_assignments.rb
-- spec/internal/db/migrate/20251029222317_create_submissions.rb
-- spec/internal/db/migrate/20251029222318_create_roles.rb
-- spec/internal/db/migrate/20251029222319_create_admins.rb
-- spec/internal/db/migrate/20251029222320_create_assignment_groups.rb
-- spec/internal/db/migrate/20251029222321_create_context_modules.rb
-- spec/internal/db/migrate/20251029222322_create_context_module_items.rb
-- spec/internal/db/migrate/20251029222324_create_grading_periods.rb
-- spec/internal/db/migrate/20251029222325_create_grading_period_groups.rb
-- spec/internal/db/migrate/20251029222326_create_content_migrations.rb
-- spec/internal/db/migrate/20251029222327_create_learning_outcomes.rb
-- spec/internal/db/migrate/20251029222328_create_learning_outcome_results.rb
-- spec/internal/db/migrate/20251029222330_create_rubrics.rb
-- spec/internal/db/migrate/20251029222331_create_rubric_associations.rb
-- spec/internal/db/migrate/20251029222332_create_rubric_assessments.rb
-- spec/internal/db/migrate/20251029222334_create_assignment_overrides.rb
-- spec/internal/db/migrate/20251029222335_create_scores.rb
-- spec/internal/db/migrate/20251029223411_create_user_observers.rb
-- spec/internal/db/migrate/20251029224009_create_course_nicknames.rb
-- spec/internal/db/migrate/20251029224010_create_course_progresses.rb
 - spec/internal/db/schema.rb
 - spec/spec_helper.rb
 - spec/support/fake_canvas.rb
@@ -938,8 +802,6 @@ test_files:
 - spec/support/fixtures/reports/learning_outcome_results.csv
 - spec/support/fixtures/reports/learning_outcomes.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/rubric_assessments.csv
 - spec/support/fixtures/reports/rubric_associations.csv
 - spec/support/fixtures/reports/rubrics.csv

data/spec/internal/app/models/account.rb

@@ -1,35 +0,0 @@
-# #
-# 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 Account < ApplicationRecord
-  include CanvasSync::Record
-  include CanvasSync::Concerns::ApiSyncable
-  # include CanvasSync::Concerns::Account::Ancestry # Add support for the ancestry Gem
-  # include CanvasSync::Concerns::LiveEventSync
-  # include CanvasSync::Concerns::DeletedScoping
-
-  canvas_sync_features :defaults
-
-  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
-  has_many :groups, primary_key: :canvas_id, foreign_key: :canvas_account_id
-
-  scope :active, -> { where.not(workflow_state: 'deleted') }
-  # scope :should_canvas_sync, -> { active } # Optional - uses .active if not given
-
-  api_syncable({
-    name: :name,
-    workflow_state: :workflow_state,
-    canvas_parent_account_id: :parent_account_id,
-  }, -> (api) { api.account(canvas_id) })
-end

data/spec/internal/app/models/admin.rb

@@ -1,35 +0,0 @@
-# #
-# 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 Admin < ApplicationRecord
-  include CanvasSync::Record
-  include CanvasSync::Concerns::ApiSyncable
-  # include CanvasSync::Concerns::DeletedScoping
-
-  canvas_sync_features :defaults
-
-  validates :canvas_id, uniqueness: true, presence: true
-  belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true
-  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
-  belongs_to :role, primary_key: :canvas_id, foreign_key: :canvas_role_id, optional: true
-
-  api_syncable({
-    canvas_id: :id,
-    role_name: :role,
-    canvas_role_id: :role_id,
-    canvas_user_id: ->(r) { r['user']['id'] },
-    # NOTICE: The :account_id field is added by CanvasSync - it is not included in the Canvas API response
-    canvas_account_id: :account_id,
-    workflow_state: :workflow_state,
-  }, -> (api) {
-    admins = api.account_admins(canvas_account_id).all_pages!
-    admin_data = admins.find{|admin| admin['id'] == canvas_id }
-    raise Footrest::HttpError::NotFound unless admin_data.present?
-    admin_data
-  })
-end

data/spec/internal/app/models/assignment.rb

@@ -1,39 +0,0 @@
-# #
-# 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 Assignment < ApplicationRecord
-  include CanvasSync::Record
-  include CanvasSync::Concerns::ApiSyncable
-  # include CanvasSync::Concerns::LiveEventSync
-  # include CanvasSync::Concerns::DeletedScoping
-
-  canvas_sync_features :defaults
-
-  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
-  belongs_to :assignment_group, optional: true, primary_key: :canvas_id, foreign_key: :canvas_assignment_group_id
-  has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_assignment_id
-
-  has_many :context_module_items, as: :content, primary_key: :canvas_id, foreign_key: :canvas_content_id, foreign_type: :canvas_content_type, dependent: :destroy
-  has_many :context_modules, through: :context_module_items
-
-  api_syncable({
-    title: :name,
-    description: :description,
-    due_at: :due_at,
-    unlock_at: :unlock_at,
-    lock_at: :lock_at,
-    points_possible: :points_possible,
-    grading_type: :grading_type,
-    submission_types: lambda { |p| p["submission_types"].join(",") },
-    canvas_context_id: :course_id,
-    canvas_context_type: lambda { |_p| "Course" },
-    canvas_assignment_group_id: :assignment_group_id,
-    canvas_grading_standard_id: :grading_standard_id,
-  }, -> (api) { api.assignment(canvas_context_id, canvas_id) })
-end

data/spec/internal/app/models/assignment_group.rb

@@ -1,31 +0,0 @@
-# #
-# 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 AssignmentGroup < ApplicationRecord
-  include CanvasSync::Record
-  include CanvasSync::Concerns::ApiSyncable
-  # include CanvasSync::Concerns::LiveEventSync
-  # include CanvasSync::Concerns::DeletedScoping
-
-  canvas_sync_features :defaults
-
-  validates :canvas_id, uniqueness: true, presence: true
-  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
-  has_many :assignments, primary_key: :canvas_id, foreign_key: :canvas_assignment_group_id
-
-  serialize :rules
-
-  api_syncable({
-    canvas_id: :id,
-    name: :name,
-    position: :position,
-    rules: :rules,
-    group_weight: :group_weight,
-    workflow_state: ->(p) { 'available' },
-  }, -> (api) { api.assignment_group(canvas_course_id, canvas_id) })
-end

data/spec/internal/app/models/assignment_override.rb

@@ -1,34 +0,0 @@
-# #
-# 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 AssignmentOverride < ApplicationRecord
-  include CanvasSync::Record
-  include CanvasSync::Concerns::ApiSyncable
-
-  canvas_sync_features :defaults
-
-  validates :canvas_id, uniqueness: true, presence: true
-  belongs_to :assignment, primary_key: :canvas_id, foreign_key: :canvas_assignment_id, optional: true
-  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
-
-  api_syncable({
-    canvas_id: :id,
-    canvas_assignment_id: :assignment_id,
-    title: :title,
-    workflow_state: :workflow_state,
-    due_at: :due_at,
-    all_day: :all_day,
-    all_day_date: :all_day_date,
-    unlock_at: :unlock_at,
-    lock_at: :lock_at,
-    student_ids: ->(r) { JSON.parse(r[:student_ids]) if r[:student_ids].present? },
-    canvas_group_id: :group_id,
-    canvas_section_id: :course_section_id,
-    canvas_course_id: -> (r) { r.dig(:assignment, :course_id) }
-  }, -> (api) { api.assignment_override(canvas_assignment_id, canvas_id) })
-end

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

@@ -1,18 +0,0 @@
-# #
-# 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
-
-  canvas_sync_features :defaults
-
-  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/internal/app/models/context_module.rb

@@ -1,69 +0,0 @@
-# # #
-# 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.
-#
-
-
-# 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
-  include CanvasSync::Record
-  include CanvasSync::Concerns::ApiSyncable
-  # include CanvasSync::Concerns::DeletedScoping
-
-  # include CanvasSync::Concerns::LiveEventSync
-  # live_events_config event_prefix: :module
-  # def process_live_event(event_type, payload, metadata)
-  #   self.canvas_context_id = payload['context_id']
-  #   self.canvas_context_type = payload['context_type']
-  #   super
-  # end
-
-  canvas_sync_features :defaults
-
-  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
-  has_many :assignments, through: :context_module_items
-
-  serialize :completion_requirements
-  serialize :prerequisites
-
-  api_syncable({
-    canvas_id: :id,
-    canvas_context_id: :context_id,
-    canvas_context_type: :context_type,
-    position: :position,
-    name: :name,
-    workflow_state: :workflow_state,
-    unlock_at: :unlock_at,
-    completion_requirements: :completion_requirements,
-    prerequisites: :prerequisites,
-    requirement_count: :requirement_count
-  }, lambda { |api|
-    course_modules = api.course_modules(canvas_context_id, { include: ['items'] }) # avoids having 2 API calls for modules as we reuse this data
-    context_module = course_modules&.detect { |course_module| course_module['id'] == canvas_id }
-
-    if context_module.nil? # no context_module here means it is deleted in Canvas
-      self.workflow_state = :deleted
-      return self
-    end
-
-    # The ContextModule model in Canvas has the 'completion_requirements' and 'prerequisites' fields that are not returned directly from the API
-    # We need to compute them here based on data that we receive from course_modules in the API
-    context_module['prerequisites'] = course_modules.map do |course_module|
-      next unless context_module['prerequisite_module_ids']&.include?(course_module['id'])
-
-      {
-        id: course_module['id'],
-        name: course_module['name'],
-        type: 'context_module'
-      }.with_indifferent_access
-    end.compact
-
-    context_module['completion_requirements'] = context_module['items']&.map { |item| item['completion_requirement'] }&.compact
-    context_module
-  })
-end

data/spec/internal/app/models/context_module_item.rb

@@ -1,33 +0,0 @@
-# # #
-# 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 ContextModuleItem < ApplicationRecord
-  include CanvasSync::Record
-  include CanvasSync::Concerns::ApiSyncable
-  # include CanvasSync::Concerns::LiveEventSync
-  # include CanvasSync::Concerns::DeletedScoping
-
-  canvas_sync_features :defaults
-
-  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
-  belongs_to :assignment, foreign_key: :canvas_assignment_id, primary_key: :canvas_id
-
-  api_syncable({
-    canvas_id: :id,
-    canvas_context_module_id: :module_id,
-    position: :position,
-    canvas_content_type: :type,
-    canvas_content_id: :content_id,
-    canvas_assignment_id: :assignment_id
-  }, lambda { |api|
-    module_item = api.module_item(context_module.context.canvas_id, context_module.canvas_id, canvas_id)
-    module_item['assignment_id'] = api.assignment(context_module.context.canvas_id, module_item['content_id'])['id'] if module_item['type'] == 'Assignment'
-    module_item
-  })
-end