ons-firestore 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1409410ed2eeda669760d9de820c52475fdc0430dc2ca073830587102d8cb23
-  data.tar.gz: 956e2ad87753f9a8e13dca996ad3d1f3be3362689e993ac077c7d5865b34e413
+  metadata.gz: 4e6104269a49789359ba927ce1673d9e25b19afdd48caab6ae01f6ca4d99b757
+  data.tar.gz: 573ed986f15a3007c20d5196c67f590d34c260f68b0a3ff2314621eddf1e8a21
 SHA512:
-  metadata.gz: b9f264f04c6e0f64ef1befda1294236a2153aa64f4862d63c0d4addfca5ac0931a4358c37f707a7786388616849a29e56970523bcd831938087f58add0eb5409
-  data.tar.gz: 11e1f4f2512587bc54de61647cae2e007f1cbac20b0cbd7f50bddb32a19b265de464ce2e1e90bbd1eddf5dd0d620d406aede404052f2df8b1629deabe6fe9694
+  metadata.gz: 01cce206bdc4f36f909304aef53704b0d51e6f6ba7dcb77af2d6f90d8adb4773dcf38c11893555da99c2f2fa2aad7cb3001fb012c409d6a4f053a51d9efe8712
+  data.tar.gz: 6e85af05d6baa2d6b364c743cda54c2027dd717af567baafb0f3df1350fa70817b9ee011b50eb44a05cfee6a892a08356e22730634894b0b679b65de5886ce03

data/lib/ons-firestore/firestore.rb

@@ -44,6 +44,24 @@ class Firestore
     @client.col(collection_name).doc(document_name)
   end
 
+  # Reads the +updated+ key within a Firestore document.
+  #
+  # @param collection_name [String] the name of the Firestore collection containing the document
+  # @param document_name [String] the name of the Firestore document
+  # @return [Object] document updated timestamp
+  # @raise [ArgumentError] if collection_name or document_name are nil
+  # @raise [FirestoreError] if the +updated+ key isn't present within the Firestore document
+  def document_updated(collection_name, document_name)
+    raise ArgumentError.new('collection_name cannot be nil') if collection_name.nil?
+    raise ArgumentError.new('document_name cannot be nil') if document_name.nil?
+
+    document = @client.col(collection_name).doc(document_name)
+    snapshot = document.get
+    raise FirestoreError, 'updated key is missing' if snapshot.updated.nil?
+
+    snapshot[:updated]
+  end
+
   # Reads the +data+ key within a Firestore document.
   #
   # @param collection_name [String] the name of the Firestore collection containing the document
@@ -57,7 +75,7 @@ class Firestore
 
     document = @client.col(collection_name).doc(document_name)
     snapshot = document.get
-    raise FirestoreError('data key is missing') if snapshot.data.nil?
+    raise FirestoreError, 'data key is missing' if snapshot.data.nil?
 
     snapshot[:data]
   end
@@ -92,7 +110,7 @@ class Firestore
     begin
       document.set({ data: hash_data, updated: Time.now.strftime(DATE_TIME_FORMAT) })
     rescue StandardError => e
-      raise FirestoreError("Failed to save Firestore document #{document_name} in collection #{collection_name}: #{e.message}")
+      raise FirestoreError, "Failed to save Firestore document #{document_name} in collection #{collection_name}: #{e.message}"
     end
   end
 end

data/lib/ons-firestore/version.rb

@@ -3,7 +3,7 @@
 module ONSFirestore
   module Version
     MAJOR = 1
-    MINOR = 2
+    MINOR = 3
     TINY  = 0
   end
   VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].compact * '.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ons-firestore
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - John Topley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: Opinionated Google Firestore abstraction.