google-cloud-firestore 1.4.4 → 2.4.0

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

@@ -85,40 +85,40 @@ module Google
 
           def raw_to_value obj
             if NilClass === obj
-              Google::Firestore::V1::Value.new null_value: :NULL_VALUE
+              Google::Cloud::Firestore::V1::Value.new null_value: :NULL_VALUE
             elsif TrueClass === obj || FalseClass === obj
-              Google::Firestore::V1::Value.new boolean_value: obj
+              Google::Cloud::Firestore::V1::Value.new boolean_value: obj
             elsif Integer === obj
-              Google::Firestore::V1::Value.new integer_value: obj
+              Google::Cloud::Firestore::V1::Value.new integer_value: obj
             elsif Numeric === obj # Any number not an integer is a double
-              Google::Firestore::V1::Value.new double_value: obj.to_f
+              Google::Cloud::Firestore::V1::Value.new double_value: obj.to_f
             elsif Time === obj || DateTime === obj || Date === obj
-              Google::Firestore::V1::Value.new \
+              Google::Cloud::Firestore::V1::Value.new \
                 timestamp_value: time_to_timestamp(obj.to_time)
             elsif String === obj || Symbol === obj
-              Google::Firestore::V1::Value.new string_value: obj.to_s
+              Google::Cloud::Firestore::V1::Value.new string_value: obj.to_s
             elsif Google::Cloud::Firestore::DocumentReference === obj
-              Google::Firestore::V1::Value.new reference_value: obj.path
+              Google::Cloud::Firestore::V1::Value.new reference_value: obj.path
             elsif Array === obj
               values = obj.map { |o| raw_to_value(o) }
-              Google::Firestore::V1::Value.new(array_value:
-                Google::Firestore::V1::ArrayValue.new(values: values))
+              Google::Cloud::Firestore::V1::Value.new(array_value:
+                Google::Cloud::Firestore::V1::ArrayValue.new(values: values))
             elsif Hash === obj
               # keys have been changed to strings before the hash gets here
               geo_pairs = hash_is_geo_point? obj
               if geo_pairs
-                Google::Firestore::V1::Value.new(
+                Google::Cloud::Firestore::V1::Value.new(
                   geo_point_value: hash_to_geo_point(obj, geo_pairs)
                 )
               else
                 fields = hash_to_fields obj
-                Google::Firestore::V1::Value.new(map_value:
-                  Google::Firestore::V1::MapValue.new(fields: fields))
+                Google::Cloud::Firestore::V1::Value.new(map_value:
+                  Google::Cloud::Firestore::V1::MapValue.new(fields: fields))
               end
             elsif obj.respond_to?(:read) && obj.respond_to?(:rewind)
               obj.rewind
               content = obj.read.force_encoding "ASCII-8BIT"
-              Google::Firestore::V1::Value.new bytes_value: content
+              Google::Cloud::Firestore::V1::Value.new bytes_value: content
             else
               raise ArgumentError,
                     "A value of type #{obj.class} is not supported."
@@ -129,7 +129,7 @@ module Google
             return false unless hash.keys.count == 2
 
             pairs = hash.map { |k, v| [String(k), v] }.sort
-            if pairs.map(&:first) == ["latitude".freeze, "longitude".freeze]
+            if pairs.map(&:first) == ["latitude", "longitude"]
               pairs
             end
           end
@@ -156,11 +156,11 @@ module Google
             data, field_paths_and_values = remove_field_value_from data
 
             if data.any? || field_paths_and_values.empty?
-              write = Google::Firestore::V1::Write.new(
-                update: Google::Firestore::V1::Document.new(
+              write = Google::Cloud::Firestore::V1::Write.new(
+                update: Google::Cloud::Firestore::V1::Document.new(
                   name: doc_path,
                   fields: hash_to_fields(data)),
-                current_document: Google::Firestore::V1::Precondition.new(
+                current_document: Google::Cloud::Firestore::V1::Precondition.new(
                   exists: false)
               )
               writes << write
@@ -171,7 +171,7 @@ module Google
 
               if data.empty?
                 transform_write.current_document = \
-                  Google::Firestore::V1::Precondition.new(exists: false)
+                  Google::Cloud::Firestore::V1::Precondition.new(exists: false)
               end
 
               writes << transform_write
@@ -207,8 +207,8 @@ module Google
 
             data, field_paths_and_values = remove_field_value_from data
 
-            writes << Google::Firestore::V1::Write.new(
-              update: Google::Firestore::V1::Document.new(
+            writes << Google::Cloud::Firestore::V1::Write.new(
+              update: Google::Cloud::Firestore::V1::Document.new(
                 name: doc_path,
                 fields: hash_to_fields(data))
             )
@@ -278,11 +278,11 @@ module Google
             end
 
             if data.any? || field_paths.any? || (allow_empty && field_paths_and_values.empty?)
-              writes << Google::Firestore::V1::Write.new(
-                update: Google::Firestore::V1::Document.new(
+              writes << Google::Cloud::Firestore::V1::Write.new(
+                update: Google::Cloud::Firestore::V1::Document.new(
                   name: doc_path,
                   fields: hash_to_fields(data)),
-                update_mask: Google::Firestore::V1::DocumentMask.new(
+                update_mask: Google::Cloud::Firestore::V1::DocumentMask.new(
                   field_paths: field_paths.map(&:formatted_string).sort)
               )
             end
@@ -339,18 +339,18 @@ module Google
             end
 
             if data.any? || delete_paths.any?
-              write = Google::Firestore::V1::Write.new(
-                update: Google::Firestore::V1::Document.new(
+              write = Google::Cloud::Firestore::V1::Write.new(
+                update: Google::Cloud::Firestore::V1::Document.new(
                   name: doc_path,
                   fields: hash_to_fields(data)),
-                update_mask: Google::Firestore::V1::DocumentMask.new(
+                update_mask: Google::Cloud::Firestore::V1::DocumentMask.new(
                   field_paths: (field_paths).map(&:formatted_string).sort),
-                current_document: Google::Firestore::V1::Precondition.new(
+                current_document: Google::Cloud::Firestore::V1::Precondition.new(
                   exists: true)
               )
               if update_time
                 write.current_document = \
-                  Google::Firestore::V1::Precondition.new(
+                  Google::Cloud::Firestore::V1::Precondition.new(
                     update_time: time_to_timestamp(update_time))
               end
               writes << write
@@ -360,7 +360,7 @@ module Google
               transform_write = transform_write doc_path, field_paths_and_values
               if data.empty?
                 transform_write.current_document = \
-                  Google::Firestore::V1::Precondition.new(exists: true)
+                  Google::Cloud::Firestore::V1::Precondition.new(exists: true)
               end
               writes << transform_write
             end
@@ -373,13 +373,13 @@ module Google
               raise ArgumentError, "cannot specify both exists and update_time"
             end
 
-            write = Google::Firestore::V1::Write.new(
+            write = Google::Cloud::Firestore::V1::Write.new(
               delete: doc_path
             )
 
             unless exists.nil? && update_time.nil?
               write.current_document = \
-                Google::Firestore::V1::Precondition.new({
+                Google::Cloud::Firestore::V1::Precondition.new({
                   exists: exists, update_time: time_to_timestamp(update_time)
                 }.delete_if { |_, v| v.nil? })
             end
@@ -584,8 +584,8 @@ module Google
               to_field_transform field_path, field_value
             end
 
-            Google::Firestore::V1::Write.new(
-              transform: Google::Firestore::V1::DocumentTransform.new(
+            Google::Cloud::Firestore::V1::Write.new(
+              transform: Google::Cloud::Firestore::V1::DocumentTransform.new(
                 document: doc_path,
                 field_transforms: field_transforms
               )
@@ -594,32 +594,32 @@ module Google
 
           def to_field_transform field_path, field_value
             if field_value.type == :server_time
-              Google::Firestore::V1::DocumentTransform::FieldTransform.new(
+              Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 set_to_server_value: :REQUEST_TIME
               )
             elsif field_value.type == :array_union
-              Google::Firestore::V1::DocumentTransform::FieldTransform.new(
+              Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 append_missing_elements: raw_to_value(Array(field_value.value)).array_value
               )
             elsif field_value.type == :array_delete
-              Google::Firestore::V1::DocumentTransform::FieldTransform.new(
+              Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 remove_all_from_array: raw_to_value(Array(field_value.value)).array_value
               )
             elsif field_value.type == :increment
-              Google::Firestore::V1::DocumentTransform::FieldTransform.new(
+              Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 increment: raw_to_value(field_value.value)
               )
             elsif field_value.type == :maximum
-              Google::Firestore::V1::DocumentTransform::FieldTransform.new(
+              Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 maximum: raw_to_value(field_value.value)
               )
             elsif field_value.type == :minimum
-              Google::Firestore::V1::DocumentTransform::FieldTransform.new(
+              Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 minimum: raw_to_value(field_value.value)
               )

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/firestore/v1/credentials"
+require "google/cloud/firestore/v1/firestore/credentials"
 
 module Google
   module Cloud
@@ -37,7 +37,7 @@ module Google
       #
       #   firestore.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::Firestore::V1::Credentials
+      class Credentials < Google::Cloud::Firestore::V1::Firestore::Credentials
       end
     end
   end

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

@@ -14,11 +14,14 @@
 
 
 require "google/cloud/firestore/watch/listener"
+require "monitor"
 
 module Google
   module Cloud
     module Firestore
       ##
+      # # DocumentListener
+      #
       # An ongoing listen operation on a document reference. This is returned by
       # calling {DocumentReference#listen}.
       #
@@ -31,25 +34,28 @@ module Google
       #   nyc_ref = firestore.doc "cities/NYC"
       #
       #   listener = nyc_ref.listen do |snapshot|
-      #     puts "The population of #{snapshot[:name]} "
-      #     puts "is #{snapshot[:population]}."
+      #     puts "The population of #{snapshot[:name]} is #{snapshot[:population]}."
       #   end
       #
       #   # When ready, stop the listen operation and close the stream.
       #   listener.stop
       #
       class DocumentListener
+        include MonitorMixin
         ##
         # @private
         # Creates the watch stream and listener object.
         def initialize doc_ref, &callback
+          super() # to init MonitorMixin
+
           @doc_ref = doc_ref
           raise ArgumentError if @doc_ref.nil?
 
           @callback = callback
           raise ArgumentError if @callback.nil?
+          @error_callbacks = []
 
-          @listener = Watch::Listener.for_doc_ref doc_ref do |query_snp|
+          @listener = Watch::Listener.for_doc_ref self, doc_ref do |query_snp|
             doc_snp = query_snp.docs.find { |doc| doc.path == @doc_ref.path }
 
             if doc_snp.nil?
@@ -80,8 +86,7 @@ module Google
         #   nyc_ref = firestore.doc "cities/NYC"
         #
         #   listener = nyc_ref.listen do |snapshot|
-        #     puts "The population of #{snapshot[:name]} "
-        #     puts "is #{snapshot[:population]}."
+        #     puts "The population of #{snapshot[:name]} is #{snapshot[:population]}."
         #   end
         #
         #   # When ready, stop the listen operation and close the stream.
@@ -103,8 +108,7 @@ module Google
         #   nyc_ref = firestore.doc "cities/NYC"
         #
         #   listener = nyc_ref.listen do |snapshot|
-        #     puts "The population of #{snapshot[:name]} "
-        #     puts "is #{snapshot[:population]}."
+        #     puts "The population of #{snapshot[:name]} is #{snapshot[:population]}."
         #   end
         #
         #   # Checks if the listener is stopped.
@@ -119,6 +123,81 @@ module Google
         def stopped?
           @listener.stopped?
         end
+
+        ##
+        # Register to be notified of errors when raised.
+        #
+        # If an unhandled error has occurred the listener will attempt to
+        # recover from the error and resume listening.
+        #
+        # Multiple error handlers can be added.
+        #
+        # @yield [callback] The block to be called when an error is raised.
+        # @yieldparam [Exception] error The error raised.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Get a document reference
+        #   nyc_ref = firestore.doc "cities/NYC"
+        #
+        #   listener = nyc_ref.listen do |snapshot|
+        #     puts "The population of #{snapshot[:name]} is #{snapshot[:population]}."
+        #   end
+        #
+        #   # Register to be notified when unhandled errors occur.
+        #   listener.on_error do |error|
+        #     puts error
+        #   end
+        #
+        #   # When ready, stop the listen operation and close the stream.
+        #   listener.stop
+        #
+        def on_error &block
+          raise ArgumentError, "on_error must be called with a block" unless block_given?
+          synchronize { @error_callbacks << block }
+        end
+
+        ##
+        # The most recent unhandled error to occur while listening for changes.
+        #
+        # If an unhandled error has occurred the listener will attempt to
+        # recover from the error and resume listening.
+        #
+        # @return [Exception, nil] error The most recent error raised.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Get a document reference
+        #   nyc_ref = firestore.doc "cities/NYC"
+        #
+        #   listener = nyc_ref.listen do |snapshot|
+        #     puts "The population of #{snapshot[:name]} is #{snapshot[:population]}."
+        #   end
+        #
+        #   # If an error was raised, it can be retrieved here:
+        #   listener.last_error #=> nil
+        #
+        #   # When ready, stop the listen operation and close the stream.
+        #   listener.stop
+        #
+        def last_error
+          synchronize { @last_error }
+        end
+
+        # @private Pass the error to user-provided error callbacks.
+        def error! error
+          error_callbacks = synchronize do
+            @last_error = error
+            @error_callbacks.dup
+          end
+          error_callbacks.each { |error_callback| error_callback.call error }
+        end
       end
     end
   end

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

@@ -70,12 +70,13 @@ module Google
         # @!group Access
 
         ##
-        # Retrieves a list of collections nested under the document snapshot.
+        # Retrieves an enumerator for the collections nested under the document snapshot.
         #
         # @yield [collections] The block for accessing the collections.
-        # @yieldparam [CollectionReference] collection A collection.
+        # @yieldparam [CollectionReference] collection A collection reference object.
         #
-        # @return [Enumerator<CollectionReference>] collection list.
+        # @return [Enumerator<CollectionReference>] An enumerator of collection references. If a block is provided, this
+        #  is the same enumerator that is accessed through the block.
         #
         # @example
         #   require "google/cloud/firestore"
@@ -91,11 +92,10 @@ module Google
         #
         def cols
           ensure_service!
-
-          return enum_for :cols unless block_given?
-
-          collection_ids = service.list_collections path
-          collection_ids.each { |collection_id| yield col collection_id }
+          grpc = service.list_collections path
+          cols_enum = CollectionReferenceList.from_grpc(grpc, client, path).all
+          cols_enum.each { |c| yield c } if block_given?
+          cols_enum
         end
         alias collections cols
         alias list_collections cols
@@ -168,8 +168,7 @@ module Google
         #   nyc_ref = firestore.doc "cities/NYC"
         #
         #   listener = nyc_ref.listen do |snapshot|
-        #     puts "The population of #{snapshot[:name]} "
-        #     puts "is #{snapshot[:population]}."
+        #     puts "The population of #{snapshot[:name]} is #{snapshot[:population]}."
         #   end
         #
         #   # When ready, stop the listen operation and close the stream.

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

@@ -162,7 +162,7 @@ module Google
 
           ##
           # @private New DocumentReference::List from a
-          # Google::Firestore::V1::ListDocumentsResponse object.
+          # Google::Cloud::Firestore::V1::ListDocumentsResponse object.
           def self.from_grpc grpc, client, parent, collection_id, max = nil
             documents = List.new(Array(grpc.documents).map do |document|
               DocumentReference.from_path document.name, client
@@ -170,7 +170,7 @@ module Google
             documents.instance_variable_set :@parent, parent
             documents.instance_variable_set :@collection_id, collection_id
             token = grpc.next_page_token
-            token = nil if token == "".freeze
+            token = nil if token == ""
             documents.instance_variable_set :@token, token
             documents.instance_variable_set :@client, client
             documents.instance_variable_set :@max, max

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

@@ -53,8 +53,7 @@ module Google
       #   nyc_ref = firestore.doc "cities/NYC"
       #
       #   listener = nyc_ref.listen do |snapshot|
-      #     puts "The population of #{snapshot[:name]} "
-      #     puts "is #{snapshot[:population]}."
+      #     puts "The population of #{snapshot[:name]} is #{snapshot[:population]}."
       #   end
       #
       #   # When ready, stop the listen operation and close the stream.
@@ -62,7 +61,7 @@ module Google
       #
       class DocumentSnapshot
         ##
-        # @private The Google::Firestore::V1::Document object.
+        # @private The Google::Cloud::Firestore::V1::Document object.
         attr_accessor :grpc
 
         ##
@@ -345,7 +344,7 @@ module Google
 
         ##
         # @private New DocumentSnapshot from a
-        # Google::Firestore::V1::RunQueryResponse object.
+        # Google::Cloud::Firestore::V1::RunQueryResponse object.
         def self.from_query_result result, client
           ref = DocumentReference.from_path result.document.name, client
           read_at = Convert.timestamp_to_time result.read_time
@@ -359,7 +358,7 @@ module Google
 
         ##
         # @private New DocumentSnapshot from a
-        # Google::Firestore::V1::DocumentChange object.
+        # Google::Cloud::Firestore::V1::DocumentChange object.
         def self.from_document document, client, read_at: nil
           ref = DocumentReference.from_path document.name, client
 
@@ -372,7 +371,7 @@ module Google
 
         ##
         # @private New DocumentSnapshot from a
-        # Google::Firestore::V1::BatchGetDocumentsResponse object.
+        # Google::Cloud::Firestore::V1::BatchGetDocumentsResponse object.
         def self.from_batch_result result, client
           ref = nil
           grpc = nil