ons-firestore 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f758241e0412f8c0b4c72776352c753dd44cea5bcca617bd80efb90baa12829
-  data.tar.gz: ada12ed5b8d5d1d4ece7cf7812d839dba8f6e55fe592e7ac97e6d00a443565ef
+  metadata.gz: '0077852086ffe77e35e89820a68feae7bc2711f74f0727dca47587344c8d0a41'
+  data.tar.gz: 3fa7333f538ac6f6ed5038d8c6190a02473c7f451ca2dfe04b4e5d151ec27ceb
 SHA512:
-  metadata.gz: 0f7c7171137c9bc2c6dc8ddf9b96f2ece25c77c3a7cb17031f9a763ac0fea9b41bc797bc3612f884cb5f30513b8a84b01ec69fbe16f9621e9df557e7c7b854fb
-  data.tar.gz: e37cf44ff5a87a260d98f045a04624eaac0cb441ac910472538d2f36716cab74ea3ad0484511901f2ad688a0a2f703a3f068914939334250250ff4aa6e9e9c15
+  metadata.gz: f01fb9331db325667ac3e60f6e1a9310f05cc3fdd0025462913bfc5c328191fefc1deb5b2de921aacb48377ade65cb090af4ac622b493b14c5a8df49d74bcedf
+  data.tar.gz: cf2ca0fb7c3fd1093c56d12388174e726133d1e8df59fe8da319d97e18d1cd089c6aaba7e31ed8eee17591d960aaa7f84bdd16f9825106c3de8a69dee80791cb

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 [Enumberator] 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?

data/lib/ons-firestore/version.rb

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