canvas_sync 0.10.6 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 85296cf62f289592ac9f7a9eae904ab8f4f95fa4e721c0746fb12b47e8f3679c
-  data.tar.gz: 4e766399a5b695d589584454e4a0697480131bde11599887b13371d10b03c09d
+SHA1:
+  metadata.gz: 4445382aaee8091e3d40bc0f836bfeaef14d99d1
+  data.tar.gz: fa0ff09fd9f2132ab29fb80a95c1353e38f2bbd8
 SHA512:
-  metadata.gz: 543d433fcf85fcae47fa4937c796d7efe59954e39d38c9bdae63e03e4c0bfef1613483c4d2e2994fd3e481c9da1b7f5ea3e7ab8719f43103d74a4caa128baa41
-  data.tar.gz: bbab77a8e574656e3030e643460694e60147f740095d6d37630d5ae6770c2eb60d0502e2a83db7cfce253035804084662e2255dd5154ed4c595c6589310e13b2
+  metadata.gz: 3acfbb161a7c11a8d2b6c093b52b55ef5b0bf82876ff0a8e28b0092753d56ea2b28f6fa65360bb4889f5145361897e45e813acd000e45b84f9e6e9b27ab538fa
+  data.tar.gz: be69604343fe4458a9e5cac5d26a8e307b909e3a2e2693d6aa9bdab38c5e3271cc73dab72f8d98959a92b0ef7b515d634c7f62701d61b9681e4f40b6abb17857

data/lib/canvas_sync.rb

@@ -138,6 +138,16 @@ module CanvasSync
       sub_items
     end
 
+    # Given a Model or Relation, scope it down to items that should be synced
+    def sync_scope(scope)
+      terms = %i[should_canvas_sync active_for_canvas_sync should_sync active_for_sync active]
+      terms.each do |t|
+        return scope.send(t) if scope.respond_to?(t)
+      end
+      Rails.logger.warn("Could not filter Syncable Scope for model '#{scope.try(:model)&.name || scope.name}'")
+      scope
+    end
+
     # Syn any report to an specific set of models
     #
     # @param reports_mapping [Array<Hash>] List of reports with their specific model and params

data/lib/canvas_sync/api_syncable.rb

@@ -21,6 +21,14 @@ module CanvasSync::ApiSyncable
       inst
     end
 
+    def create_or_update_from_api_params(api_params)
+      api_params = api_params.with_indifferent_access
+      inst = find_or_initialize_by(canvas_id: api_params[:id])
+      inst.update_from_api_params(api_params)
+      inst.save! if inst.changed?
+      inst
+    end
+
     def api_sync_options=(opts)
       @api_sync_options = opts
     end

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

@@ -5,13 +5,16 @@ class CreateAdmins < ActiveRecord::Migration[5.1]
     create_table :admins do |t|
       t.bigint :canvas_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.bigint :canvas_account_id
+      t.bigint :canvas_role_id
+      t.bigint :canvas_user_id
+      t.string :workflow_state
 
       t.timestamps
     end
     add_index :admins, :canvas_id, unique: true
+    add_index :admins, :canvas_role_id
+    add_index :admins, :canvas_user_id
+    add_index :admins, :canvas_account_id
   end
 end

data/lib/canvas_sync/generators/templates/migrations/create_roles.rb

@@ -4,11 +4,10 @@ class CreateRoles < ActiveRecord::Migration[5.1]
   def change
     create_table :roles do |t|
       t.integer :canvas_id, null: false
-      t.string :label, null: false
-      t.string :base_role_type, null: false
-      t.json :account
+      t.string :label
+      t.string :base_role_type
       t.integer :canvas_account_id
-      t.string :workflow_state, null: false
+      t.string :workflow_state
       t.json :permissions
 
       t.timestamps

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

@@ -5,6 +5,8 @@ class Account < ApplicationRecord
 
   validates :canvas_id, uniqueness: true, presence: true
 
+  has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_account_id
+
   api_syncable({
     name: :name,
     workflow_state: :workflow_state,

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

@@ -4,6 +4,7 @@ class Admin < ApplicationRecord
   include CanvasSync::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
   belongs_to :role, primary_key: :canvas_id, foreign_key: :canvas_role_id, optional: true
 
@@ -11,16 +12,14 @@ class Admin < ApplicationRecord
     canvas_id: :id,
     role_name: :role,
     canvas_role_id: :role_id,
-    user_data: :user,
     canvas_user_id: ->(r) { r['user']['id'] },
+    # NOTICE: The :account_id field is added by CanvasSync - it is not included in the Canvas API response
+    canvas_account_id: :account_id,
     workflow_state: :workflow_state,
   }, -> (api) {
-    admins = api.account_admins('self').all_pages!
+    admins = api.account_admins(canvas_account_id).all_pages!
     admin_data = admins.find{|admin| admin['id'] == canvas_id }
     raise Footrest::HttpError::NotFound unless admin_data.present?
     admin_data
   })
-
-  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
-
 end

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

@@ -10,12 +10,8 @@ class Role < ApplicationRecord
     canvas_id: :id,
     label: :label,
     base_role_type: :base_role_type,
-    account: :account,
     canvas_account_id: ->(r) { r.dig('account', 'id') },
     permissions: :permissions,
     workflow_state: :workflow_state,
   }, -> (api) { api.get("/api/v1/accounts/#{canvas_account_id}/roles/#{canvas_id}") })
-
-  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
-
 end

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

@@ -21,8 +21,6 @@ class Term < ApplicationRecord
     term_data
   })
 
-  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
-
   # This is a sample scope created by the CanvasSync gem; feel
   # free to customize it for your tool's requirements.
   scope :active, -> {

data/lib/canvas_sync/job.rb

@@ -56,5 +56,15 @@ module CanvasSync
         status: JobLog::ENQUEUED_STATUS,
       )
     end
+
+    def update_or_create_model(model, params)
+      if model.respond_to? :create_or_update
+        model.create_or_update(params)
+      elsif model.method_defined? :update_from_api_params!
+        model.find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params)
+      else
+        raise "Could not create/update #{model.name}. It must have a create_or_update(params) ClassMethod or implement ApiSyncable."
+      end
+    end
   end
 end

data/lib/canvas_sync/jobs/sync_admins_job.rb

@@ -7,12 +7,16 @@ module CanvasSync
       # @param job_chain [Hash]
       # @param options [Hash]
       def perform(job_chain, _options)
-        updated_admins = []
-        CanvasSync.get_canvas_sync_client(job_chain[:global_options]).account_admins("self").all_pages!.each do |admin_params|
-          admin = Admin.create_or_update(admin_params)
-          updated_admins.push(admin.id)
+        updated_admin_ids = []
+        api_client = CanvasSync.get_canvas_sync_client(job_chain[:global_options])
+        CanvasSync.sync_scope(Account).find_each do |acc|
+          api_client.account_admins(acc.canvas_id).all_pages_each do |admin_params|
+            admin_params[:account_id] = acc.canvas_id
+            admin = update_or_create_model(Admin, admin_params)
+            updated_admin_ids.push(admin.id)
+          end
         end
-        Admin.where.not(id: updated_admins).delete_all
+        Admin.where.not(id: updated_admin_ids).update_all(workflow_state: 'inactive')
         CanvasSync.invoke_next(job_chain)
       end
     end

data/lib/canvas_sync/jobs/sync_roles_job.rb

@@ -7,12 +7,15 @@ module CanvasSync
       # @param job_chain [Hash]
       # @param options [Hash]
       def perform(job_chain, _options)
-        updated_roles = []
-        CanvasSync.get_canvas_sync_client(job_chain[:global_options]).list_roles("self").all_pages!.each do |role_params|
-          role = Role.create_or_update(role_params)
-          updated_roles.push(role.id)
+        updated_role_ids = []
+        api_client = CanvasSync.get_canvas_sync_client(job_chain[:global_options])
+        CanvasSync.sync_scope(Account).find_each do |acc|
+          api_client.list_roles(acc.canvas_id, state: %w[active inactive]).all_pages_each do |role_params|
+            role = update_or_create_model(Role, role_params)
+            updated_role_ids.push(role.id)
+          end
         end
-        Role.where.not(id: updated_roles).delete_all
+        Role.where.not(id: updated_role_ids).update_all(workflow_state: 'inactive')
         CanvasSync.invoke_next(job_chain)
       end
     end

data/lib/canvas_sync/jobs/sync_terms_job.rb

@@ -10,9 +10,15 @@ module CanvasSync
       def perform(job_chain, _options)
         CanvasSync.get_canvas_sync_client(job_chain[:global_options]).terms("self").all_pages!.each do |term_params|
           if job_chain[:global_options][:account_id]
-            Term.create_or_update(term_params, job_chain[:global_options][:account_id])
+            # These branches are primarily to support Legacy apps
+            if Term.respond_to?(:create_or_update) && Term.method(:create_or_update).arity.abs == 2
+              Term.create_or_update(term_params, job_chain[:global_options][:account_id])
+            else
+              term_params[:account_id] |= job_chain[:global_options][:account_id]
+              update_or_create_model(Term, term_params)
+            end
           else
-            Term.create_or_update(term_params)
+            update_or_create_model(Term, term_params)
           end
         end
 

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.10.6".freeze
+  VERSION = "0.11.0".freeze
 end

data/spec/canvas_sync/jobs/sync_admins_job_spec.rb

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 RSpec.describe CanvasSync::Jobs::SyncAdminsJob do
   describe '#perform' do
+    let!(:account) { FactoryGirl.create(:account, canvas_id: 1) }
     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
+    it 'retrieves all admins from the Canvas API and then invokes the next job' do
       expect(CanvasSync).to receive(:invoke_next).with(job_chain)
 
       expect {

data/spec/canvas_sync/jobs/sync_roles_job_spec.rb

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 RSpec.describe CanvasSync::Jobs::SyncRolesJob do
   describe '#perform' do
+    let!(:account) { FactoryGirl.create(:account, canvas_id: 1) }
     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
+    it 'retrieves all roles from the Canvas API and then invokes the next job' do
       expect(CanvasSync).to receive(:invoke_next).with(job_chain)
 
       expect {

data/spec/canvas_sync/models/admins_spec.rb

@@ -8,19 +8,18 @@ RSpec.describe Admin, type: :model do
     it { should validate_uniqueness_of(:canvas_id) }
   end
 
-  describe '.create_or_update' do
+  describe '.create_or_update_from_api_params' 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)
+          Admin.create_or_update_from_api_params(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
@@ -31,13 +30,12 @@ RSpec.describe Admin, type: :model do
 
       it 'updates it' do
         expect {
-          Admin.create_or_update(admin_params)
+          Admin.create_or_update_from_api_params(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

data/spec/canvas_sync/models/roles_spec.rb

@@ -8,19 +8,19 @@ RSpec.describe Role, type: :model do
     it { should validate_uniqueness_of(:canvas_id) }
   end
 
-  describe '.create_or_update' do
+  describe '.create_or_update_from_api_params' 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)
+          Role.create_or_update_from_api_params(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.canvas_account_id).to eq(role_params['account']['id'])
         expect(role.permissions).to eq(role_params['permissions'])
         expect(role.workflow_state).to eq(role_params['workflow_state'])
       end
@@ -31,13 +31,13 @@ RSpec.describe Role, type: :model do
 
       it 'updates it' do
         expect {
-          Role.create_or_update(role_params)
+          Role.create_or_update_from_api_params(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.canvas_account_id).to eq(role_params['account']['id'])
         expect(existing_role.permissions).to eq(role_params['permissions'])
         expect(existing_role.workflow_state).to eq(role_params['workflow_state'])
       end

data/spec/canvas_sync/models/term_spec.rb

@@ -29,13 +29,13 @@ RSpec.describe Term, type: :model do
     end
   end
 
-  describe '.create_or_update' do
+  describe '.create_or_update_from_api_params' do
     let(:term_params) { open_canvas_fixture('terms')['enrollment_terms'][0] }
 
     context 'the term does not already exist' do
       it 'creates it' do
         expect {
-          Term.create_or_update(term_params)
+          Term.create_or_update_from_api_params(term_params)
         }.to change { Term.count }.by(1)
 
         term = Term.last
@@ -54,7 +54,7 @@ RSpec.describe Term, type: :model do
 
       it 'updates it' do
         expect {
-          Term.create_or_update(term_params)
+          Term.create_or_update_from_api_params(term_params)
         }.to_not change { Term.count }
 
         existing_term.reload

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

@@ -11,6 +11,8 @@ class Account < ApplicationRecord
 
   validates :canvas_id, uniqueness: true, presence: true
 
+  has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_account_id
+
   api_syncable({
     name: :name,
     workflow_state: :workflow_state,

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

@@ -10,6 +10,7 @@ class Admin < ApplicationRecord
   include CanvasSync::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true
   belongs_to :role, primary_key: :canvas_id, foreign_key: :canvas_role_id, optional: true
 
@@ -17,16 +18,14 @@ class Admin < ApplicationRecord
     canvas_id: :id,
     role_name: :role,
     canvas_role_id: :role_id,
-    user_data: :user,
     canvas_user_id: ->(r) { r['user']['id'] },
+    # NOTICE: The :account_id field is added by CanvasSync - it is not included in the Canvas API response
+    canvas_account_id: :account_id,
     workflow_state: :workflow_state,
   }, -> (api) {
-    admins = api.account_admins('self').all_pages!
+    admins = api.account_admins(canvas_account_id).all_pages!
     admin_data = admins.find{|admin| admin['id'] == canvas_id }
     raise Footrest::HttpError::NotFound unless admin_data.present?
     admin_data
   })
-
-  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
-
 end

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

@@ -16,12 +16,8 @@ class Role < ApplicationRecord
     canvas_id: :id,
     label: :label,
     base_role_type: :base_role_type,
-    account: :account,
     canvas_account_id: ->(r) { r.dig('account', 'id') },
     permissions: :permissions,
     workflow_state: :workflow_state,
   }, -> (api) { api.get("/api/v1/accounts/#{canvas_account_id}/roles/#{canvas_id}") })
-
-  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
-
 end

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

@@ -27,8 +27,6 @@ class Term < ApplicationRecord
     term_data
   })
 
-  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
-
   # This is a sample scope created by the CanvasSync gem; feel
   # free to customize it for your tool's requirements.
   scope :active, -> {

data/spec/dummy/db/migrate/{20190702203628_create_roles.rb → 20190927204545_create_roles.rb}

@@ -10,11 +10,10 @@ class CreateRoles < ActiveRecord::Migration[5.1]
   def change
     create_table :roles do |t|
       t.integer :canvas_id, null: false
-      t.string :label, null: false
-      t.string :base_role_type, null: false
-      t.json :account
+      t.string :label
+      t.string :base_role_type
       t.integer :canvas_account_id
-      t.string :workflow_state, null: false
+      t.string :workflow_state
       t.json :permissions
 
       t.timestamps

data/spec/dummy/db/migrate/{20190702203629_create_admins.rb → 20190927204546_create_admins.rb}

@@ -11,13 +11,16 @@ class CreateAdmins < ActiveRecord::Migration[5.1]
     create_table :admins do |t|
       t.bigint :canvas_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.bigint :canvas_account_id
+      t.bigint :canvas_role_id
+      t.bigint :canvas_user_id
+      t.string :workflow_state
 
       t.timestamps
     end
     add_index :admins, :canvas_id, unique: true
+    add_index :admins, :canvas_role_id
+    add_index :admins, :canvas_user_id
+    add_index :admins, :canvas_account_id
   end
 end