ons-firestore 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffae582656edb80c22028523bd1b307e9878e20450ee25a2bba2924da506eb19
-  data.tar.gz: cdbe8832c4f0a5d49fbf340530b8d1f3211ebf6bf50e49814b8e382ec7433224
+  metadata.gz: 69b4219eca0d252b55957168f6e4aca618dbbad9e1f74aef7817b5a0029c255e
+  data.tar.gz: f1903c35d349d6a9c01b078adbed46fe2c6b72317e579cdebe0d8dde7bae99ff
 SHA512:
-  metadata.gz: fcbc120f1016150d54bff96aee74d5d2d772c807a7d17c6bb8da58f9728d899ef1ff543688c2b96229c1a87c63ff9fb5845100383f444a9970b1d71454378ce3
-  data.tar.gz: 6f408ae0027ca9fc946acfc006081a5b018f837e0f8a5ada236d4d0f8aa826ef46fb2ed2bcdc712b960e6ea72a9fe22625d581968f95f6da5f4bc7b717609945
+  metadata.gz: bfc82c60dec246a70e691192d71956d4e7fd4fbbe024fa21b62da45ecdbf48bc6f15c0a54b93c4ce543f5ead701bd76c22a968d0ca4782385c8f91c5fde09b2c
+  data.tar.gz: 4801011c5534fdfcdc9d31e1d27560d98e66982fc7f030a4fbebd16fe4a7d6c72e67d60fffd14fc11a98aaa0b23c1b94da9652e52e801ed16d4cd75e4440bce0

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

data/lib/ons-firestore/version.rb

@@ -3,7 +3,7 @@
 module ONSFirestore
   module Version
     MAJOR = 1
-    MINOR = 2
+    MINOR = 3
     TINY  = 1
   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.1
+  version: 1.3.1
 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.