canvas_sync 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54bb6b7603e9eb4a7f2fbc7d88fa6354c2cd52bc23a840ba78c6400d963566c7
-  data.tar.gz: 1028c665074ab1bea726ca6e9f5e33540678b6779b8246588339130a96be1584
+  metadata.gz: 909d10005caebf8b944e5a2974c3ce652b6258d7cf09fe20927a56a5075e3ed8
+  data.tar.gz: b529e9db0073aecedfdc66d254b3671fac73385cf29f2e9eee3e1c975afffa58
 SHA512:
-  metadata.gz: 1d70812e869e445f11c21339dfb82df08cf01c68ff807009871bfe1604c2608bde446578202a7b01f92f1faea9b01f85bed0cca1f60eae856530edbecbe86eb2
-  data.tar.gz: da8887bdf95dc211ee9f8e32c2dd1751476c464526efc9e69f6eba5c93d73c9796442312c6b3d04c074315114211cc1fc8da5557d8fa677829867efb53423843
+  metadata.gz: 0f9a6dc8f671dae6cfbeb5bc274e8656393a4c22e3dd462e4a6c778e5262f592a47c6d09c0117f0edfd7f70b7cd2cf808f813451861527e9236df745b1290186
+  data.tar.gz: 51eb712ce9a987295d99711e507b25112f31adaadf6cbc4932978f697786fbe4f92f59e2ce9ebd2414d4efb9f8e979c9c5fde5c0267c12d632e448dc6fe8b5b3

data/lib/canvas_sync.rb

@@ -10,19 +10,20 @@ require "canvas_sync/jobs/sync_provisioning_report_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 }
 
 module CanvasSync
-  SUPPORTED_MODELS = %w(users courses terms enrollments sections roles)
+  SUPPORTED_MODELS = %w(users courses terms enrollments sections roles admins)
   SUPPORTED_LIVE_EVENTS = %w(course enrollment submission assignment user syllabus grade)
 
   # 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
-  # and have also specified a Term scope, Users/Roles will by synced first, before
-  # every other model (as Users/Roles are never scoped to Term).
+  # Terms will be synced first using the API. If you are syncing users/roles/admins
+  # and have also specified a Term scope, Users/Roles/Admins will by synced first, before
+  # every other model (as Users/Roles/Admins are never scoped to Term).
   #
   # @param models [Array<String>] A list of models to sync. e.g., ['users', 'courses'].
   #   must be one of SUPPORTED_MODELS
@@ -65,7 +66,7 @@ module CanvasSync
     next_job_class.perform_later(duped_job_chain, next_job[:options])
   end
 
-  # Syncs terms, users/roles if necessary, then the rest of the specified models.
+  # Syncs terms, users/roles/admins if necessary, then the rest of the specified models.
   #
   # @param models [Array<String>]
   # @param term_scope [String]
@@ -94,6 +95,12 @@ module CanvasSync
       models = models - ['roles']
     end
 
+    if models.include?('admins')
+      # Sync all admins first when scoping by term, because admins cannot be scoped to term
+      jobs.push({ job: CanvasSync::Jobs::SyncAdminsJob.to_s, options: {} })
+      models = models - ['admins']
+    end
+
     jobs.push({ job: CanvasSync::Jobs::SyncProvisioningReportJob.to_s, options: { term_scope: term_scope, models: models } })
 
     global_options = { legacy_support: legacy_support }

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

@@ -0,0 +1,20 @@
+<%= autogenerated_model_warning %>
+
+class Admin < ApplicationRecord
+  validates :canvas_admin_id, uniqueness: true, presence: true
+  belongs_to :user, primary_key: :canvas_user_id, foreign_key: :canvas_user_id, optional: true
+  belongs_to :role, primary_key: :canvas_role_id, foreign_key: :canvas_role_id, optional: true
+
+  def self.create_or_update(admin_params)
+    admin = Admin.find_or_initialize_by(canvas_admin_id: admin_params['id'])
+
+    admin.assign_attributes(role_name: admin_params['role'],
+                            canvas_role_id: admin_params['role_id'],
+                            user_data: admin_params['user'],
+                            canvas_user_id: admin_params['user']['id'],
+                            workflow_state: admin_params['workflow_state'])
+
+    admin.save! if admin.changed?
+    admin
+  end
+end

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

@@ -0,0 +1,17 @@
+<%= autogenerated_migration_warning %>
+
+class CreateAdmins < ActiveRecord::Migration[5.1]
+  def change
+    create_table :admins do |t|
+      t.bigint :canvas_admin_id, null: false
+      t.string :role_name
+      t.bigint :canvas_role_id, null: false
+      t.json :user_data
+      t.bigint :canvas_user_id, null: false
+      t.string :workflow_state, null: false
+
+      t.timestamps
+    end
+    add_index :admins, :canvas_admin_id, unique: true
+  end
+end

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

@@ -2,6 +2,7 @@
 
 class Role < ApplicationRecord
   validates :canvas_role_id, uniqueness: true, presence: true
+  has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_role_id
 
   def self.create_or_update(role_params)
     role = Role.find_or_initialize_by(canvas_role_id: role_params['id'])

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

@@ -3,4 +3,6 @@
 class User < ApplicationRecord
   validates :canvas_user_id, uniqueness: true, presence: true
   has_many :enrollments, primary_key: :canvas_user_id, foreign_key: :canvas_user_id
+  has_many :admins, foreign_key: :canvas_user_id, primary_key: :canvas_user_id
+  has_many :admin_roles, through: :admins, source: :role
 end

data/lib/canvas_sync/jobs/sync_admins_job.rb

@@ -0,0 +1,18 @@
+module CanvasSync
+  module Jobs
+    class SyncAdminsJob < CanvasSync::Job
+      # Syncs Admins 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]).account_admins('self').all_pages!.each do |admin_params|
+          Admin.create_or_update(admin_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.6'
+  VERSION = '0.3.7'
 end

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -78,6 +78,34 @@ RSpec.describe CanvasSync do
           })
         end
       end
+
+      context 'we are syncing admins with a term scope' do
+        it 'syncs the admins in a separate job that runs first' do
+          chain = CanvasSync.default_provisioning_report_chain(['admins', 'courses'], :active)
+          expect(chain).to eq({
+            jobs: [
+              { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
+              { job: CanvasSync::Jobs::SyncAdminsJob.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 admins without a term scope' do
+        it 'syncs admins separately even with no term scope' do
+          chain = CanvasSync.default_provisioning_report_chain(['admins', 'courses'])
+          expect(chain).to eq({
+            jobs: [
+              { job: CanvasSync::Jobs::SyncTermsJob.to_s, options: {} },
+              { job: CanvasSync::Jobs::SyncAdminsJob.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_admins_job_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+RSpec.describe CanvasSync::Jobs::SyncAdminsJob do
+  describe '#perform' do
+    let(:admin_params) { open_canvas_fixture('admins') }
+    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::SyncAdminsJob.perform_now(job_chain, {})
+      }.to change { Admin.count }.by(admin_params.length)
+    end
+  end
+end

data/spec/canvas_sync/models/admins_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe Admin, type: :model do
+  let(:subject) { FactoryGirl.create(:admin) }
+
+  describe 'validations' do
+    it { should validate_presence_of(:canvas_admin_id) }
+    it { should validate_uniqueness_of(:canvas_admin_id) }
+  end
+
+  describe '.create_or_update' do
+    let(:admin_params) { open_canvas_fixture('admins')[0] }
+
+    context 'the admin does not already exist' do
+      it 'creates it' do
+        expect {
+          Admin.create_or_update(admin_params)
+        }.to change { Admin.count }.by(1)
+
+        admin = Admin.last
+        expect(admin.role_name).to eq(admin_params['role'])
+        expect(admin.canvas_role_id).to eq(admin_params['role_id'])
+        expect(admin.user_data).to eq(admin_params['user'])
+        expect(admin.canvas_user_id).to eq(admin_params['user']['id'])
+        expect(admin.workflow_state).to eq(admin_params['workflow_state'])
+      end
+    end
+
+    context 'the admin already exists' do
+      let!(:existing_admin) { FactoryGirl.create(:admin, canvas_admin_id: admin_params['id']) }
+
+      it 'updates it' do
+        expect {
+          Admin.create_or_update(admin_params)
+        }.to_not change { Admin.count }
+
+        existing_admin.reload
+        expect(existing_admin.role_name).to eq(admin_params['role'])
+        expect(existing_admin.canvas_role_id).to eq(admin_params['role_id'])
+        expect(existing_admin.user_data).to eq(admin_params['user'])
+        expect(existing_admin.canvas_user_id).to eq(admin_params['user']['id'])
+        expect(existing_admin.workflow_state).to eq(admin_params['workflow_state'])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+#
+# 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 Admin < ApplicationRecord
+  validates :canvas_admin_id, uniqueness: true, presence: true
+  belongs_to :user, primary_key: :canvas_user_id, foreign_key: :canvas_user_id, optional: true
+  belongs_to :role, primary_key: :canvas_role_id, foreign_key: :canvas_role_id, optional: true
+
+  def self.create_or_update(admin_params)
+    admin = Admin.find_or_initialize_by(canvas_admin_id: admin_params['id'])
+
+    admin.assign_attributes(role_name: admin_params['role'],
+                            canvas_role_id: admin_params['role_id'],
+                            user_data: admin_params['user'],
+                            canvas_user_id: admin_params['user']['id'],
+                            workflow_state: admin_params['workflow_state'])
+
+    admin.save! if admin.changed?
+    admin
+  end
+end

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

@@ -8,6 +8,7 @@
 
 class Role < ApplicationRecord
   validates :canvas_role_id, uniqueness: true, presence: true
+  has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_role_id
 
   def self.create_or_update(role_params)
     role = Role.find_or_initialize_by(canvas_role_id: role_params['id'])

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

@@ -9,4 +9,6 @@
 class User < ApplicationRecord
   validates :canvas_user_id, uniqueness: true, presence: true
   has_many :enrollments, primary_key: :canvas_user_id, foreign_key: :canvas_user_id
+  has_many :admins, foreign_key: :canvas_user_id, primary_key: :canvas_user_id
+  has_many :admin_roles, through: :admins, source: :role
 end

data/spec/dummy/db/migrate/20180109210452_create_admins.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 CreateAdmins < ActiveRecord::Migration[5.1]
+  def change
+    create_table :admins do |t|
+      t.bigint :canvas_admin_id, null: false
+      t.string :role_name
+      t.bigint :canvas_role_id, null: false
+      t.json :user_data
+      t.bigint :canvas_user_id, null: false
+      t.string :workflow_state, null: false
+
+      t.timestamps
+    end
+    add_index :admins, :canvas_admin_id, unique: true
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,11 +10,23 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20180103162102) do
+ActiveRecord::Schema.define(version: 20180109210452) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
+  create_table "admins", force: :cascade do |t|
+    t.bigint "canvas_admin_id", null: false
+    t.string "role_name"
+    t.bigint "canvas_role_id", null: false
+    t.json "user_data"
+    t.bigint "canvas_user_id", null: false
+    t.string "workflow_state", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["canvas_admin_id"], name: "index_admins_on_canvas_admin_id", unique: true
+  end
+
   create_table "canvas_sync_job_logs", force: :cascade do |t|
     t.datetime "started_at"
     t.datetime "completed_at"

data/spec/factories/admin_factory.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+  factory :admin do
+    canvas_admin_id { SecureRandom.random_number(100_000_000) }
+    role_name 'Cool Role'
+    canvas_role_id { SecureRandom.random_number(100_000_000) }
+    user_data { "{ 'id': 1}" }
+    canvas_user_id 1
+    workflow_state 'active'
+  end
+end

data/spec/support/fake_canvas.rb

@@ -12,6 +12,10 @@ class FakeCanvas < Sinatra::Base
     json_response 200, 'roles.json'
   end
 
+  get '/api/v1/accounts/self/admins' do
+    json_response 200, 'admins.json'
+  end
+
   get '/sample_report_download' do
     json_response 200, 'terms.json'
   end

data/spec/support/fixtures/canvas_responses/admins.json

@@ -0,0 +1,50 @@
+[
+{
+"id": 2,
+"role": "AccountAdmin",
+"role_id": 1,
+"user": {
+"id": 1,
+"name": "mvalentine@instructure.com",
+"sortable_name": "mvalentine@instructure.com",
+"short_name": "mvalentine@instructure.com",
+"sis_user_id": null,
+"integration_id": null,
+"sis_import_id": null,
+"login_id": "mvalentine@instructure.com"
+},
+"workflow_state": "active"
+},
+{
+"id": 3,
+"role": "Custom Account Role",
+"role_id": 11,
+"user": {
+"id": 11,
+"name": "Test Account User",
+"sortable_name": "User, Test Account",
+"short_name": "Test Account User",
+"sis_user_id": null,
+"integration_id": null,
+"sis_import_id": null,
+"login_id": "testaccountuser@example.com"
+},
+"workflow_state": "active"
+},
+{
+"id": 4,
+"role": "Test",
+"role_id": 10,
+"user": {
+"id": 11,
+"name": "Test Account User",
+"sortable_name": "User, Test Account",
+"short_name": "Test Account User",
+"sis_user_id": null,
+"integration_id": null,
+"sis_import_id": null,
+"login_id": "testaccountuser@example.com"
+},
+"workflow_state": "active"
+}
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Nate Collings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -293,7 +293,9 @@ files:
 - lib/canvas_sync/engine.rb
 - lib/canvas_sync/generators/install_generator.rb
 - lib/canvas_sync/generators/install_live_events_generator.rb
+- lib/canvas_sync/generators/templates/models/admin.rb
 - lib/canvas_sync/generators/templates/models/course.rb
+- lib/canvas_sync/generators/templates/models/create_admins.rb
 - lib/canvas_sync/generators/templates/models/create_courses.rb
 - lib/canvas_sync/generators/templates/models/create_enrollments.rb
 - lib/canvas_sync/generators/templates/models/create_roles.rb
@@ -331,6 +333,7 @@ files:
 - lib/canvas_sync/jobs/report_checker.rb
 - lib/canvas_sync/jobs/report_processor_job.rb
 - lib/canvas_sync/jobs/report_starter.rb
+- lib/canvas_sync/jobs/sync_admins_job.rb
 - lib/canvas_sync/jobs/sync_provisioning_report_job.rb
 - lib/canvas_sync/jobs/sync_roles_job.rb
 - lib/canvas_sync/jobs/sync_terms_job.rb
@@ -343,10 +346,12 @@ files:
 - spec/canvas_sync/jobs/report_checker_spec.rb
 - spec/canvas_sync/jobs/report_processor_job_spec.rb
 - spec/canvas_sync/jobs/report_starter_spec.rb
+- spec/canvas_sync/jobs/sync_admins_job_spec.rb
 - spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb
 - spec/canvas_sync/jobs/sync_roles_job_spec.rb
 - spec/canvas_sync/jobs/sync_terms_job_spec.rb
 - spec/canvas_sync/jobs/sync_users_job_spec.rb
+- spec/canvas_sync/models/admins_spec.rb
 - spec/canvas_sync/models/course_spec.rb
 - spec/canvas_sync/models/enrollment_spec.rb
 - spec/canvas_sync/models/roles_spec.rb
@@ -356,6 +361,7 @@ files:
 - spec/canvas_sync/processors/provisioning_report_processor_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
+- spec/dummy/app/models/admin.rb
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/course.rb
 - spec/dummy/app/models/enrollment.rb
@@ -383,10 +389,12 @@ files:
 - spec/dummy/db/migrate/20170918221413_create_users.rb
 - spec/dummy/db/migrate/20171107213207_create_sections.rb
 - spec/dummy/db/migrate/20180103162102_create_roles.rb
+- spec/dummy/db/migrate/20180109210452_create_admins.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
 - spec/dummy/log/development.log
 - spec/dummy/log/test.log
+- spec/factories/admin_factory.rb
 - spec/factories/course_factory.rb
 - spec/factories/enrollment_factory.rb
 - spec/factories/role_factory.rb
@@ -395,6 +403,7 @@ files:
 - spec/factories/user_factory.rb
 - spec/spec_helper.rb
 - spec/support/fake_canvas.rb
+- spec/support/fixtures/canvas_responses/admins.json
 - spec/support/fixtures/canvas_responses/roles.json
 - spec/support/fixtures/canvas_responses/terms.json
 - spec/support/fixtures/reports/courses.csv
@@ -434,10 +443,12 @@ test_files:
 - spec/canvas_sync/jobs/report_checker_spec.rb
 - spec/canvas_sync/jobs/report_processor_job_spec.rb
 - spec/canvas_sync/jobs/report_starter_spec.rb
+- spec/canvas_sync/jobs/sync_admins_job_spec.rb
 - spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb
 - spec/canvas_sync/jobs/sync_roles_job_spec.rb
 - spec/canvas_sync/jobs/sync_terms_job_spec.rb
 - spec/canvas_sync/jobs/sync_users_job_spec.rb
+- spec/canvas_sync/models/admins_spec.rb
 - spec/canvas_sync/models/course_spec.rb
 - spec/canvas_sync/models/enrollment_spec.rb
 - spec/canvas_sync/models/roles_spec.rb
@@ -447,6 +458,7 @@ test_files:
 - spec/canvas_sync/processors/provisioning_report_processor_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
+- spec/dummy/app/models/admin.rb
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/course.rb
 - spec/dummy/app/models/enrollment.rb
@@ -474,10 +486,12 @@ test_files:
 - spec/dummy/db/migrate/20170918221413_create_users.rb
 - spec/dummy/db/migrate/20171107213207_create_sections.rb
 - spec/dummy/db/migrate/20180103162102_create_roles.rb
+- spec/dummy/db/migrate/20180109210452_create_admins.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
 - spec/dummy/log/development.log
 - spec/dummy/log/test.log
+- spec/factories/admin_factory.rb
 - spec/factories/course_factory.rb
 - spec/factories/enrollment_factory.rb
 - spec/factories/role_factory.rb
@@ -486,6 +500,7 @@ test_files:
 - spec/factories/user_factory.rb
 - spec/spec_helper.rb
 - spec/support/fake_canvas.rb
+- spec/support/fixtures/canvas_responses/admins.json
 - spec/support/fixtures/canvas_responses/roles.json
 - spec/support/fixtures/canvas_responses/terms.json
 - spec/support/fixtures/reports/courses.csv