google-cloud-firestore 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c376cdc37ee4df6dda7cd41213f01a8662279cef89bd9a0bac780c68d470ccf1
-  data.tar.gz: 45b1405ee2ea98bd26a2220fbfc0c5018e95d4b5e9bd828474c65ccfaa74a7db
+  metadata.gz: 3a0e9fff59882f2965b8f56086b8627ec80d55275535bd889aa5a87c7c0877ff
+  data.tar.gz: d9e8f986e2fd220cd68179e6c2cd1e3c3795dcd2f45ba6a8c050d255f01bd99f
 SHA512:
-  metadata.gz: 894292d1be7d5175b880fd986a4ac5d7ff06a541b3f80fef4994242707d71680d7776b7be1f18892c9978ad3a89ba66a85cbda43a52f90ba032278722b8c981e
-  data.tar.gz: a45b97170718f6e751c2593f5e00cdcaab7bd19ae1d12bb371e0030ff33eaf5d4e590bda05bc9431e5273f9f62320db44a8fd7dd954bad31c4d467c146aa3be6
+  metadata.gz: 478dc298a9f6fd09b99c297e84c30e615ab7fe1e9ac6b5fa1b9f6eeb5c427719f96714cb3fc0ecb53bfe230c15b80a6b11a885692028bfdff3ed56b4acec49c9
+  data.tar.gz: 002bd881ad0a3bbe61ed09e69b3395577a63c1e1a8af8584256dc974d609108b047a8de3f2bd08dcd3dba263be48ae9cb31f30f1294d13cb0cf050cbd1970f62

data/README.md

@@ -18,6 +18,17 @@ steps:
 $ gem install google-cloud-firestore
 ```
 
+### Supported Ruby Versions
+
+This library is supported on Ruby 2.0+.
+
+However, Ruby 2.3 or later is strongly recommended, as earlier releases have
+reached or are nearing end-of-life. After June 1, 2018, Google will provide
+official support only for Ruby versions that are considered current and
+supported by Ruby Core (that is, Ruby versions that are either in normal
+maintenance or in security maintenance).
+See https://www.ruby-lang.org/en/downloads/branches/ for further details.
+
 ### Next Steps
 - Read the [Client Library Documentation][] for Google Cloud Firestore API
   to see other available methods on the client.

data/lib/google/cloud/firestore.rb

@@ -212,9 +212,7 @@ module Google
     #
     # user_snap = firestore.doc("users/frank").get
     #
-    # nested_field_path = Google::Cloud::Firestore::FieldPath.new(
-    #   :favorites, :food
-    # )
+    # nested_field_path = firestore.field_path :favorites, :food
     # user_snap.get(nested_field_path) #=> "Pizza"
     # ```
     #
@@ -355,10 +353,8 @@ module Google
     #
     # user_ref = firestore.doc "users/frank"
     #
-    # nested_field_path = Google::Cloud::Firestore::FieldPath.new(
-    #   :favorites, :food
-    # )
-    # user_ref.update({ nested_field_path: "Pasta" })
+    # nested_field_path = firestore.field_path :favorites, :food
+    # user_ref.update({ nested_field_path => "Pasta" })
     # ```
     #
     # ## Using transactions and batched writes

data/lib/google/cloud/firestore/batch.rb

@@ -257,12 +257,10 @@ module Google
         #
         #   firestore = Google::Cloud::Firestore.new
         #
-        #   nested_field_path = Google::Cloud::Firestore::FieldPath.new(
-        #     :favorites, :food
-        #   )
+        #   nested_field_path = firestore.field_path :favorites, :food
         #
         #   firestore.batch do |b|
-        #     b.update("users/frank", { nested_field_path: "Pasta" })
+        #     b.update("users/frank", { nested_field_path => "Pasta" })
         #   end
         #
         # @example Update a document using a document reference:

data/lib/google/cloud/firestore/client.rb

@@ -170,9 +170,9 @@ module Google
         ##
         # Retrieves a list of document snapshots.
         #
-        # @param [String, DocumentReference] docs One or more strings
-        #   representing the path of the document, or document reference
-        #   objects.
+        # @param [String, DocumentReference, Array<String|DocumentReference>]
+        #   docs One or more strings representing the path of the document, or
+        #   document reference objects.
         #
         # @yield [documents] The block for accessing the document snapshots.
         # @yieldparam [DocumentSnapshot] document A document snapshot.
@@ -238,10 +238,14 @@ module Google
         end
 
         ##
-        # Creates a field path object representing the nested fields for
+        # Creates a field path object representing a nested field for
         # document data.
         #
-        # @return [Array<String>] The fields.
+        # @param [String, Symbol, Array<String|Symbol>] fields One or more
+        #   strings representing the path of the data to select. Each field must
+        #   be provided separately.
+        #
+        # @return [FieldPath] The field path object.
         #
         # @example
         #   require "google/cloud/firestore"

data/lib/google/cloud/firestore/collection_reference.rb

@@ -128,13 +128,13 @@ module Google
 
         ##
         # The document reference or database the collection reference belongs
-        # to. If the collection is a root collection, it will return the
-        # database object. If the collection is nested under a document, it
-        # will return the document reference object.
+        # to. If the collection is a root collection, it will return the client
+        # object. If the collection is nested under a document, it will return
+        # the document reference object.
         #
-        # @return [Database, DocumentReference] parent object.
+        # @return [Client, DocumentReference] parent object.
         #
-        # @example Returns database object for root collections:
+        # @example Returns client object for root collections:
         #   require "google/cloud/firestore"
         #
         #   firestore = Google::Cloud::Firestore.new

data/lib/google/cloud/firestore/document_reference.rb

@@ -323,10 +323,8 @@ module Google
         #
         #   user_ref = firestore.doc "users/frank"
         #
-        #   nested_field_path = Google::Cloud::Firestore::FieldPath.new(
-        #     :favorites, :food
-        #   )
-        #   user_ref.update({ nested_field_path: "Pasta" })
+        #   nested_field_path = firestore.field_path :favorites, :food
+        #   user_ref.update({ nested_field_path => "Pasta" })
         #
         # @example Update a document using the `update_time` precondition:
         #   require "google/cloud/firestore"

data/lib/google/cloud/firestore/field_path.rb

@@ -42,6 +42,10 @@ module Google
         # Creates a field path object representing a nested field for
         # document data.
         #
+        # @param [String, Symbol, Array<String|Symbol>] fields One or more
+        #   strings representing the path of the data to select. Each field must
+        #   be provided separately.
+        #
         # @return [FieldPath] The field path object.
         #
         # @example

data/lib/google/cloud/firestore/query.rb

@@ -57,9 +57,9 @@ module Google
         # Restricts documents matching the query to return only data for the
         # provided fields.
         #
-        # @param [FieldPath, String, Symbol] fields A field path to
-        #   filter results with and return only the specified fields. One or
-        #   more field paths can be specified.
+        # @param [FieldPath, String, Symbol, Array<FieldPath|String|Symbol>]
+        #   fields A field path to filter results with and return only the
+        #   specified fields. One or more field paths can be specified.
         #
         #   If a {FieldPath} object is not provided then the field will be
         #   treated as a dotted string, meaning the string represents individual
@@ -365,7 +365,8 @@ module Google
         # Values provided to `start_at` without an associated field path
         # provided to `order` will result in an error.
         #
-        # @param [Object] values The field value to start the query at.
+        # @param [Object, Array<Object>] values The field value to start the
+        #   query at.
         #
         # @return [Query] New query with `start_at` called on it.
         #
@@ -407,7 +408,8 @@ module Google
         # Values provided to `start_after` without an associated field path
         # provided to `order` will result in an error.
         #
-        # @param [Object] values The field value to start the query after.
+        # @param [Object, Array<Object>] values The field value to start the
+        #   query after.
         #
         # @return [Query] New query with `start_after` called on it.
         #
@@ -449,7 +451,8 @@ module Google
         # Values provided to `end_before` without an associated field path
         # provided to `order` will result in an error.
         #
-        # @param [Object] values The field value to end the query before.
+        # @param [Object, Array<Object>] values The field value to end the query
+        #   before.
         #
         # @return [Query] New query with `end_before` called on it.
         #
@@ -491,7 +494,8 @@ module Google
         # Values provided to `end_at` without an associated field path provided
         # to `order` will result in an error.
         #
-        # @param [Object] values The field value to end the query at.
+        # @param [Object, Array<Object>] values The field value to end the query
+        #   at.
         #
         # @return [Query] New query with `end_at` called on it.
         #
@@ -526,9 +530,9 @@ module Google
         # Retrieves document snapshots for the query.
         #
         # @yield [documents] The block for accessing the document snapshots.
-        # @yieldparam [DocumentReference] document A document snapshot.
+        # @yieldparam [DocumentSnapshot] document A document snapshot.
         #
-        # @return [Enumerator<DocumentReference>] A list of document snapshots.
+        # @return [Enumerator<DocumentSnapshot>] A list of document snapshots.
         #
         # @example
         #   require "google/cloud/firestore"
@@ -553,7 +557,7 @@ module Google
           results = service.run_query parent_path, @query
           results.each do |result|
             next if result.document.nil?
-            yield DocumentSnapshot.from_query_result(result, self)
+            yield DocumentSnapshot.from_query_result(result, client)
           end
         end
         alias run get

data/lib/google/cloud/firestore/transaction.rb

@@ -81,9 +81,9 @@ module Google
         ##
         # Retrieves a list of document snapshots.
         #
-        # @param [String, DocumentReference] docs One or more strings
-        #   representing the path of the document, or document reference
-        #   objects.
+        # @param [String, DocumentReference, Array<String|DocumentReference>]
+        #   docs One or more strings representing the path of the document, or
+        #   document reference objects.
         #
         # @yield [documents] The block for accessing the document snapshots.
         # @yieldparam [DocumentSnapshot] document A document snapshot.
@@ -117,7 +117,7 @@ module Google
           results.each do |result|
             extract_transaction_from_result! result
             next if result.result.nil?
-            yield DocumentSnapshot.from_batch_result(result, self)
+            yield DocumentSnapshot.from_batch_result(result, client)
           end
         end
         alias get_docs get_all
@@ -136,12 +136,12 @@ module Google
         #   to run.
         #
         # @yield [documents] The block for accessing the document snapshots.
-        # @yieldparam [DocumentReference] document A document snapshot.
+        # @yieldparam [DocumentSnapshot] document A document snapshot.
         #
-        # @return [DocumentReference, Enumerator<DocumentReference>] A
-        #   single document snapshot when passed a document path a document
-        #   reference, or a list of document snapshots when passed other valid
-        #   values.
+        # @return [DocumentSnapshot, Enumerator<DocumentSnapshot>] A
+        #   single document snapshot when passed a document path or a document
+        #   reference object, or a list of document snapshots when passed other
+        #   valid values.
         #
         # @example Get a document snapshot given a document path:
         #   require "google/cloud/firestore"
@@ -230,7 +230,7 @@ module Google
           results.each do |result|
             extract_transaction_from_result! result
             next if result.document.nil?
-            yield DocumentSnapshot.from_query_result(result, self)
+            yield DocumentSnapshot.from_query_result(result, client)
           end
         end
         alias run get
@@ -427,12 +427,10 @@ module Google
         #
         #   firestore = Google::Cloud::Firestore.new
         #
-        #   nested_field_path = Google::Cloud::Firestore::FieldPath.new(
-        #     :favorites, :food
-        #   )
+        #   nested_field_path = firestore.field_path :favorites, :food
         #
         #   firestore.transaction do |tx|
-        #     tx.update("users/frank", { nested_field_path: "Pasta" })
+        #     tx.update("users/frank", { nested_field_path => "Pasta" })
         #   end
         #
         # @example Update a document using a document reference:

data/lib/google/cloud/firestore/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Firestore
-      VERSION = "0.21.0".freeze
+      VERSION = "0.21.1".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -244,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Firestore API