canvas_sync 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 5c8386afbd924c0148b5c2158d23ea7acd5b0b85349da51312103e1ea9368c54
-  data.tar.gz: 051471b40b5a464b66df8ca7ae482874f2791c55604e28f7fe9ce54cb07f875a
+SHA1:
+  metadata.gz: 6dc939cb0559d835965e4b61416fa79f19fdb0a4
+  data.tar.gz: 9e075f746f42ae230ed6219c8e16b00b77526748
 SHA512:
-  metadata.gz: '00742595c4797ba758ef98ab8b034545eb2193a2cae92dfc585e720c7cd9adef663ba0aadcae2c7085e19497ff74461c6d5553d49114f42dac520c8fe48ca448'
-  data.tar.gz: d8c7eb61e630bb65ea9aa2e86b86c03c2c1f87c151e127314c938f7d1b2438c90dfc5f5ddcc4cb74fe0b525bc4ef9c03dfb140d09fc10045b2f7f56b41524e43
+  metadata.gz: c4acb86d39b2aaf09ee9de7ae33d689bc28570babd3086098634fa85e0cca9f8144b22193e3b0d1e21c659e31c807e00899b670d0e52f8549e214b899aae17e2
+  data.tar.gz: a18ac0d166e5e61b24f0a00a0284db3c73ea9bf5ea642f4ac11ccbab0a7b436222d68e4930ed2c3f75d517fe0ef9ebb1bb4752019ea29c988f9ab27e92388f70

data/lib/canvas_sync.rb

@@ -23,6 +23,8 @@ module CanvasSync
   SUPPORTED_MODELS = %w[
     users
     courses
+    groups
+    group_memberships
     accounts
     terms
     enrollments

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

@@ -0,0 +1,18 @@
+# <%= autogenerated_migration_warning %>
+
+class CreateGroupMemberships < ActiveRecord::Migration[5.1]
+  def change
+    create_table :group_memberships do |t|
+      t.bigint :canvas_id, null: false
+      t.bigint :canvas_user_id, null: false
+      t.bigint :canvas_group_id, null: false
+      t.string :group_sis_id
+      t.string :user_sis_id
+      t.string :workflow_state
+
+      t.timestamps
+    end
+
+    add_index :group_memberships, :canvas_id, unique: true
+  end
+end

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

@@ -0,0 +1,23 @@
+# <%= autogenerated_migration_warning %>
+
+class CreateGroups < ActiveRecord::Migration[5.1]
+  def change
+    create_table :groups do |t|
+      t.bigint :canvas_id, null: false
+      t.string :sis_id
+      t.bigint :canvas_group_category_id
+      t.string :group_category_sis_id
+      t.bigint :canvas_account_id
+      t.bigint :canvas_course_id
+      t.string :name
+      t.string :workflow_state
+      t.bigint :context_id
+      t.string :context_type
+      t.integer :max_membership
+
+      t.timestamps
+    end
+
+    add_index :groups, :canvas_id, unique: true
+  end
+end

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

@@ -12,6 +12,7 @@ class Account < ApplicationRecord
                              primary_key: :canvas_id, foreign_key: :canvas_parent_account_id
   has_many :sub_accounts, class_name: 'Account',
                           primary_key: :canvas_id, foreign_key: :canvas_parent_account_id
+  has_many :groups, primary_key: :canvas_id, foreign_key: :canvas_account_id
 
   api_syncable({
     name: :name,

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

@@ -11,6 +11,7 @@ class Course < ApplicationRecord
   has_many :assignments, as: :context, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
   has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_course_id
   has_many :assignment_groups, primary_key: :canvas_id, foreign_key: :canvas_course_id
+  has_many :groups, primary_key: :canvas_id, foreign_key: :canvas_course_id
 
   api_syncable({
     sis_id: :sis_course_id,

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

@@ -0,0 +1,19 @@
+# <%= autogenerated_model_warning %>
+
+class Group < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
+  belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true
+  has_many :group_memberships, primary_key: :canvas_id, foreign_key: :canvas_group_id
+
+  api_syncable({
+    canvas_id: :id,
+    name: :name,
+    canvas_course_id: :course_id,
+    sis_id: :sis_group_id,
+    workflow_state: ->(r){ 'available' },
+  }, -> (api) { api.group(canvas_id) })
+end

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

@@ -0,0 +1,17 @@
+# <%= autogenerated_model_warning %>
+
+class GroupMembership < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :group, primary_key: :canvas_id, foreign_key: :canvas_group_id
+  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id
+
+  api_syncable({
+    canvas_id: :id,
+    canvas_group_id: :group_id,
+    canvas_user_id: :user_id,
+    workflow_state: :workflow_state,
+  }, -> (api) { api.group_membership(canvas_group_id, canvas_id) })
+end

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

@@ -9,6 +9,7 @@ class User < ApplicationRecord
   has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_user_id
   has_many :admin_roles, through: :admins, source: :role
   has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_user_id
+  has_many :group_memberships, primary_key: :canvas_id, foreign_key: :canvas_user_id
 
   api_syncable({
     sis_id: :sis_user_id,

data/lib/canvas_sync/jobs/sync_provisioning_report_job.rb

@@ -49,6 +49,8 @@ module CanvasSync
         }
 
         options[:models].each do |model|
+          # group_membership is the only model param that is singular :(
+          model = 'group_membership' if model == 'group_memberships'
           params[model] = true
         end
 

data/lib/canvas_sync/processors/model_mappings.yml

@@ -326,3 +326,62 @@ context_module_items:
     assignment_id:
       database_column_name: canvas_assignment_id
       type: integer
+
+groups:
+  conflict_target: canvas_group_id
+  report_columns:
+    canvas_group_id:
+      database_column_name: canvas_id
+      type: integer
+    group_id:
+      database_column_name: sis_id
+      type: string
+    canvas_group_category_id:
+      database_column_name: canvas_group_category_id
+      type: integer
+    group_category_id:
+      database_column_name: group_category_sis_id
+      type: integer
+    canvas_account_id:
+      database_column_name: canvas_account_id
+      type: integer
+    canvas_course_id:
+      database_column_name: canvas_course_id
+      type: integer
+    name:
+      database_column_name: name
+      type: string
+    status:
+      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
+    max_membership:
+      database_column_name: max_membership
+      type: integer
+
+group_memberships:
+  conflict_target: canvas_group_membership_id
+  report_columns:
+    canvas_group_membership_id:
+      database_column_name: canvas_id
+      type: integer
+    canvas_group_id:
+      database_column_name: canvas_group_id
+      type: integer
+    group_id:
+      database_column_name: group_sis_id
+      type: string
+    canvas_user_id:
+      database_column_name: canvas_user_id
+      type: integer
+    user_id:
+      database_column_name: user_sis_id
+      type: string
+    status:
+      database_column_name: workflow_state
+      type: string

data/lib/canvas_sync/processors/provisioning_report_processor.rb

@@ -122,6 +122,25 @@ module CanvasSync
           mapping[:xlist][:conflict_target].to_sym,
         )
       end
+
+      def bulk_process_groups(report_file_path)
+        CanvasSync::Importers::BulkImporter.import(
+          report_file_path,
+          mapping[:groups][:report_columns],
+          Group,
+          mapping[:groups][:conflict_target].to_sym,
+        )
+      end
+
+      # Note that group membership is singular because we override the model name param in sync_provisioning_report_job
+      def bulk_process_group_membership(report_file_path)
+        CanvasSync::Importers::BulkImporter.import(
+          report_file_path,
+          mapping[:group_memberships][:report_columns],
+          GroupMembership,
+          mapping[:group_memberships][:conflict_target].to_sym,
+        )
+      end
     end
   end
 end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.13.0".freeze
+  VERSION = "0.14.0".freeze
 end

data/spec/canvas_sync/models/accounts_spec.rb

@@ -8,4 +8,7 @@ RSpec.describe Account, type: :model do
     it { should validate_uniqueness_of(:canvas_id) }
   end
 
+  describe 'associations' do
+    it { should have_many(:groups) }
+  end
 end

data/spec/canvas_sync/models/course_spec.rb

@@ -41,5 +41,9 @@ RSpec.describe Course, type: :model do
     it do
       should have_many(:submissions)
     end
+
+    it do
+      should have_many(:groups)
+    end
   end
 end

data/spec/canvas_sync/models/group_membership_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe GroupMembership, type: :model do
+  let(:subject) {
+    FactoryGirl.create(:group_membership, group: FactoryGirl.create(:group), user: FactoryGirl.create(:user))
+  }
+
+  describe 'validations' do
+    it { should validate_presence_of(:canvas_id) }
+    it { should validate_uniqueness_of(:canvas_id) }
+  end
+
+  describe 'associations' do
+    it do
+      should belong_to(:group)
+        .with_primary_key(:canvas_id)
+        .with_foreign_key(:canvas_group_id)
+    end
+
+    it do
+      should belong_to(:user)
+        .with_primary_key(:canvas_id)
+        .with_foreign_key(:canvas_user_id)
+    end
+  end
+end

data/spec/canvas_sync/models/group_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe Group, type: :model do
+  let(:subject) { FactoryGirl.create(:group) }
+
+  describe 'validations' do
+    it { should validate_presence_of(:canvas_id) }
+    it { should validate_uniqueness_of(:canvas_id) }
+  end
+
+  describe 'associations' do
+    it { should have_many(:group_memberships) }
+
+    it do
+      should belong_to(:course)
+        .with_primary_key(:canvas_id)
+        .with_foreign_key(:canvas_course_id)
+    end
+
+    it do
+      should belong_to(:account)
+        .with_primary_key(:canvas_id)
+        .with_foreign_key(:canvas_account_id)
+    end
+  end
+end

data/spec/canvas_sync/models/user_spec.rb

@@ -9,6 +9,8 @@ RSpec.describe User, type: :model do
   end
 
   describe 'associations' do
+    it { should have_many(:group_memberships) }
+
     it do
       should have_many(:enrollments)
         .with_primary_key(:canvas_id)

data/spec/canvas_sync/processors/provisioning_report_processor_spec.rb

@@ -42,6 +42,26 @@ RSpec.describe CanvasSync::Processors::ProvisioningReportProcessor do
       expect(cross_listed_section.canvas_nonxlist_course_id).to eq 2
     end
 
+    it 'processes groups' do
+      expect {
+        subject.process('spec/support/fixtures/reports/groups.csv', { models: ['groups'] }, 1)
+      }.to change { Group.count }.by(2)
+      group = Group.find_by_name('Group1')
+      expect(group.workflow_state).to eq 'available'
+      expect(group.canvas_account_id).to eq 1
+      expect(group.canvas_id).to eq 50
+    end
+
+    it 'processes group memberships' do
+      expect {
+        subject.process('spec/support/fixtures/reports/group_memberships.csv', { models: ['group_membership'] }, 1)
+      }.to change { GroupMembership.count }.by(2)
+      group = GroupMembership.find_by_canvas_id(50)
+      expect(group.workflow_state).to eq 'accepted'
+      expect(group.canvas_group_id).to eq 1
+      expect(group.canvas_user_id).to eq 10
+    end
+
     context 'options[:models] is multiple models' do
       it 'extracts the ZIP and processes each model' do
         user_count = User.count

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

@@ -18,6 +18,7 @@ class Account < ApplicationRecord
                              primary_key: :canvas_id, foreign_key: :canvas_parent_account_id
   has_many :sub_accounts, class_name: 'Account',
                           primary_key: :canvas_id, foreign_key: :canvas_parent_account_id
+  has_many :groups, primary_key: :canvas_id, foreign_key: :canvas_account_id
 
   api_syncable({
     name: :name,

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

@@ -17,6 +17,7 @@ class Course < ApplicationRecord
   has_many :assignments, as: :context, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
   has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_course_id
   has_many :assignment_groups, primary_key: :canvas_id, foreign_key: :canvas_course_id
+  has_many :groups, primary_key: :canvas_id, foreign_key: :canvas_course_id
 
   api_syncable({
     sis_id: :sis_course_id,

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

@@ -0,0 +1,25 @@
+# #
+# 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 Group < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :course, primary_key: :canvas_id, foreign_key: :canvas_course_id, optional: true
+  belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true
+  has_many :group_memberships, primary_key: :canvas_id, foreign_key: :canvas_group_id
+
+  api_syncable({
+    canvas_id: :id,
+    name: :name,
+    canvas_course_id: :course_id,
+    sis_id: :sis_group_id,
+    workflow_state: ->(r){ 'available' },
+  }, -> (api) { api.group(canvas_id) })
+end

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

@@ -0,0 +1,23 @@
+# #
+# 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 GroupMembership < ApplicationRecord
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :group, primary_key: :canvas_id, foreign_key: :canvas_group_id
+  belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id
+
+  api_syncable({
+    canvas_id: :id,
+    canvas_group_id: :group_id,
+    canvas_user_id: :user_id,
+    workflow_state: :workflow_state,
+  }, -> (api) { api.group_membership(canvas_group_id, canvas_id) })
+end

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

@@ -15,6 +15,7 @@ class User < ApplicationRecord
   has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_user_id
   has_many :admin_roles, through: :admins, source: :role
   has_many :submissions, primary_key: :canvas_id, foreign_key: :canvas_user_id
+  has_many :group_memberships, primary_key: :canvas_id, foreign_key: :canvas_user_id
 
   api_syncable({
     sis_id: :sis_user_id,

data/spec/dummy/db/migrate/20200415171620_create_groups.rb

@@ -0,0 +1,29 @@
+# #
+# 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 CreateGroups < ActiveRecord::Migration[5.1]
+  def change
+    create_table :groups do |t|
+      t.bigint :canvas_id, null: false
+      t.string :sis_id
+      t.bigint :canvas_group_category_id
+      t.string :group_category_sis_id
+      t.bigint :canvas_account_id
+      t.bigint :canvas_course_id
+      t.string :name
+      t.string :workflow_state
+      t.bigint :context_id
+      t.string :context_type
+      t.integer :max_membership
+
+      t.timestamps
+    end
+
+    add_index :groups, :canvas_id, unique: true
+  end
+end