canvas_sync 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412a668db952bd2cf0956aa69353615ab3fe528446183040d3f66a8a77f3160a
-  data.tar.gz: 537d6166a490ecc754e9e8dca2b7d54fe627ed0b5376479e9431c4297e47fd92
+  metadata.gz: fd62cb62c721c5e1262ddbac6bfbecfb2712d8830cd6d738350876e6459895ab
+  data.tar.gz: 7ac53b25cb60a449c5a678d12c5e902b48c9d96c10199473f630fca728141d99
 SHA512:
-  metadata.gz: 0e0bfd9c81593f35a2f19c430ccf4c19b7642babc29afbadb8e67d3f6285eee9fecb730cbb73d10f48819f02c000c38fedd8bfc61e5ae33672570868bb1b5a24
-  data.tar.gz: f50dfde884b32425a3f679619800c279811060a79765e8f70a0338e64a88d50c8f3a12de6663b26432d1ff4ca036ee45e30c4f7835cd689b48f1cc2fad412c59
+  metadata.gz: ac382d711a3ce11c8abc6cf1e7747548c0d8cd851f0bcddedaafcf2225861e2747efae3c97b6037d5d81fe7bba969b2d8ee13da1185dc037b3670c004f63027e
+  data.tar.gz: 4b9483d5bdb4c5b3d10b1dc1216fad6a6480b646d655463b4148318a58aa2ae5c8251a1e44e96af1e7970e239e52220b1c9c945cef3e7de097aa220735bda5c3

data/README.md

@@ -213,6 +213,21 @@ class CanvasSyncModel < ApplicationRecord
   ) do |api_response, mapped_fields| # Must accept 1-2 parameters
     # Override behavior for actually applying the response to the model instance
   end
+
+  def something()
+    # ApiSyncable models add several instance methods:
+
+    request_from_api( # Starts an API request and and returns the params
+      retries: 3, # Number of times to retry the API call before failing
+    )
+
+    update_from_api_params(params) # Merge the API response into the model instance
+    update_from_api_params!(params) # Merge and save! if changed
+
+    sync_from_api( # Starts an API request and calls save! (if changed)
+      retries: 3, # Number of times to retry the API call before failing
+    )
+  end
 end
 ```
 

data/lib/canvas_sync/api_syncable.rb

@@ -12,7 +12,11 @@ module CanvasSync::ApiSyncable
   end
 
   def sync_from_api(retries: 3)
-    params = api_call_with_retry(retries || 3) {
+    update_from_api_params!(request_from_api(retries: retries))
+  end
+
+  def request_from_api(retries: 3)
+    api_call_with_retry(retries || 3) {
       blk = self.class.api_sync_fetch
       case blk.arity
       when 1
@@ -21,10 +25,9 @@ module CanvasSync::ApiSyncable
         self.instance_exec(&blk)
       end
     }
-    update_from_api_params!(params)
   end
 
-  def update_from_api_params!(api_params)
+  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
@@ -32,7 +35,15 @@ module CanvasSync::ApiSyncable
     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]
+        if remote_name.respond_to?(:call)
+          mapped_params[local_name] = self.instance_exec(api_params, &remote_name)
+        elsif api_params.include?(remote_name)
+          mapped_params[local_name] = api_params[remote_name]
+          if remote_name == :id
+            current_value = send("#{local_name}")
+            raise "Mismatched Canvas ID" if current_value.present? && current_value != api_params[remote_name]
+          end
+        end
       end
     end
 
@@ -48,8 +59,13 @@ module CanvasSync::ApiSyncable
         send("#{local_name}=", val)
       end
     end
+    self
+  end
 
+  def update_from_api_params!(api_params)
+    update_from_api_params(api_params)
     save! if changed?
+    self
   end
 
   private

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

@@ -11,19 +11,19 @@ class Assignment < ApplicationRecord
   has_many :context_modules, through: :context_module_items
 
   api_syncable({
-    title: :tile,
+    title: :name,
     description: :description,
     due_at: :due_at,
     unlock_at: :unlock_at,
-    points_posible: :points_posible,
+    points_possible: :points_possible,
     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(",") },
+    submission_types: lambda { |p| p["submission_types"].join(",") },
     workflow_state: :workflow_state,
     context_id: :course_id,
-    context_type: lambda { |_a, _p| "Course" },
+    context_type: lambda { |_p| "Course" },
     canvas_assignment_group_id: :canvas_assignment_group_id,
     grading_scheme_id: :grading_scheme_id,
     grading_standard_id: :grading_standard_id,

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

@@ -1,7 +1,19 @@
 <%= autogenerated_model_warning %>
 
 class AssignmentGroup < ApplicationRecord
+  include CanvasSync::ApiSyncable
+
   validates :canvas_assignment_group_id, uniqueness: true, presence: true
   belongs_to :course, primary_key: :canvas_course_id, foreign_key: :canvas_course_id, optional: true
   has_many :assignments, primary_key: :canvas_assignment_group_id, foreign_key: :canvas_assignment_group_id
+
+  serialize :rules
+
+  api_syncable({
+    canvas_assignment_group_id: :id,
+    name: :name,
+    position: :position,
+    rules: :rules,
+    group_weight: :group_weight,
+  }, -> (api) { api.assignment(course_id, canvas_assignment_group_id) })
 end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.8.3".freeze
+  VERSION = "0.8.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Nate Collings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler