canvas_sync 0.19.0.beta10 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd64554a1f451160b874e8901b7275a25b6f9c526d687a29e531abff9f0b285
-  data.tar.gz: 9cac31449a633b4c3513088abf00b0274b0ce794e54f72742d65802bf2bb5a8c
+  metadata.gz: 56b320065eb2aec256795336a077f2c5c93652293313bd3d69ebbb8f65a70d4e
+  data.tar.gz: 750f717c88eebcdebc3959bd084fd2872bee21f7bb507ae7f15207ad2ea9bfcd
 SHA512:
-  metadata.gz: a479a1705e765b3e338c7aed688728436fbeedd82809218bcbd288775e9a2175c62d5294dc2a206fdb77a7945f0223be723b74e9ec6800635841124e42149c22
-  data.tar.gz: 96bef245b0ba1a4de671dfc1d49a184d35bd03fea62efad44dbaac1bdcff345cabd19b1f12147f1d334b967641ce72e9c66704e0709f55b5f2378475d39d9d86
+  metadata.gz: b98a1f43e84bda12e540da6d4d45c2e5781435db2232f7b71400d42991cfd7cb38e1c686930801e3e91ac9ccd97e550e2cf5661e4895cbd804cfd7bd739bed8d
+  data.tar.gz: b0e1546e0ceb23dc1577cdaab04a6b6e64fe2351634aa1cd3a0cc8897d78d301585350f68baf577badcccedd77b9280a7d8fb65e0c7abfb574bee2120d086c2f

data/lib/canvas_sync/concerns/account/ancestry.rb

@@ -11,7 +11,7 @@ module CanvasSync::Concerns
       extend ActiveSupport::Concern
       include CanvasSync::Record
 
-      CanvasSync::Record.define_feature self, default: ->{ column_names.include?("ancestry") }
+      CanvasSync::Record.define_feature self, default: ->{ column_names.include?("ancestry") rescue nil }
 
       included do
         has_ancestry

data/lib/canvas_sync/concerns/api_syncable.rb

@@ -1,7 +1,7 @@
 module CanvasSync::Concerns
   module ApiSyncable
     extend ActiveSupport::Concern
-    NON_EXISTANT_ERRORS = [Faraday::Error::ResourceNotFound, Footrest::HttpError::NotFound]
+    NON_EXISTANT_ERRORS = [Faraday::ResourceNotFound, Footrest::HttpError::NotFound]
 
     class_methods do
       def find_or_fetch(canvas_id, save: false, retries: 1, **kwargs)

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

@@ -0,0 +1,17 @@
+# <%= autogenerated_migration_warning %>
+
+class CreateCourseNicknames < ActiveRecord::Migration[5.1]
+  def change
+    create_table :course_nicknames do |t|
+      t.bigint :canvas_user_preference_value_id, null: false
+      t.integer :canvas_user_id
+      t.integer :canvas_course_id
+      t.string :nickname
+
+      t.timestamps
+    end
+
+    add_index :course_nicknames, :canvas_user_preference_value_id, unique: true
+    add_index :course_nicknames, [:canvas_course_id, :canvas_user_id], unique: true
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# # <%= autogenerated_migration_warning %>
+
+class CourseNickname < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  canvas_sync_features :defaults
+
+  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
+end

data/lib/canvas_sync/processors/model_mappings.yml

@@ -565,3 +565,21 @@ learning_outcomes:
     description:
       database_column_name: description
       type: string
+
+course_nicknames:
+  conflict_target:
+    - canvas_user_id
+    - canvas_course_id
+  report_columns:
+    user_preference_value_id:
+      database_column_name: canvas_user_preference_value_id
+      type: integer
+    canvas_user_id:
+      database_column_name: canvas_user_id
+      type: integer
+    canvas_course_id:
+      database_column_name: canvas_course_id
+      type: integer
+    nickname:
+      database_column_name: nickname
+      type: string

data/lib/canvas_sync/processors/provisioning_report_processor.rb

@@ -123,6 +123,16 @@ module CanvasSync
           row
         end
       end
+
+      def bulk_process_course_nicknames(report_file_path)
+        exists = []
+        do_bulk_import(report_file_path, CourseNickname, options: @options) do |row|
+          exists << row[:user_preference_value_id]
+          row
+        end
+        # Canvas does not soft delete UserPreferenceValues so there's no point in doing the same
+        CourseNickname.where.not(canvas_user_preference_value_id: exists).delete_all
+      end
     end
   end
 end

data/lib/canvas_sync/record.rb

@@ -47,7 +47,7 @@ module CanvasSync
         feat = applicable_canvas_sync_features[feature]
 
         if !feat
-          raise "Unkown feature :#{feature} for model #{self}"
+          raise "Unknown feature :#{feature} for model #{self}"
         end
 
         setup = feat[:setup]

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.19.0.beta10".freeze
+  VERSION = "0.19.0".freeze
 end

data/lib/canvas_sync.rb

@@ -46,6 +46,7 @@ module CanvasSync
     grading_period_groups
     content_migrations
     learning_outcomes
+    course_nicknames
   ].freeze
 
   SUPPORTED_TERM_SCOPE_MODELS = %w[

data/spec/canvas_sync/processors/provisioning_report_processor_spec.rb

@@ -131,6 +131,15 @@ RSpec.describe CanvasSync::Processors::ProvisioningReportProcessor do
       }.to change { LearningOutcome.count }.by(2)
     end
 
+    it 'processes course_nicknames' do
+      CourseNickname.create(canvas_user_preference_value_id: 42, canvas_course_id: 42, canvas_user_id: 42, nickname: 'test')
+      expect(CourseNickname.all.pluck(:canvas_user_preference_value_id)).to include(42)
+      expect {
+        subject.process('spec/support/fixtures/reports/course_nicknames.csv', { models: ['course_nicknames'] }, 1)
+      }.to change { CourseNickname.count }.by(1)
+      expect(CourseNickname.all.pluck(:canvas_user_preference_value_id)).not_to include(42)
+    end
+
     it 'model with composite key behaves as expected' do
       expect {
         subject.process('spec/support/fixtures/reports/user_observers.csv', { models: ['user_observers'] }, 1)

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

@@ -11,6 +11,8 @@ class Account < ApplicationRecord
   include CanvasSync::Concerns::ApiSyncable
   # include CanvasSync::Concerns::Account::Ancestry # Add support for the ancestry Gem
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
 
   has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_account_id

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

@@ -10,6 +10,8 @@ class Admin < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  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

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

@@ -10,6 +10,8 @@ class Assignment < 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
   belongs_to :assignment_group, optional: true, primary_key: :canvas_id, foreign_key: :canvas_assignment_group_id

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

@@ -10,6 +10,8 @@ class AssignmentGroup < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  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

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

@@ -10,6 +10,8 @@ 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
 

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

@@ -13,6 +13,8 @@ class ContextModule < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  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

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

@@ -10,6 +10,8 @@ class ContextModuleItem < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  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

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

@@ -10,6 +10,8 @@ class Course < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_id, optional: true
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_course_id

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# # #
+# 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 CourseNickname < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  canvas_sync_features :defaults
+
+  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
+end

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

@@ -10,6 +10,8 @@ class Enrollment < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: 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

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

@@ -9,6 +9,8 @@
 class GradingPeriod < ApplicationRecord
   include CanvasSync::Record
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :grading_period_group, primary_key: :canvas_id, foreign_key: :canvas_grading_period_group_id, optional: true
 end

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

@@ -9,5 +9,7 @@
 class GradingPeriodGroup < ApplicationRecord
   include CanvasSync::Record
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
 end

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

@@ -10,6 +10,8 @@ class Group < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  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
   belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true

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

@@ -10,6 +10,8 @@ class GroupMembership < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :group, primary_key: :canvas_id, foreign_key: :canvas_group_id
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id

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

@@ -12,6 +12,8 @@ class LearningOutcome < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  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
 
   api_syncable({

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

@@ -9,6 +9,8 @@
 class Pseudonym < ApplicationRecord
   include CanvasSync::Record
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id
 end

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

@@ -10,6 +10,8 @@ class Role < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_id
 

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

@@ -10,6 +10,8 @@ class Section < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  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 :enrollments, primary_key: :canvas_id, foreign_key: :canvas_section_id

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

@@ -10,6 +10,8 @@ class Submission < 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 :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true

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

@@ -10,6 +10,8 @@ class Term < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :courses, foreign_key: :canvas_term_id, primary_key: :canvas_id
   belongs_to :grading_period_group, primary_key: :canvas_id, foreign_key: :grading_period_group_id, optional: true

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

@@ -10,6 +10,8 @@ class User < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :pseudonyms, primary_key: :canvas_id, foreign_key: :canvas_user_id
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_user_id

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

@@ -10,6 +10,8 @@ class UserObserver < ApplicationRecord
   include CanvasSync::Record
   include CanvasSync::Concerns::ApiSyncable
 
+  canvas_sync_features :defaults
+
   validates :canvas_id, uniqueness: true, presence: true
 
   belongs_to :observing_user, primary_key: :canvas_id, foreign_key: :observing_user_id, class_name: 'User', optional: true

data/spec/dummy/db/migrate/20240408223326_create_course_nicknames.rb

@@ -0,0 +1,23 @@
+# #
+# 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 CreateCourseNicknames < ActiveRecord::Migration[5.1]
+  def change
+    create_table :course_nicknames do |t|
+      t.bigint :canvas_user_preference_value_id, null: false
+      t.integer :canvas_user_id
+      t.integer :canvas_course_id
+      t.string :nickname
+
+      t.timestamps
+    end
+
+    add_index :course_nicknames, :canvas_user_preference_value_id, unique: true
+    add_index :course_nicknames, [:canvas_course_id, :canvas_user_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: 2022_09_26_221926) do
+ActiveRecord::Schema.define(version: 2024_04_08_223326) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -157,6 +157,17 @@ ActiveRecord::Schema.define(version: 2022_09_26_221926) do
     t.index ["canvas_id"], name: "index_context_modules_on_canvas_id", unique: true
   end
 
+  create_table "course_nicknames", force: :cascade do |t|
+    t.bigint "canvas_user_preference_value_id", null: false
+    t.integer "canvas_user_id"
+    t.integer "canvas_course_id"
+    t.string "nickname"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_course_id", "canvas_user_id"], name: "index_course_nicknames_on_canvas_course_id_and_canvas_user_id", unique: true
+    t.index ["canvas_user_preference_value_id"], name: "index_course_nicknames_on_canvas_user_preference_value_id", unique: true
+  end
+
   create_table "courses", force: :cascade do |t|
     t.bigint "canvas_id", null: false
     t.string "sis_id"

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

@@ -0,0 +1,3 @@
+user_preference_value_id,canvas_user_id,canvas_course_id,nickname
+86,17,35,foo
+123,8348,12,bar

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.19.0.beta10
+  version: 0.19.0
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -430,6 +430,7 @@ files:
 - 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_course_nicknames.rb
 - lib/canvas_sync/generators/templates/migrations/create_courses.rb
 - lib/canvas_sync/generators/templates/migrations/create_enrollments.rb
 - lib/canvas_sync/generators/templates/migrations/create_grading_period_groups.rb
@@ -452,6 +453,7 @@ files:
 - 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
+- lib/canvas_sync/generators/templates/models/course_nickname.rb
 - lib/canvas_sync/generators/templates/models/enrollment.rb
 - lib/canvas_sync/generators/templates/models/grading_period.rb
 - lib/canvas_sync/generators/templates/models/grading_period_group.rb
@@ -597,6 +599,7 @@ files:
 - spec/dummy/app/models/context_module.rb
 - spec/dummy/app/models/context_module_item.rb
 - spec/dummy/app/models/course.rb
+- spec/dummy/app/models/course_nickname.rb
 - spec/dummy/app/models/enrollment.rb
 - spec/dummy/app/models/grading_period.rb
 - spec/dummy/app/models/grading_period_group.rb
@@ -673,6 +676,7 @@ files:
 - spec/dummy/db/migrate/20220308072643_create_content_migrations.rb
 - spec/dummy/db/migrate/20220712210559_create_learning_outcomes.rb
 - spec/dummy/db/migrate/20220926221926_create_users.rb
+- spec/dummy/db/migrate/20240408223326_create_course_nicknames.rb
 - spec/dummy/db/schema.rb
 - spec/factories/account_factory.rb
 - spec/factories/admin_factory.rb
@@ -717,6 +721,7 @@ files:
 - 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/course_nicknames.csv
 - spec/support/fixtures/reports/courses.csv
 - spec/support/fixtures/reports/enrollments.csv
 - spec/support/fixtures/reports/grading_period_groups.csv
@@ -746,9 +751,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: 
@@ -832,6 +837,7 @@ test_files:
 - spec/support/fixtures/reports/assignment_groups.csv
 - spec/support/fixtures/reports/group_memberships.csv
 - spec/support/fixtures/reports/enrollments.csv
+- spec/support/fixtures/reports/course_nicknames.csv
 - spec/support/fixtures/reports/provisioning_csv
 - spec/support/fixtures/reports/grading_periods.csv
 - spec/support/fixtures/reports/content_migrations.csv
@@ -852,6 +858,7 @@ test_files:
 - spec/dummy/db/migrate/20220926221926_create_users.rb
 - spec/dummy/db/migrate/20210907233330_create_grading_periods.rb
 - spec/dummy/db/migrate/20190702203631_create_context_modules.rb
+- spec/dummy/db/migrate/20240408223326_create_course_nicknames.rb
 - spec/dummy/db/migrate/20190702203632_create_context_module_items.rb
 - spec/dummy/db/migrate/20190927204545_create_roles.rb
 - spec/dummy/db/migrate/20190702203622_create_accounts.rb
@@ -893,6 +900,7 @@ test_files:
 - spec/dummy/app/services/live_events/module_item_event.rb
 - spec/dummy/app/services/live_events/submission_updated_event.rb
 - spec/dummy/app/services/live_events/user_event.rb
+- spec/dummy/app/models/course_nickname.rb
 - spec/dummy/app/models/user.rb
 - spec/dummy/app/models/submission.rb
 - spec/dummy/app/models/group_membership.rb