canvas_sync 0.3.23 → 0.4.0

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

@@ -0,0 +1,6 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class ModuleCreatedEvent < LiveEvents::ModuleEvent
+  end
+end

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

@@ -0,0 +1,39 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class ModuleEvent < LiveEvents::BaseEvent
+    # The following is provided in the live events call:
+    # {
+    #   module_id,
+    #   context_id,
+    #   context_type,
+    #   name,
+    #   position,
+    #   workflow_state,
+    # }
+
+    def perform(_event_payload)
+      super
+      create_or_update_from_api(payload)
+    end
+
+    private
+
+    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"])
+      api_params = canvas_sync_client.course_module(payload["context_id"], payload["module_id"])
+
+      context_module.assign_attributes(
+        canvas_context_id: payload["context_id"],
+        canvas_context_type: payload["context_type"],
+        position: api_params["position"],
+        name: api_params["name"],
+        workflow_state: payload["workflow_state"],
+        unlock_at: api_params["unlock_at"],
+      )
+
+      context_module.save! if context_module.changed?
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# <%= autogenerated_event_warning %>
+
+module LiveEvents
+  class ModuleUpdatedEvent < LiveEvents::ModuleEvent
+  end
+end

data/lib/canvas_sync/generators/templates/services/live_events/submission/submission_created_event.rb

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

data/lib/canvas_sync/generators/templates/services/live_events/submission/submission_event.rb

@@ -1,57 +1,52 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::SubmissionEvent < LiveEvents::BaseEvent
+module LiveEvents
+  class SubmissionEvent < LiveEvents::BaseEvent
+    # The following is provided in the live events call:
+    # {
+    #     submission_id: submission.global_id,
+    #     assignment_id: submission.global_assignment_id,
+    #     user_id: submission.global_user_id,
+    #     submitted_at: submission.submitted_at,
+    #     graded_at: submission.graded_at,
+    #     updated_at: submission.updated_at,
+    #     score: submission.score,
+    #     grade: submission.grade,
+    #     submission_type: submission.submission_type,
+    #     body: LiveEvents.truncate(submission.body),
+    #     url: submission.url,
+    #     attempt: submission.attempt
+    # }
 
-  # The following is provided in the live events call:
-  # {
-  #     submission_id: submission.global_id,
-  #     assignment_id: submission.global_assignment_id,
-  #     user_id: submission.global_user_id,
-  #     submitted_at: submission.submitted_at,
-  #     graded_at: submission.graded_at,
-  #     updated_at: submission.updated_at,
-  #     score: submission.score,
-  #     grade: submission.grade,
-  #     submission_type: submission.submission_type,
-  #     body: LiveEvents.truncate(submission.body),
-  #     url: submission.url,
-  #     attempt: submission.attempt
-  # }
-
-  def perform(event_payload)
-    super
-    return if assignment.nil? || user.nil?
-    attrs = {
+    def perform(event_payload)
+      super
+      return if assignment.nil? || user.nil?
+      attrs = {
         canvas_submission_id: local_canvas_id(payload[:submission_id]),
-        assignment_id: assignment.try(:id),
-        user_id: user.try(:id),
+        canvas_assignment_id: assignment.try(:id),
+        canvas_user_id: user.try(:id),
         submitted_at: payload[:submitted_at],
         graded_at: payload[:graded_at],
         score: payload[:score],
-        grade: payload[:grade],
-        submission_type: payload[:submission_type]
-    }
-    create_or_update(attrs)
-  rescue => e
-    log_error e
-  ensure
-    true
+      }
+      create_or_update(attrs)
+    end
   end
-end
 
-private
-def create_or_update(attrs)
-  submission = Submission.where(canvas_submission_id: attrs[:canvas_submission_id]).first_or_initialize
-  submission.assign_attributes(attrs)
-  submission.save!
-  submission
-end
+  private
 
+  def create_or_update(attrs)
+    submission = Submission.where(canvas_submission_id: attrs[:canvas_submission_id]).first_or_initialize
+    submission.assign_attributes(attrs)
+    submission.save!
+    submission
+  end
 
-def assignment
-  @assignment ||= Assignment.find_by(canvas_assignment_id: local_canvas_id(payload[:assignment_id]))
-end
+  def assignment
+    @assignment ||= Assignment.find_by(canvas_assignment_id: local_canvas_id(payload[:assignment_id]))
+  end
 
-def user
-  @user ||= User.find_by(canvas_user_id: local_canvas_id(payload[:user_id]))
+  def user
+    @user ||= User.find_by(canvas_user_id: local_canvas_id(payload[:user_id]))
+  end
 end

data/lib/canvas_sync/generators/templates/services/live_events/submission/submission_updated_event.rb

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

data/lib/canvas_sync/generators/templates/services/live_events/syllabus/syllabus_event.rb

@@ -1,35 +1,34 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::SyllabusEvent < LiveEvents::BaseEvent
-  # The following is provided in the live events call:
-  # {
-  #   course_id: course.global_id,
-  #   syllabus_body: LiveEvents.truncate(course.syllabus_body),
-  #   old_syllabus_body: LiveEvents.truncate(old_syllabus_body)
-  # }
-  #
+module LiveEvents
+  class SyllabusEvent < LiveEvents::BaseEvent
+    # The following is provided in the live events call:
+    # {
+    #   course_id: course.global_id,
+    #   syllabus_body: LiveEvents.truncate(course.syllabus_body),
+    #   old_syllabus_body: LiveEvents.truncate(old_syllabus_body)
+    # }
+    #
 
-  def perform(event_payload)
-    super
-    attrs = {
-      course_id: course.try(:id),
-      syllabus_body: payload[:syllabus_body]
-    }
-    create_or_update(attrs)
-  rescue => e
-    log_error e
-  ensure
-    true
-  end
+    def perform(event_payload)
+      super
+      attrs = {
+        course_id: course.try(:id),
+        syllabus_body: payload[:syllabus_body],
+      }
+      create_or_update(attrs)
+    end
 
-  private
-  def create_or_update(attrs)
-    syllabus = Syllabus.where(course_id: attrs[:course_id]).first_or_initialize
-    syllabus.body = attrs[:syllabus_body] # Syllabus Body can get truncated by live events
-    syllabus.save!
-  end
+    private
+
+    def create_or_update(attrs)
+      syllabus = Syllabus.where(course_id: attrs[:course_id]).first_or_initialize
+      syllabus.body = attrs[:syllabus_body] # Syllabus Body can get truncated by live events
+      syllabus.save!
+    end
 
-  def course
-    Course.find_by(canvas_course_id: local_canvas_id(payload[:course_id]))
+    def course
+      Course.find_by(canvas_course_id: local_canvas_id(payload[:course_id]))
+    end
   end
-end
+end

data/lib/canvas_sync/generators/templates/services/live_events/syllabus/syllabus_updated_event.rb

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

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

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

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

@@ -1,6 +1,7 @@
-<%= autogenerated_event_warning %>
+# <%= autogenerated_event_warning %>
 
-class LiveEvents::UserEvent < LiveEvents::BaseEvent
+module LiveEvents
+  class UserEvent < LiveEvents::BaseEvent
   # The following is provided in the live events call:
   # {
   #   user_id: user.global_id,
@@ -16,17 +17,13 @@ class LiveEvents::UserEvent < LiveEvents::BaseEvent
     super
     attrs = {
       canvas_user_id: local_canvas_id(payload[:user_id]),
-      name: payload[:name],
-      workflow_state: payload[:workflow_state]
+      status: payload[:workflow_state],
     }
     create_or_update(attrs)
-  rescue => e
-    log_error e
-  ensure
-    true
   end
 
   private
+
   def create_or_update(attrs)
     user = User.where(canvas_user_id: attrs[:canvas_user_id]).first_or_initialize
     user.assign_attributes(attrs)

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

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

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.3.23".freeze
+  VERSION = "0.4.0".freeze
 end

data/spec/canvas_sync/services/module_event_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+RSpec.describe LiveEvents::ModuleEvent do
+  let(:payload) {
+    {
+      "body" => {
+        module_id: "1",
+        name: "Module 2",
+        position: 1337,
+        workflow_state: "active",
+        context_id: 1,
+        context_type: "Course",
+      },
+    }
+  }
+
+  describe "#perform" do
+    context "the module already exists" do
+      let!(:context_module) { FactoryGirl.create(:context_module, canvas_context_module_id: payload["body"][:module_id]) }
+
+      it "updates it" do
+        expect {
+          LiveEvents::ModuleEvent.new.perform(payload)
+        }.to_not change { ContextModule.count }
+        expect(context_module.reload.name).to eq(payload["body"][:name])
+        expect(context_module.position).to eq(payload["body"][:position])
+        expect(context_module.workflow_state).to eq(payload["body"][:workflow_state])
+      end
+    end
+
+    context "the module does not already exist" do
+      it "creates it" do
+        expect {
+          LiveEvents::ModuleEvent.new.perform(payload)
+        }.to change { ContextModule.count }.by(1)
+        expect(ContextModule.last.name).to eq(payload["body"][:name])
+        expect(ContextModule.last.position).to eq(payload["body"][:position])
+        expect(ContextModule.last.workflow_state).to eq(payload["body"][:workflow_state])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# #
+# AUTO GENERATED LIVE EVENT
+# This was auto generated by the CanvasSync Gem.
+# You can customize it as needed, but make sure you test
+# any changes you make to the auto generated methods.
+#
+
+
+module LiveEvents
+  class AssignmentCreatedEvent < LiveEvents::AssignmentEvent
+  end
+end

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

@@ -0,0 +1,60 @@
+# #
+# AUTO GENERATED LIVE EVENT
+# This was auto generated by the CanvasSync Gem.
+# You can customize it as needed, but make sure you test
+# any changes you make to the auto generated methods.
+#
+
+
+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 = {
+        canvas_assignment_id: local_canvas_id(payload[:assignment_id]),
+        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],
+      }
+      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
+
+    # 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 ||= Course.find_by(canvas_course_id: canvas_course_id)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# #
+# AUTO GENERATED LIVE EVENT
+# This was auto generated by the CanvasSync Gem.
+# You can customize it as needed, but make sure you test
+# any changes you make to the auto generated methods.
+#
+
+
+module LiveEvents
+  class AssignmentUpdatedEvent < LiveEvents::AssignmentEvent
+  end
+end

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

@@ -0,0 +1,22 @@
+# #
+# AUTO GENERATED LIVE EVENT
+# This was auto generated by the CanvasSync Gem.
+# You can customize it as needed, but make sure you test
+# any changes you make to the auto generated methods.
+#
+
+
+module LiveEvents
+  class BaseEvent < CanvasSync::Job
+    attr_accessor :payload
+
+    def perform(event_payload)
+      @payload = HashWithIndifferentAccess.new(event_payload["body"])
+    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
+  end
+end