google-cloud-firestore 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 827e034858a868b3f10ad1aa997efd49ae602d56a57d16cbc12fa57cd6d69f1c
-  data.tar.gz: 3a7e878306128346310111ec5c99ca008b48cb030c44096f7a86c1d9b99da6fc
+  metadata.gz: ec9d1913fdc1c6817571acb97d791e1f452b7a774b8958d0affe0d80d61a3aa7
+  data.tar.gz: 139129578cb7616d7f3f1b4e8ffc0991913f57982c3c9e66e8b190b5166a0d02
 SHA512:
-  metadata.gz: 2bee3a7931f0dedec0666925e3e8e1485cd9c2865cc6a2d5909dba2121a15590f4282baa61190829d888610e289c33ef3d60421a19378cdd1019773a9d9bce86
-  data.tar.gz: afad9e59107345669f0918e6f28faf2fd5baefc01e445111e9e01abb6d19278e10789a7cff21930125f6229a5e03886c32bf63b8a8e17d70e1ac70b58917400c
+  metadata.gz: 28805388905373117c1ddb97e176d4e98bb45312ab6e5d2097ffe6dd96af9d6cef799496f3dedf5322f6b712c53091c51fd2e0365120d3c97ccfe2e01fdbe974
+  data.tar.gz: fe2f0cb02869d789fe5ee18336c3486f099662452ad4ad78676cbe3d7488feb46ef84b162c02508b07352dd785b2c6f0e5672af603dfcd060b62eb4f424b8f9f

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 0.26.0 / 2019-06-13
+
+BREAKING CHANGE: The default return value of Client#transaction has been
+changed to the return value of the yielded block. Pass commit_response: true
+for the previous default behavior of returning the CommitResponse.
+
+* Add commit_response to Client#transaction
+* Add Collection Group queries
+* Add CollectionReference#list_documents
+* Enable grpc.service_config_disable_resolution
+* Use VERSION constant in GAPIC client
+
 ### 0.25.1 / 2019-04-29
 
 * Add AUTHENTICATION.md guide.

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

@@ -139,6 +139,46 @@ module Google
         end
         alias collection col
 
+        ##
+        # Creates and returns a new Query that includes all documents in the
+        # database that are contained in a collection or subcollection with the
+        # given collection_id.
+        #
+        # @param [String] collection_id Identifies the collections to query
+        #   over. Every collection or subcollection with this ID as the last
+        #   segment of its path will be included. Cannot contain a slash (`/`).
+        #
+        # @return [Query] The created Query.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Get the cities collection group query
+        #   query = firestore.col_group "cities"
+        #
+        #   query.get do |city|
+        #     puts "#{city.document_id} has #{city[:population]} residents."
+        #   end
+        #
+        def col_group collection_id
+          if collection_id.include? "/"
+            raise ArgumentError, "Invalid collection_id: '#{collection_id}', " \
+              "must not contain '/'."
+          end
+          query = Google::Firestore::V1::StructuredQuery.new(
+            from: [
+              Google::Firestore::V1::StructuredQuery::CollectionSelector.new(
+                collection_id: collection_id, all_descendants: true
+              )
+            ]
+          )
+
+          Query.start query, service.documents_path, self
+        end
+        alias collection_group col_group
+
         ##
         # Retrieves a document reference.
         #
@@ -555,12 +595,19 @@ module Google
         #
         # @param [Integer] max_retries The maximum number of retries for
         #   transactions failed due to errors. Default is 5. Optional.
+        # @param [Boolean] commit_response When `true`, the return value from
+        #   this method will be a `Google::Cloud::Firestore::CommitResponse`
+        #   object with a `commit_time` attribute. Otherwise, the return
+        #   value from this method will be the return value of the provided
+        #   yield block. Default is `false`. Optional.
         #
         # @yield [transaction] The block for reading data and making changes.
         # @yieldparam [Transaction] transaction The transaction object for
         #   making changes.
         #
-        # @return [CommitResponse] The response from committing the changes.
+        # @return [Object, CommitResponse] The return value of the provided
+        #   yield block, or if `commit_response` is provided and true, the
+        #   `CommitResponse` object from the commit operation.
         #
         # @example
         #   require "google/cloud/firestore"
@@ -578,14 +625,16 @@ module Google
         #     tx.delete("cities/LA")
         #   end
         #
-        def transaction max_retries: nil
+        def transaction max_retries: nil, commit_response: nil
           max_retries = 5 unless max_retries.is_a? Integer
           backoff = { current: 0, delay: 1.0, max: max_retries, mod: 1.3 }
 
           transaction = Transaction.from_client self
           begin
-            yield transaction
-            transaction.commit
+            transaction_return = yield transaction
+            commit_return = transaction.commit
+            # Conditional return value, depending on truthy commit_response
+            commit_response ? commit_return : transaction_return
           rescue Google::Cloud::UnavailableError => err
             # Re-raise if retried more than the max
             raise err if backoff[:current] > backoff[:max]
@@ -618,6 +667,14 @@ module Google
 
         # @!endgroup
 
+        # @private
+        def list_documents parent, collection_id, token: nil, max: nil
+          ensure_service!
+          grpc = service.list_documents \
+            parent, collection_id, token: token, max: max
+          DocumentReference::List.from_grpc grpc, service, parent, collection_id
+        end
+
         protected
 
         ##

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

@@ -25,7 +25,7 @@ module Google
       ##
       # # CollectionReference
       #
-      # A collection reference object ise used for adding documents, getting
+      # A collection reference object is used for adding documents, getting
       # document references, and querying for documents (See {Query}).
       #
       # @example
@@ -126,6 +126,39 @@ module Google
         end
         alias document doc
 
+        ##
+        # Retrieves a list of document references for the documents in this
+        # collection.
+        #
+        # The document references returned may include references to "missing
+        # documents", i.e. document locations that have no document present but
+        # which contain subcollections with documents. Attempting to read such a
+        # document reference (e.g. via {DocumentReference#get}) will return
+        # a {DocumentSnapshot} whose `exists?` method returns false.
+        #
+        # @param [String] token A previously-returned page token representing
+        #   part of the larger set of results to view.
+        # @param [Integer] max Maximum number of results to return.
+        #
+        # @return [Array<DocumentReference>] An array of document references.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   col = firestore.col "cities"
+        #
+        #   col.list_documents.each do |doc_ref|
+        #     puts doc_ref.document_id
+        #   end
+        #
+        def list_documents token: nil, max: nil
+          ensure_client!
+          client.list_documents \
+            parent_path, collection_id, token: token, max: max
+        end
+
         ##
         # The document reference or database the collection reference belongs
         # to. If the collection is a root collection, it will return the client

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

@@ -0,0 +1,191 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "delegate"
+
+module Google
+  module Cloud
+    module Firestore
+      class DocumentReference
+        ##
+        # DocumentReference::List is a special case Array with additional
+        # values.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   col = firestore.col "cities"
+        #
+        #   doc_refs = col.list_documents
+        #
+        #   doc_refs.each do |doc_ref|
+        #     puts doc_ref.document_id
+        #   end
+        #
+        class List < DelegateClass(::Array)
+          ##
+          # If not empty, indicates that there are more records that match
+          # the request and this value should be passed to continue.
+          attr_accessor :token
+
+          ##
+          # @private Create a new DocumentReference::List with an array of
+          # DocumentReference instances.
+          def initialize arr = []
+            super arr
+          end
+
+          ##
+          # Whether there is a next page of document references.
+          #
+          # @return [Boolean]
+          #
+          # @example
+          #   require "google/cloud/firestore"
+          #
+          #   firestore = Google::Cloud::Firestore.new
+          #   col = firestore.col "cities"
+          #
+          #   doc_refs = col.list_documents
+          #   if doc_refs.next?
+          #     next_documents = doc_refs.next
+          #   end
+          def next?
+            !token.nil?
+          end
+
+          ##
+          # Retrieve the next page of document references.
+          #
+          # @return [DocumentReference::List]
+          #
+          # @example
+          #   require "google/cloud/firestore"
+          #
+          #   firestore = Google::Cloud::Firestore.new
+          #   col = firestore.col "cities"
+          #
+          #   doc_refs = col.list_documents
+          #   if doc_refs.next?
+          #     next_documents = doc_refs.next
+          #   end
+          def next
+            return nil unless next?
+            ensure_service!
+            options = { token: token, max: @max }
+            grpc = @service.list_documents @parent, @collection_id, options
+            self.class.from_grpc grpc, @service, @parent, @collection_id, @max
+          end
+
+          ##
+          # Retrieves remaining results by repeatedly invoking {#next} until
+          # {#next?} returns `false`. Calls the given block once for each
+          # result, which is passed as the argument to the block.
+          #
+          # An Enumerator is returned if no block is given.
+          #
+          # This method will make repeated API calls until all remaining results
+          # are retrieved. (Unlike `#each`, for example, which merely iterates
+          # over the results returned by a single API call.) Use with caution.
+          #
+          # @param [Integer] request_limit The upper limit of API requests to
+          #   make to load all document references. Default is no limit.
+          # @yield [document] The block for accessing each document.
+          # @yieldparam [DocumentReference] document The document reference
+          #   object.
+          #
+          # @return [Enumerator]
+          #
+          # @example Iterating each document reference by passing a block:
+          #   require "google/cloud/firestore"
+          #
+          #   firestore = Google::Cloud::Firestore.new
+          #   col = firestore.col "cities"
+          #
+          #   doc_refs = col.list_documents
+          #   doc_refs.all do |doc_ref|
+          #     puts doc_ref.document_id
+          #   end
+          #
+          # @example Using the enumerator by not passing a block:
+          #   require "google/cloud/firestore"
+          #
+          #   firestore = Google::Cloud::Firestore.new
+          #   col = firestore.col "cities"
+          #
+          #   doc_refs = col.list_documents
+          #   all_document_ids = doc_refs.all.map do |doc_ref|
+          #     doc_ref.document_id
+          #   end
+          #
+          # @example Limit the number of API calls made:
+          #   require "google/cloud/firestore"
+          #
+          #   firestore = Google::Cloud::Firestore.new
+          #   col = firestore.col "cities"
+          #
+          #   doc_refs = col.list_documents
+          #   doc_refs.all(request_limit: 10) do |doc_ref|
+          #     puts doc_ref.document_id
+          #   end
+          #
+          def all request_limit: nil
+            request_limit = request_limit.to_i if request_limit
+            unless block_given?
+              return enum_for :all, request_limit: request_limit
+            end
+            results = self
+            loop do
+              results.each { |r| yield r }
+              if request_limit
+                request_limit -= 1
+                break if request_limit < 0
+              end
+              break unless results.next?
+              results = results.next
+            end
+          end
+
+          ##
+          # @private New DocumentReference::List from a
+          # Google::Firestore::V1::ListDocumentsResponse object.
+          def self.from_grpc grpc, service, parent, collection_id, max = nil
+            documents = List.new(Array(grpc.documents).map do |document|
+              DocumentReference.from_path document.name, service
+            end)
+            documents.instance_variable_set :@parent, parent
+            documents.instance_variable_set :@collection_id, collection_id
+            token = grpc.next_page_token
+            token = nil if token == "".freeze
+            documents.instance_variable_set :@token, token
+            documents.instance_variable_set :@service, service
+            documents.instance_variable_set :@max, max
+            documents
+          end
+
+          protected
+
+          ##
+          # Raise an error unless an active service is available.
+          def ensure_service!
+            raise "Must have active connection" unless @service
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,6 +17,7 @@ require "google/cloud/firestore/v1"
 require "google/cloud/firestore/document_snapshot"
 require "google/cloud/firestore/collection_reference"
 require "google/cloud/firestore/document_listener"
+require "google/cloud/firestore/document_reference/list"
 
 module Google
   module Cloud

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

@@ -63,7 +63,7 @@ module Google
         attr_accessor :parent_path
 
         ##
-        # @private The Google::Firestore::V1::Query object.
+        # @private The Google::Firestore::V1::StructuredQuery object.
         attr_accessor :query
 
         ##

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

@@ -41,7 +41,11 @@ module Google
 
         def channel
           require "grpc"
-          GRPC::Core::Channel.new host, nil, chan_creds
+          GRPC::Core::Channel.new host, chan_args, chan_creds
+        end
+
+        def chan_args
+          { "grpc.service_config_disable_resolution" => 1 }
         end
 
         def chan_creds
@@ -81,6 +85,26 @@ module Google
           end
         end
 
+        ##
+        # Returns a list of DocumentReferences that are directly nested under
+        # the given collection. Fetches all documents from the server, but
+        # provides an empty field mask to avoid unnecessary data transfer. Sets
+        # the showMissing flag to true to support full document traversal. If
+        # there are too many documents, recommendation will be not to call this
+        # method.
+        def list_documents parent, collection_id, token: nil, max: nil
+          mask = { field_paths: [] }
+          call_options = nil
+          call_options = Google::Gax::CallOptions.new page_token: token if token
+          execute do
+            paged_enum = firestore.list_documents \
+              parent, collection_id, mask: mask, show_missing: true,
+                                     page_size: max, options: call_options
+
+            paged_enum.page.response
+          end
+        end
+
         def list_collections parent, transaction: nil
           list_args = {}
           if transaction.is_a? String

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

@@ -604,6 +604,7 @@ module Google
 
         ##
         # @private commit the transaction
+        # @return [CommitResponse] The response from committing the changes.
         def commit
           ensure_not_closed!
 

data/lib/google/cloud/firestore/v1/firestore_client.rb

@@ -27,6 +27,7 @@ require "google/gax"
 
 require "google/firestore/v1/firestore_pb"
 require "google/cloud/firestore/v1/credentials"
+require "google/cloud/firestore/version"
 
 module Google
   module Cloud
@@ -223,7 +224,7 @@ module Google
               updater_proc = credentials.updater_proc
             end
 
-            package_version = Gem.loaded_specs['google-cloud-firestore'].version.version
+            package_version = Google::Cloud::Firestore::VERSION
 
             google_api_client = "gl-ruby/#{RUBY_VERSION}"
             google_api_client << " #{lib_name}/#{lib_version}" if lib_name

data/lib/google/cloud/firestore/v1beta1/firestore_client.rb

@@ -27,6 +27,7 @@ require "google/gax"
 
 require "google/firestore/v1beta1/firestore_pb"
 require "google/cloud/firestore/v1beta1/credentials"
+require "google/cloud/firestore/version"
 
 module Google
   module Cloud
@@ -223,7 +224,7 @@ module Google
               updater_proc = credentials.updater_proc
             end
 
-            package_version = Gem.loaded_specs['google-cloud-firestore'].version.version
+            package_version = Google::Cloud::Firestore::VERSION
 
             google_api_client = "gl-ruby/#{RUBY_VERSION}"
             google_api_client << " #{lib_name}/#{lib_version}" if lib_name

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -234,6 +234,7 @@ files:
 - lib/google/cloud/firestore/document_change.rb
 - lib/google/cloud/firestore/document_listener.rb
 - lib/google/cloud/firestore/document_reference.rb
+- lib/google/cloud/firestore/document_reference/list.rb
 - lib/google/cloud/firestore/document_snapshot.rb
 - lib/google/cloud/firestore/field_path.rb
 - lib/google/cloud/firestore/field_value.rb