fmrest-spyke 0.23.1 → 0.24.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4e30c2055c096479e79ba9c5d4fd2d5376ba854b9295cb8936e81a86fc4e231
-  data.tar.gz: d18a1d36aca81732e4e90d67a13575d5e891f6504e48f8e7df529d23acaf576d
+  metadata.gz: ebd19342bbf84f1a13e8aacb58af0479f085b0b67712e5dc7feb67b94b8f0372
+  data.tar.gz: bf58fdb4882b2dacf66d03768d50134be239239e7221af91e27a2350613f06a2
 SHA512:
-  metadata.gz: 4e1748cc9448aa032c4683ba809a7298e3f6a9ef4530ac7811ee0d24cabe9911ddd447f4773af06919a5bbb0c08fd85ae4e5908ee14f87f88f7fd6ae7778e05c
-  data.tar.gz: b8e6828dcf31aeb7a6443483d560e529833606b0a55e2454532db855d4d3bef9e4357aaa3c1bff073015df0d2370047826ba38f555631ed9a0ac8f4add2a9609
+  metadata.gz: ae8b64ca0398e4e6d49dd5d0c6660c8674614bc36590d40a5e62e67f1c062a4b84789bb48f01c6aad9850a99790ef6373071743ad5db6df1d703d8a5a2af9edf
+  data.tar.gz: c96aa5a722e4f9a099d3a3c82be5c3f0d431f62364f3e4a2670334f912ce657a237c7ffe87e03cd6c8ecef8b7c43378c26b376cf3595ee3395d6e9ca49f30667

data/README.md

@@ -469,6 +469,36 @@ class method. Also note that this will only catch exceptions raised during an
 API call to the Data API server (in other words, only on actions that perform
 an HTTP request).
 
+### Optional `modId`
+
+The Data API provides an optional `modId` value that gets set on a record every
+time you fetch or update it. This value then gets included in the API request
+when you save the record, and FileMaker compares it against the current value,
+preventing the update in case of a mismatch.
+
+This safety feature is enabled by default in `fmrest-spyke` models, but you can
+disable it using the inheritable `ignore_mod_id` flag on your model classes or
+instances. E.g.
+
+```ruby
+class Bee < FmRest::Layout
+  # This disables modId for all instances and subclasses
+  self.ignore_mod_id = true
+end
+
+# Or set it on instances:
+bee = Bee.new
+bee.ignore_mod_id # => true (set in class)
+bee.ignore_mod_id = false # (affects only this instance)
+```
+
+You can also set it directly on `FmRest::Layout` if you want to disable it for
+your entire app:
+
+```ruby
+FmRest::Layout.ignore_mod_id = true
+```
+
 ## Logging
 
 If using `fmrest-spyke` with Rails then pretty log output will be set up for

data/lib/fmrest/spyke/model/serialization.rb

@@ -4,6 +4,16 @@ module FmRest
   module Spyke
     module Model
       module Serialization
+        extend ::ActiveSupport::Concern
+
+        included do
+          # Set this flag to `true` to prevent sending modId with update
+          # requests, as it's optional in the Data API specs.
+          # Note that `class_attribute` provides an instance-level attribute
+          # too that can override the class-level one (without modifying it)
+          class_attribute :ignore_mod_id
+        end
+
         # Spyke override -- Return FM Data API's expected JSON format,
         # including only modified fields.
         #
@@ -12,7 +22,7 @@ module FmRest
             fieldData: serialize_values!(changed_params_not_embedded_in_url).merge(serialize_portal_deletions)
           }
 
-          params[:modId] = __mod_id.to_s if __mod_id
+          params[:modId] = __mod_id.to_s if __mod_id && !ignore_mod_id?
 
           portal_data = serialize_portals
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest-spyke
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.24.0.rc1
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fmrest-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.24.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.24.0.rc1
 - !ruby/object:Gem::Dependency
   name: spyke
   requirement: !ruby/object:Gem::Requirement
@@ -88,9 +88,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.3
 signing_key: