canvas_sync 0.9.4 → 0.10.0

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

@@ -1,6 +1,7 @@
 # <%= autogenerated_migration_warning %>
 
 class ContextModuleItem < ApplicationRecord
-  belongs_to :context_module, primary_key: :canvas_context_module_id, foreign_key: :canvas_context_module_id, optional: true
-  belongs_to :assignment, foreign_key: :canvas_assignment_id, primary_key: :canvas_assignment_id
+  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
 end

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

@@ -3,22 +3,22 @@
 class Course < ApplicationRecord
   include CanvasSync::ApiSyncable
 
-  validates :canvas_course_id, uniqueness: true, presence: true
-  belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_term_id, optional: true
-  has_many :enrollments, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
-  has_many :sections, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
-  has_many :assignments, as: :context, primary_key: :canvas_course_id
-  has_many :submissions, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
-  has_many :assignment_groups, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
-
+  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
+  has_many :sections, primary_key: :canvas_id, foreign_key: :canvas_course_id
+  has_many :assignments, as: :context, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
+  has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_course_id
+  has_many :assignment_groups, primary_key: :canvas_id, foreign_key: :canvas_course_id
+  
   api_syncable({
     sis_id: :sis_course_id,
-    short_name: :course_code,
-    long_name: :name,
-    status: :workflow_state,
+    course_code: :course_code,
+    name: :name,
+    workflow_state: :workflow_state,
     canvas_term_id: :enrollment_term_id,
     canvas_account_id: :account_id,
-    start_date: :start_at,
-    end_date: :end_at,
-  }, -> (api) { api.course(canvas_course_id) })
+    start_at: :start_at,
+    end_at: :end_at,
+  }, -> (api) { api.course(canvas_id) })
 end

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

@@ -3,21 +3,22 @@
 class Enrollment < ApplicationRecord
   include CanvasSync::ApiSyncable
 
-  validates :canvas_enrollment_id, uniqueness: true, presence: true
-  belongs_to :user, primary_key: :canvas_user_id, foreign_key: :canvas_user_id, optional: true
-  belongs_to :course, primary_key: :canvas_course_id, foreign_key: :canvas_course_id, optional: true
-  belongs_to :section, primary_key: :canvas_section_id, foreign_key: :canvas_section_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
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
+  belongs_to :section, primary_key: :canvas_id, foreign_key: :canvas_section_id, optional: true
 
   api_syncable({
-    canvas_enrollment_id: :id,
+    canvas_id: :id,
     canvas_course_id: :course_id,
     course_sis_id: :sis_course_id,
     canvas_user_id: :user_id,
     user_sis_id: :sis_user_id,
     canvas_section_id: :course_section_id,
-    section_sis_id: :sis_section_id,
     role: :role,
-    role_id: :role_id,
-    status: :enrollment_state,
-  }, -> (api) { api.enrollment("self", canvas_enrollment_id) })
+    canvas_role_id: :role_id,
+    base_role_type: :type,
+    workflow_state: :enrollment_state,
+  }, -> (api) { api.enrollment("self", canvas_id) })
 end

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

@@ -1,11 +1,11 @@
 <%= autogenerated_model_warning %>
 
 class Role < ApplicationRecord
-  validates :canvas_role_id, uniqueness: true, presence: true
-  has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_role_id
+  validates :canvas_id, uniqueness: true, presence: true
+  has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_id
 
   def self.create_or_update(role_params)
-    role = Role.find_or_initialize_by(canvas_role_id: role_params['id'])
+    role = Role.find_or_initialize_by(canvas_id: role_params['id'])
 
     role.assign_attributes(label: role_params['label'],
                            base_role_type: role_params['base_role_type'],

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

@@ -3,16 +3,16 @@
 class Section < ApplicationRecord
   include CanvasSync::ApiSyncable
 
-  validates :canvas_section_id, uniqueness: true, presence: true
-  belongs_to :course, primary_key: :canvas_course_id, foreign_key: :canvas_course_id, optional: true
-  has_many :enrollments, primary_key: :canvas_section_id, foreign_key: :canvas_section_id
+  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
 
   api_syncable({
     sis_id: :sis_section_id,
     canvas_course_id: :course_id,
     canvas_nonxlist_course_id: :nonxlist_course_id,
     name: :name,
-    start_date: :start_at,
-    end_date: :end_at,
-  }, -> (api) { api.section(canvas_section_id) })
+    start_at: :start_at,
+    end_at: :end_at,
+  }, -> (api) { api.section(canvas_id) })
 end

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

@@ -3,10 +3,10 @@
 class Submission < ApplicationRecord
   include CanvasSync::ApiSyncable
 
-  validates :canvas_submission_id, uniqueness: true, presence: true
-  belongs_to :assignment, primary_key: :canvas_assignment_id, foreign_key: :canvas_assignment_id, optional: true
-  belongs_to :user, primary_key: :canvas_user_id, foreign_key: :canvas_user_id, optional: true
-  belongs_to :course, primary_key: :canvas_course_id, foreign_key: :canvas_course_id, optional: true
+  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
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
 
   api_syncable({
     canvas_assignment_id: :assignment_id,
@@ -16,5 +16,5 @@ class Submission < ApplicationRecord
     score: :score,
     excused: :excused,
     workflow_state: :workflow_state,
-  }, -> (api) { api.user_course_assignment_submission(assignment.context.canvas_course_id, canvas_assignment_id, canvas_user_id) })
+  }, -> (api) { api.user_course_assignment_submission(assignment.context.canvas_id, canvas_assignment_id, canvas_user_id) })
 end

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

@@ -1,8 +1,8 @@
 <%= autogenerated_model_warning %>
 
 class Term < ApplicationRecord
-  validates :canvas_term_id, uniqueness: true, presence: true
-  has_many :courses, foreign_key: :canvas_term_id, primary_key: :canvas_term_id
+  validates :canvas_id, uniqueness: true, presence: true
+  has_many :courses, foreign_key: :canvas_term_id, primary_key: :canvas_id
 
   # This is a sample scope created by the CanvasSync gem; feel
   # free to customize it for your tool's requirements.
@@ -13,7 +13,7 @@ class Term < ApplicationRecord
   }
 
   def self.create_or_update(term_params)
-    term = Term.find_or_initialize_by(canvas_term_id: term_params['id'])
+    term = Term.find_or_initialize_by(canvas_id: term_params['id'])
 
     term.assign_attributes(name: term_params['name'],
                            start_at: term_params['start_at'],
@@ -25,4 +25,5 @@ class Term < ApplicationRecord
     term.save! if term.changed?
     term
   end
+
 end

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

@@ -3,18 +3,18 @@
 class User < ApplicationRecord
   include CanvasSync::ApiSyncable
 
-  validates :canvas_user_id, uniqueness: true, presence: true
-  has_many :enrollments, primary_key: :canvas_user_id, foreign_key: :canvas_user_id
-  has_many :admins, foreign_key: :canvas_user_id, primary_key: :canvas_user_id
+  validates :canvas_id, uniqueness: true, presence: true
+  has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_user_id
+  has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_user_id
   has_many :admin_roles, through: :admins, source: :role
-  has_many :submissions, primary_key: :canvas_user_id, foreign_key: :canvas_user_id
+  has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_user_id
 
   api_syncable({
     sis_id: :sis_user_id,
     email: :email,
     login_id: :login_id,
-    full_name: :name,
+    name: :name,
     sortable_name: :sortable_name,
     first_name: :short_name,
-  }, -> (api) { api.user_detail(canvas_user_id) })
+  }, -> (api) { api.user_detail(canvas_id) })
 end

data/lib/canvas_sync/generators/templates/services/live_events/base_event.rb

@@ -2,9 +2,13 @@
 
 module LiveEvents
   class BaseEvent < CanvasSync::Job
+    attr_accessor :raw_payload
     attr_accessor :payload
+    attr_accessor :metadata
 
     def perform(event_payload)
+      @raw_payload = event_payload
+      @metadata = HashWithIndifferentAccess.new(event_payload["attributes"])
       @payload = HashWithIndifferentAccess.new(event_payload["body"])
     end
 

data/lib/canvas_sync/generators/templates/services/live_events/course/course_event.rb

@@ -18,7 +18,7 @@ module LiveEvents
       attrs = {
         canvas_course_id: local_canvas_id(payload[:course_id]),
         canvas_account_id: local_canvas_id(payload[:account_id]),
-        long_name: payload[:name],
+        name: payload[:name],
         status: payload[:workflow_state],
       }
       create_or_update(attrs)

data/lib/canvas_sync/generators/templates/services/live_events/course_section/course_section_event.rb

@@ -5,7 +5,7 @@ module LiveEvents
     # The following is provided in the live events call:
     # {
     #   course_section_id: section.id,
-    #   sis_source_id: section.sis_source_id,
+    #   sis_id: section.sis_id,
     #   sis_batch_id: section.sis_batch_id,
     #   course_id: section.course_id,
     #   root_account_id: section.root_account_id,
@@ -29,9 +29,9 @@ module LiveEvents
         canvas_section_id: local_canvas_id(payload[:course_section_id]),
         canvas_course_id: local_canvas_id(payload[:course_id]),
         name: payload[:name],
-        status: payload[:workflow_state],
-        start_date: payload[:start_at],
-        end_date: payload[:end_at],
+        workflow_state: payload[:workflow_state],
+        start_at: payload[:start_at],
+        end_at: payload[:end_at],
         canvas_nonxlist_course_id: payload[:nonxlist_course_id],
       }
       create_or_update(attrs)

data/lib/canvas_sync/generators/templates/services/live_events/module/module_event.rb

@@ -21,7 +21,7 @@ module LiveEvents
 
     def create_or_update_from_api(payload)
       return unless payload["context_type"] == "Course"
-      context_module = ContextModule.find_or_initialize_by(canvas_context_module_id: payload["module_id"])
+      context_module = ContextModule.find_or_initialize_by(canvas_id: payload["module_id"])
       api_params = canvas_sync_client.course_module(payload["context_id"], payload["module_id"])
 
       context_module.assign_attributes(

data/lib/canvas_sync/generators/templates/services/live_events/module_item/module_item_event.rb

@@ -20,15 +20,15 @@ module LiveEvents
     private
 
     def create_or_update_from_api(payload)
-      context_module_item = ContextModuleItem.find_or_initialize_by(canvas_context_module_item_id: payload["module_item_id"])
+      context_module_item = ContextModuleItem.find_or_initialize_by(canvas_id: payload["module_item_id"])
       api_params = canvas_sync_client.module_item(payload["context_id"], payload["module_id"], payload["module_item_id"])
 
       context_module_item.assign_attributes(
         canvas_context_module_id: payload["module_id"],
         position: payload["position"],
         workflow_state: payload["workflow_state"],
-        content_id: api_params["content_id"],
-        content_type: api_params["type"],
+        canvas_content_id: api_params["content_id"],
+        canvas_content_type: api_params["type"],
       )
 
       context_module_item.save! if context_module_item.changed?

data/lib/canvas_sync/generators/templates/services/live_events/user/user_event.rb

@@ -17,7 +17,7 @@ module LiveEvents
       super
       attrs = {
         canvas_user_id: local_canvas_id(payload[:user_id]),
-        full_name: payload[:name],
+        name: payload[:name],
         status: payload[:workflow_state],
       }
       create_or_update(attrs)

data/lib/canvas_sync/jobs/sync_provisioning_report_job.rb

@@ -11,9 +11,10 @@ module CanvasSync
           Term.send(options[:term_scope]).find_each do |term|
             # Deep copy the job_chain so each report gets the correct term id passed into
             # its options with no side effects
+            term_id = get_term_id(term)
             duped_job_chain = Marshal.load(Marshal.dump(job_chain))
-            duped_job_chain[:global_options][:canvas_term_id] = term.canvas_term_id
-            start_report(report_params(options, term.canvas_term_id), duped_job_chain, options)
+            duped_job_chain[:global_options][:canvas_term_id] = term_id
+            start_report(report_params(options, term_id), duped_job_chain, options)
           end
         else
           start_report(report_params(options), job_chain, options)
@@ -45,6 +46,10 @@ module CanvasSync
 
         params
       end
+
+      def get_term_id(term)
+        term.try(:canvas_id) || term.canvas_term_id
+      end
     end
   end
 end

data/lib/canvas_sync/jobs/sync_simple_table_job.rb

@@ -12,9 +12,10 @@ module CanvasSync
           Term.send(options[:term_scope]).find_each do |term|
             # Deep copy the job_chain so each report gets the correct term id passed into
             # its options with no side effects
+            term_id = get_term_id(term)
             duped_job_chain = Marshal.load(Marshal.dump(job_chain))
-            duped_job_chain[:global_options][:canvas_term_id] = term.canvas_term_id
-            start_report(report_params(options, term.canvas_term_id), duped_job_chain, options)
+            duped_job_chain[:global_options][:canvas_term_id] = term_id
+            start_report(report_params(options, term_id), duped_job_chain, options)
           end
         else
           start_report(report_params(options), job_chain, options)
@@ -36,6 +37,10 @@ module CanvasSync
         params["parameters[enrollment_term_id]"] = canvas_term_id if canvas_term_id
         params
       end
+
+      def get_term_id(term)
+        term.try(:canvas_id) || term.canvas_term_id
+      end
     end
   end
 end

data/lib/canvas_sync/processors/model_mappings.yml

@@ -2,7 +2,7 @@ users:
   conflict_target: canvas_user_id
   report_columns:
     canvas_user_id:
-      database_column_name: canvas_user_id
+      database_column_name: canvas_id
       type: integer
     user_id:
       database_column_name: sis_id
@@ -17,13 +17,13 @@ users:
       database_column_name: last_name
       type: string
     full_name:
-      database_column_name: full_name
+      database_column_name: name
       type: string
     sortable_name:
       database_column_name: sortable_name
       type: string
     status:
-      database_column_name: status
+      database_column_name: workflow_state
       type: string
     login_id:
       database_column_name: login_id
@@ -33,38 +33,38 @@ accounts:
   conflict_target: canvas_account_id
   report_columns:
     canvas_account_id:
-      database_column_name: canvas_account_id
+      database_column_name: canvas_id
       type: integer
     account_id:
-      database_column_name: account_id
+      database_column_name: sis_id
       type: string
     canvas_parent_id:
-      database_column_name: canvas_parent_id
+      database_column_name: canvas_parent_account_id
       type: integer
     parent_account_id:
-      database_column_name: parent_account_id
+      database_column_name: sis_parent_account_id
       type: string
     name:
       database_column_name: name
       type: string
     status:
-      database_column_name: status
+      database_column_name: workflow_state
       type: string
 
 courses:
   conflict_target: canvas_course_id
   report_columns:
     canvas_course_id:
-      database_column_name: canvas_course_id
+      database_column_name: canvas_id
       type: integer
     course_id:
       database_column_name: sis_id
       type: string
     short_name:
-      database_column_name: short_name
+      database_column_name: course_code
       type: string
     long_name:
-      database_column_name: long_name
+      database_column_name: name
       type: string
     canvas_account_id:
       database_column_name: canvas_account_id
@@ -72,24 +72,21 @@ courses:
     canvas_term_id:
       database_column_name: canvas_term_id
       type: integer
-    term_id:
-      database_column_name: term_sis_id
-      type: string
     start_date:
-      database_column_name: start_date
+      database_column_name: start_at
       type: datetime
     end_date:
-      database_column_name: end_date
+      database_column_name: end_at
       type: datetime
     status:
-      database_column_name: status
+      database_column_name: workflow_state
       type: integer
 
 enrollments:
   conflict_target: canvas_enrollment_id
   report_columns:
     canvas_enrollment_id:
-      database_column_name: canvas_enrollment_id
+      database_column_name: canvas_id
       type: integer
     canvas_course_id:
       database_column_name: canvas_course_id
@@ -107,16 +104,13 @@ enrollments:
       database_column_name: role
       type: string
     role_id:
-      database_column_name: role_id
+      database_column_name: canvas_role_id
       type: integer
     canvas_section_id:
       database_column_name: canvas_section_id
       type: integer
-    section_id:
-      database_column_name: section_sis_id
-      type: string
     status:
-      database_column_name: status
+      database_column_name: workflow_state
       type: string
     base_role_type:
       database_column_name: base_role_type
@@ -126,7 +120,7 @@ sections:
   conflict_target: canvas_section_id
   report_columns:
     canvas_section_id:
-      database_column_name: canvas_section_id
+      database_column_name: canvas_id
       type: integer
     section_id:
       database_column_name: sis_id
@@ -138,20 +132,20 @@ sections:
       database_column_name: name
       type: string
     status:
-      database_column_name: status
+      database_column_name: workflow_state
       type: string
     start_date:
-      database_column_name: start_date
+      database_column_name: start_at
       type: datetime
     end_date:
-      database_column_name: end_date
+      database_column_name: end_at
       type: datetime
 
 xlist:
   conflict_target: canvas_section_id
   report_columns:
     canvas_section_id:
-      database_column_name: canvas_section_id
+      database_column_name: canvas_id
       type: integer
     canvas_nonxlist_course_id:
       database_column_name: canvas_nonxlist_course_id
@@ -161,7 +155,7 @@ assignments:
   conflict_target: id
   report_columns:
     id:
-      database_column_name: :canvas_assignment_id
+      database_column_name: canvas_id
       type: integer
     title:
       database_column_name: title
@@ -200,26 +194,26 @@ assignments:
       database_column_name: workflow_state
       type: string
     context_id:
-      database_column_name: context_id
+      database_column_name: canvas_context_id
       type: integer
     context_type:
-      database_column_name: context_type
+      database_column_name: canvas_context_type
       type: string
     assignment_group_id:
       database_column_name: canvas_assignment_group_id
       type: integer
     grading_scheme_id:
-      database_column_name: grading_scheme_id
+      database_column_name: canvas_grading_scheme_id
       type: integer
     grading_standard_id:
-      database_column_name: grading_standard_id
+      database_column_name: canvas_grading_standard_id
       type: integer
 
 submissions:
   conflict_target: submission_id
   report_columns:
     submission_id:
-      database_column_name: :canvas_submission_id
+      database_column_name: canvas_id
       type: integer
     canvas_user_id:
       database_column_name: :canvas_user_id
@@ -253,7 +247,7 @@ assignment_groups:
   conflict_target: id
   report_columns:
     id:
-      database_column_name: :canvas_assignment_group_id
+      database_column_name: canvas_id
       type: integer
     canvas_course_id:
       database_column_name: :canvas_course_id
@@ -284,7 +278,7 @@ context_modules:
   conflict_target: canvas_context_module_id
   report_columns:
     canvas_context_module_id:
-      database_column_name: canvas_context_module_id
+      database_column_name: canvas_id
       type: integer
     canvas_context_id:
       database_column_name: canvas_context_id
@@ -309,7 +303,7 @@ context_module_items:
   conflict_target: canvas_context_module_item_id
   report_columns:
     canvas_context_module_item_id:
-      database_column_name: canvas_context_module_item_id
+      database_column_name: canvas_id
       type: integer
     context_module_id:
       database_column_name: canvas_context_module_id
@@ -317,12 +311,12 @@ context_module_items:
     position:
       database_column_name: position
       type: integer
-    content_type:
-      database_column_name: content_type
-      type: string
     content_id:
-      database_column_name: content_id
+      database_column_name: canvas_content_id
       type: integer
+    content_type:
+      database_column_name: canvas_content_type
+      type: string
     workflow_state:
       database_column_name: workflow_state
       type: string