ons-firestore 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c03f48298f3f5b0bd96a5f30547076852959de3f6f4980d39ebf2cc580fbe68
-  data.tar.gz: 8af0d18d60cf314bf93f53f8647655b7482f472a338480078cedf55362dc22b2
+  metadata.gz: b1409410ed2eeda669760d9de820c52475fdc0430dc2ca073830587102d8cb23
+  data.tar.gz: 956e2ad87753f9a8e13dca996ad3d1f3be3362689e993ac077c7d5865b34e413
 SHA512:
-  metadata.gz: 3a6a540662de8767427f296d377e08b3ca359a30751f5047fdb076147bb8b050f22ec70b7aecbdf665fb45df33553bbf48d489b6cc04ffcfaa2c3243b767d027
-  data.tar.gz: d0fc5a3f590acb665517dd02e7927d66b40192e82ef0656dcaf468e82a1e2bd99b6faa521d87741b7b7d7f2c8a5931fa442b6705e2f2e2537d9452b097c3f115
+  metadata.gz: b9f264f04c6e0f64ef1befda1294236a2153aa64f4862d63c0d4addfca5ac0931a4358c37f707a7786388616849a29e56970523bcd831938087f58add0eb5409
+  data.tar.gz: 11e1f4f2512587bc54de61647cae2e007f1cbac20b0cbd7f50bddb32a19b265de464ce2e1e90bbd1eddf5dd0d620d406aede404052f2df8b1629deabe6fe9694

data/lib/ons-firestore/firestore.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'google/cloud/firestore'
-require 'logger'
+
+require_relative 'firestore_error'
 
 # Class to manage access to Firestore.
 class Firestore
@@ -49,12 +50,15 @@ class Firestore
   # @param document_name [String] the name of the Firestore document
   # @return [Object] document data
   # @raise [ArgumentError] if collection_name or document_name are nil
+  # @raise [FirestoreError] if the +data+ key isn't present within the Firestore document
   def read_document(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('data key is missing') if snapshot.data.nil?
+
     snapshot[:data]
   end
 
@@ -67,6 +71,7 @@ class Firestore
   # @param document_name [String] the name of the Firestore document
   # @param data [Object] data to save to the Firestore document
   # @raise [ArgumentError] if collection_name or document_name are nil
+  # @raise [FirestoreError] if an error occurred whilst saving the document
   def save_document(collection_name, document_name, data)
     raise ArgumentError.new('collection_name cannot be nil') if collection_name.nil?
     raise ArgumentError.new('document_name cannot be nil') if document_name.nil?
@@ -87,9 +92,7 @@ class Firestore
     begin
       document.set({ data: hash_data, updated: Time.now.strftime(DATE_TIME_FORMAT) })
     rescue StandardError => e
-      logger = Logger.new($stderr)
-      logger.error("Failed to save Firestore document #{document_name} in collection #{collection_name}: #{e.message}")
-      logger.error(e.backtrace.join("\n"))
+      raise FirestoreError("Failed to save Firestore document #{document_name} in collection #{collection_name}: #{e.message}")
     end
   end
 end

data/lib/ons-firestore/firestore_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Class representing an error that occurred whilst reading or writing Firestore data.
+class FirestoreError < StandardError
+end

data/lib/ons-firestore/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ons-firestore
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - John Topley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore
@@ -78,6 +78,7 @@ files:
 - README.md
 - lib/ons-firestore.rb
 - lib/ons-firestore/firestore.rb
+- lib/ons-firestore/firestore_error.rb
 - lib/ons-firestore/version.rb
 homepage: https://github.com/ONSdigital/ons-firestore
 licenses: