canvas_sync 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5aacd90f1c55b16e6cd1faac3695c27d102a026
-  data.tar.gz: 537204f3c66ab4f9a639afbdc23abbabb31e7b52
+  metadata.gz: 8f7a480e67851b3de7f12b0df8569aa09aa36431
+  data.tar.gz: 51923b6e9707be4f3969160cfa495d1bb75c19c0
 SHA512:
-  metadata.gz: 9681ea9b57ea44cfdb2676192515ff7992efcdbf9af34b46619bc3af680774bf8792efbafe29a7f151d522ae18d41e7fe4e23f15e2bb0945d988c22d1dbccc2e
-  data.tar.gz: 6e8d2dc6ba412e169cdf4a0b204b1893647773b62264e59d655a2dd87bd522e36b620976c9169e9b8590112284b6872b7c77ca00503cccb839f0854f5108e841
+  metadata.gz: '029af7cd4b8d5f277c5688c9439fe98435cf40dd2f8f88093b8c743a527d4864f3c3a7af4e4544bdd8ec0372fff954aea6f688a59dee6f3608e3fd4af3b4abe1'
+  data.tar.gz: 4d4825e66d7e8f2e3850c6422eba37fc0afcee18b9380039837c15238f25fc73aab8dda0c58784b4557f84360f2d4b5ee4492582ae568167d57ab208c3315613

data/README.md

@@ -189,7 +189,7 @@ Overrides are useful for two scenarios:
 
 In order to create an override, place a file called `canvas_sync_provisioning_mapping.yml` in your Rails `config` directory. Define the tables and columns you want to override using the following format:
 
-```
+```ruby
 users:
   conflict_target: canvas_user_id # This must be a unique field that is present in the report and the database
   report_columns: # The keys specified here are the column names in the report CSV
@@ -198,6 +198,25 @@ users:
         type: integer
 ```
 
+### API Sync
+Several models implement the `ApiSyncable` Concern. This is done in the Model Templates so as to be customizable and tweakable.
+Models that `include CanvasSync::ApiSyncable` should also call the `api_syncable` class method to configure the Synchronization.
+`api_syncable` takes two arguments and an optional block callback:
+```ruby
+class CanvasSyncModel < ApplicationRecord
+  api_syncable(
+    {
+      local_field: :response_field, # api_response[:response_field] will be mapped to local_field on the model.
+      local_field: -> (api_response) { api_response[:some_field] + 5 }, # A calculated result will be mapped to local_field on the model. The lambda is executed in the context of the model instance.
+    },
+    -> (bearcat) { bearcat.some_request(some_model_getter) } # A lambda, executed in the context of the model instance, to actually make the API call. Should accept 0 or 1 parameters. Must accept 0 parameters if your `canvas_sync_client` requires an `account_id`
+  ) do |api_response, mapped_fields| # Must accept 1-2 parameters
+    # Override behavior for actually applying the response to the model instance
+  end
+end
+```
+
+
 ## Legacy Support
 
 If you have an old style tool that needs to sync data on a row by row basis, you can pass in the `legacy_support: true` option. In order for this to work, your models must have a `create_or_update_from_csv` class method defined that accepts a row argument. This method will get passed each row from the CSV, and it's up to you to persist it.

data/lib/canvas_sync.rb

@@ -3,6 +3,7 @@ require "canvas_sync/version"
 require "canvas_sync/engine"
 require "canvas_sync/job"
 require "canvas_sync/sidekiq_job"
+require "canvas_sync/api_syncable"
 require "canvas_sync/jobs/report_starter"
 require "canvas_sync/jobs/report_checker"
 require "canvas_sync/jobs/report_processor_job"

data/lib/canvas_sync/api_syncable.rb

@@ -0,0 +1,65 @@
+module CanvasSync::ApiSyncable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    attr_accessor :api_sync_map, :api_sync_fetch, :api_sync_block
+
+    def api_syncable(map, fetch, &blk)
+      self.api_sync_map = map
+      self.api_sync_fetch = fetch
+      self.api_sync_block = blk
+    end
+  end
+
+  def sync_from_api(retries: 3)
+    params = api_call_with_retry(retries || 3) {
+      blk = self.class.api_sync_fetch
+      case blk.arity
+      when 1
+        self.instance_exec(canvas_sync_client, &blk)
+      else
+        self.instance_exec(&blk)
+      end
+    }
+    update_from_api_params!(params)
+  end
+
+  def update_from_api_params!(api_params)
+    api_params = api_params.with_indifferent_access
+    apply_block = self.class.api_sync_block
+    map = self.class.api_sync_map
+
+    mapped_params = {}
+    if map.present?
+      map.each do |local_name, remote_name|
+        mapped_params[local_name] = remote_name.respond_to?(:call) ? self.instance_exec(api_params, &remote_name) : api_params[remote_name]
+      end
+    end
+
+    if apply_block.present?
+      case apply_block.arity
+      when 1
+        self.instance_exec(api_params, &apply_block)
+      when 2
+        self.instance_exec(api_params, mapped_params, &apply_block)
+      end
+    else
+      mapped_params.each do |local_name, val|
+        send("#{local_name}=", val)
+      end
+    end
+
+    save! if changed?
+  end
+
+  private
+
+  def api_call_with_retry(retries=3)
+    tries ||= retries
+    yield
+  rescue Faraday::ConnectionFailed => e
+    raise e if (tries -= 1).zero?
+    sleep 5
+    retry
+  end
+end

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

@@ -1,5 +1,13 @@
 <%= autogenerated_model_warning %>
 
 class Account < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_account_id, uniqueness: true, presence: true
+
+  api_syncable({
+    name: :name,
+    status: :status,
+    canvas_parent_id: :canvas_parent_id,
+  }, -> (api) { api.account(canvas_account_id) })
 end

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

@@ -1,10 +1,31 @@
 <%= autogenerated_model_warning %>
 
 class Assignment < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_assignment_id, uniqueness: true, presence: true
   belongs_to :context, polymorphic: true, optional: true, primary_key: :canvas_course_id
   belongs_to :assignment_group, optional: true, primary_key: :canvas_assignment_group_id, foreign_key: :canvas_assignment_group_id
   has_many :submissions, primary_key: :canvas_assignment_id, foreign_key: :canvas_assignment_id
   has_many :context_module_items, primary_key: :canvas_assignment_id, foreign_key: :content_id, dependent: :destroy
   has_many :context_modules, through: :context_module_items
+
+  api_syncable({
+    title: :tile,
+    description: :description,
+    due_at: :due_at,
+    unlock_at: :unlock_at,
+    points_posible: :points_posible,
+    min_score: :min_score,
+    max_score: :max_score,
+    mastery_score: :mastery_score,
+    grading_type: :grading_type,
+    submission_types: lambda { |_a, p| p["submission_types"].join(",") },
+    workflow_state: :workflow_state,
+    context_id: :course_id,
+    context_type: lambda { |_a, _p| "Course" },
+    canvas_assignment_group_id: :canvas_assignment_group_id,
+    grading_scheme_id: :grading_scheme_id,
+    grading_standard_id: :grading_standard_id,
+  }, -> (api) { api.assignment(context_id, canvas_assignment_id) })
 end

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

@@ -1,6 +1,8 @@
 <%= autogenerated_model_warning %>
 
 class Course < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_course_id, uniqueness: true, presence: true
   belongs_to :term, foreign_key: :canvas_term_id, primary_key: :canvas_term_id, optional: true
   has_many :enrollments, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
@@ -8,4 +10,16 @@ class Course < ApplicationRecord
   has_many :assignments, as: :context, primary_key: :canvas_course_id
   has_many :submissions, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
   has_many :assignment_groups, primary_key: :canvas_course_id, foreign_key: :canvas_course_id
+
+  api_syncable({
+    sis_id: :sis_id,
+    short_name: :short_name,
+    long_name: :long_name,
+    status: :status,
+    canvas_term_id: :canvas_term_id,
+    canvas_account_id: :canvas_account_id,
+    term_sis_id: :term_sis_id,
+    start_date: :start_date,
+    end_date: :end_date,
+  }, -> (api) { api.course(canvas_course_id) })
 end

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

@@ -1,8 +1,24 @@
 <%= autogenerated_model_warning %>
 
 class Enrollment < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_enrollment_id, uniqueness: true, presence: true
   belongs_to :user, primary_key: :canvas_user_id, foreign_key: :canvas_user_id, optional: true
   belongs_to :course, primary_key: :canvas_course_id, foreign_key: :canvas_course_id, optional: true
   belongs_to :section, primary_key: :canvas_section_id, foreign_key: :canvas_section_id, optional: true
+
+  api_syncable({
+    canvas_enrollment_id: :canvas_enrollment_id,
+    canvas_course_id: :canvas_course_id,
+    course_sis_id: :course_sis_id,
+    canvas_user_id: :canvas_user_id,
+    user_sis_id: :user_sis_id,
+    canvas_section_id: :canvas_section_id,
+    section_sis_id: :section_sis_id,
+    role: :role,
+    role_id: :role_id,
+    status: :status,
+    base_role_type: :base_role_type,
+  }, -> (api) { api.enrollment("self", canvas_enrollment_id) })
 end

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

@@ -1,7 +1,19 @@
 <%= autogenerated_model_warning %>
 
 class Section < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_section_id, uniqueness: true, presence: true
   belongs_to :course, primary_key: :canvas_course_id, foreign_key: :canvas_course_id, optional: true
   has_many :enrollments, primary_key: :canvas_section_id, foreign_key: :canvas_section_id
+
+  api_syncable({
+    sis_id: :sis_id,
+    canvas_course_id: :canvas_course_id,
+    canvas_nonxlist_course_id: :canvas_nonxlist_course_id,
+    name: :name,
+    status: :status,
+    start_date: :start_at,
+    end_date: :end_at,
+  }, -> (api) { api.section(canvas_section_id) })
 end

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

@@ -1,8 +1,19 @@
 <%= autogenerated_model_warning %>
 
 class Submission < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_submission_id, uniqueness: true, presence: true
   belongs_to :assignment, primary_key: :canvas_assignment_id, foreign_key: :canvas_assignment_id, optional: true
   belongs_to :user, primary_key: :canvas_user_id, foreign_key: :canvas_user_id, optional: true
   belongs_to :course, primary_key: :canvas_course_id, foreign_key: :canvas_course_id, optional: true
+
+  api_syncable({
+    submitted_at: :submitted_at,
+    graded_at: :graded_at,
+    score: :score,
+    points_possible: :points_possible,
+    excused: :excused,
+    workflow_state: :workflow_state,
+  }, -> (api) { api.user_course_assignment_submission(assignment.context.canvas_course_id, canvas_assignment_id, canvas_user_id) })
 end

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

@@ -1,9 +1,22 @@
 <%= autogenerated_model_warning %>
 
 class User < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   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
   has_many :submissions, primary_key: :canvas_user_id, foreign_key: :canvas_user_id
+
+  api_syncable({
+    sis_id: :sis_id,
+    email: :email,
+    login_id: :login_id,
+    full_name: :name,
+    sortable_name: :sortable_name,
+    first_name: :first_name,
+    last_name: :last_name,
+    status: :status,
+  }, -> (api) { api.user_detail(canvas_user_id) })
 end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.8.1".freeze
+  VERSION = "0.8.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Nate Collings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -320,6 +320,7 @@ files:
 - db/migrate/20170915210836_create_canvas_sync_job_log.rb
 - db/migrate/20180725155729_add_job_id_to_canvas_sync_job_logs.rb
 - lib/canvas_sync.rb
+- lib/canvas_sync/api_syncable.rb
 - lib/canvas_sync/config.rb
 - lib/canvas_sync/engine.rb
 - lib/canvas_sync/generators/install_generator.rb