canvas_sync 0.22.3 → 0.22.5

data/spec/canvas_sync/processors/context_modules_processor_spec.rb

@@ -8,6 +8,20 @@ RSpec.describe CanvasSync::Processors::ContextModulesProcessor do
       expect {
         subject.process("spec/support/fixtures/reports/context_modules.csv", {}, 1)
       }.to change { ContextModule.count }.by(2)
+      expect(ContextModule.first).to have_attributes(
+        canvas_id: 23,
+        canvas_context_id: 785,
+        canvas_context_type: 'Course',
+        name: 'New Mod',
+        position: 1,
+        workflow_state: 'active',
+        completion_requirements: [],
+        prerequisites: []
+      )
+      # Check for properly serialized YAML
+      expect(ContextModule.last.completion_requirements).to eq([
+        { id: 1, type: 'must_view' }
+      ])
     end
   end
 end

data/spec/canvas_sync/processors/course_completion_report_processor_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Processors::CourseCompletionReportProcessor do
+
+  describe '#process' do
+    it 'inserts course progresses' do
+      expect {
+        described_class.process('spec/support/fixtures/reports/course_progresses.csv', {}, 1)
+      }.to change { CourseProgress.count }.by(2)
+      cp = CourseProgress.first
+      expect(cp).to have_attributes(
+        canvas_user_id: 1,
+        canvas_course_id: 1,
+        requirement_count: 0,
+        requirement_completed_count: 0,
+      )
+      expect(cp.completion_date.strftime('%Y-%m-%d %H:%M:%S')).to eq('2024-05-01 09:00:00')
+      expect(CourseProgress.last).to have_attributes(
+        canvas_user_id: 2,
+        canvas_course_id: 2,
+        requirement_count: 1,
+        requirement_completed_count: 1,
+        completion_date: nil
+      )
+    end
+
+    context 'record already present in the database' do
+      before do
+        described_class.process('spec/support/fixtures/reports/course_progresses.csv', {}, 1)
+      end
+
+      it 'updates the course progress' do
+        expect {
+          described_class.process('spec/support/fixtures/reports/course_progresses_conflict.csv', {}, 1)
+        }.to change { CourseProgress.count }.by(0)
+        cp = CourseProgress.first
+        expect(cp).to have_attributes(
+          canvas_user_id: 1,
+          canvas_course_id: 1,
+          requirement_count: 10,
+          requirement_completed_count: 10,
+        )
+        expect(cp.completion_date.strftime('%Y-%m-%d %H:%M:%S')).to eq('2028-05-01 09:00:00')
+      end
+    end
+  end
+end

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

@@ -20,8 +20,42 @@ class ContextModule < ApplicationRecord
   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({
-    # TODO If your tool Syncs ContextModules, please complete this and merge it into CanvasSync
-  }, -> (api) { api.course_module(canvas_context_id, canvas_id) })
+    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/dummy/app/models/context_module_item.rb

@@ -18,7 +18,15 @@ class ContextModuleItem < ApplicationRecord
   belongs_to :assignment, foreign_key: :canvas_assignment_id, primary_key: :canvas_id
 
   api_syncable({
-    # TODO If your tool Syncs ContextModuleItems, please complete this and merge it into CanvasSync
-  }, -> (api) { api.module_item(context_module.context.canvas_id, context_module.canvas_id, canvas_id) })
-
+    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

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

@@ -0,0 +1,20 @@
+# #
+# 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.
+#
+
+
+# CourseProgress is not a Canvas model. It is a table built from the Custom Report
+class CourseProgress < ApplicationRecord
+  include CanvasSync::Record
+
+  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
+
+  validates_presence_of :canvas_user_id, :canvas_course_id
+  validates_uniqueness_of :canvas_user_id, scope: :canvas_course_id
+end

data/spec/dummy/db/migrate/20190702203631_create_context_modules.rb

@@ -17,6 +17,8 @@ class CreateContextModules < ActiveRecord::Migration[5.1]
       t.string :workflow_state
       t.datetime :deleted_at
       t.datetime :unlock_at
+      t.text :completion_requirements
+      t.text :prerequisites
       t.timestamps
     end
 

data/spec/dummy/db/migrate/20240828161300_create_course_progresses.rb

@@ -0,0 +1,26 @@
+# #
+# 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 CreateCourseProgresses < ActiveRecord::Migration[5.1]
+  def change
+    create_table :course_progresses do |t|
+      t.bigint :canvas_course_id, null: false
+      t.bigint :canvas_user_id, null: false
+      t.integer :requirement_count
+      t.integer :requirement_completed_count
+      t.datetime :completion_date
+
+      t.timestamps
+    end
+
+    add_index :course_progresses, :canvas_user_id
+    add_index :course_progresses, :canvas_course_id
+    add_index :course_progresses, [:canvas_user_id, :canvas_course_id], unique: true
+  end
+end
+

data/spec/dummy/db/schema.rb

@@ -153,6 +153,8 @@ ActiveRecord::Schema.define(version: 2024_05_23_101010) do
     t.datetime "unlock_at"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.text "completion_requirements"
+    t.text "prerequisites"
     t.index ["canvas_context_id", "canvas_context_type"], name: "index_context_modules_on_context"
     t.index ["canvas_id"], name: "index_context_modules_on_canvas_id", unique: true
   end
@@ -168,6 +170,19 @@ ActiveRecord::Schema.define(version: 2024_05_23_101010) do
     t.index ["canvas_user_preference_value_id"], name: "index_course_nicknames_on_canvas_user_preference_value_id", unique: true
   end
 
+  create_table "course_progresses", force: :cascade do |t|
+    t.bigint "canvas_course_id", null: false
+    t.bigint "canvas_user_id", null: false
+    t.integer "requirement_count"
+    t.integer "requirement_completed_count"
+    t.datetime "completion_date"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_user_id"], name: "index_course_progresses_on_canvas_user_id"
+    t.index ["canvas_course_id"], name: "index_course_progresses_on_canvas_course_id"
+    t.index ["canvas_user_id", "canvas_course_id"], name: "index_course_progresses_on_canvas_user_id_and_canvas_course_id", unique: true
+  end
+
   create_table "courses", force: :cascade do |t|
     t.bigint "canvas_id", null: false
     t.string "sis_id"