canvas_sync 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ea56aa1b7bf0b7e65519d1405021705021cff4d51754b3cad619b399350fec9
-  data.tar.gz: 67cfa628a75892751cc515560f8d6a6fd8f1832473e0280f2967bfc4a1007ae5
+  metadata.gz: efb7341f8d1643d211f53ffde7c7fbaf9c7e0b89359d83ffa12e293f8e977863
+  data.tar.gz: 4919a841fc27a2b85cb0049f03a18a46f27d1c5928345eaf2dd3460fba764f06
 SHA512:
-  metadata.gz: 590e2a9fad154c55824eb6d3bf158973b81e971e59a2f8c9ce2db4f46ae88ce9d93721c29c479390f7df474a070a1fc939311c0a5b7d784c972b55798766638e
-  data.tar.gz: 1e53b3b933b1e9255ab448dc9585172cf4af183176492b407d2228997864f376da06847750c366283c47f0b51fca2f48a8742ac90f20b22d59ea1bad0a2a7204
+  metadata.gz: ae1217a2ab3c9f5168cd759372ac0d306e906bf185a3f6684c208443f9611ce494d7cd8d6ccd732e11425ddf3711c5886fb43b7caa881d1d9064ab10e6d85c9c
+  data.tar.gz: 619b4f60710761a1381074d1d058fb49e6b09f79264b7ed57f97143f2bcab468fb0e1eb0571591aaedd7b9536b5318acc7463a01a3732014b974fc33457c5dc0

data/README.md

@@ -237,6 +237,14 @@ end
 
 ## Legacy Support
 
+### Legacy Mappings
+
+CanvasSync 0.10.0+, by default, changes Canvas primary-keys from `:canvas_MODEL_id` to just `:canvas_id`.
+Because CanvasSync primarily consists of templates, this change shouldn't require any large changes in your app, but you will need to
+apply the `model_mappings_legacy.yml` (located in the root of this repo) to your model mappings - see [Mapping Overrides](#mapping-overrides).
+
+### Row-by-Row Syncing
+
 If you have an old style tool that needs to sync data on a row by row basis, you can pass in the `legacy_support: true` option. In order for this to work, your models must have a `create_or_update_from_csv` class method defined that accepts a row argument. This method will get passed each row from the CSV, and it's up to you to persist it.
 
 Example:

data/lib/canvas_sync/api_syncable.rb

@@ -44,6 +44,7 @@ module CanvasSync::ApiSyncable
     api_response
   rescue Faraday::Error::ResourceNotFound, Footrest::HttpError::NotFound => e
     api_mark_deleted
+    save! if changed?
     nil
   end
 

data/lib/canvas_sync/generators/install_generator.rb

@@ -4,7 +4,7 @@ require "rails/generators/migration"
 module CanvasSync
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
-    source_root File.expand_path("../templates/models", __FILE__)
+    source_root File.expand_path("../templates", __FILE__)
     class_option :models, type: :string, required: true
 
     def self.next_migration_number(path)
@@ -46,8 +46,8 @@ module CanvasSync
       CanvasSync.validate_models!(models)
 
       models.each do |model|
-        migration_template "create_#{model}.rb", "db/migrate/create_#{model}.rb"
-        template "#{model.singularize}.rb", "app/models/#{model.singularize}.rb"
+        migration_template "migrations/create_#{model}.rb", "db/migrate/create_#{model}.rb"
+        template "models/#{model.singularize}.rb", "app/models/#{model.singularize}.rb"
       end
     end
   end

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

@@ -0,0 +1,17 @@
+<%= autogenerated_migration_warning %>
+
+class CreateAccounts < ActiveRecord::Migration[5.1]
+  def change
+    create_table :accounts do |t|
+      t.bigint :canvas_id, null: false
+      t.string :sis_id
+      t.bigint :canvas_parent_account_id
+      t.string :sis_parent_account_id
+      t.string :name
+      t.string :workflow_state
+
+      t.timestamps
+    end
+    add_index :accounts, :canvas_id, unique: true
+  end
+end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_admins.rb

@@ -3,7 +3,7 @@
 class CreateAdmins < ActiveRecord::Migration[5.1]
   def change
     create_table :admins do |t|
-      t.bigint :canvas_admin_id, null: false
+      t.bigint :canvas_id, null: false
       t.string :role_name
       t.bigint :canvas_role_id, null: false
       t.json :user_data
@@ -12,6 +12,6 @@ class CreateAdmins < ActiveRecord::Migration[5.1]
 
       t.timestamps
     end
-    add_index :admins, :canvas_admin_id, unique: true
+    add_index :admins, :canvas_id, unique: true
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_assignment_groups.rb

@@ -3,7 +3,7 @@
 class CreateAssignmentGroups < ActiveRecord::Migration[5.1]
   def change
     create_table :assignment_groups do |t|
-      t.bigint :canvas_assignment_group_id, null: false
+      t.bigint :canvas_id, null: false
       t.bigint :canvas_course_id
       t.string :name
       t.text :rules
@@ -16,7 +16,7 @@ class CreateAssignmentGroups < ActiveRecord::Migration[5.1]
       t.timestamps
     end
 
-    add_index :assignment_groups, :canvas_assignment_group_id, unique: true
+    add_index :assignment_groups, :canvas_id, unique: true
     add_index :assignment_groups, :canvas_course_id
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_assignments.rb

@@ -3,7 +3,7 @@
 class CreateAssignments < ActiveRecord::Migration[5.1]
   def change
     create_table :assignments do |t|
-      t.bigint :canvas_assignment_id, null: false
+      t.bigint :canvas_id, null: false
       t.string :title
       t.text :description
       t.datetime :due_at
@@ -16,16 +16,16 @@ class CreateAssignments < ActiveRecord::Migration[5.1]
       t.string :grading_type
       t.string :submission_types
       t.string :workflow_state
-      t.integer :context_id
-      t.string :context_type
+      t.integer :canvas_context_id
+      t.string :canvas_context_type
       t.integer :canvas_assignment_group_id
-      t.integer :grading_scheme_id
-      t.integer :grading_standard_id
+      t.integer :canvas_grading_scheme_id
+      t.integer :canvas_grading_standard_id
 
       t.timestamps
     end
 
-    add_index :assignments, :canvas_assignment_id, unique: true
-    add_index :assignments, [:context_id, :context_type]
+    add_index :assignments, :canvas_id, unique: true
+    add_index :assignments, [:canvas_context_id, :canvas_context_type]
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_context_module_items.rb

@@ -3,18 +3,18 @@
 class CreateContextModuleItems < ActiveRecord::Migration[5.1]
   def change
     create_table :context_module_items do |t|
-      t.bigint :canvas_context_module_item_id
+      t.bigint :canvas_id
       t.bigint :canvas_context_module_id
       t.integer :position
-      t.string :content_type
-      t.bigint :content_id
+      t.bigint :canvas_content_id
+      t.string :canvas_content_type
       t.bigint :canvas_assignment_id
       t.string :workflow_state
 
       t.timestamps
     end
 
-    add_index :context_module_items, :canvas_context_module_item_id, unique: true
+    add_index :context_module_items, :canvas_id, unique: true
     add_index :context_module_items, :canvas_context_module_id
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_context_modules.rb

@@ -3,7 +3,7 @@
 class CreateContextModules < ActiveRecord::Migration[5.1]
   def change
     create_table :context_modules do |t|
-      t.bigint :canvas_context_module_id
+      t.bigint :canvas_id
       t.bigint :canvas_context_id
       t.string :canvas_context_type
       t.integer :position
@@ -14,7 +14,7 @@ class CreateContextModules < ActiveRecord::Migration[5.1]
       t.timestamps
     end
 
-    add_index :context_modules, :canvas_context_module_id, unique: true
+    add_index :context_modules, :canvas_id, unique: true
     add_index :context_modules, [:canvas_context_id, :canvas_context_type], name: "index_context_modules_on_context"
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_courses.rb

@@ -3,20 +3,19 @@
 class CreateCourses < ActiveRecord::Migration[5.1]
   def change
     create_table :courses do |t|
-      t.bigint :canvas_course_id, null: false
+      t.bigint :canvas_id, null: false
       t.string :sis_id
-      t.string :short_name
-      t.string :long_name
-      t.string :status
+      t.string :course_code
+      t.string :name
+      t.string :workflow_state
       t.integer :canvas_account_id
       t.integer :canvas_term_id
-      t.integer :term_sis_id
-      t.datetime :start_date
-      t.datetime :end_date
+      t.datetime :start_at
+      t.datetime :end_at
 
       t.timestamps
     end
 
-    add_index :courses, :canvas_course_id, unique: true
+    add_index :courses, :canvas_id, unique: true
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_enrollments.rb

@@ -3,23 +3,21 @@
 class CreateEnrollments < ActiveRecord::Migration[5.1]
   def change
     create_table :enrollments do |t|
-      t.bigint :canvas_enrollment_id, null: false
+      t.bigint :canvas_id, null: false
       t.bigint :canvas_course_id
       t.string :course_sis_id
       t.bigint :canvas_user_id
       t.string :user_sis_id
       t.string :role
-      t.integer :role_id
+      t.integer :canvas_role_id
       t.bigint :canvas_section_id
-      t.string :section_sis_id
-      t.string :status
+      t.string :workflow_state
       t.string :base_role_type
 
-
       t.timestamps
     end
 
-    add_index :enrollments, :canvas_enrollment_id, unique: true
+    add_index :enrollments, :canvas_id, unique: true
     add_index :enrollments, :canvas_course_id
     add_index :enrollments, :canvas_user_id
   end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_roles.rb

@@ -3,7 +3,7 @@
 class CreateRoles < ActiveRecord::Migration[5.1]
   def change
     create_table :roles do |t|
-      t.integer :canvas_role_id, null: false
+      t.integer :canvas_id, null: false
       t.string :label, null: false
       t.string :base_role_type, null: false
       t.json :account
@@ -12,6 +12,6 @@ class CreateRoles < ActiveRecord::Migration[5.1]
 
       t.timestamps
     end
-    add_index :roles, :canvas_role_id, unique: true
+    add_index :roles, :canvas_id, unique: true
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_sections.rb

@@ -3,19 +3,19 @@
 class CreateSections < ActiveRecord::Migration[5.1]
   def change
     create_table :sections do |t|
-      t.bigint :canvas_section_id, null: false
+      t.bigint :canvas_id, null: false
       t.string :sis_id
       t.bigint :canvas_course_id
       t.bigint :canvas_nonxlist_course_id
       t.string :name
-      t.string :status
-      t.datetime :start_date
-      t.datetime :end_date
+      t.string :workflow_state
+      t.datetime :start_at
+      t.datetime :end_at
 
       t.timestamps
     end
 
-    add_index :sections, :canvas_section_id, unique: true
+    add_index :sections, :canvas_id, unique: true
     add_index :sections, :canvas_course_id
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_submissions.rb

@@ -3,7 +3,7 @@
 class CreateSubmissions < ActiveRecord::Migration[5.1]
   def change
     create_table :submissions do |t|
-      t.bigint :canvas_submission_id, null: false
+      t.bigint :canvas_id, null: false
       t.bigint :canvas_course_id
       t.bigint :canvas_assignment_id
       t.bigint :canvas_user_id
@@ -17,7 +17,7 @@ class CreateSubmissions < ActiveRecord::Migration[5.1]
       t.timestamps
     end
 
-    add_index :submissions, :canvas_submission_id, unique: true
+    add_index :submissions, :canvas_id, unique: true
     add_index :submissions, :canvas_assignment_id
     add_index :submissions, :canvas_course_id
     add_index :submissions, :canvas_user_id

data/lib/canvas_sync/generators/templates/{models → migrations}/create_terms.rb

@@ -3,7 +3,7 @@
 class CreateTerms < ActiveRecord::Migration[5.1]
   def change
     create_table :terms do |t|
-      t.integer :canvas_term_id, null: false
+      t.integer :canvas_id, null: false
       t.string :name
       t.datetime :start_at
       t.datetime :end_at
@@ -13,6 +13,6 @@ class CreateTerms < ActiveRecord::Migration[5.1]
 
       t.timestamps
     end
-    add_index :terms, :canvas_term_id, unique: true
+    add_index :terms, :canvas_id, unique: true
   end
 end

data/lib/canvas_sync/generators/templates/{models → migrations}/create_users.rb

@@ -3,19 +3,19 @@
 class CreateUsers < ActiveRecord::Migration[5.1]
   def change
     create_table :users do |t|
-      t.bigint :canvas_user_id, null: false
+      t.bigint :canvas_id, null: false
       t.string :sis_id
       t.string :email
       t.string :first_name
       t.string :last_name
-      t.string :status
+      t.string :workflow_state
       t.string :login_id
-      t.string :full_name
+      t.string :name
       t.string :sortable_name
 
       t.timestamps
     end
 
-    add_index :users, :canvas_user_id, unique: true
+    add_index :users, :canvas_id, unique: true
   end
 end

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

@@ -3,11 +3,11 @@
 class Account < ApplicationRecord
   include CanvasSync::ApiSyncable
 
-  validates :canvas_account_id, uniqueness: true, presence: true
+  validates :canvas_id, uniqueness: true, presence: true
 
   api_syncable({
     name: :name,
-    status: :workflow_state,
-    canvas_parent_id: :parent_account_id,
-  }, -> (api) { api.account(canvas_account_id) })
+    workflow_state: :workflow_state,
+    canvas_parent_account_id: :parent_account_id,
+  }, -> (api) { api.account(canvas_id) })
 end

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

@@ -1,12 +1,12 @@
 <%= autogenerated_model_warning %>
 
 class Admin < ApplicationRecord
-  validates :canvas_admin_id, uniqueness: true, presence: true
-  belongs_to :user, primary_key: :canvas_user_id, foreign_key: :canvas_user_id, optional: true
-  belongs_to :role, primary_key: :canvas_role_id, foreign_key: :canvas_role_id, optional: true
+  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
 
   def self.create_or_update(admin_params)
-    admin = Admin.find_or_initialize_by(canvas_admin_id: admin_params['id'])
+    admin = Admin.find_or_initialize_by(canvas_id: admin_params['id'])
 
     admin.assign_attributes(role_name: admin_params['role'],
                             canvas_role_id: admin_params['role_id'],

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

@@ -3,11 +3,12 @@
 class Assignment < ApplicationRecord
   include CanvasSync::ApiSyncable
 
-  validates :canvas_assignment_id, uniqueness: true, presence: true
-  belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_course_id
-  belongs_to :assignment_group, optional: true, primary_key: :canvas_assignment_group_id, foreign_key: :canvas_assignment_group_id
-  has_many :submissions, primary_key: :canvas_assignment_id, foreign_key: :canvas_assignment_id
-  has_many :context_module_items, primary_key: :canvas_assignment_id, foreign_key: :content_id, dependent: :destroy
+  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({
@@ -19,9 +20,9 @@ class Assignment < ApplicationRecord
     points_possible: :points_possible,
     grading_type: :grading_type,
     submission_types: lambda { |p| p["submission_types"].join(",") },
-    context_id: :course_id,
-    context_type: lambda { |_p| "Course" },
+    canvas_context_id: :course_id,
+    canvas_context_type: lambda { |_p| "Course" },
     canvas_assignment_group_id: :assignment_group_id,
-    grading_standard_id: :grading_standard_id,
-  }, -> (api) { api.assignment(context_id, canvas_assignment_id) })
+    canvas_grading_standard_id: :grading_standard_id,
+  }, -> (api) { api.assignment(canvas_context_id, canvas_id) })
 end

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

@@ -3,17 +3,17 @@
 class AssignmentGroup < ApplicationRecord
   include CanvasSync::ApiSyncable
 
-  validates :canvas_assignment_group_id, uniqueness: true, presence: true
-  belongs_to :course, primary_key: :canvas_course_id, foreign_key: :canvas_course_id, optional: true
-  has_many :assignments, primary_key: :canvas_assignment_group_id, foreign_key: :canvas_assignment_group_id
+  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_assignment_group_id: :id,
+    canvas_id: :id,
     name: :name,
     position: :position,
     rules: :rules,
     group_weight: :group_weight,
-  }, -> (api) { api.assignment(course_id, canvas_assignment_group_id) })
+  }, -> (api) { api.assignment(course_id, canvas_id) })
 end

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

@@ -4,7 +4,7 @@
 #   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
-  belongs_to :canvas_context, polymorphic: true, optional: true
-  has_many :context_module_items, primary_key: :canvas_context_module_id, foreign_key: :canvas_context_module_id
+  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
 end