canvas_sync 0.10.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efb7341f8d1643d211f53ffde7c7fbaf9c7e0b89359d83ffa12e293f8e977863
-  data.tar.gz: 4919a841fc27a2b85cb0049f03a18a46f27d1c5928345eaf2dd3460fba764f06
+  metadata.gz: 50ea86e0116f11f92019daae4edd22aa3a402355e1d910947e391a0f3b6ac000
+  data.tar.gz: 5712f275605f93eefc0f0ab5f1711b31e20dbc29d9a5e2b56d39853745610a49
 SHA512:
-  metadata.gz: ae1217a2ab3c9f5168cd759372ac0d306e906bf185a3f6684c208443f9611ce494d7cd8d6ccd732e11425ddf3711c5886fb43b7caa881d1d9064ab10e6d85c9c
-  data.tar.gz: 619b4f60710761a1381074d1d058fb49e6b09f79264b7ed57f97143f2bcab468fb0e1eb0571591aaedd7b9536b5318acc7463a01a3732014b974fc33457c5dc0
+  metadata.gz: f914d9934b0b7c7c31fc3e3188d9884a07aeb104a4b89b9815f2455ada59bf74f6f43b3eb8fdc3fbd994dcca48166fd108dc45ae415f8715197ac96f33b3a2df
+  data.tar.gz: b56ddedc9b422d64bf319f2f425cb209b1889fbfd4a5992eb403ab1901efd2b3aaeaa7463c3ca9b4d32924e6b44fc0b8479084c6462796ea547a8d6e5fd516b9

data/lib/canvas_sync/api_syncable.rb

@@ -1,7 +1,26 @@
 module CanvasSync::ApiSyncable
   extend ActiveSupport::Concern
+  NON_EXISTANT_ERRORS = [Faraday::Error::ResourceNotFound, Footrest::HttpError::NotFound]
 
   class_methods do
+    def find_or_fetch(canvas_id, save: false, retries: 1)
+      inst = find_by(canvas_id: canvas_id)
+      return inst if inst.present?
+      inst = new(canvas_id: canvas_id)
+      api_response = inst.request_from_api(retries: retries)
+      inst.update_from_api_params(api_response)
+      inst.save! if save
+      inst
+    rescue *NON_EXISTANT_ERRORS
+      nil
+    end
+
+    def find_or_fetch!(*args)
+      inst = find_or_fetch(*args)
+      raise ActiveRecord::RecordNotFound unless inst.present?
+      inst
+    end
+
     def api_sync_options=(opts)
       @api_sync_options = opts
     end
@@ -42,7 +61,7 @@ module CanvasSync::ApiSyncable
     api_response = request_from_api(retries: retries)
     update_from_api_params!(api_response)
     api_response
-  rescue Faraday::Error::ResourceNotFound, Footrest::HttpError::NotFound => e
+  rescue *NON_EXISTANT_ERRORS
     api_mark_deleted
     save! if changed?
     nil

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

@@ -7,11 +7,13 @@ class CreateRoles < ActiveRecord::Migration[5.1]
       t.string :label, null: false
       t.string :base_role_type, null: false
       t.json :account
+      t.integer :canvas_account_id
       t.string :workflow_state, null: false
       t.json :permissions
 
       t.timestamps
     end
     add_index :roles, :canvas_id, unique: true
+    add_index :roles, :canvas_account_id
   end
 end

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

@@ -1,20 +1,26 @@
 <%= autogenerated_model_warning %>
 
 class Admin < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_id, uniqueness: true, presence: 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
 
-  def self.create_or_update(admin_params)
-    admin = Admin.find_or_initialize_by(canvas_id: admin_params['id'])
+  api_syncable({
+    canvas_id: :id,
+    role_name: :role,
+    canvas_role_id: :role_id,
+    user_data: :user,
+    canvas_user_id: ->(r) { r['user']['id'] },
+    workflow_state: :workflow_state,
+  }, -> (api) {
+    admins = api.account_admins('self').all_pages!
+    admin_data = admins.find{|admin| admin['id'] == canvas_id }
+    raise Footrest::HttpError::NotFound unless admin_data.present?
+    admin_data
+  })
 
-    admin.assign_attributes(role_name: admin_params['role'],
-                            canvas_role_id: admin_params['role_id'],
-                            user_data: admin_params['user'],
-                            canvas_user_id: admin_params['user']['id'],
-                            workflow_state: admin_params['workflow_state'])
+  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
 
-    admin.save! if admin.changed?
-    admin
-  end
 end

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

@@ -15,5 +15,6 @@ class AssignmentGroup < ApplicationRecord
     position: :position,
     rules: :rules,
     group_weight: :group_weight,
-  }, -> (api) { api.assignment(course_id, canvas_id) })
+    workflow_state: ->(p) { 'available' },
+  }, -> (api) { api.assignment_group(canvas_course_id, canvas_id) })
 end

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

@@ -1,19 +1,21 @@
 <%= autogenerated_model_warning %>
 
 class Role < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_id
 
-  def self.create_or_update(role_params)
-    role = Role.find_or_initialize_by(canvas_id: role_params['id'])
+  api_syncable({
+    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}") })
 
-    role.assign_attributes(label: role_params['label'],
-                           base_role_type: role_params['base_role_type'],
-                           account: role_params['account'],
-                           permissions: role_params['permissions'],
-                           workflow_state: role_params['workflow_state'])
+  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
 
-    role.save! if role.changed?
-    role
-  end
 end

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

@@ -1,9 +1,28 @@
 <%= autogenerated_model_warning %>
 
 class Term < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :courses, foreign_key: :canvas_term_id, primary_key: :canvas_id
 
+  api_syncable({
+    canvas_id: :id,
+    name: :name,
+    sis_id: :sis_term_id,
+    start_at: :start_at,
+    end_at: :end_at,
+    workflow_state: :workflow_state,
+    grading_period_group_id: :grading_period_group_id,
+  }, -> (api) {
+    terms = api.terms('self').all_pages!
+    term_data = terms.find{|term| term['id'] == canvas_id }
+    raise Footrest::HttpError::NotFound unless term_data.present?
+    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, -> {
@@ -12,18 +31,4 @@ class Term < ApplicationRecord
       .where("end_at >= ? OR end_at IS NULL", 15.days.ago)
   }
 
-  def self.create_or_update(term_params)
-    term = Term.find_or_initialize_by(canvas_id: term_params['id'])
-
-    term.assign_attributes(name: term_params['name'],
-                           start_at: term_params['start_at'],
-                           end_at: term_params['end_at'],
-                           workflow_state: term_params['workflow_state'],
-                           grading_period_group_id: term_params['grading_period_group_id'],
-                           sis_id: term_params['sis_term_id'])
-
-    term.save! if term.changed?
-    term
-  end
-
 end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.10.0".freeze
+  VERSION = "0.10.2".freeze
 end

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

@@ -7,20 +7,26 @@
 
 
 class Admin < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_id, uniqueness: true, presence: 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
 
-  def self.create_or_update(admin_params)
-    admin = Admin.find_or_initialize_by(canvas_id: admin_params['id'])
+  api_syncable({
+    canvas_id: :id,
+    role_name: :role,
+    canvas_role_id: :role_id,
+    user_data: :user,
+    canvas_user_id: ->(r) { r['user']['id'] },
+    workflow_state: :workflow_state,
+  }, -> (api) {
+    admins = api.account_admins('self').all_pages!
+    admin_data = admins.find{|admin| admin['id'] == canvas_id }
+    raise Footrest::HttpError::NotFound unless admin_data.present?
+    admin_data
+  })
 
-    admin.assign_attributes(role_name: admin_params['role'],
-                            canvas_role_id: admin_params['role_id'],
-                            user_data: admin_params['user'],
-                            canvas_user_id: admin_params['user']['id'],
-                            workflow_state: admin_params['workflow_state'])
+  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
 
-    admin.save! if admin.changed?
-    admin
-  end
 end

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

@@ -7,19 +7,21 @@
 
 
 class Role < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :admins, foreign_key: :canvas_role_id, primary_key: :canvas_id
 
-  def self.create_or_update(role_params)
-    role = Role.find_or_initialize_by(canvas_id: role_params['id'])
+  api_syncable({
+    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}") })
 
-    role.assign_attributes(label: role_params['label'],
-                           base_role_type: role_params['base_role_type'],
-                           account: role_params['account'],
-                           permissions: role_params['permissions'],
-                           workflow_state: role_params['workflow_state'])
+  def self.create_or_update(params); find_or_initialize_by(canvas_id: params['id']).update_from_api_params!(params); end
 
-    role.save! if role.changed?
-    role
-  end
 end

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

@@ -7,9 +7,28 @@
 
 
 class Term < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_id, uniqueness: true, presence: true
   has_many :courses, foreign_key: :canvas_term_id, primary_key: :canvas_id
 
+  api_syncable({
+    canvas_id: :id,
+    name: :name,
+    sis_id: :sis_term_id,
+    start_at: :start_at,
+    end_at: :end_at,
+    workflow_state: :workflow_state,
+    grading_period_group_id: :grading_period_group_id,
+  }, -> (api) {
+    terms = api.terms('self').all_pages!
+    term_data = terms.find{|term| term['id'] == canvas_id }
+    raise Footrest::HttpError::NotFound unless term_data.present?
+    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, -> {
@@ -18,18 +37,4 @@ class Term < ApplicationRecord
       .where("end_at >= ? OR end_at IS NULL", 15.days.ago)
   }
 
-  def self.create_or_update(term_params)
-    term = Term.find_or_initialize_by(canvas_id: term_params['id'])
-
-    term.assign_attributes(name: term_params['name'],
-                           start_at: term_params['start_at'],
-                           end_at: term_params['end_at'],
-                           workflow_state: term_params['workflow_state'],
-                           grading_period_group_id: term_params['grading_period_group_id'],
-                           sis_id: term_params['sis_term_id'])
-
-    term.save! if term.changed?
-    term
-  end
-
 end

data/spec/dummy/db/migrate/{20190521003448_create_roles.rb → 20190606161037_create_roles.rb}

@@ -13,11 +13,13 @@ class CreateRoles < ActiveRecord::Migration[5.1]
       t.string :label, null: false
       t.string :base_role_type, null: false
       t.json :account
+      t.integer :canvas_account_id
       t.string :workflow_state, null: false
       t.json :permissions
 
       t.timestamps
     end
     add_index :roles, :canvas_id, unique: true
+    add_index :roles, :canvas_account_id
   end
 end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20190604193942) do
+ActiveRecord::Schema.define(version: 20190606161037) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -162,10 +162,12 @@ ActiveRecord::Schema.define(version: 20190604193942) do
     t.string "label", null: false
     t.string "base_role_type", null: false
     t.json "account"
+    t.integer "canvas_account_id"
     t.string "workflow_state", null: false
     t.json "permissions"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.index ["canvas_account_id"], name: "index_roles_on_canvas_account_id"
     t.index ["canvas_id"], name: "index_roles_on_canvas_id", unique: true
   end
 

data/spec/support/fixtures/canvas_responses/admins.json

@@ -1,50 +1,50 @@
 [
-{
-"id": 2,
-"role": "AccountAdmin",
-"role_id": 1,
-"user": {
-"id": 1,
-"name": "mvalentine@instructure.com",
-"sortable_name": "mvalentine@instructure.com",
-"short_name": "mvalentine@instructure.com",
-"sis_user_id": null,
-"integration_id": null,
-"sis_import_id": null,
-"login_id": "mvalentine@instructure.com"
-},
-"workflow_state": "active"
-},
-{
-"id": 3,
-"role": "Custom Account Role",
-"role_id": 11,
-"user": {
-"id": 11,
-"name": "Test Account User",
-"sortable_name": "User, Test Account",
-"short_name": "Test Account User",
-"sis_user_id": null,
-"integration_id": null,
-"sis_import_id": null,
-"login_id": "testaccountuser@example.com"
-},
-"workflow_state": "active"
-},
-{
-"id": 4,
-"role": "Test",
-"role_id": 10,
-"user": {
-"id": 11,
-"name": "Test Account User",
-"sortable_name": "User, Test Account",
-"short_name": "Test Account User",
-"sis_user_id": null,
-"integration_id": null,
-"sis_import_id": null,
-"login_id": "testaccountuser@example.com"
-},
-"workflow_state": "active"
-}
-]
+    {
+        "id": 2,
+        "role": "AccountAdmin",
+        "role_id": 1,
+        "user": {
+            "id": 1,
+            "name": "mvalentine@instructure.com",
+            "sortable_name": "mvalentine@instructure.com",
+            "short_name": "mvalentine@instructure.com",
+            "sis_user_id": null,
+            "integration_id": null,
+            "sis_import_id": null,
+            "login_id": "mvalentine@instructure.com"
+        },
+        "workflow_state": "active"
+    },
+    {
+        "id": 3,
+        "role": "Custom Account Role",
+        "role_id": 11,
+        "user": {
+            "id": 11,
+            "name": "Test Account User",
+            "sortable_name": "User, Test Account",
+            "short_name": "Test Account User",
+            "sis_user_id": null,
+            "integration_id": null,
+            "sis_import_id": null,
+            "login_id": "testaccountuser@example.com"
+        },
+        "workflow_state": "active"
+    },
+    {
+        "id": 4,
+        "role": "Test",
+        "role_id": 10,
+        "user": {
+            "id": 11,
+            "name": "Test Account User",
+            "sortable_name": "User, Test Account",
+            "short_name": "Test Account User",
+            "sis_user_id": null,
+            "integration_id": null,
+            "sis_import_id": null,
+            "login_id": "testaccountuser@example.com"
+        },
+        "workflow_state": "active"
+    }
+]