canvas_sync 0.9.4 → 0.10.0

data/spec/canvas_sync/services/module_event_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe LiveEvents::ModuleEvent do
 
   describe "#perform" do
     context "the module already exists" do
-      let!(:context_module) { FactoryGirl.create(:context_module, canvas_context_module_id: payload["body"][:module_id]) }
+      let!(:context_module) { FactoryGirl.create(:context_module, canvas_id: payload["body"][:module_id]) }
 
       it "updates it" do
         expect {

data/spec/canvas_sync/services/module_item_event_spec.rb

@@ -16,17 +16,17 @@ RSpec.describe LiveEvents::ModuleItemEvent do
 
   describe "#perform" do
     context "the module item already exists" do
-      let!(:cmi) { FactoryGirl.create(:context_module_item, canvas_context_module_item_id: payload["body"][:module_item_id]) }
+      let!(:cmi) { FactoryGirl.create(:context_module_item, canvas_id: payload["body"][:module_item_id]) }
 
       it "updates it" do
         expect {
           LiveEvents::ModuleItemEvent.new.perform(payload)
         }.to_not change { ContextModuleItem.count }
-        expect(cmi.reload.canvas_context_module_id).to eq(payload["body"][:module_item_id])
+        expect(cmi.reload.canvas_id).to eq(payload["body"][:module_item_id])
         expect(cmi.position).to eq(payload["body"][:position])
         expect(cmi.workflow_state).to eq(payload["body"][:workflow_state])
-        expect(cmi.content_type).to eq("Assignment")
-        expect(cmi.content_id).to eq(143)
+        expect(cmi.canvas_content_type).to eq("Assignment")
+        expect(cmi.canvas_content_id).to eq(143)
       end
     end
 
@@ -36,11 +36,11 @@ RSpec.describe LiveEvents::ModuleItemEvent do
           LiveEvents::ModuleItemEvent.new.perform(payload)
         }.to change { ContextModuleItem.count }.by(1)
         cmi = ContextModuleItem.last
-        expect(cmi.canvas_context_module_id).to eq(payload["body"][:module_item_id])
+        expect(cmi.canvas_id).to eq(payload["body"][:module_item_id])
         expect(cmi.position).to eq(payload["body"][:position])
         expect(cmi.workflow_state).to eq(payload["body"][:workflow_state])
-        expect(cmi.content_type).to eq("Assignment")
-        expect(cmi.content_id).to eq(143)
+        expect(cmi.canvas_content_type).to eq("Assignment")
+        expect(cmi.canvas_content_id).to eq(143)
       end
     end
   end

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

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

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

@@ -7,12 +7,12 @@
 
 
 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/spec/dummy/app/models/assignment.rb

@@ -7,10 +7,28 @@
 
 
 class Assignment < ApplicationRecord
-  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
+  include CanvasSync::ApiSyncable
+
+  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({
+    title: :name,
+    description: :description,
+    due_at: :due_at,
+    unlock_at: :unlock_at,
+    lock_at: :lock_at,
+    points_possible: :points_possible,
+    grading_type: :grading_type,
+    submission_types: lambda { |p| p["submission_types"].join(",") },
+    canvas_context_id: :course_id,
+    canvas_context_type: lambda { |_p| "Course" },
+    canvas_assignment_group_id: :assignment_group_id,
+    canvas_grading_standard_id: :grading_standard_id,
+  }, -> (api) { api.assignment(canvas_context_id, canvas_id) })
 end

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

@@ -7,7 +7,19 @@
 
 
 class AssignmentGroup < ApplicationRecord
-  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
+  include CanvasSync::ApiSyncable
+
+  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_id: :id,
+    name: :name,
+    position: :position,
+    rules: :rules,
+    group_weight: :group_weight,
+  }, -> (api) { api.assignment(course_id, canvas_id) })
 end

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

@@ -10,7 +10,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

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

@@ -7,6 +7,7 @@
 
 
 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/spec/dummy/app/models/course.rb

@@ -7,11 +7,24 @@
 
 
 class Course < ApplicationRecord
-  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
+  include CanvasSync::ApiSyncable
+
+  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,
+    course_code: :course_code,
+    name: :name,
+    workflow_state: :workflow_state,
+    canvas_term_id: :enrollment_term_id,
+    canvas_account_id: :account_id,
+    start_at: :start_at,
+    end_at: :end_at,
+  }, -> (api) { api.course(canvas_id) })
 end

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

@@ -7,8 +7,24 @@
 
 
 class Enrollment < ApplicationRecord
-  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
+  include CanvasSync::ApiSyncable
+
+  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_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,
+    role: :role,
+    canvas_role_id: :role_id,
+    base_role_type: :type,
+    workflow_state: :enrollment_state,
+  }, -> (api) { api.enrollment("self", canvas_id) })
 end

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

@@ -7,11 +7,11 @@
 
 
 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/spec/dummy/app/models/section.rb

@@ -7,7 +7,18 @@
 
 
 class Section < ApplicationRecord
-  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
+  include CanvasSync::ApiSyncable
+
+  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_at: :start_at,
+    end_at: :end_at,
+  }, -> (api) { api.section(canvas_id) })
 end

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

@@ -7,8 +7,20 @@
 
 
 class Submission < ApplicationRecord
-  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
+  include CanvasSync::ApiSyncable
+
+  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,
+    canvas_user_id: :user_id,
+    submitted_at: :submitted_at,
+    graded_at: :graded_at,
+    score: :score,
+    excused: :excused,
+    workflow_state: :workflow_state,
+  }, -> (api) { api.user_course_assignment_submission(assignment.context.canvas_id, canvas_assignment_id, canvas_user_id) })
 end

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

@@ -7,8 +7,8 @@
 
 
 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.
@@ -19,7 +19,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'],
@@ -31,4 +31,5 @@ class Term < ApplicationRecord
     term.save! if term.changed?
     term
   end
+
 end

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

@@ -7,9 +7,20 @@
 
 
 class User < ApplicationRecord
-  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
+  include CanvasSync::ApiSyncable
+
+  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,
+    name: :name,
+    sortable_name: :sortable_name,
+    first_name: :short_name,
+  }, -> (api) { api.user_detail(canvas_id) })
 end

data/spec/dummy/app/services/live_events/base_event.rb

@@ -8,9 +8,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/spec/dummy/app/services/live_events/course_event.rb

@@ -24,7 +24,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/spec/dummy/app/services/live_events/course_section_event.rb

@@ -11,7 +11,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,
@@ -35,9 +35,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/spec/dummy/app/services/live_events/module_event.rb

@@ -27,7 +27,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/spec/dummy/app/services/live_events/module_item_event.rb

@@ -26,15 +26,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/spec/dummy/app/services/live_events/user_event.rb

@@ -23,7 +23,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/spec/dummy/db/migrate/{20180216171618_create_submissions.rb → 20190521003447_create_submissions.rb}

@@ -9,21 +9,21 @@
 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
       t.datetime :submitted_at
       t.datetime :graded_at
-      t.integer :score
-      t.integer :points_possible
+      t.float :score
+      t.float :points_possible
       t.boolean :excused
       t.string :workflow_state
 
       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