canvas_sync 0.12.0 → 0.16.1

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

@@ -7,11 +7,18 @@
 
 
 class Account < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
+  # include CanvasSync::Concerns::Account::Ancestry # Add support for the ancestry Gem
 
   validates :canvas_id, uniqueness: true, presence: true
 
   has_many :admins, primary_key: :canvas_id, foreign_key: :canvas_account_id
+  belongs_to :canvas_parent, class_name: 'Account', optional: true,
+                             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/admin.rb

@@ -7,7 +7,8 @@
 
 
 class Admin < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :account, primary_key: :canvas_id, foreign_key: :canvas_account_id, optional: true

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

@@ -7,7 +7,8 @@
 
 
 class Assignment < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type

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

@@ -7,7 +7,8 @@
 
 
 class AssignmentGroup < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  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

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

@@ -10,7 +10,8 @@
 #   1 - Module is a reserved word in Rails and you can't call a model a Module
 #   2 - Canvas calls them ContextModules
 class ContextModule < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_context_id, foreign_type: :canvas_context_type
   has_many :context_module_items, primary_key: :canvas_id, foreign_key: :canvas_context_module_id

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

@@ -7,7 +7,8 @@
 
 
 class ContextModuleItem < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   belongs_to :context_module, primary_key: :canvas_id, foreign_key: :canvas_context_module_id, optional: true
   belongs_to :content, polymorphic: true, optional: true, primary_key: :canvas_id, foreign_key: :canvas_content_id, foreign_type: :canvas_content_type

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

@@ -7,7 +7,8 @@
 
 
 class Course < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_id, optional: true
@@ -16,7 +17,8 @@ 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,
     course_code: :course_code,

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

@@ -7,7 +7,8 @@
 
 
 class Enrollment < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :user, primary_key: :canvas_id, foreign_key: :canvas_user_id, optional: true

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/role.rb

@@ -7,7 +7,8 @@
 
 
 class Role < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_id

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

@@ -7,7 +7,8 @@
 
 
 class Section < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  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

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

@@ -7,7 +7,8 @@
 
 
 class Submission < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   belongs_to :assignment, primary_key: :canvas_id, foreign_key: :canvas_assignment_id, optional: true

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

@@ -7,7 +7,8 @@
 
 
 class Term < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   has_many :courses, foreign_key: :canvas_term_id, primary_key: :canvas_id

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

@@ -7,13 +7,15 @@
 
 
 class User < ApplicationRecord
-  include CanvasSync::ApiSyncable
+  include CanvasSync::Record
+  include CanvasSync::Concerns::ApiSyncable
 
   validates :canvas_id, uniqueness: true, presence: true
   has_many :enrollments, primary_key: :canvas_id, foreign_key: :canvas_user_id
   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/config/application.rb

@@ -1,6 +1,17 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+require 'rails'
+require 'active_record/railtie'
+# require 'active_storage/engine'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'active_job/railtie'
+# require 'action_cable/engine'
+# require 'action_mailbox/engine'
+# require 'action_text/engine'
+require 'rails/test_unit/railtie'
+# require 'sprockets/railtie'
 
 Bundler.require(*Rails.groups)
 require "canvas_sync"

data/spec/dummy/config/database.yml

@@ -1,25 +1,25 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-#
+
 default: &default
   adapter: postgresql
-  pool: 5
-  timeout: 5000
+  encoding: unicode
+  # For details on connection pooling, see Rails configuration guide
+  # http://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: <%= ENV.fetch("DB_POOL_SIZE", nil) || (ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i + 10) %>
+  username: <%= ENV.fetch("DB_USERNAME", "") %>
+  password: <%= ENV.fetch("DB_PASSWORD", "") %>
+  host: <%= ENV.fetch("DB_ADDRESS", "localhost") %>
 
 development:
   <<: *default
   database: canvas_sync_development
 
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
 test:
   <<: *default
   database: canvas_sync_test
 
 production:
   <<: *default
+  host: <%= ENV.fetch('DB_ADDRESS', 'localhost') %>
   database: canvas_sync_production
+  username: <%= ENV.fetch("DB_USERNAME", "canvas_sync_specs_postgres_user") %>
+  password: <%= ENV.fetch("DB_PASSWORD", 'canvas_sync_specs_postgres_password') %>

data/spec/dummy/config/environments/development.rb

@@ -25,16 +25,16 @@ Rails.application.configure do
   # Debug mode disables concatenation and preprocessing of assets.
   # This option may cause significant delays in view rendering with a large
   # number of complex assets.
-  config.assets.debug = true
+  # config.assets.debug = true
 
   # Asset digests allow you to set far-future HTTP expiration dates on all assets,
   # yet still be able to expire them through the digest params.
-  config.assets.digest = true
+  # config.assets.digest = true
 
   # Adds additional error checking when serving assets at runtime.
   # Checks for improperly declared sprockets dependencies.
   # Raises helpful error messages.
-  config.assets.raise_runtime_errors = true
+  # config.assets.raise_runtime_errors = true
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true

data/spec/dummy/config/initializers/assets.rb

@@ -1,7 +1,7 @@
 # Be sure to restart your server when you modify this file.
 
 # Version of your assets, change this if you want to expire all your assets.
-Rails.application.config.assets.version = '1.0'
+# Rails.application.config.assets.version = '1.0'
 
 # Add additional assets to the asset load path
 # Rails.application.config.assets.paths << Emoji.images_path

data/spec/dummy/db/migrate/20190702203627_create_submissions.rb

@@ -14,6 +14,7 @@ class CreateSubmissions < ActiveRecord::Migration[5.1]
       t.bigint :canvas_assignment_id
       t.bigint :canvas_user_id
       t.datetime :submitted_at
+      t.datetime :due_at
       t.datetime :graded_at
       t.float :score
       t.float :points_possible

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