ons-firestore 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7071e0cea0d0adb25db556b56c07e5e3db7373efb6568d80fa86ad3de7f0553a
-  data.tar.gz: fa2f124217f08065cbeec384fa2d2c896c4b6c935dde744861a3b03d10e77019
+  metadata.gz: ffae582656edb80c22028523bd1b307e9878e20450ee25a2bba2924da506eb19
+  data.tar.gz: cdbe8832c4f0a5d49fbf340530b8d1f3211ebf6bf50e49814b8e382ec7433224
 SHA512:
-  metadata.gz: 5d67f09a82059d39cd90ef7e5b153562d68e71e27f1b379748bb139bd498c58f4ea4c548b4f5132a44ea666e7ef4f7f19ba356fe65d55b9937a8e8b3601266fa
-  data.tar.gz: 7098b9941d613ca972ca4078987e306b7d7ad2d01a2d1a9a4b821e0efa88a40da0f664103caaa41713875c788cfb2c059cd9be20b6a136190c2a277a23e590c2
+  metadata.gz: fcbc120f1016150d54bff96aee74d5d2d772c807a7d17c6bb8da58f9728d899ef1ff543688c2b96229c1a87c63ff9fb5845100383f444a9970b1d71454378ce3
+  data.tar.gz: 6f408ae0027ca9fc946acfc006081a5b018f837e0f8a5ada236d4d0f8aa826ef46fb2ed2bcdc712b960e6ea72a9fe22625d581968f95f6da5f4bc7b717609945

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?
@@ -80,17 +85,14 @@ class Firestore
     if data.is_a?(Hash)
       hash_data = {}
       data.each do |key, value|
-        hash_data[key] = value if value.is_a?(Array)
-        hash_data[key] = value.map(&:to_h) unless value.is_a?(Array)
+        hash_data[key] = value.class.method_defined?(:to_h) ? value.map(&:to_h) : value
       end
     end
 
     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,7 +3,7 @@
 module ONSFirestore
   module Version
     MAJOR = 1
-    MINOR = 1
+    MINOR = 2
     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.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - John Topley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-03 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: