canvas_sync 0.3.23 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccdb328d97ea616a2a39b64ba9850567fefb03ae271306645fe878f82dbdf77d
-  data.tar.gz: dca87f606c8c5f4cede335ea725e8b18240592a2464a54295bc96c1812aaf373
+  metadata.gz: 9134dcc286332c0330b16783033e524f75b69f7039455d2e0aab562a50709181
+  data.tar.gz: 6575d7cb108b9977015db6f0e55c9de6fc3d7e0c8753e18889b381384d87b6e3
 SHA512:
-  metadata.gz: 2ccfc2afaa8a06b8ba6dde376c12354910ecd9116341168d900b13ad67218d7480fd74485ea11dcf7d2d1c8478c65cb78d28090f7025024a485e5a1682b1a994
-  data.tar.gz: 402f8066f80bbd3c0858492ffc6afb91f32b1006d7d46c89368a589b50ed8c720eaaa617a18323fec3fe582b7deec3ef4edb4760c0658123048e781b44236faf
+  metadata.gz: d21d1deaec48dc3eb4c008eacdf0336373a4aa3a0e0bf4d9e68050b65b7529be883756408b97999aa13a78d6c1c158412beaf3413fef87ece53a1623651be91b
+  data.tar.gz: f8e73459889128a11793ecb0d9edf423edc3504c071eec4ed8728b79764f803395aa71a9a348108e38604eab1aedeba815cd023f75cfaa740686c22a5adec181

data/Rakefile

@@ -10,6 +10,8 @@ desc 'This updates the models and migrations used by the testing Rails Dummy app
 task :update_test_schema do
   puts "Updating test models and migration files..."
   stream_command("spec/dummy/bin/rails generate canvas_sync:install --models all --force")
+  puts "Updating live event files..."
+  stream_command("spec/dummy/bin/rails generate canvas_sync:install_live_events --events all --force")
   puts "Updating the test database and schema..."
   stream_command("cd spec/dummy; bundle exec rake db:drop; bundle exec rake db:create; bundle exec rake db:migrate")
 end

data/lib/canvas_sync.rb

@@ -36,7 +36,17 @@ module CanvasSync
     context_module_items
     xlist
   ].freeze
-  SUPPORTED_LIVE_EVENTS = %w[course enrollment submission assignment user syllabus grade].freeze
+
+  SUPPORTED_LIVE_EVENTS = %w[
+    course
+    enrollment
+    submission
+    assignment
+    user
+    syllabus
+    grade
+    module
+  ].freeze
 
   # Runs a standard provisioning sync job with no extra report types.
   # Terms will be synced first using the API. If you are syncing users/roles/admins

data/lib/canvas_sync/generators/templates/services/live_events/assignment/assignment_created_event.rb

@@ -1,5 +1,6 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::AssignmentCreatedEvent < LiveEvents::AssignmentEvent
-
-end
+module LiveEvents
+  class AssignmentCreatedEvent < LiveEvents::AssignmentEvent
+  end
+end

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

@@ -1,63 +1,54 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::AssignmentEvent < LiveEvents::BaseEvent
-  # The following is provided in the live events call:
-  # {
-  #     assignment_id: assignment.global_id,
-  #     context_id: assignment.global_context_id,
-  #     context_type: assignment.context_type,
-  #     workflow_state: assignment.workflow_state,
-  #     title: LiveEvents.truncate(assignment.title),
-  #     description: LiveEvents.truncate(assignment.description),
-  #     due_at: assignment.due_at,
-  #     unlock_at: assignment.unlock_at,
-  #     lock_at: assignment.lock_at,
-  #     updated_at: assignment.updated_at,
-  #     points_possible: assignment.points_possible
-  # }
+module LiveEvents
+  class AssignmentEvent < LiveEvents::BaseEvent
+    # The following is provided in the live events call:
+    # {
+    #     assignment_id: assignment.global_id,
+    #     context_id: assignment.global_context_id,
+    #     context_type: assignment.context_type,
+    #     workflow_state: assignment.workflow_state,
+    #     title: LiveEvents.truncate(assignment.title),
+    #     description: LiveEvents.truncate(assignment.description),
+    #     due_at: assignment.due_at,
+    #     unlock_at: assignment.unlock_at,
+    #     lock_at: assignment.lock_at,
+    #     updated_at: assignment.updated_at,
+    #     points_possible: assignment.points_possible
+    # }
 
-  def perform(event_payload)
-    super
-    attrs = {
+    def perform(event_payload)
+      super
+      attrs = {
         canvas_assignment_id: local_canvas_id(payload[:assignment_id]),
-        course_id: course.try(:id),
-        name: payload[:title],
+        title: payload[:title],
         workflow_state: payload[:workflow_state],
         description: payload[:description],
         due_at: payload[:due_at],
         unlock_at: payload[:unlock_at],
         lock_at: payload[:lock_at],
         points_possible: payload[:points_possible],
-        canvas_updated_at: payload[:updated_at]
-    }
-    create_or_update(attrs)
-  rescue => e
-    log_error e
-  ensure
-    true
-  end
+      }
+      create_or_update(attrs)
+    end
 
-  private
-  def create_or_update(attrs)
-    assignment = Assignment.where(canvas_assignment_id: attrs[:canvas_assignment_id]).first_or_initialize
-    assignment.assign_attributes(attrs)
-    assignment.save!
-    assignment
-  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
+    def create_or_update(attrs)
+      assignment = Assignment.where(canvas_assignment_id: attrs[:canvas_assignment_id]).first_or_initialize
+      assignment.assign_attributes(attrs)
+      assignment.save!
+      assignment
+    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
-    unless @course
-      if canvas_course_id.present?
-        @course = Course.find_by(canvas_course_id: canvas_course_id)
-      end
+    # 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
-    @course
-  end
 
-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 ||= Course.find_by(canvas_course_id: canvas_course_id)
+    end
+  end
+end

data/lib/canvas_sync/generators/templates/services/live_events/assignment/assignment_updated_event.rb

@@ -1,4 +1,6 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::AssignmentUpdatedEvent < LiveEvents::AssignmentEvent
-end
+module LiveEvents
+  class AssignmentUpdatedEvent < LiveEvents::AssignmentEvent
+  end
+end

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

@@ -1,23 +1,16 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::BaseEvent
+module LiveEvents
+  class BaseEvent < CanvasSync::Job
+    attr_accessor :payload
 
-  attr_accessor :payload
+    def perform(event_payload)
+      @payload = HashWithIndifferentAccess.new(event_payload["body"])
+    end
 
-  def perform(event_payload)
-    @payload = HashWithIndifferentAccess.new(event_payload['body'])
+    # 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
   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
-
-  def log_error(e)
-    Rails.logger.error "Error processing Live Event: #{self.class.name}"
-    Rails.logger.error "#{payload}"
-    Rails.logger.error e.message
-    Rails.logger.error e.backtrace.join("\n")
-  end
-
-end
+end

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

@@ -1,4 +1,6 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::CourseCreatedEvent < LiveEvents::CourseEvent
-end
+module LiveEvents
+  class CourseCreatedEvent < LiveEvents::CourseEvent
+  end
+end

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

@@ -1,42 +1,36 @@
-<%= autogenerated_event_warning %>
-
-class LiveEvents::CourseEvent < LiveEvents::BaseEvent
-
-  # The following is provided in the live events call:
-  # {
-  #     course_id: course.global_id,
-  #     uuid: course.uuid,
-  #     account_id: course.global_account_id,
-  #     name: course.name,
-  #     created_at: course.created_at,
-  #     updated_at: course.updated_at,
-  #     workflow_state: course.workflow_state
-  # }
-
-
-  def perform(event_payload)
-    super
-    attrs = {
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class CourseEvent < LiveEvents::BaseEvent
+    # The following is provided in the live events call:
+    # {
+    #     course_id: course.global_id,
+    #     uuid: course.uuid,
+    #     account_id: course.global_account_id,
+    #     name: course.name,
+    #     created_at: course.created_at,
+    #     updated_at: course.updated_at,
+    #     workflow_state: course.workflow_state
+    # }
+
+    def perform(event_payload)
+      super
+      attrs = {
         canvas_course_id: local_canvas_id(payload[:course_id]),
         canvas_account_id: local_canvas_id(payload[:account_id]),
-        name: payload[:name],
-        workflow_state: payload[:workflow_state]
-    }
-    create_or_update(attrs)
-  rescue => e
-    log_error e
-  ensure
-    true
+        long_name: payload[:name],
+        status: payload[:workflow_state],
+      }
+      create_or_update(attrs)
+    end
+
+    private
+
+    def create_or_update(attrs)
+      course = Course.where(canva_course_id: attrs[:canva_course_id]).first_or_initialize
+      course.assign_attributes(attrs)
+      course.save!
+      course
+    end
   end
-
-  private
-
-  def create_or_update(attrs)
-    course = Course.where(canva_course_id: attrs[:canva_course_id]).first_or_initialize
-    course.assign_attributes(attrs)
-    course.save!
-    course
-  end
-
 end
-

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

@@ -1,4 +1,6 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::CourseUpdatedEvent < LiveEvents::CourseEvent
-end
+module LiveEvents
+  class CourseUpdatedEvent < LiveEvents::CourseEvent
+  end
+end

data/lib/canvas_sync/generators/templates/services/live_events/enrollment/enrollment_created_event.rb

@@ -1,4 +1,6 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::EnrollmentCreatedEvent < LiveEvents::EnrollmentEvent
-end
+module LiveEvents
+  class EnrollmentCreatedEvent < LiveEvents::EnrollmentEvent
+  end
+end

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

@@ -1,58 +1,55 @@
-<%= autogenerated_event_warning %>
-
-class LiveEvents::EnrollmentEvent < LiveEvents::BaseEvent
-
-  # The following is provided in the live events call:
-  # {
-  #
-  #     enrollment_id: enrollment.global_id,
-  #     course_id: enrollment.global_course_id,
-  #     user_id: enrollment.global_user_id,
-  #     user_name: enrollment.user_name,
-  #     type: enrollment.type,
-  #     created_at: enrollment.created_at,
-  #     updated_at: enrollment.updated_at,
-  #     limit_privileges_to_course_section: enrollment.limit_privileges_to_course_section,
-  #     course_section_id: enrollment.global_course_section_id,
-  #     workflow_state: enrollment.workflow_state
-  # }
-
-  def perform(paload)
-    super
-    return if course.nil? || section.nil? || user.nil?
-    attrs = {
-
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class EnrollmentEvent < LiveEvents::BaseEvent
+    # The following is provided in the live events call:
+    # {
+    #
+    #     enrollment_id: enrollment.global_id,
+    #     course_id: enrollment.global_course_id,
+    #     user_id: enrollment.global_user_id,
+    #     user_name: enrollment.user_name,
+    #     type: enrollment.type,
+    #     created_at: enrollment.created_at,
+    #     updated_at: enrollment.updated_at,
+    #     limit_privileges_to_course_section: enrollment.limit_privileges_to_course_section,
+    #     course_section_id: enrollment.global_course_section_id,
+    #     workflow_state: enrollment.workflow_state
+    # }
+
+    def perform(payload)
+      super
+      return if course.nil? || section.nil? || user.nil?
+      attrs = {
         canvas_enrollment_id: local_canvas_id(payload[:enrollment_id]),
-        course_id: course.try(:id),
-        user_id: user.try(:id),
-        type: payload[:type],
-        section_id: section.try(:id),
-        workflow_state: payload[:workflow_state]
-    }
-    create_or_update(attrs)
-  rescue => e
-    log_error e
-  ensure
-    true
-  end
-
-  private
-  def create_or_update(attrs)
-    enrollment = Enrollment.where(canvas_enrollment_id: attrs[:canvas_enrollment_id]).first_or_initialize
-    enrollment.assign_attributes(attrs)
-    enrollment.save!
-    enrollment
-  end
-
-  def course
-    @course ||= Course.find_by(canvas_course_id: local_canvas_id(payload[:course_id]))
-  end
-
-  def section
-    @section ||= Section.find_by(canvas_section_id: local_canvas_id(payload[:section_id]))
-  end
-
-  def user
-    @user ||= User.find_by(canvas_user_id: local_canvas_id(payload[:user_id]))
+        canvas_course_id: course.try(:id),
+        canvas_user_id: user.try(:id),
+        role: payload[:type],
+        canvas_section_id: section.try(:id),
+        status: payload[:workflow_state],
+      }
+      create_or_update(attrs)
+    end
+
+    private
+
+    def create_or_update(attrs)
+      enrollment = Enrollment.where(canvas_enrollment_id: attrs[:canvas_enrollment_id]).first_or_initialize
+      enrollment.assign_attributes(attrs)
+      enrollment.save!
+      enrollment
+    end
+
+    def course
+      @course ||= Course.find_by(canvas_course_id: local_canvas_id(payload[:course_id]))
+    end
+
+    def section
+      @section ||= Section.find_by(canvas_section_id: local_canvas_id(payload[:section_id]))
+    end
+
+    def user
+      @user ||= User.find_by(canvas_user_id: local_canvas_id(payload[:user_id]))
+    end
   end
-end
+end

data/lib/canvas_sync/generators/templates/services/live_events/enrollment/enrollment_updated_event.rb

@@ -1,4 +1,6 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::EnrollmentUpdatedEvent < LiveEvents::EnrollmentEvent
-end
+module LiveEvents
+  class EnrollmentUpdatedEvent < LiveEvents::EnrollmentEvent
+  end
+end

data/lib/canvas_sync/generators/templates/services/live_events/grade/grade_changed_event.rb

@@ -1,4 +1,6 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::GradeChangedEvent < LiveEvents::GradeEvent
-end
+module LiveEvents
+  class GradeChangedEvent < LiveEvents::GradeEvent
+  end
+end

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

@@ -1,56 +1,55 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::GradeEvent < LiveEvents::BaseEvent
-  # The following is provided in the live events call:
-  # {
-  #   submission_id: submission.global_id,
-  #   assignment_id: submission.global_assignment_id,
-  #   grade: submission.grade,
-  #   old_grade: old_submission.try(:grade),
-  #   score: submission.score,
-  #   old_score: old_submission.try(:score),
-  #   points_possible: submission.assignment.points_possible,
-  #   old_points_possible: old_assignment.points_possible,
-  #   grader_id: grader_id,
-  #   student_id: submission.global_user_id,
-  #   user_id: submission.global_user_id,
-  #   grading_complete: submission.graded?,
-  #   muted: submission.muted_assignment?
-  # }
+module LiveEvents
+  class GradeEvent < LiveEvents::BaseEvent
+    # The following is provided in the live events call:
+    # {
+    #   submission_id: submission.global_id,
+    #   assignment_id: submission.global_assignment_id,
+    #   grade: submission.grade,
+    #   old_grade: old_submission.try(:grade),
+    #   score: submission.score,
+    #   old_score: old_submission.try(:score),
+    #   points_possible: submission.assignment.points_possible,
+    #   old_points_possible: old_assignment.points_possible,
+    #   grader_id: grader_id,
+    #   student_id: submission.global_user_id,
+    #   user_id: submission.global_user_id,
+    #   grading_complete: submission.graded?,
+    #   muted: submission.muted_assignment?
+    # }
 
-  def perform(event_payload)
-    super
-    attrs = {
-      submission_id: submission.try(:id),
-      assignment_id: assignment.try(:id),
-      score: payload[:score],
-      points_possible: payload[:points_possible],
-      grader_id: payload[:grader_id],
-      user_id: user.try(:id),
-      grading_complete: payload[:grading_complete],
-      muted: payload[:muted]
-    }
-    create_or_update(attrs)
-  rescue => e
-    log_error e
-  ensure
-    true
-  end
+    def perform(event_payload)
+      super
+      attrs = {
+        submission_id: submission.try(:id),
+        assignment_id: assignment.try(:id),
+        score: payload[:score],
+        points_possible: payload[:points_possible],
+        grader_id: payload[:grader_id],
+        user_id: user.try(:id),
+        grading_complete: payload[:grading_complete],
+        muted: payload[:muted],
+      }
+      create_or_update(attrs)
+    end
 
-  private
-  def create_or_update(attrs)
-    # Todo: add your code here
-  end
+    private
 
-  def submission
-    Submission.find_by(canvas_submission_id: local_canvas_id(payload[:submission_id]))
-  end
+    def create_or_update(attrs)
+      # TODO: add your code here
+    end
 
-  def assignment
-    Assignment.find_by(canvas_assignment_id: local_canvas_id(payload[:assignment_id]))
-  end
+    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]))
+    def user
+      User.find_by(canvas_user_id: local_canvas_id(payload[:user_id]))
+    end
   end
 end