fmrest 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5873c0192a2b166cfef71b33c521665dd6953660bd9d23d3ef728b89c55e886f
-  data.tar.gz: 7615faa115cc7506d3a472d2fac70ea293bd3dbec1e03bb3c19f0faca51b7c9d
+  metadata.gz: 5f96cf4500b2417bde1c853954dee03a362088adac933fc7d803d8e37e91cc8a
+  data.tar.gz: e6cd271dbfef1c87c04a515b8a22e7ead87ec88ab915b37245d4dcecc7c9a237
 SHA512:
-  metadata.gz: b627994fa66842be8200692895077649837a7b343c337aaf5762926c633de02baf14ba6428cc33b8b3cc0d0314d7d62a4f6cf16173edb09d32ba8218c533d7d6
-  data.tar.gz: 2cd9e7f7003f9ec05120587f50ee892076d8e02045a6b18e9311276792bf831dee6c4434969990b17f4f5898f95040da0614aabbdb5940fa8906f3c507f7f0e8
+  metadata.gz: 68c4083e32e942fd609b050c2001d32b97c18d88ab70301f10ff0ce31527af2c5faff6e210afceaf152280dc2e0924a8edf2e2994e28ad331d2f015860f172f3
+  data.tar.gz: 9af1f38e2a59bda96639d6b6f1d3756b007a8c327392159f6288f2365161a94a211ff483744499771716e8e1d61cd8a57876fbfffcf7646e61db52d1794ab1a3

data/CHANGELOG.md

@@ -1,11 +1,16 @@
 ## Changelog
 
+### 0.9.0
+
+* Added `FmRest::Spyke::Base.set_globals`
+
 ### 0.8.0
 
 * Improved metadata when using `FmRest::Spyke::Model`. Metadata now uses
   Struct/OpenStruct, so properties are accessible through `.property`, as well
   as `[:property]`
-* Implemented `.find_in_batches` and `.find_each` for `FmRest::Spyke::Model`
+* Added batch-finders `.find_in_batches` and `.find_each` for
+* `FmRest::Spyke::Base`
 
 ### 0.7.1
 

data/README.md

@@ -943,6 +943,32 @@ to retrieving single records, in that case you'll have to use
 `.last_request_metadata`.
 
 
+### Setting global field values
+
+You can call `.set_globals` on any `FmRest::Spyke::Base` model to set glabal
+field values on the database that model is configured for.
+
+You can pass it either a hash of fully qualified field names
+(table_name::field_name), or 1-level-deep nested hashes, with the outer being a
+table name and the inner keys being the field names:
+
+```ruby
+Honeybee.set_globals(
+  "beeTable::myVar"      => "value",
+  "beeTable::myOtherVar" => "also a value"
+)
+
+# Equivalent to the above example
+Honeybee.set_globals(beeTable: { myVar: "value", myOtherVar: "also a value" })
+
+# Combined
+Honeybee.set_globals(
+  "beeTable::myVar" => "value",
+  beeTable: { myOtherVar: "also a value" }
+)
+```
+
+
 ## Logging
 
 If using fmrest-ruby + Spyke in a Rails app pretty log output will be set up
@@ -1011,7 +1037,7 @@ FM Data API reference: https://fmhelp.filemaker.com/docs/18/en/dataapi/
 | Get container data                  | Manual*                       | Yes                              |
 | Upload container data               | Manual*                       | Yes                              |
 | Perform a find request              | Manual*                       | Yes                              |
-| Set global field values             | Manual*                       | No                               |
+| Set global field values             | Manual*                       | Yes
 | Run a script                        | Manual*                       | Yes                              |
 | Run a script with another request   | Manual*                       | Yes                              |
 

data/lib/fmrest/spyke/model.rb

@@ -7,6 +7,7 @@ require "fmrest/spyke/model/serialization"
 require "fmrest/spyke/model/associations"
 require "fmrest/spyke/model/orm"
 require "fmrest/spyke/model/container_fields"
+require "fmrest/spyke/model/global_fields"
 require "fmrest/spyke/model/http"
 require "fmrest/spyke/model/auth"
 
@@ -22,6 +23,7 @@ module FmRest
       include Associations
       include Orm
       include ContainerFields
+      include GlobalFields
       include Http
       include Auth
 

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FmRest
+  module Spyke
+    module Model
+      module GlobalFields
+        extend ::ActiveSupport::Concern
+
+        FULLY_QUALIFIED_FIELD_NAME_MATCHER = /\A[^:]+::[^:]+\Z/.freeze
+
+        class_methods do
+          def set_globals(values_hash)
+            connection.patch(FmRest::V1.globals_path, {
+              globalFields: normalize_globals_hash(values_hash)
+            })
+          end
+
+          private
+
+          def normalize_globals_hash(hash)
+            hash.each_with_object({}) do |(k, v), normalized|
+              if v.kind_of?(Hash)
+                v.each do |k2, v2|
+                  normalized["#{k}::#{k2}"] = v2
+                end
+                next
+              end
+
+              unless FULLY_QUALIFIED_FIELD_NAME_MATCHER === k.to_s
+                raise ArgumentError, "global fields must be given in fully qualified format (table name::field name)"
+              end
+
+              normalized[k] = v
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fmrest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FmRest
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-16 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -247,6 +247,7 @@ files:
 - lib/fmrest/spyke/model/auth.rb
 - lib/fmrest/spyke/model/connection.rb
 - lib/fmrest/spyke/model/container_fields.rb
+- lib/fmrest/spyke/model/global_fields.rb
 - lib/fmrest/spyke/model/http.rb
 - lib/fmrest/spyke/model/orm.rb
 - lib/fmrest/spyke/model/serialization.rb