ons-firestore 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfcc9c616b8d8e3309c90dcd33395a620ccdd4d51a88b0fdfe817df3f5559a9e
-  data.tar.gz: 25695e1400af224f5ac2e690c1330d55939bdac2bda22bdf37705e8b396e9e83
+  metadata.gz: 7071e0cea0d0adb25db556b56c07e5e3db7373efb6568d80fa86ad3de7f0553a
+  data.tar.gz: fa2f124217f08065cbeec384fa2d2c896c4b6c935dde744861a3b03d10e77019
 SHA512:
-  metadata.gz: 73943d0336742113d2b666b3efcf8e4a2af6690bc4810f4f7e3c11b2cc00c0e79a89db08aae1cf4f61a094a689ab80c31fe6dfe6da1201811c6f69d4e18c4507
-  data.tar.gz: 86c4ef0555351bd5c86e1621f4eec4024dcb43fd628f6621c376f5bae9aeb2ed3032e650f997f5d758c614e6d8eec67c8f7eadfa9c9213494a8c90178730c46c
+  metadata.gz: 5d67f09a82059d39cd90ef7e5b153562d68e71e27f1b379748bb139bd498c58f4ea4c548b4f5132a44ea666e7ef4f7f19ba356fe65d55b9937a8e8b3601266fa
+  data.tar.gz: 7098b9941d613ca972ca4078987e306b7d7ad2d01a2d1a9a4b821e0efa88a40da0f664103caaa41713875c788cfb2c059cd9be20b6a136190c2a277a23e590c2

data/lib/ons-firestore/firestore.rb

@@ -10,10 +10,8 @@ class Firestore
 
   # Constructor that initialises the Firestore client.
   #
-  # Params:
-  # - project_id: The ID of the GCP project containing the Firestore database.
-  #
-  # An Argument error is raised if project_id is nil.
+  # @param project_id [String] the ID of the GCP project containing the Firestore database
+  # @raise [ArgumentError] if project_id is nil
   def initialize(project_id)
     raise ArgumentError.new('project_id cannot be nil') if project_id.nil?
 
@@ -21,13 +19,36 @@ class Firestore
     @client = Google::Cloud::Firestore.new
   end
 
-  # Reads a Firestore document.
+  # Returns all Firestore documents within a collection.
+  #
+  # @param collection_name [String] the name of the Firestore collection containing the documents
+  # @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?
+
+    @client.col(collection_name).list_documents.all
+  end
+
+  # Returns a reference to a Firestore document.
   #
-  # Params:
-  # - collection_name: The name of the Firestore collection containing the document.
-  # - document_name: The name of the 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 [Google::Cloud::Firestore::DocumentReference] reference to the document
+  # @raise [ArgumentError] if collection_name or document_name are nil
+  def document_reference(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?
+
+    @client.col(collection_name).doc(document_name)
+  end
+
+  # Reads the +data+ key within a Firestore document.
   #
-  # An Argument error is raised if collection_name or document_name are nil.
+  # @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 data
+  # @raise [ArgumentError] if collection_name or document_name are nil
   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?
@@ -42,12 +63,10 @@ class Firestore
   # The passed data are saved under a +data+ key within the document.
   # A timestamp at which the operation occurred is saved under the +updated+ key within the document.
   #
-  # Params:
-  # - collection_name: The name of the Firestore collection containing the document.
-  # - document_name: The name of the Firestore document.
-  # - data: Data to save to the Firestore document.
-  #
-  # An Argument error is raised if collection_name or document_name are nil.
+  # @param collection_name [String] the name of the Firestore collection containing the document
+  # @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
   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?
@@ -61,7 +80,8 @@ class Firestore
     if data.is_a?(Hash)
       hash_data = {}
       data.each do |key, value|
-        hash_data[key] = value.respond_to?(:to_h) ? value.map(&:to_h) : value
+        hash_data[key] = value if value.is_a?(Array)
+        hash_data[key] = value.map(&:to_h) unless value.is_a?(Array)
       end
     end
 

data/lib/ons-firestore/version.rb

@@ -3,7 +3,7 @@
 module ONSFirestore
   module Version
     MAJOR = 1
-    MINOR = 0
+    MINOR = 1
     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.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - John Topley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore