canvas_sync 0.17.33 → 0.17.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8585726d4c1e8cf1627897ed3b7e8af68a76f86d3ea35b9ba3ac0b7eaa56ff9
-  data.tar.gz: 1318778a8bbaadb0f5069a1b9bfdb106f0ae2e8ed5124079a8e9d7c4583be359
+  metadata.gz: 8029fc55239810f8064f8d1c9fb4cd1f1756a7605581e7aced13e150e69c8b6b
+  data.tar.gz: 2deac9eb222ed8c636159c8100e8aa6cd59d2fa26d3b13b83c7be31cf7cbc0bd
 SHA512:
-  metadata.gz: 0ef7f29ce974199f5f1f26d43e4827ee77d93245b7b1ac4339fd33d03cbce1f6707df45d97ea533f24c21a45678e22b75db611a5a770ef073bf70fd0f37aa797
-  data.tar.gz: cc8892a896e4950e251c202e39ad4f17f012d8a1d39e588201ff27d927cd7e9d7160836fd05fd6892838cc3466dda5fd3e840121392cdb86269c5908cf0b0cea
+  metadata.gz: b1d70b6a2493a49a9eeb48532e9438d02209d3de9609afa0a9bd09a5fe4c9816dcd9b3d7724ffa2385cd65f19b873901cce5fe5b733fa534e4c96ce785146f91
+  data.tar.gz: c985b3da6ca96c4120b852f0b4df938a6393a797dd8365ce3c9e61404b67623484930b9001e13172309399e745774bd63208097954d569e094f86c4a56e94e38

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

@@ -0,0 +1,30 @@
+# <%= autogenerated_migration_warning %>
+
+class CreateLearningOutcomes < ActiveRecord::Migration[5.1]
+  def change
+    create_table :learning_outcomes do |t|
+      t.bigint :canvas_id, null: false
+      t.integer :canvas_context_id
+      t.string :canvas_context_type
+      t.string :name
+      t.string :friendly_name
+      t.string :workflow_state
+      t.datetime :canvas_created_at
+      t.datetime :canvas_updated_at
+      t.string :migration_id
+      t.string :vendor_guid
+      t.string :low_grade
+      t.string :high_grade
+      t.string :calculation_method
+      t.string :calculation_int
+      t.integer :outcome_import_id
+      t.integer :root_account_ids, array: true, default: []
+      t.text :description
+
+      t.timestamps
+    end
+
+    add_index :learning_outcomes, :canvas_id, unique: true
+    add_index :learning_outcomes, [:canvas_context_id, :canvas_context_type], name: "index_learning_outcomes_on_context"
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# # <%= autogenerated_migration_warning %>
+
+class LearningOutcome < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
+
+  api_syncable({
+    canvas_id: :id,
+    canvas_context_id: :context_id,
+    canvas_context_type: :context_type,
+    name: :title,
+    friendly_name: :display_name,
+    vendor_guid: :vendor_guid,
+    calculation_method: :calculation_method,
+    calculation_int: :calculation_int,
+    description: :description
+  }, ->(api) { api.get("/api/v1/outcomes/#{canvas_id}") })
+end

data/lib/canvas_sync/processors/model_mappings.yml

@@ -509,3 +509,58 @@ content_migrations:
     canvas_root_account_id:
       database_column_name: canvas_root_account_id
       type: integer
+
+learning_outcomes:
+  conflict_target: learning_outcome_id
+  report_columns:
+    learning_outcome_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
+    name:
+      database_column_name: name
+      type: string
+    friendly_name:
+      database_column_name: friendly_name
+      type: string
+    workflow_state:
+      database_column_name: workflow_state
+      type: string
+    created_at:
+      database_column_name: canvas_created_at
+      type: datetime
+    updated_at:
+      database_column_name: canvas_updated_at
+      type: datetime
+    migration_id:
+      database_column_name: migration_id
+      type: string
+    vendor_guid:
+      database_column_name: vendor_guid
+      type: string
+    low_grade:
+      database_column_name: low_grade
+      type: string
+    high_grade:
+      database_column_name: high_grade
+      type: string
+    calculation_method:
+      database_column_name: calculation_method
+      type: string
+    calculation_int:
+      database_column_name: calculation_int
+      type: integer
+    outcome_import_id:
+      database_column_name: outcome_import_id
+      type: integer
+    root_account_ids:
+      database_column_name: root_account_ids
+      type: integer
+    description:
+      database_column_name: description
+      type: string

data/lib/canvas_sync/processors/provisioning_report_processor.rb

@@ -116,6 +116,13 @@ module CanvasSync
       def bulk_process_group_membership(report_file_path)
         do_bulk_import(report_file_path, GroupMembership, options: @options)
       end
+
+      def bulk_process_learning_outcomes(report_file_path)
+        do_bulk_import(report_file_path, LearningOutcome, options: @options) do |row|
+          row[:root_account_ids] = JSON.parse row[:root_account_ids]
+          row
+        end
+      end
     end
   end
 end

data/lib/canvas_sync/processors/report_processor.rb

@@ -12,14 +12,15 @@ module CanvasSync
         model.try(:get_sync_mapping, key) || mapping[key || CanvasSync::Concerns::SyncMapping::Mapping.normalize_model_name(model)]
       end
 
-      def do_bulk_import(report_file_path, model, options: {}, mapping_key: nil)
+      def do_bulk_import(report_file_path, model, options: {}, mapping_key: nil, &blk)
         m = mapping_for(model, mapping_key)
         CanvasSync::Importers::BulkImporter.import(
           report_file_path,
           m[:report_columns],
           model,
           m[:conflict_target],
-          import_args: options
+          import_args: options,
+          &blk
         )
       end
     end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.17.33".freeze
+  VERSION = "0.17.34".freeze
 end

data/lib/canvas_sync.rb

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

data/spec/canvas_sync/processors/provisioning_report_processor_spec.rb

@@ -104,6 +104,12 @@ RSpec.describe CanvasSync::Processors::ProvisioningReportProcessor do
       expect(obj.workflow_state).to eq 'active'
     end
 
+    it 'processes learning_outcomes' do
+      expect {
+        subject.process('spec/support/fixtures/reports/learning_outcomes.csv', { models: ['learning_outcomes'] }, 1)
+      }.to change { LearningOutcome.count }.by(2)
+    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/learning_outcome.rb

@@ -0,0 +1,28 @@
+# 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 LearningOutcome < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
+
+  api_syncable({
+    canvas_id: :id,
+    canvas_context_id: :context_id,
+    canvas_context_type: :context_type,
+    name: :title,
+    friendly_name: :display_name,
+    vendor_guid: :vendor_guid,
+    calculation_method: :calculation_method,
+    calculation_int: :calculation_int,
+    description: :description
+  }, ->(api) { api.get("/api/v1/outcomes/#{canvas_id}") })
+end

data/spec/dummy/db/migrate/20220712210559_create_learning_outcomes.rb

@@ -0,0 +1,36 @@
+# #
+# 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 CreateLearningOutcomes < ActiveRecord::Migration[5.1]
+  def change
+    create_table :learning_outcomes do |t|
+      t.bigint :canvas_id, null: false
+      t.integer :canvas_context_id
+      t.string :canvas_context_type
+      t.string :name
+      t.string :friendly_name
+      t.string :workflow_state
+      t.datetime :canvas_created_at
+      t.datetime :canvas_updated_at
+      t.string :migration_id
+      t.string :vendor_guid
+      t.string :low_grade
+      t.string :high_grade
+      t.string :calculation_method
+      t.string :calculation_int
+      t.integer :outcome_import_id
+      t.integer :root_account_ids, array: true, default: []
+      t.text :description
+
+      t.timestamps
+    end
+
+    add_index :learning_outcomes, :canvas_id, unique: true
+    add_index :learning_outcomes, [:canvas_context_id, :canvas_context_type], name: "index_learning_outcomes_on_context"
+  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_03_08_072643) do
+ActiveRecord::Schema.define(version: 2022_07_12_210559) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -246,6 +246,30 @@ ActiveRecord::Schema.define(version: 2022_03_08_072643) do
     t.index ["canvas_id"], name: "index_groups_on_canvas_id", unique: true
   end
 
+  create_table "learning_outcomes", force: :cascade do |t|
+    t.bigint "canvas_id", null: false
+    t.integer "canvas_context_id"
+    t.string "canvas_context_type"
+    t.string "name"
+    t.string "friendly_name"
+    t.string "workflow_state"
+    t.datetime "canvas_created_at"
+    t.datetime "canvas_updated_at"
+    t.string "migration_id"
+    t.string "vendor_guid"
+    t.string "low_grade"
+    t.string "high_grade"
+    t.string "calculation_method"
+    t.string "calculation_int"
+    t.integer "outcome_import_id"
+    t.integer "root_account_ids", default: [], array: true
+    t.text "description"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_context_id", "canvas_context_type"], name: "index_learning_outcomes_on_context"
+    t.index ["canvas_id"], name: "index_learning_outcomes_on_canvas_id", unique: true
+  end
+
   create_table "pseudonyms", force: :cascade do |t|
     t.bigint "canvas_id", null: false
     t.bigint "canvas_user_id"