canvas_sync 0.3.14 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffcf605b5474780a893dd4cb81c60d39568e5198
-  data.tar.gz: d2e32471b37b95667680a17c4907c42ce6965bdc
+  metadata.gz: f691f2ffe7d6115dae15aed67684917d1b0f5716
+  data.tar.gz: 2892f5f534919b7cca8245d458081de23e9908be
 SHA512:
-  metadata.gz: 36943420c9986863bc1ae0f54b6cdf50ed284115c99d5bae5ba1421ed65dfada0adc4ba9943c4e6481e5e1eacec50407c103ce82d2bbb926535093d2ba5f0d92
-  data.tar.gz: 468ee9f16f45dd6cffb2779ea45a4f78b552c17ebb0de0cd4534711aec4c4f9f0a5ab5da38ae4f8cdf7eb812623c11e1591091319b55d2cbaafa834440429d8f
+  metadata.gz: a183d815dfae6ba9de78085002f22c27de7ebc68d86e17e331bd8cea89bc7dd43ef4262aaf47800b249cf84750b678b8a066f10cf929bd1d67b4eaf51bce213b
+  data.tar.gz: a17e849b655aeeda3d2818bdba6f1e0b12b1addff753e8082687c1d94a5a57a77781e0107196b269fdf949ba6a4a71d1d5eb106c3587b8bf0e2cac7a5005f9cf

data/README.md

@@ -27,9 +27,11 @@ bundle exec rake db:migrate
 For a list of currently supported models, see `CanvasSync::SUPPORTED_MODELS`.
 
 Additionally, your Canvas instance must have the "Proserv Provisioning Report" enabled.
-- If you are syncing assignments the "Assignment Report" report must be enabled.
-- If you are syncing submissions the "Student Submissions"
-  (proserv_student_submissions_csv) report must be enabled.
+
+The following custom reports are required for the specified models:
+- assignments = "Assignments Report" (proserv_assignment_export_csv)
+- submissions = "Student Submissions" (proserv_student_submissions_csv)
+- assignment_groups = "Assignment Group Export" (proserv_assignment_group_export_csv)
 
 ## Prerequisites
 

data/lib/canvas_sync.rb

@@ -8,6 +8,7 @@ require "canvas_sync/jobs/report_processor_job"
 require "canvas_sync/jobs/sync_provisioning_report_job"
 require "canvas_sync/jobs/sync_assignments_job"
 require "canvas_sync/jobs/sync_submissions_job"
+require "canvas_sync/jobs/sync_assignment_groups_job"
 require "canvas_sync/jobs/sync_terms_job"
 require "canvas_sync/jobs/sync_users_job"
 require "canvas_sync/jobs/sync_roles_job"
@@ -17,7 +18,7 @@ Dir[File.dirname(__FILE__) +  "/canvas_sync/importers/*.rb"].each { |file| requi
 Dir[File.dirname(__FILE__) +  "/canvas_sync/generators/*.rb"].each { |file| require file }
 
 module CanvasSync
-  SUPPORTED_MODELS = %w[users courses terms enrollments sections assignments submissions roles admins xlist].freeze
+  SUPPORTED_MODELS = %w[users courses terms enrollments sections assignments submissions roles admins assignment_groups xlist].freeze
   SUPPORTED_LIVE_EVENTS = %w[course enrollment submission assignment user syllabus grade].freeze
 
   # Runs a standard provisioning sync job with no extra report types.
@@ -105,6 +106,7 @@ module CanvasSync
 
     jobs.push(job: CanvasSync::Jobs::SyncAssignmentsJob.to_s, options: {}) if models.include?("assignments")
     jobs.push(job: CanvasSync::Jobs::SyncSubmissionsJob.to_s, options: {}) if models.include?("submissions")
+    jobs.push(job: CanvasSync::Jobs::SyncAssignmentGroupsJob.to_s, options: {}) if models.include?("assignment_groups")
 
     global_options = { legacy_support: legacy_support }
     global_options[:account_id] = account_id if account_id.present?

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

@@ -3,5 +3,6 @@
 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
 end

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

@@ -0,0 +1,7 @@
+<%= autogenerated_model_warning %>
+
+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
+end

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

@@ -7,4 +7,5 @@ class Course < ApplicationRecord
   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
 end

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

@@ -0,0 +1,24 @@
+<%= autogenerated_migration_warning %>
+
+class CreateAssignmentGroups < ActiveRecord::Migration[5.1]
+  def change
+    create_table :assignment_groups do |t|
+      t.bigint :canvas_assignment_group_id, null: false
+      t.bigint :canvas_course_id
+      t.string :name
+      t.text :rules
+      t.string :default_assignment_name
+      t.integer :position
+      t.text :assignment_weighting_scheme
+      t.float :group_weight
+      t.string :workflow_state
+      t.datetime :canvas_created_at
+      t.datetime :canvas_updated_at
+
+      t.timestamps
+    end
+
+    add_index :assignment_groups, :canvas_assignment_group_id, unique: true
+    add_index :assignment_groups, :canvas_course_id
+  end
+end

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

@@ -18,7 +18,7 @@ class CreateAssignments < ActiveRecord::Migration[5.1]
       t.string :workflow_state
       t.integer :context_id
       t.string :context_type
-      t.integer :assignment_group_id
+      t.integer :canvas_assignment_group_id
       t.integer :grading_scheme_id
       t.integer :grading_standard_id
 

data/lib/canvas_sync/jobs/sync_assignment_groups_job.rb

@@ -0,0 +1,28 @@
+module CanvasSync
+  module Jobs
+    class SyncAssignmentGroupsJob < ReportStarter
+      # Syncs AssignmentGroups
+      #
+      # Starts a report processor for the assignment_groups report
+      # (the proserv_assignment_group_export_csv report must be enabled)
+      #
+      # @param job_chain [Hash]
+      # @param options [Hash]
+      def perform(job_chain, _options)
+        report_params = if job_chain[:global_options][:term_id].present?
+                          { enrollment_term_id: job_chain[:global_options][:term_id] }
+                        else
+                          {}
+                        end
+
+        super(
+          job_chain,
+          "proserv_assignment_group_export_csv",
+          report_params,
+          CanvasSync::Processors::AssignmentGroupsProcessor.to_s,
+          {},
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/assignment_groups_processor.rb

@@ -0,0 +1,24 @@
+require_relative "./report_processor"
+
+module CanvasSync
+  module Processors
+    # Processes a assignment_groups report using the bulk importer.
+    #
+    # @param report_file_path [String]
+    # @param options [Hash]
+    class AssignmentGroupsProcessor < ReportProcessor
+      def self.process(report_file_path, _options)
+        new(report_file_path)
+      end
+
+      def initialize(report_file_path)
+        CanvasSync::Importers::BulkImporter.import(
+          report_file_path,
+          mapping[:assignment_groups][:report_columns],
+          AssignmentGroup,
+          mapping[:assignment_groups][:conflict_target].to_sym,
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/model_mappings.yml

@@ -178,7 +178,7 @@ assignments:
       database_column_name: context_type
       type: string
     assignment_group_id:
-      database_column_name: assignment_group_id
+      database_column_name: canvas_assignment_group_id
       type: integer
     grading_scheme_id:
       database_column_name: grading_scheme_id
@@ -214,3 +214,40 @@ submissions:
     points_possible:
       database_column_name: points_possible
       type: integer
+
+assignment_groups:
+  conflict_target: id
+  report_columns:
+    id:
+      database_column_name: :canvas_assignment_group_id
+      type: integer
+    canvas_course_id:
+      database_column_name: :canvas_course_id
+      type: integer
+    name:
+      database_column_name: :name
+      type: string
+    rules:
+      database_column_name: :rules
+      type: string
+    default_assignment_name:
+      database_column_name: :default_assignment_name
+      type: string
+    position:
+      database_column_name: :position
+      type: integer
+    assignment_weighting_scheme:
+      database_column_name: :assignment_weighting_scheme
+      type: string
+    group_weight:
+      database_column_name: :group_weight
+      type: string
+    workflow_state:
+      database_column_name: :workflow_state
+      type: string
+    created_at:
+      database_column_name: canvas_created_at
+      type: datetime
+    updated_at:
+      database_column_name: canvas_updated_at
+      type: datetime

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.3.14".freeze
+  VERSION = "0.3.15".freeze
 end

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -136,6 +136,21 @@ RSpec.describe CanvasSync do
           )
         end
       end
+
+      context "we are syncing assignment groups" do
+        it "appends the SyncAssignmentGroupsJob" do
+          chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments assignment_groups])
+
+          expect(chain).to eq(
+            jobs: [
+              { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
+              { job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: nil, models: %w[users enrollments assignment_groups] } },
+              { job: CanvasSync::Jobs::SyncAssignmentGroupsJob.to_s, options: {} },
+            ],
+            global_options: { legacy_support: false },
+          )
+        end
+      end
     end
   end
 end

data/spec/canvas_sync/jobs/sync_assignment_groups_job_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Jobs::SyncAssignmentGroupsJob do
+  describe "#perform" do
+    context "a term id is in the global_options" do
+      it "enqueues a ReportStarter for the proserv_assignment_group_export_csv for the given term" do
+        expect_any_instance_of(Bearcat::Client).to receive(:start_report)
+          .with("self", "proserv_assignment_group_export_csv", enrollment_term_id: 1)
+          .and_return("id" => 1)
+
+        expect(CanvasSync::Jobs::ReportChecker).to receive(:set).and_call_original
+
+        CanvasSync::Jobs::SyncAssignmentGroupsJob.perform_now({ jobs: [], global_options: { term_id: 1 } }, {})
+      end
+    end
+  end
+end

data/spec/canvas_sync/models/assignment_group_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe AssignmentGroup, type: :model do
+  let(:subject) { FactoryGirl.create(:assignment_group) }
+
+  describe 'validations' do
+    it { should validate_presence_of(:canvas_assignment_group_id) }
+    it { should validate_uniqueness_of(:canvas_assignment_group_id) }
+  end
+
+  describe 'associations' do
+    it do
+      should belong_to(:course)
+        .with_primary_key(:canvas_course_id)
+        .with_foreign_key(:canvas_course_id)
+    end
+
+    it do
+      should have_many(:assignments)
+        .with_primary_key(:canvas_assignment_group_id)
+        .with_foreign_key(:canvas_assignment_group_id)
+    end
+  end
+end

data/spec/canvas_sync/{assignment_spec.rb → models/assignment_spec.rb}

@@ -15,6 +15,12 @@ RSpec.describe Assignment, type: :model do
         .with_foreign_key(:canvas_assignment_id)
     end
 
+    it do
+      should belong_to(:assignment_group)
+        .with_primary_key(:canvas_assignment_group_id)
+        .with_foreign_key(:canvas_assignment_group_id)
+    end
+
     describe "context" do
       let!(:other_course) { FactoryGirl.create(:course) }
       let!(:matching_course) { FactoryGirl.create(:course) }

data/spec/canvas_sync/models/course_spec.rb

@@ -27,6 +27,12 @@ RSpec.describe Course, type: :model do
         .with_foreign_key(:canvas_course_id)
     end
 
+    it do
+      should have_many(:assignment_groups)
+        .with_primary_key(:canvas_course_id)
+        .with_foreign_key(:canvas_course_id)
+    end
+
     it do
       should have_many(:assignments)
         .with_primary_key(:canvas_course_id)

data/spec/canvas_sync/processors/assignment_groups_processor_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+RSpec.describe CanvasSync::Processors::AssignmentGroupsProcessor do
+  let(:subject) { CanvasSync::Processors::AssignmentGroupsProcessor }
+
+  describe "#process" do
+    it "inserts assignment_groups" do
+      expect {
+        subject.process("spec/support/fixtures/reports/assignment_groups.csv", {})
+      }.to change { AssignmentGroup.count }.by(2)
+    end
+  end
+end

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

@@ -9,5 +9,6 @@
 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
 end

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

@@ -0,0 +1,13 @@
+#
+# 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 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
+end

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

@@ -13,4 +13,5 @@ class Course < ApplicationRecord
   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
 end

data/spec/dummy/db/migrate/{20180212204530_create_assignments.rb → 20180215214227_create_assignments.rb}

@@ -24,7 +24,7 @@ class CreateAssignments < ActiveRecord::Migration[5.1]
       t.string :workflow_state
       t.integer :context_id
       t.string :context_type
-      t.integer :assignment_group_id
+      t.integer :canvas_assignment_group_id
       t.integer :grading_scheme_id
       t.integer :grading_standard_id
 

data/spec/dummy/db/migrate/20180215220605_create_assignment_groups.rb

@@ -0,0 +1,30 @@
+#
+# 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 CreateAssignmentGroups < ActiveRecord::Migration[5.1]
+  def change
+    create_table :assignment_groups do |t|
+      t.bigint :canvas_assignment_group_id, null: false
+      t.bigint :canvas_course_id
+      t.string :name
+      t.text :rules
+      t.string :default_assignment_name
+      t.integer :position
+      t.text :assignment_weighting_scheme
+      t.float :group_weight
+      t.string :workflow_state
+      t.datetime :canvas_created_at
+      t.datetime :canvas_updated_at
+
+      t.timestamps
+    end
+
+    add_index :assignment_groups, :canvas_assignment_group_id, unique: true
+    add_index :assignment_groups, :canvas_course_id
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20180213235544) do
+ActiveRecord::Schema.define(version: 20180215220605) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -27,6 +27,24 @@ ActiveRecord::Schema.define(version: 20180213235544) do
     t.index ["canvas_admin_id"], name: "index_admins_on_canvas_admin_id", unique: true
   end
 
+  create_table "assignment_groups", force: :cascade do |t|
+    t.bigint "canvas_assignment_group_id", null: false
+    t.bigint "canvas_course_id"
+    t.string "name"
+    t.text "rules"
+    t.string "default_assignment_name"
+    t.integer "position"
+    t.text "assignment_weighting_scheme"
+    t.float "group_weight"
+    t.string "workflow_state"
+    t.datetime "canvas_created_at"
+    t.datetime "canvas_updated_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_assignment_group_id"], name: "index_assignment_groups_on_canvas_assignment_group_id", unique: true
+    t.index ["canvas_course_id"], name: "index_assignment_groups_on_canvas_course_id"
+  end
+
   create_table "assignments", force: :cascade do |t|
     t.bigint "canvas_assignment_id", null: false
     t.string "title"
@@ -43,7 +61,7 @@ ActiveRecord::Schema.define(version: 20180213235544) do
     t.string "workflow_state"
     t.integer "context_id"
     t.string "context_type"
-    t.integer "assignment_group_id"
+    t.integer "canvas_assignment_group_id"
     t.integer "grading_scheme_id"
     t.integer "grading_standard_id"
     t.datetime "created_at", null: false