canvas_sync 0.3.3 → 0.3.5

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

@@ -0,0 +1,56 @@
+<%= 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?
+  # }
+
+  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
+
+  private
+  def create_or_update(attrs)
+    # Todo: add your code here
+  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]))
+  end
+end

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

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

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

@@ -0,0 +1,57 @@
+<%= autogenerated_event_warning %>
+
+class LiveEvents::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
+  # }
+
+  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),
+        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
+  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
+
+
+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]))
+end

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

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

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

@@ -0,0 +1,35 @@
+<%= 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)
+  # }
+  #
+
+  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
+
+  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]))
+  end
+end

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

@@ -0,0 +1,2 @@
+class LiveEvents::SyllabusUpdatedEvent < LiveEvents::SyllabusEvent
+end

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

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

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

@@ -0,0 +1,35 @@
+<%= autogenerated_event_warning %>
+
+class LiveEvents::UserEvent < LiveEvents::BaseEvent
+  # The following is provided in the live events call:
+  # {
+  #   user_id: user.global_id,
+  #   uuid: user.uuid,
+  #   name: user.name,
+  #   short_name: user.short_name,
+  #   workflow_state: user.workflow_state,
+  #   created_at: user.created_at,
+  #   updated_at: user.updated_at
+  # }
+
+  def perform(event_payload)
+    super
+    attrs = {
+      canvas_user_id: local_canvas_id(payload[:user_id]),
+      name: payload[:name],
+      workflow_state: 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)
+    user.save!
+  end
+end

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

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

data/lib/canvas_sync/importers/bulk_importer.rb

@@ -31,7 +31,7 @@ module CanvasSync
           row_ids[row[conflict_target]] = true
 
           rows << csv_column_names.map do |column|
-            if mapping[column][:type] == :datetime
+            if mapping[column][:type].to_sym == :datetime
               # todo - add some timezone config to the mapping.
               # In cases where the timestamp or date doesn't include a timezone, you should be able to specify one
               DateTime.parse(row[column]).utc rescue ''

data/lib/canvas_sync/jobs/sync_roles_job.rb

@@ -0,0 +1,18 @@
+module CanvasSync
+  module Jobs
+    class SyncRolesJob < CanvasSync::Job
+      # Syncs Roles using the Canvas API
+      #
+      #
+      # @param job_chain [Hash]
+      # @param options [Hash]
+      def perform(job_chain, options)
+        CanvasSync.get_canvas_sync_client(job_chain[:global_options]).list_roles('self').all_pages!.each do |role_params|
+          Role.create_or_update(role_params)
+        end
+
+        CanvasSync.invoke_next(job_chain)
+      end
+    end
+  end
+end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = '0.3.3'
+  VERSION = '0.3.5'
 end

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -50,6 +50,34 @@ RSpec.describe CanvasSync do
           })
         end
       end
+
+      context 'we are syncing roles with a term scope' do
+        it 'syncs the roles in a separate job that runs first' do
+          chain = CanvasSync.default_provisioning_report_chain(['roles', 'courses'], :active)
+          expect(chain).to eq({
+            jobs: [
+              { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
+              { job: CanvasSync::Jobs::SyncRolesJob.to_s, options: {} },
+              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: 'active', models: ['courses'] } }
+            ],
+            global_options: { legacy_support: false }
+          })
+        end
+      end
+
+      context 'we are syncing roles without a term scope' do
+        it 'syncs roles separately even with no term scope' do
+          chain = CanvasSync.default_provisioning_report_chain(['roles', 'courses'])
+          expect(chain).to eq({
+            jobs: [
+              { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
+              { job: CanvasSync::Jobs::SyncRolesJob.to_s, options: {} },
+              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: ['courses'] } }
+            ],
+            global_options: { legacy_support: false }
+          })
+        end
+      end
     end
   end
 end

data/spec/canvas_sync/jobs/sync_roles_job_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+RSpec.describe CanvasSync::Jobs::SyncRolesJob do
+  describe '#perform' do
+    let(:role_params) { open_canvas_fixture('roles') }
+    let(:job_chain) { { jobs: [], global_options: {}} }
+
+    it 'retrieves all terms from the Canvas API and then invokes the next job' do
+      expect(CanvasSync).to receive(:invoke_next).with(job_chain)
+
+      expect {
+        CanvasSync::Jobs::SyncRolesJob.perform_now(job_chain, {})
+      }.to change { Role.count }.by(role_params.length)
+    end
+  end
+end

data/spec/canvas_sync/models/roles_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe Role, type: :model do
+  let(:subject) { FactoryGirl.create(:role) }
+
+  describe 'validations' do
+    it { should validate_presence_of(:canvas_role_id) }
+    it { should validate_uniqueness_of(:canvas_role_id) }
+  end
+
+  describe '.create_or_update' do
+    let(:role_params) { open_canvas_fixture('roles')[0] }
+
+    context 'the role does not already exist' do
+      it 'creates it' do
+        expect {
+          Role.create_or_update(role_params)
+        }.to change { Role.count }.by(1)
+
+        role = Role.last
+        expect(role.label).to eq(role_params['label'])
+        expect(role.base_role_type).to eq(role_params['base_role_type'])
+        expect(role.account).to eq(role_params['account'])
+        expect(role.permissions).to eq(role_params['permissions'])
+        expect(role.workflow_state).to eq(role_params['workflow_state'])
+      end
+    end
+
+    context 'the role already exists' do
+      let!(:existing_role) { FactoryGirl.create(:role, canvas_role_id: role_params['id']) }
+
+      it 'updates it' do
+        expect {
+          Role.create_or_update(role_params)
+        }.to_not change { Role.count }
+
+        existing_role.reload
+        expect(existing_role.label).to eq(role_params['label'])
+        expect(existing_role.base_role_type).to eq(role_params['base_role_type'])
+        expect(existing_role.account).to eq(role_params['account'])
+        expect(existing_role.permissions).to eq(role_params['permissions'])
+        expect(existing_role.workflow_state).to eq(role_params['workflow_state'])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+#
+# AUTO GENERATED MODEL
+# This model 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.
+#
+
+
+class Role < ApplicationRecord
+  validates :canvas_role_id, uniqueness: true, presence: true
+
+  def self.create_or_update(role_params)
+    role = Role.find_or_initialize_by(canvas_role_id: role_params['id'])
+
+    role.assign_attributes(label: role_params['label'],
+                           base_role_type: role_params['base_role_type'],
+                           account: role_params['account'],
+                           permissions: role_params['permissions'],
+                           workflow_state: role_params['workflow_state'])
+
+    role.save! if role.changed?
+    role
+  end
+end

data/spec/dummy/config/database.yml

@@ -5,21 +5,21 @@
 #   gem 'sqlite3'
 #
 default: &default
-  adapter: sqlite3
+  adapter: postgresql
   pool: 5
   timeout: 5000
 
 development:
   <<: *default
-  database: db/development.sqlite3
+  database: canvas_sync_development
 
 # Warning: The database defined as "test" will be erased and
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
   <<: *default
-  database: db/test.sqlite3
+  database: canvas_sync_test
 
 production:
   <<: *default
-  database: db/production.sqlite3
+  database: canvas_sync_production

data/spec/dummy/db/migrate/20180103162102_create_roles.rb

@@ -0,0 +1,23 @@
+#
+# AUTO GENERATED MIGRATION
+# This migration was auto generated by the CanvasSync Gem.
+# You can add new columns to this table, but removing or
+# re-naming ones created here may break Canvas Syncing.
+#
+
+
+class CreateRoles < ActiveRecord::Migration[5.1]
+  def change
+    create_table :roles do |t|
+      t.integer :canvas_role_id, null: false
+      t.string :label, null: false
+      t.string :base_role_type, null: false
+      t.json :account
+      t.string :workflow_state, null: false
+      t.json :permissions
+
+      t.timestamps
+    end
+    add_index :roles, :canvas_role_id, unique: true
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,10 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20171107213207) do
+ActiveRecord::Schema.define(version: 20180103162102) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
 
   create_table "canvas_sync_job_logs", force: :cascade do |t|
     t.datetime "started_at"
@@ -60,6 +63,18 @@ ActiveRecord::Schema.define(version: 20171107213207) do
     t.index ["canvas_user_id"], name: "index_enrollments_on_canvas_user_id"
   end
 
+  create_table "roles", force: :cascade do |t|
+    t.integer "canvas_role_id", null: false
+    t.string "label", null: false
+    t.string "base_role_type", null: false
+    t.json "account"
+    t.string "workflow_state", null: false
+    t.json "permissions"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_role_id"], name: "index_roles_on_canvas_role_id", unique: true
+  end
+
   create_table "sections", force: :cascade do |t|
     t.bigint "canvas_section_id", null: false
     t.string "sis_id"