canvas_sync 0.22.15 → 0.22.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8fbeee209380af1879194e5c4e1a95cb131e3ee638e2941ef66160682443c38
-  data.tar.gz: eba40becd6465d29e887ac1e44e315d483e7635190bf9ac617ba898491ae467f
+  metadata.gz: edf3fa2e60b56a50ba72da7e2e930b6ee7580e48350b99aaa9f69597aa01541f
+  data.tar.gz: cf055ba20dc5a53dc978d78ad3d6b5a3b0fc987ada68a678a86b1f09c7446ae3
 SHA512:
-  metadata.gz: fed475cc7ef3535b65bdf11e23d2b553f4064d0745fdc76b5af9c49c52d9123ae2073545013d20e5605121b0a57c7555e5a524a3f1be255629cd6f0f0d219104
-  data.tar.gz: 3cec741d0045cb8a7224b1cf3eeaf241c1b28b0336c09e615c77041e8690c504058e834984ef71b7820ed6d6e21a19ec17b0a6a980d243f31f26168279c7c3ee
+  metadata.gz: e15a40d668b06d5c449d7375441b8551ec9b4516b4f7348ec342d02287ee53b2c8f9c9faeda792148dd55358f860f9e3e008e1871c1f74944e7c9fbcf9f0c8fc
+  data.tar.gz: 6a1ff13780555575d896cbd9a783b28b9bbe6a1fa82f78134b531ae7c5b06954834c71f2f668c78933d21c09679e1444aee638c990ae711ce4e63050e0e88851

data/README.md

@@ -463,6 +463,18 @@ Available config options (if you add more, please update this!):
 
 * `config.classes_to_only_log_errors_on` - use this if you are utilizing the `CanvasSync::JobLog` table, but want certain classes to only persist in the `job_logs` table if an error is encountered. This is useful if you've got a very frequently used job that's filling up your database, and only really care about tracking failures.
 
+
+## Job Chain options
+
+Options can be passed into the job_chain and delivered to specific jobs tied to models.
+For example: options { roles: { show_inherited: true } } will pass "show_inherited" into the SyncRolesJob.
+
+* roles
+  * `show_inherited` - this applies to the roles model.  If it is set to true we will use the "show_inherited" option when pulling roles from Canvas API.
+  "show_inherited" will include things like shadow records.  It will also include roles from parent accounts if you are not syncing at the root account.
+ 
+* `global` - See "Global Options"
+
 ## Global Options
 You can pass in global_options to a job chain.  Global options are added to the batch_context and referenced by
 various internal processes.

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

@@ -0,0 +1,36 @@
+# <%= autogenerated_migration_warning %>
+
+class CreateScores < ActiveRecord::Migration[5.1]
+  def change
+    create_table :scores do |t|
+      t.bigint :canvas_id, null: false
+      t.bigint :canvas_enrollment_id, null: false
+      t.bigint :canvas_assignment_group_id
+      t.bigint :canvas_grading_period_id
+      t.float :current_score
+      t.float :unposted_current_score
+      t.string :workflow_state, default: :active, null: false, limit: 255
+      t.float :final_score
+      t.boolean :course_score, default: false, null: false
+      t.float :unposted_final_score
+      t.float :current_points
+      t.float :unposted_current_points
+      t.float :final_points
+      t.float :unposted_final_points
+      t.float :override_score
+
+      t.timestamps
+    end
+
+    add_index :scores, :canvas_id, unique: true
+    add_index :scores, :canvas_enrollment_id, unique: true, where: 'course_score'
+    add_index :scores, [:canvas_enrollment_id, :canvas_assignment_group_id],
+              unique: true,
+              where: 'canvas_assignment_group_id IS NOT NULL',
+              name: 'index_scores_on_canvas_enrollment_id_and_assignment_group_id'
+    add_index :scores, [:canvas_enrollment_id, :canvas_grading_period_id],
+              unique: true,
+              where: 'canvas_grading_period_id IS NOT NULL',
+              name: 'index_scores_on_canvas_enrollment_id_and_grading_period_id'
+  end
+end

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

@@ -0,0 +1,12 @@
+# <%= autogenerated_model_warning %>
+
+class Score < ApplicationRecord
+  include CanvasSync::Record
+
+  canvas_sync_features :defaults
+
+  validates :canvas_id, uniqueness: true, presence: true
+  belongs_to :enrollment, primary_key: :canvas_id, foreign_key: :canvas_enrollment_id, optional: true
+  belongs_to :assignment_group, primary_key: :canvas_id, foreign_key: :canvas_assignment_group_id, optional: true
+  belongs_to :grading_period, primary_key: :canvas_id, foreign_key: :canvas_grading_period_id, optional: true
+end

data/lib/canvas_sync/jobs/sync_roles_job.rb

@@ -8,7 +8,11 @@ module CanvasSync
         updated_role_ids = []
         api_client = CanvasSync.get_canvas_sync_client(batch_context)
         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|
+          api_params = { state: %w[active inactive] }
+          if options[:show_inherited]
+            api_params[:show_inherited] = true
+          end
+          api_client.list_roles(acc.canvas_id, api_params).all_pages_each do |role_params|
             role = update_or_create_model(Role, role_params)
             updated_role_ids.push(role.id)
           end

data/lib/canvas_sync/jobs/sync_scores_job.rb

@@ -0,0 +1,18 @@
+module CanvasSync
+  module Jobs
+    class SyncScoresJob < ReportStarter
+      # @param options [Hash]
+      def perform(options)
+        super(
+          "proserv_scores_data_csv",
+          merge_report_params(options),
+          CanvasSync::Processors::NormalProcessor.to_s,
+          {
+            klass: 'Score',
+            mapping: 'scores'
+          },
+        )
+      end
+    end
+  end
+end

data/lib/canvas_sync/processors/model_mappings.yml

@@ -900,3 +900,49 @@ rubric_assessments:
     root_account_id:
       database_column_name: canvas_root_account_id
       type: integer
+
+scores:
+  conflict_id: id
+  report_columns:
+    id:
+      database_column_name: canvas_id
+      type: integer
+    canvas_enrollment_id:
+      database_column_name: canvas_enrollment_id
+      type: integer
+    canvas_assignment_group_id:
+      database_column_name: canvas_assignment_group_id
+      type: integer
+    canvas_grading_period_id:
+      database_column_name: canvas_grading_period_id
+      type: integer
+    current_score:
+      database_column_name: current_score
+      type: float
+    unposted_current_score:
+      database_column_name: unposted_current_score
+      type: float
+    workflow_state:
+      database_column_name: workflow_state
+      type: string
+    final_score:
+      database_column_name: final_score
+      type: float
+    unposted_final_score:
+      database_column_name: unposted_final_score
+      type: float
+    current_points:
+      database_column_name: current_points
+      type: float
+    unposted_current_points:
+      database_column_name: unposted_current_points
+      type: float
+    final_points:
+      database_column_name: final_points
+      type: float
+    unposted_final_points:
+      database_column_name: unposted_final_points
+      type: float
+    course_score:
+      database_column_name: course_score
+      type: boolean