canvas_sync 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 50ea86e0116f11f92019daae4edd22aa3a402355e1d910947e391a0f3b6ac000
-  data.tar.gz: 5712f275605f93eefc0f0ab5f1711b31e20dbc29d9a5e2b56d39853745610a49
+SHA1:
+  metadata.gz: f220a92d0d85cce6ff10b1ef1a10784039e93583
+  data.tar.gz: 0c305e04af7875261f6c36561b1b39e073f41c41
 SHA512:
-  metadata.gz: f914d9934b0b7c7c31fc3e3188d9884a07aeb104a4b89b9815f2455ada59bf74f6f43b3eb8fdc3fbd994dcca48166fd108dc45ae415f8715197ac96f33b3a2df
-  data.tar.gz: b56ddedc9b422d64bf319f2f425cb209b1889fbfd4a5992eb403ab1901efd2b3aaeaa7463c3ca9b4d32924e6b44fc0b8479084c6462796ea547a8d6e5fd516b9
+  metadata.gz: ec6ceaf390ae8a814420d927b1294b66492bd855b62ef9d80042e973871aac7dfb45b061861d503b8ee5303371e67c3df1446be4b159f7f8991ec237684007ad
+  data.tar.gz: 83c67e7bdd93c2ac6e068309955c04a08e8f6204481f667049cb3ac6dc8ba5212c31f5e25febde46a788bc5582d18c893cf421718f7604a2399623289e9ff422

data/lib/canvas_sync/generators/install_live_events_generator.rb

@@ -13,6 +13,10 @@ module CanvasSync
         # You can customize it as needed, but make sure you test
         # any changes you make to the auto generated methods.
         #
+        # LiveEvent message formats can be found at https://canvas.instructure.com/doc/api/file.live_events.html
+        # In the general case, LiveEvent message content should not be trusted - it is highly possible that events may
+        # arrive out of order. Most of the CanvasSync LiveEvent templates solve this by always fetching the object from the API.
+        #
       HERE
     end
 
@@ -28,7 +32,7 @@ module CanvasSync
       CanvasSync.validate_live_events!(events)
 
       events.each do |event|
-        Dir.glob("#{File.dirname(__FILE__)}/templates/services/live_events/#{event}/*.rb") do |rb_file|
+        Dir.glob("#{File.dirname(__FILE__)}/templates/services/live_events/#{event}_event.rb") do |rb_file|
           template rb_file.to_s, "app/services/live_events/#{File.basename(rb_file)}"
         end
       end

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateAccounts < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateAdmins < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateAssignmentGroups < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateAssignments < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateContextModuleItems < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateContextModules < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateCourses < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateEnrollments < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateRoles < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateSections < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateSubmissions < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateTerms < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_migration_warning %>
+# <%= autogenerated_migration_warning %>
 
 class CreateUsers < ActiveRecord::Migration[5.1]
   def change

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Account < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Admin < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Assignment < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class AssignmentGroup < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,10 +1,17 @@
-<%= autogenerated_migration_warning %>
+# # <%= autogenerated_migration_warning %>
 
 # A ContextModule is the same as a Canvas Module. They're called ContextModules for 2 reasons:
 #   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
+  include CanvasSync::ApiSyncable
+
   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
+
+  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) })
+
 end

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

@@ -1,7 +1,14 @@
-# <%= autogenerated_migration_warning %>
+# # <%= autogenerated_migration_warning %>
 
 class ContextModuleItem < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   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
+
+  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) })
+
 end

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Course < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Enrollment < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Role < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Section < ApplicationRecord
   include CanvasSync::ApiSyncable
@@ -14,5 +14,6 @@ class Section < ApplicationRecord
     name: :name,
     start_at: :start_at,
     end_at: :end_at,
+    workflow_state: ->(r){ 'active' },
   }, -> (api) { api.section(canvas_id) })
 end

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Submission < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class Term < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -1,4 +1,4 @@
-<%= autogenerated_model_warning %>
+# <%= autogenerated_model_warning %>
 
 class User < ApplicationRecord
   include CanvasSync::ApiSyncable

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

@@ -0,0 +1,33 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class AssignmentEvent < LiveEvents::BaseEvent
+
+    def process
+      canvas_assignment_id = local_canvas_id(payload[:assignment_id])
+      assignment = Assignment.where(canvas_id: canvas_assignment_id).first_or_initialize
+      assignment.context_id = canvas_course_id
+      assignment.sync_from_api
+    end
+
+    private
+
+    # This could be nil if the context type for this assignment is not 'Course' of if a local course was not found
+    def canvas_course_id
+      payload[:context_type] == "Course" ? local_canvas_id(payload[:context_id]) : nil
+    end
+
+    # This could be nil if the context type for this assignment is not 'Course' of if a local course was not found
+    def course
+      @course ||= begin
+        course = Course.where(canvas_id: canvas_course_id).first_or_initialize
+        course.sync_from_api unless course.persisted?
+        course
+      end
+    end
+
+  end
+
+  class AssignmentCreatedEvent < LiveEvents::AssignmentEvent; end
+  class AssignmentUpdatedEvent < LiveEvents::AssignmentEvent; end
+end

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

@@ -0,0 +1,24 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class AssignmentGroupEvent < LiveEvents::BaseEvent
+
+    def process
+      canvas_assignment_group_id = local_canvas_id(payload[:assignment_group_id])
+      assignment_group = AssignmentGroup.where(canvas_id: canvas_assignment_group_id).first_or_initialize
+      assignment_group.canvas_course_id = canvas_course_id
+      assignment_group.sync_from_api
+    end
+
+    private
+
+    # This could be nil if the context type for this assignment is not 'Course' of if a local course was not found
+    def canvas_course_id
+      payload[:context_type] == "Course" ? local_canvas_id(payload[:context_id]) : nil
+    end
+
+  end
+
+  class AssignmentGroupCreatedEvent < LiveEvents::AssignmentGroupEvent; end
+  class AssignmentGroupUpdatedEvent < LiveEvents::AssignmentGroupEvent; end
+end

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

@@ -1,6 +1,8 @@
 # <%= autogenerated_event_warning %>
 
 module LiveEvents
+  class RetryLiveEventJob < StandardError; end
+
   class BaseEvent < CanvasSync::Job
     attr_accessor :raw_payload
     attr_accessor :payload
@@ -10,11 +12,31 @@ module LiveEvents
       @raw_payload = event_payload
       @metadata = HashWithIndifferentAccess.new(event_payload["attributes"])
       @payload = HashWithIndifferentAccess.new(event_payload["body"])
+      process_with_retry
+    end
+
+    def process
+      raise "process must be implemented in your subclass"
     end
 
     # Live events will use a canvas global ID (cross shard) for any ID's provided. This method will return the local ID.
     def local_canvas_id(id)
       id.to_i % 10_000_000_000_000
     end
+
+    private
+
+    # Sometimes a creation and update event get sent by Canvas at almost the exact same time. This means
+    # that there is sometimes a race condition that causes them to both try to save a new record at the same time.
+    # If that happens, just wait a few seconds and try again -- the second try should be able to see that
+    # the save already occured, and it will just update the row..
+    def process_with_retry
+      tries ||= 5
+      process
+    rescue ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid, RetryLiveEventJob => e
+      raise e if (tries -= 1).zero?
+      sleep 5
+      retry
+    end
   end
 end

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

@@ -0,0 +1,20 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class CourseEvent < LiveEvents::BaseEvent
+
+    def process
+      course = Course.where(canvas_id: local_canvas_id(payload[:course_id])).first_or_initialize
+      course.canvas_account_id = local_canvas_id(payload[:account_id])
+      if course.account.nil?
+        acc = Account.new(canvas_id: course.canvas_account_id)
+        acc.sync_from_api
+      end
+      course.sync_from_api
+    end
+
+  end
+
+  class CourseCreatedEvent < LiveEvents::CourseEvent; end
+  class CourseUpdatedEvent < LiveEvents::CourseEvent; end
+end

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

@@ -0,0 +1,18 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class CourseSectionEvent < LiveEvents::BaseEvent
+
+    def process
+      section = Section.where(canvas_id: local_canvas_id(payload[:course_section_id])).first_or_initialize
+      section.sync_from_api
+      # A section change could constitute a crosslisting change, which means
+      # we need to make sure all our enrollments are pointing to the correct course
+      section.enrollments.update_all(canvas_course_id: section.canvas_course_id)
+    end
+
+  end
+
+  class CourseSectionCreatedEvent < LiveEvents::CourseSectionEvent; end
+  class CourseSectionUpdatedEvent < LiveEvents::CourseSectionEvent; end
+end

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

@@ -0,0 +1,20 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class EnrollmentEvent < LiveEvents::BaseEvent
+    attr_accessor :enrollment
+
+    def process()
+      @enrollment = Enrollment.where(canvas_id: local_canvas_id(payload[:enrollment_id])).first_or_initialize
+      enrollment.canvas_course_id = local_canvas_id(payload[:course_id])
+      enrollment.sync_from_api
+      if enrollment.user.nil?
+        u = User.new(canvas_id: enrollment.canvas_user_id)
+        u.sync_from_api
+      end
+    end
+  end
+
+  class EnrollmentCreatedEvent < LiveEvents::EnrollmentEvent; end
+  class EnrollmentUpdatedEvent < LiveEvents::EnrollmentEvent; end
+end

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

@@ -0,0 +1,26 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class GradeEvent < LiveEvents::BaseEvent
+
+    def process
+      raise "process must be implemented in your subclass"
+    end
+
+    private
+
+    def submission
+      Submission.find_by(canvas_submission_id: local_canvas_id(payload[:submission_id]))
+    end
+
+    def assignment
+      Assignment.find_by(canvas_assignment_id: local_canvas_id(payload[:assignment_id]))
+    end
+
+    def user
+      User.find_by(canvas_user_id: local_canvas_id(payload[:user_id]))
+    end
+  end
+
+  class GradeChangedEvent < LiveEvents::GradeEvent; end
+end