canvas_sync 0.20.0 → 0.20.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64eb8c4553c0f0bc3d4c67d934c1fa50d59d0dff7fe5907bf84697b48a7e26d8
-  data.tar.gz: 78acaecd3238bed5e840d3508a62addce82b8a56913ce672326d758f425eeae8
+  metadata.gz: 43303b8631013b7ccf949d391e027e98fb8c18abfbd36f22cddedc8ee2bfda7d
+  data.tar.gz: 35ded010f078affa8a164f7168c313318e90c9c1415afbc1c049a059912204d5
 SHA512:
-  metadata.gz: '086155981aa48b2b1bebe0b9e29b441211424399f09ce66e958d896f2f0c5f375b409d11c156b0f6bacbc229d61c6f30046113f4a953a30e6a82f6714671f598'
-  data.tar.gz: 35b520ee37d2d5c74939a3e1c12374722a1e9eec81ed703a68af83e7ee1af5993987fe415dcc6c75fe413a96da65138ee1228a92ca22c2bbcbff87553a192990
+  metadata.gz: 214cf249fbadc69713bd7a29159874fc64891e886438f72a43f02c08d2f45b46f8d52fd7c3916d12fe260d94f669df42a1f9c46f69c8c56915760fd73878ff14
+  data.tar.gz: b8c1b5b0038f12a676704e8b957894441f9566dfcfa1a91132436520aa12b0d86590a57f5d74fccc27f769fc82b1530ad908e88693d2213b7888ad739e07a087

data/lib/canvas_sync/concerns/ability_helper.rb

@@ -1,4 +1,5 @@
 begin
+  require "panda_pal"
   require "panda_pal/concerns/ability_helper"
 rescue LoadError
 end

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

@@ -0,0 +1,46 @@
+# <%= autogenerated_migration_warning %>
+
+class CreateLearningOutcomeResults < ActiveRecord::Migration[5.1]
+  def change
+    create_table :learning_outcome_results do |t|
+      t.bigint :canvas_id, null: false
+      t.bigint :canvas_context_id
+      t.string :canvas_context_type
+      t.bigint :canvas_association_id
+      t.string :canvas_association_type
+      t.bigint :canvas_content_tag_id
+      t.bigint :canvas_learning_outcome_id
+      t.bigint :canvas_user_id
+      t.boolean :mastery
+      t.boolean :original_mastery
+      t.bigint :canvas_artifact_id
+      t.string :canvas_artifact_type
+      t.datetime :assessed_at
+      t.string :title
+      t.float :percent
+      t.bigint :canvas_associated_asset_id
+      t.string :canvas_associated_asset_type
+      t.integer :attempt
+      t.float :score
+      t.float :possible
+      t.float :original_score
+      t.float :original_possible
+      t.string :workflow_state
+
+      t.timestamps
+    end
+
+    add_index :learning_outcome_results, :canvas_id, unique: true
+    add_index :learning_outcome_results, %i[
+      canvas_user_id
+      canvas_content_tag_id
+      canvas_association_id
+      canvas_association_type
+      canvas_associated_asset_id
+      canvas_associated_asset_type
+    ], unique: true, name: :index_learning_outcome_results_association
+    add_index :learning_outcome_results, :canvas_content_tag_id
+    add_index :learning_outcome_results, :canvas_learning_outcome_id
+    add_index :learning_outcome_results, %i[canvas_artifact_id canvas_artifact_type], name: :index_learning_outcome_results_on_canvas_arid_and_artype
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# # <%= autogenerated_model_warning %>
+
+class LearningOutcomeResult < ActiveRecord::Base
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
+  belongs_to :learning_outcome, primary_key: :canvas_id, foreign_key: :canvas_learning_outcome_id, optional: true
+  belongs_to :alignment, class_name: "ContentTag", primary_key: :canvas_id, foreign_key: :canvas_content_tag_id, optional: true
+  belongs_to :association_object,
+             polymorphic: [:rubric_association, :assignment],
+             foreign_key: :association_id,
+             foreign_type: :association_type,
+             optional: true
+  belongs_to :artifact,
+            polymorphic: [:rubric_assessment, :submission],
+            primary_key: :canvas_artifact_id,
+            foreign_key: :canvas_artifact_id,
+            foreign_type: :canvas_artifact_type,
+            optional: true
+
+  belongs_to :context, polymorphic: [:course], primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type, optional: true
+
+  # Not yet implemented in CanvasSync
+  # belongs_to :associated_asset,
+  #           polymorphic:
+  #                 [:assessment_question,
+  #                  :assignment,
+  #                  { quiz: "Quizzes::Quiz", assessment: "LiveAssessments::Assessment" }],
+  #           polymorphic_prefix: true
+
+  # Not yet implemented in CanvasSync
+  # has_many :learning_outcome_question_results, dependent: :destroy
+
+  api_syncable({
+    canvas_id: :id,
+    canvas_content_tag_id: :links&.[]("alignment"),
+    canvas_learning_outcome_id: :links&.[]("learning_outcome"),
+    canvas_user_id: :links&.[]("user"),
+    score: :score,
+    assessed_at: :submitted_or_assessed_at,
+    percent: :percent
+  }, ->(api) {
+    api.get("/api/v1/courses/#{self.canvas_context_id}/#{self.canvas_id}")&.find { |item| item[:id] == self.canvas_id }
+  })
+end

data/lib/canvas_sync/importers/bulk_importer.rb

@@ -102,15 +102,24 @@ module CanvasSync
         options = { validate: false, on_duplicate_key_update: update_conditions }.merge(import_args)
         options.delete(:on_duplicate_key_update) if options.key?(:on_duplicate_key_ignore)
 
-        result = klass.import(columns, rows, options)
-
-        global_updates = {
-          canvas_synced_at: DateTime.now,
-          canvas_sync_batch_id: JobBatches::Batch.current_context[:sync_batch_id],
+        result = nil
+        callback_env = {
+          batch: rows,
+          import_result: nil,
+          import_options: options,
         }
-        global_updates.slice!(*klass.column_names.map(&:to_sym))
-        if global_updates.present? && result.ids.present?
-          klass.where(id: result.ids).update_all(global_updates)
+        ClassCallbackExecutor.run_if_defined(klass, :sync_batch_import, env: callback_env) do
+          result = klass.import(columns, rows, options)
+          callback_env[:import_result] = result
+
+          global_updates = {
+            canvas_synced_at: DateTime.now,
+            canvas_sync_batch_id: JobBatches::Batch.current_context[:sync_batch_id],
+          }
+          global_updates.slice!(*klass.column_names.map(&:to_sym))
+          if global_updates.present? && result.ids.present?
+            klass.where(id: result.ids).update_all(global_updates)
+          end
         end
 
         result

data/lib/canvas_sync/processors/model_mappings.yml

@@ -569,6 +569,79 @@ learning_outcomes:
       database_column_name: short_description
       type: text
 
+learning_outcome_results:
+  conflict_target: id
+  report_columns:
+    id:
+      database_column_name: canvas_id
+      type: integer
+    context_id:
+      database_column_name: canvas_context_id
+      type: integer
+    context_type:
+      database_column_name: canvas_context_type
+      type: string
+    association_id:
+      database_column_name: canvas_association_id
+      type: integer
+    association_type:
+      database_column_name: canvas_association_type
+      type: string
+    content_tag_id:
+      database_column_name: canvas_content_tag_id
+      type: integer
+    learning_outcome_id:
+      database_column_name: canvas_learning_outcome_id
+      type: integer
+    user_id:
+      database_column_name: canvas_user_id
+      type: integer
+    mastery:
+      database_column_name: mastery
+      type: boolean
+    original_mastery:
+      database_column_name: original_mastery
+      type: boolean
+    artifact_id:
+      database_column_name: canvas_artifact_id
+      type: integer
+    artifact_type:
+      database_column_name: canvas_artifact_type
+      type: string
+    assessed_at:
+      database_column_name: assessed_at
+      type: datetime
+    title:
+      database_column_name: title
+      type: string
+    percent:
+      database_column_name: percent
+      type: float
+    associated_asset_id:
+      database_column_name: canvas_associated_asset_id
+      type: integer
+    associated_asset_type:
+      database_column_name: canvas_associated_asset_type
+      type: string
+    attempt:
+      database_column_name: attempt
+      type: integer
+    score:
+      database_column_name: score
+      type: float
+    possible:
+      database_column_name: possible
+      type: float
+    original_score:
+      database_column_name: original_score
+      type: float
+    original_possible:
+      database_column_name: original_possible
+      type: float
+    workflow_state:
+      database_column_name: workflow_state
+      type: string
+
 course_nicknames:
   conflict_target:
     - canvas_user_id

data/lib/canvas_sync/processors/provisioning_report_processor.rb

@@ -124,6 +124,10 @@ module CanvasSync
         end
       end
 
+      def bulk_process_learning_outcome_results(report_file_path)
+        do_bulk_import(report_file_path, LearningOutcomeResult, options: @options)
+      end
+
       def bulk_process_course_nicknames(report_file_path)
         exists = []
         do_bulk_import(report_file_path, CourseNickname, options: @options) do |row|

data/lib/canvas_sync/record.rb

@@ -100,6 +100,7 @@ module CanvasSync
 
     included do
       define_model_callbacks :sync_import
+      define_model_callbacks :sync_batch_import
 
       col_names = column_names rescue []
 

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.20.0".freeze
+  VERSION = "0.20.3".freeze
 end

data/lib/canvas_sync.rb

@@ -46,6 +46,7 @@ module CanvasSync
     grading_period_groups
     content_migrations
     learning_outcomes
+    learning_outcome_results
     course_nicknames
     rubrics
     rubric_associations
@@ -214,7 +215,7 @@ module CanvasSync
       end
 
       current_chain.insert(
-        generate_provisioning_jobs(models, options)
+        generate_provisioning_jobs(models - ['terms'], options)
       )
 
       # Skip syncing terms if not required

data/spec/canvas_sync/processors/provisioning_report_processor_spec.rb

@@ -131,6 +131,18 @@ RSpec.describe CanvasSync::Processors::ProvisioningReportProcessor do
       }.to change { LearningOutcome.count }.by(2)
     end
 
+    it 'processes learning_outcome_results' do
+      expect {
+        subject.process('spec/support/fixtures/reports/learning_outcome_results.csv', { models: ['learning_outcome_results'] }, 1)
+      }.to change { LearningOutcomeResult.count }.by(2)
+
+      columns = LearningOutcomeResult.attribute_names - ['id', 'created_at', 'updated_at']
+      expect(LearningOutcomeResult.all.pluck(columns.join(','))).to eq([
+        [1, 1, 'Course', 1, 'RubricAssociation', 1, 1, 1, true, true, 1, 'RubricAssessment', '2012-01-01T00:00:00Z', 'Learning Outcome Result 1', 1.0, 1, 'LearningOutcomeGroup', 1, 5.0, 5.0, 5.0, 5.0, 'active'],
+        [2, 2, 'Course', 2, 'RubricAssociation', 2, 2, 2, true, true, 2, 'RubricAssessment', '2013-01-01T00:00:00Z', 'Learning Outcome Result 2', 2.0, 2, 'LearningOutcomeGroup', 1, 10.0, 10.0, 10.0, 10.0, 'active']
+      ])
+    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)

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

@@ -0,0 +1,54 @@
+# 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 LearningOutcomeResult < ActiveRecord::Base
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
+  belongs_to :learning_outcome, primary_key: :canvas_id, foreign_key: :canvas_learning_outcome_id, optional: true
+  belongs_to :alignment, class_name: "ContentTag", primary_key: :canvas_id, foreign_key: :canvas_content_tag_id, optional: true
+  belongs_to :association_object,
+             polymorphic: [:rubric_association, :assignment],
+             foreign_key: :association_id,
+             foreign_type: :association_type,
+             optional: true
+  belongs_to :artifact,
+            polymorphic: [:rubric_assessment, :submission],
+            primary_key: :canvas_artifact_id,
+            foreign_key: :canvas_artifact_id,
+            foreign_type: :canvas_artifact_type,
+            optional: true
+
+  belongs_to :context, polymorphic: [:course], primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type, optional: true
+
+  # Not yet implemented in CanvasSync
+  # belongs_to :associated_asset,
+  #           polymorphic:
+  #                 [:assessment_question,
+  #                  :assignment,
+  #                  { quiz: "Quizzes::Quiz", assessment: "LiveAssessments::Assessment" }],
+  #           polymorphic_prefix: true
+
+  # Not yet implemented in CanvasSync
+  # has_many :learning_outcome_question_results, dependent: :destroy
+
+  api_syncable({
+    canvas_id: :id,
+    canvas_content_tag_id: :links&.[]("alignment"),
+    canvas_learning_outcome_id: :links&.[]("learning_outcome"),
+    canvas_user_id: :links&.[]("user"),
+    score: :score,
+    assessed_at: :submitted_or_assessed_at,
+    percent: :percent
+  }, ->(api) {
+    api.get("/api/v1/courses/#{self.canvas_context_id}/#{self.canvas_id}")&.find { |item| item[:id] == self.canvas_id }
+  })
+end

data/spec/dummy/db/migrate/20240523101010_create_learning_outcome_results.rb

@@ -0,0 +1,52 @@
+# #
+# 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 CreateLearningOutcomeResults < ActiveRecord::Migration[5.1]
+  def change
+    create_table :learning_outcome_results do |t|
+      t.bigint :canvas_id, null: false
+      t.bigint :canvas_context_id
+      t.string :canvas_context_type
+      t.bigint :canvas_association_id
+      t.string :canvas_association_type
+      t.bigint :canvas_content_tag_id
+      t.bigint :canvas_learning_outcome_id
+      t.bigint :canvas_user_id
+      t.boolean :mastery
+      t.boolean :original_mastery
+      t.bigint :canvas_artifact_id
+      t.string :canvas_artifact_type
+      t.datetime :assessed_at
+      t.string :title
+      t.float :percent
+      t.bigint :canvas_associated_asset_id
+      t.string :canvas_associated_asset_type
+      t.integer :attempt
+      t.float :score
+      t.float :possible
+      t.float :original_score
+      t.float :original_possible
+      t.string :workflow_state
+
+      t.timestamps
+    end
+
+    add_index :learning_outcome_results, :canvas_id, unique: true
+    add_index :learning_outcome_results, %i[
+      canvas_user_id
+      canvas_content_tag_id
+      canvas_association_id
+      canvas_association_type
+      canvas_associated_asset_id
+      canvas_associated_asset_type
+    ], unique: true, name: :index_learning_outcome_results_association
+    add_index :learning_outcome_results, :canvas_content_tag_id
+    add_index :learning_outcome_results, :canvas_learning_outcome_id
+    add_index :learning_outcome_results, %i[canvas_artifact_id canvas_artifact_type], name: :index_learning_outcome_results_on_canvas_arid_and_artype
+  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: 2024_05_10_101100) do
+ActiveRecord::Schema.define(version: 2024_05_23_101010) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -282,6 +282,46 @@ ActiveRecord::Schema.define(version: 2024_05_10_101100) do
     t.index ["canvas_id"], name: "index_learning_outcomes_on_canvas_id", unique: true
   end
 
+  create_table "learning_outcome_results", force: :cascade do |t|
+    t.bigint "canvas_id",  null: false
+    t.bigint "canvas_context_id"
+    t.string "canvas_context_type"
+    t.bigint "canvas_association_id"
+    t.string "canvas_association_type"
+    t.bigint "canvas_content_tag_id"
+    t.bigint "canvas_learning_outcome_id"
+    t.bigint "canvas_user_id"
+    t.boolean "mastery"
+    t.boolean "original_mastery"
+    t.bigint "canvas_artifact_id"
+    t.string "canvas_artifact_type"
+    t.datetime "assessed_at"
+    t.string "title"
+    t.float "percent"
+    t.bigint "canvas_associated_asset_id"
+    t.string "canvas_associated_asset_type"
+    t.integer "attempt"
+    t.float "score"
+    t.float "possible"
+    t.float "original_score"
+    t.float "original_possible"
+    t.string "workflow_state"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index "canvas_id", unique: true
+    t.index [
+      "canvas_user_id",
+      "canvas_content_tag_id",
+      "canvas_association_id",
+      "canvas_association_type",
+      "canvas_associated_asset_id",
+      "canvas_associated_asset_type"
+    ], unique: true, name: 'index_learning_outcome_results_association'
+    t.index "canvas_content_tag_id"
+    t.index "canvas_learning_outcome_id"
+    t.index ["canvas_artifact_id", "canvas_artifact_type"], name: "index_learning_outcome_results_on_canvas_arid_and_artype"
+  end
+
   create_table "pseudonyms", force: :cascade do |t|
     t.bigint "canvas_id", null: false
     t.bigint "canvas_user_id"

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

@@ -0,0 +1,3 @@
+id,context_id,context_type,association_id,association_type,content_tag_id,learning_outcome_id,user_id,mastery,original_mastery,artifact_id,artifact_type,assessed_at,title,percent,associated_asset_id,associated_asset_type,attempt,score,possible,original_score,original_possible,workflow_state
+1,1,Course,1,RubricAssociation,1,1,1,true,true,1,RubricAssessment,2012-01-01T00:00:00Z,Learning Outcome Result 1,1.0,1,LearningOutcomeGroup,1,5.0,5.0,5.0,5.0,active
+2,2,Course,2,RubricAssociation,2,2,2,true,true,2,RubricAssessment,2013-01-01T00:00:00Z,Learning Outcome Result 2,2.0,2,LearningOutcomeGroup,1,10.0,10.0,10.0,10.0,active

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.20.3
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -437,6 +437,7 @@ files:
 - lib/canvas_sync/generators/templates/migrations/create_grading_periods.rb
 - lib/canvas_sync/generators/templates/migrations/create_group_memberships.rb
 - lib/canvas_sync/generators/templates/migrations/create_groups.rb
+- lib/canvas_sync/generators/templates/migrations/create_learning_outcome_results.rb
 - lib/canvas_sync/generators/templates/migrations/create_learning_outcomes.rb
 - lib/canvas_sync/generators/templates/migrations/create_pseudonyms.rb
 - lib/canvas_sync/generators/templates/migrations/create_roles.rb
@@ -463,6 +464,7 @@ files:
 - lib/canvas_sync/generators/templates/models/group.rb
 - lib/canvas_sync/generators/templates/models/group_membership.rb
 - lib/canvas_sync/generators/templates/models/learning_outcome.rb
+- lib/canvas_sync/generators/templates/models/learning_outcome_result.rb
 - lib/canvas_sync/generators/templates/models/pseudonym.rb
 - lib/canvas_sync/generators/templates/models/role.rb
 - lib/canvas_sync/generators/templates/models/rubric.rb
@@ -621,6 +623,7 @@ files:
 - spec/dummy/app/models/group.rb
 - spec/dummy/app/models/group_membership.rb
 - spec/dummy/app/models/learning_outcome.rb
+- spec/dummy/app/models/learning_outcome_result.rb
 - spec/dummy/app/models/pseudonym.rb
 - spec/dummy/app/models/role.rb
 - spec/dummy/app/models/rubric.rb
@@ -698,6 +701,7 @@ files:
 - spec/dummy/db/migrate/20240509105100_create_rubrics.rb
 - spec/dummy/db/migrate/20240510094100_create_rubric_associations.rb
 - spec/dummy/db/migrate/20240510101100_create_rubric_assessments.rb
+- spec/dummy/db/migrate/20240523101010_create_learning_outcome_results.rb
 - spec/dummy/db/schema.rb
 - spec/factories/account_factory.rb
 - spec/factories/admin_factory.rb
@@ -749,6 +753,7 @@ files:
 - spec/support/fixtures/reports/grading_periods.csv
 - spec/support/fixtures/reports/group_memberships.csv
 - spec/support/fixtures/reports/groups.csv
+- 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
@@ -866,6 +871,7 @@ test_files:
 - spec/support/fixtures/reports/group_memberships.csv
 - spec/support/fixtures/reports/rubric_assessments.csv
 - spec/support/fixtures/reports/enrollments.csv
+- spec/support/fixtures/reports/learning_outcome_results.csv
 - spec/support/fixtures/reports/course_nicknames.csv
 - spec/support/fixtures/reports/provisioning_csv
 - spec/support/fixtures/reports/grading_periods.csv
@@ -896,6 +902,7 @@ test_files:
 - spec/dummy/db/migrate/20190927204545_create_roles.rb
 - spec/dummy/db/migrate/20190702203622_create_accounts.rb
 - spec/dummy/db/migrate/20190702203626_create_assignments.rb
+- spec/dummy/db/migrate/20240523101010_create_learning_outcome_results.rb
 - spec/dummy/db/migrate/20200415171620_create_groups.rb
 - spec/dummy/db/migrate/20190927204546_create_admins.rb
 - spec/dummy/db/migrate/20190702203625_create_sections.rb
@@ -946,6 +953,7 @@ test_files:
 - spec/dummy/app/models/admin.rb
 - spec/dummy/app/models/rubric_assessment.rb
 - spec/dummy/app/models/learning_outcome.rb
+- spec/dummy/app/models/learning_outcome_result.rb
 - spec/dummy/app/models/grading_period.rb
 - spec/dummy/app/models/context_module.rb
 - spec/dummy/app/models/context_module_item.rb