canvas_sync 0.3.11 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b9c94d7b3d1ab3d2a2249ed687faa4b68e88d780f3c2c61344aa896488dba6
-  data.tar.gz: 6912ce81b3a87b97233764d8874d84ae60aa1c4e168beba9b41f8c996d96c2ce
+  metadata.gz: 6c6eec06420fbb476e980bf7c1aae7d9f8679eb6b98558de1cb7765f5df13a12
+  data.tar.gz: 60963185f828d72df3e2a24d3bb3d1d4cf4dde73c0e2a9ce38f0c2147c178d70
 SHA512:
-  metadata.gz: 233214ceff623a94e72c60ab5d31879c23776623fb13498b8dacc63281e587dc4d3cf0b71eab17113395752785b3d93c644cb591dc8cbaceaf950ca77203d7e8
-  data.tar.gz: d4397f49130c1691d20bb1d421d8f91f4d90325de932ab0b52d8be0fb2eb230eef258f04329f598dadb942f0020f106b42481703bd9077dd968e57dee374bbc8
+  metadata.gz: 45c726b97e96b370c84fa2393d4d4378a22f145bf3b7f4544c4f78f1aff2a0a0b40b76e3b9d5c5e920e3ff423f6da0e5b8893f6744f05de69dcbfdabe5ea42d4
+  data.tar.gz: 02d4f57c81e21724da088b3bf877b88a507895da1fd595335a0f42581d82e3875646084ce229f0d58d6c5ad72b4e13e68712e1befab589bea2673193b3e7c9de

data/Rakefile

@@ -11,7 +11,7 @@ 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 the test database and schema..."
-  stream_command("cd spec/dummy; bundle exec rake db:drop; bundle exec rake db:migrate")
+  stream_command("cd spec/dummy; bundle exec rake db:drop; bundle exec rake db:create; bundle exec rake db:migrate")
 end
 
 def stream_command(cmd)

data/lib/canvas_sync.rb

@@ -7,18 +7,19 @@ require "canvas_sync/jobs/report_starter"
 require "canvas_sync/jobs/report_checker"
 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_terms_job"
 require "canvas_sync/jobs/sync_users_job"
 require "canvas_sync/jobs/sync_roles_job"
 require "canvas_sync/jobs/sync_admins_job"
 
-Dir[File.dirname(__FILE__) +  "/canvas_sync/processors/*.rb"].each {|file| require file }
-Dir[File.dirname(__FILE__) +  "/canvas_sync/importers/*.rb"].each {|file| require file }
-Dir[File.dirname(__FILE__) +  "/canvas_sync/generators/*.rb"].each {|file| require file }
+Dir[File.dirname(__FILE__) +  "/canvas_sync/processors/*.rb"].each { |file| require file }
+Dir[File.dirname(__FILE__) +  "/canvas_sync/importers/*.rb"].each { |file| require file }
+Dir[File.dirname(__FILE__) +  "/canvas_sync/generators/*.rb"].each { |file| require file }
 
 module CanvasSync
-  SUPPORTED_MODELS = %w(users courses terms enrollments sections roles admins xlist)
-  SUPPORTED_LIVE_EVENTS = %w(course enrollment submission assignment user syllabus grade)
+  SUPPORTED_MODELS = %w[users courses terms enrollments sections assignments roles admins 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.
   # Terms will be synced first using the API. If you are syncing users/roles/admins
@@ -101,7 +102,11 @@ module CanvasSync
       models = models - ['admins']
     end
 
-    jobs.push({ job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: term_scope, models: models } })
+    jobs.push(job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: term_scope, models: models })
+
+    if models.include?("assignments")
+      jobs.push(job: CanvasSync::Jobs::SyncAssignmentsJob.to_s, options: {})
+    end
 
     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

@@ -0,0 +1,6 @@
+<%= autogenerated_model_warning %>
+
+class Assignment < ApplicationRecord
+  validates :canvas_assignment_id, uniqueness: true, presence: true
+  belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_course_id
+end

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

@@ -5,4 +5,5 @@ class Course < ApplicationRecord
   belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_term_id, optional: true
   has_many :enrollments, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
   has_many :sections, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
+  has_many :assignments, as: :context, primary_key: :canvas_course_id
 end

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

@@ -0,0 +1,31 @@
+<%= autogenerated_migration_warning %>
+
+class CreateAssignments < ActiveRecord::Migration[5.1]
+  def change
+    create_table :assignments do |t|
+      t.bigint :canvas_assignment_id, null: false
+      t.string :title
+      t.text :description
+      t.datetime :due_at
+      t.datetime :unlock_at
+      t.datetime :lock_at
+      t.integer :points_possible
+      t.integer :min_score
+      t.integer :max_score
+      t.integer :mastery_score
+      t.string :grading_type
+      t.string :submission_types
+      t.string :workflow_state
+      t.integer :context_id
+      t.string :context_type
+      t.integer :assignment_group_id
+      t.integer :grading_scheme_id
+      t.integer :grading_standard_id
+
+      t.timestamps
+    end
+
+    add_index :assignments, :canvas_assignment_id, unique: true
+    add_index :assignments, [:context_id, :context_type]
+  end
+end

data/lib/canvas_sync/jobs/sync_assignments_job.rb

@@ -0,0 +1,28 @@
+module CanvasSync
+  module Jobs
+    class SyncAssignmentsJob < ReportStarter
+      # Syncs Assignments
+      #
+      # Starts a report processor for the assignment report
+      # (the proserv_assignment_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_export_csv",
+          report_params,
+          CanvasSync::Processors::AssignmentsProcessor.to_s,
+          {},
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/assignments_processor.rb

@@ -0,0 +1,24 @@
+require_relative "./report_processor"
+
+module CanvasSync
+  module Processors
+    # Processes an assignments report using the bulk importer.
+    #
+    # @param report_file_path [String]
+    # @param options [Hash]
+    class AssignmentsProcessor < 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[:assignments][:report_columns],
+          Assignment,
+          mapping[:assignments][:conflict_target].to_sym,
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/model_mappings.yml

@@ -128,3 +128,61 @@ xlist:
     canvas_nonxlist_course_id:
       database_column_name: canvas_nonxlist_course_id
       type: integer
+
+assignments:
+  conflict_target: id
+  report_columns:
+    id:
+      database_column_name: :canvas_assignment_id
+      type: integer
+    title:
+      database_column_name: title
+      type: string
+    description:
+      database_column_name: description
+      type: text
+    due_at:
+      database_column_name: due_at
+      type: datetime
+    unlock_at:
+      database_column_name: unlock_at
+      type: datetime
+    lock_at:
+      database_column_name: lock_at
+      type: datetime
+    points_possible:
+      database_column_name: points_possible
+      type: integer
+    min_score:
+      database_column_name: min_score
+      type: integer
+    max_score:
+      database_column_name: max_score
+      type: integer
+    mastery_score:
+      database_column_name: mastery_score
+      type: integer
+    grading_type:
+      database_column_name: grading_type
+      type: string
+    submission_types:
+      database_column_name: submission_types
+      type: string
+    workflow_state:
+      database_column_name: workflow_state
+      type: string
+    context_id:
+      database_column_name: context_id
+      type: integer
+    context_type:
+      database_column_name: context_type
+      type: string
+    assignment_group_id:
+      database_column_name: assignment_group_id
+      type: integer
+    grading_scheme_id:
+      database_column_name: grading_scheme_id
+      type: integer
+    grading_standard_id:
+      database_column_name: grading_standard_id
+      type: integer

data/lib/canvas_sync/processors/provisioning_report_processor.rb

@@ -1,11 +1,11 @@
-require 'csv'
-require 'activerecord-import'
-require 'zip'
-require 'yaml'
+require "csv"
+require "activerecord-import"
+require "zip"
+require_relative "./report_processor"
 
 module CanvasSync
   module Processors
-    class ProvisioningReportProcessor
+    class ProvisioningReportProcessor < ReportProcessor
       # Processes a provisioning report using the bulk importer.
       #
       # options must contain a models key. If there is only one model
@@ -101,20 +101,6 @@ module CanvasSync
           mapping[:xlist][:conflict_target].to_sym
         )
       end
-
-      def mapping
-        @mapping ||= begin
-          mapping = YAML::load_file(File.join(__dir__, 'model_mappings.yml')).deep_symbolize_keys!
-          override_filepath = Rails.root.join("config/canvas_sync_provisioning_mapping.yml")
-
-          if File.file?(override_filepath)
-            override = YAML::load_file(override_filepath).deep_symbolize_keys!
-            mapping = mapping.merge(override)
-          end
-
-          mapping
-        end
-      end
     end
   end
 end

data/lib/canvas_sync/processors/report_processor.rb

@@ -0,0 +1,22 @@
+require "yaml"
+
+module CanvasSync
+  module Processors
+    # Base report processing class
+    class ReportProcessor
+      def mapping
+        @mapping ||= begin
+          mapping = YAML.load_file(File.join(__dir__, "model_mappings.yml")).deep_symbolize_keys!
+          override_filepath = Rails.root.join("config/canvas_sync_provisioning_mapping.yml")
+
+          if File.file?(override_filepath)
+            override = YAML.load_file(override_filepath).deep_symbolize_keys!
+            mapping = mapping.merge(override)
+          end
+
+          mapping
+        end
+      end
+    end
+  end
+end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = '0.3.11'
+  VERSION = '0.3.12'
 end

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -106,6 +106,21 @@ RSpec.describe CanvasSync do
           })
         end
       end
+
+      context "we are syncing assignments" do
+        it "appends the SyncAssignmentsJob" do
+          chain = CanvasSync.default_provisioning_report_chain(%w[users enrollments assignments])
+
+          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 assignments] } },
+              { job: CanvasSync::Jobs::SyncAssignmentsJob.to_s, options: {} },
+            ],
+            global_options: { legacy_support: false },
+          )
+        end
+      end
     end
   end
 end

data/spec/canvas_sync/jobs/sync_assignments_job_spec.rb

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

data/spec/canvas_sync/models/assignments_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+RSpec.describe Assignment, type: :model do
+  let(:subject) { FactoryGirl.create(:assignment) }
+
+  describe "validations" do
+    it { should validate_presence_of(:canvas_assignment_id) }
+    it { should validate_uniqueness_of(:canvas_assignment_id) }
+  end
+
+  describe "associations" do
+    describe "context" do
+      let!(:other_course) { FactoryGirl.create(:course) }
+      let!(:matching_course) { FactoryGirl.create(:course) }
+
+      before do
+        subject.update_attributes(context_type: "Course", context_id: matching_course.canvas_course_id)
+      end
+
+      it "should belong to courses where the context_type is Course and context_id is the canvas_course_id" do
+        expect(subject.context).to eq(matching_course)
+      end
+    end
+  end
+end

data/spec/canvas_sync/models/course_spec.rb

@@ -26,5 +26,10 @@ RSpec.describe Course, type: :model do
         .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)
+    end
   end
 end

data/spec/canvas_sync/processors/assignments_processor_spec.rb

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

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

@@ -0,0 +1,12 @@
+#
+# 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 Assignment < ApplicationRecord
+  validates :canvas_assignment_id, uniqueness: true, presence: true
+  belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_course_id
+end

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

@@ -11,4 +11,5 @@ class Course < ApplicationRecord
   belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_term_id, optional: true
   has_many :enrollments, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
   has_many :sections, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
+  has_many :assignments, as: :context, primary_key: :canvas_course_id
 end

data/spec/dummy/db/migrate/20180212204530_create_assignments.rb

@@ -0,0 +1,37 @@
+#
+# 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 CreateAssignments < ActiveRecord::Migration[5.1]
+  def change
+    create_table :assignments do |t|
+      t.bigint :canvas_assignment_id, null: false
+      t.string :title
+      t.text :description
+      t.datetime :due_at
+      t.datetime :unlock_at
+      t.datetime :lock_at
+      t.integer :points_possible
+      t.integer :min_score
+      t.integer :max_score
+      t.integer :mastery_score
+      t.string :grading_type
+      t.string :submission_types
+      t.string :workflow_state
+      t.integer :context_id
+      t.string :context_type
+      t.integer :assignment_group_id
+      t.integer :grading_scheme_id
+      t.integer :grading_standard_id
+
+      t.timestamps
+    end
+
+    add_index :assignments, :canvas_assignment_id, unique: true
+    add_index :assignments, [:context_id, :context_type]
+  end
+end