ons-firestore 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0077852086ffe77e35e89820a68feae7bc2711f74f0727dca47587344c8d0a41'
-  data.tar.gz: 3fa7333f538ac6f6ed5038d8c6190a02473c7f451ca2dfe04b4e5d151ec27ceb
+  metadata.gz: b1409410ed2eeda669760d9de820c52475fdc0430dc2ca073830587102d8cb23
+  data.tar.gz: 956e2ad87753f9a8e13dca996ad3d1f3be3362689e993ac077c7d5865b34e413
 SHA512:
-  metadata.gz: f01fb9331db325667ac3e60f6e1a9310f05cc3fdd0025462913bfc5c328191fefc1deb5b2de921aacb48377ade65cb090af4ac622b493b14c5a8df49d74bcedf
-  data.tar.gz: cf2ca0fb7c3fd1093c56d12388174e726133d1e8df59fe8da319d97e18d1cd089c6aaba7e31ed8eee17591d960aaa7f84bdd16f9825106c3de8a69dee80791cb
+  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
@@ -22,7 +23,7 @@ class Firestore
   # Returns all Firestore documents within a collection.
   #
   # @param collection_name [String] the name of the Firestore collection containing the documents
-  # @return [Enumberator] list of documents within the collection
+  # @return [Enumerator] list of documents within the collection
   # @raise [ArgumentError] if collection_name is nil
   def all_documents(collection_name)
     raise ArgumentError.new('collection_name cannot be nil') if collection_name.nil?
@@ -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  = 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.1.0
+  version: 1.2.0
 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: