google-cloud-firestore 1.4.2 → 2.2.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_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

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

@@ -62,7 +62,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 +345,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 +359,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 +372,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

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

@@ -63,7 +63,11 @@ module Google
         attr_accessor :parent_path
 
         ##
-        # @private The Google::Firestore::V1::StructuredQuery object.
+        # @private The type for limit queries.
+        attr_reader :limit_type
+
+        ##
+        # @private The Google::Cloud::Firestore::V1::StructuredQuery object.
         attr_accessor :query
 
         ##
@@ -118,7 +122,7 @@ module Google
             new_query.select.fields << field_ref
           end
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
@@ -154,7 +158,7 @@ module Google
 
           new_query.from.last.all_descendants = true
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
@@ -190,7 +194,7 @@ module Google
 
           new_query.from.last.all_descendants = false
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
@@ -246,7 +250,7 @@ module Google
           new_filter = filter field.formatted_string, operator, value
           add_filters_to_query new_query, new_filter
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
@@ -298,9 +302,8 @@ module Google
         #   end
         #
         def order field, direction = :asc
-          if query_has_cursors?
-            raise "cannot call order after calling " \
-                  "start_at, start_after, end_before, or end_at"
+          if query_has_cursors? || limit_type == :last
+            raise "cannot call order after calling limit_to_last, start_at, start_after, end_before, or end_at"
           end
 
           new_query = @query.dup
@@ -315,7 +318,7 @@ module Google
             direction: order_direction(direction)
           )
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
         alias order_by order
 
@@ -348,12 +351,13 @@ module Google
 
           new_query.offset = num
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
-        # Limits a query to return a fixed number of results. If the current
-        # query already has a limit set, this will overwrite it.
+        # Limits a query to return only the first matching documents.
+        #
+        # If the current query already has a limit set, this will overwrite it.
         #
         # @param [Integer] num The maximum number of results to return.
         #
@@ -368,19 +372,83 @@ module Google
         #   cities_col = firestore.col "cities"
         #
         #   # Create a query
-        #   query = cities_col.offset(10).limit(5)
+        #   query = cities_col.order(:name, :desc).offset(10).limit(5)
         #
         #   query.get do |city|
         #     puts "#{city.document_id} has #{city[:population]} residents."
         #   end
         #
         def limit num
+          if limit_type == :last
+            raise "cannot call limit after calling limit_to_last"
+          end
+
           new_query = @query.dup
           new_query ||= StructuredQuery.new
 
           new_query.limit = Google::Protobuf::Int32Value.new value: num
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: :first
+        end
+
+        ##
+        # Limits a query to return only the last matching documents.
+        #
+        # You must specify at least one "order by" clause for limitToLast queries.
+        # (See {#order}.)
+        #
+        # Results for `limit_to_last` queries are only available once all documents
+        # are received. Hence, `limit_to_last` queries cannot be streamed using
+        # {#listen}.
+        #
+        # @param [Integer] num The maximum number of results to return.
+        #
+        # @return [Query] New query with `limit_to_last` called on it.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Get a collection reference
+        #   cities_col = firestore.col "cities"
+        #
+        #   # Create a query
+        #   query = cities_col.order(:name, :desc).limit_to_last(5)
+        #
+        #   query.get do |city|
+        #     puts "#{city.document_id} has #{city[:population]} residents."
+        #   end
+        #
+        def limit_to_last num
+          new_query = @query.dup
+
+          if new_query.nil? || new_query.order_by.nil? || new_query.order_by.empty?
+            raise "specify at least one order clause before calling limit_to_last"
+          end
+
+          if limit_type != :last # Don't reverse order_by more than once.
+            # Reverse the order_by directions since we want the last results.
+            new_query.order_by.each do |order|
+              order.direction = order.direction.to_sym == :DESCENDING ? :ASCENDING : :DESCENDING
+            end
+
+            # Swap the cursors to match the reversed query ordering.
+            new_end_at = new_query.start_at.dup
+            new_start_at = new_query.end_at.dup
+            if new_end_at
+              new_end_at.before = !new_end_at.before
+              new_query.end_at = new_end_at
+            end
+            if new_start_at
+              new_start_at.before = !new_start_at.before
+              new_query.start_at = new_start_at
+            end
+          end
+
+          new_query.limit = Google::Protobuf::Int32Value.new value: num
+
+          Query.start new_query, parent_path, client, limit_type: :last
         end
 
         ##
@@ -477,6 +545,10 @@ module Google
         def start_at *values
           raise ArgumentError, "must provide values" if values.empty?
 
+          if limit_type == :last
+            raise "cannot call start_at after calling limit_to_last"
+          end
+
           new_query = @query.dup
           new_query ||= StructuredQuery.new
 
@@ -484,7 +556,7 @@ module Google
           cursor.before = true
           new_query.start_at = cursor
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
@@ -581,6 +653,11 @@ module Google
         def start_after *values
           raise ArgumentError, "must provide values" if values.empty?
 
+          if limit_type == :last
+            raise "cannot call start_after after calling limit_to_last"
+          end
+
+
           new_query = @query.dup
           new_query ||= StructuredQuery.new
 
@@ -588,7 +665,7 @@ module Google
           cursor.before = false
           new_query.start_at = cursor
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
@@ -685,6 +762,11 @@ module Google
         def end_before *values
           raise ArgumentError, "must provide values" if values.empty?
 
+          if limit_type == :last
+            raise "cannot call end_before after calling limit_to_last"
+          end
+
+
           new_query = @query.dup
           new_query ||= StructuredQuery.new
 
@@ -692,7 +774,7 @@ module Google
           cursor.before = true
           new_query.end_at = cursor
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
@@ -789,6 +871,11 @@ module Google
         def end_at *values
           raise ArgumentError, "must provide values" if values.empty?
 
+          if limit_type == :last
+            raise "cannot call end_at after calling limit_to_last"
+          end
+
+
           new_query = @query.dup
           new_query ||= StructuredQuery.new
 
@@ -796,7 +883,7 @@ module Google
           cursor.before = false
           new_query.end_at = cursor
 
-          Query.start new_query, parent_path, client
+          Query.start new_query, parent_path, client, limit_type: limit_type
         end
 
         ##
@@ -828,6 +915,10 @@ module Google
           return enum_for :get unless block_given?
 
           results = service.run_query parent_path, @query
+
+          # Reverse the results for Query#limit_to_last queries since that method reversed the order_by directions.
+          results = results.to_a.reverse if limit_type == :last
+
           results.each do |result|
             next if result.document.nil?
             yield DocumentSnapshot.from_query_result result, client
@@ -870,11 +961,12 @@ module Google
 
         ##
         # @private Start a new Query.
-        def self.start query, parent_path, client
+        def self.start query, parent_path, client, limit_type: nil
           query ||= StructuredQuery.new
           Query.new.tap do |q|
             q.instance_variable_set :@query, query
             q.instance_variable_set :@parent_path, parent_path
+            q.instance_variable_set :@limit_type, limit_type
             q.instance_variable_set :@client, client
           end
         end
@@ -883,7 +975,7 @@ module Google
 
         ##
         # @private
-        StructuredQuery = Google::Firestore::V1::StructuredQuery
+        StructuredQuery = Google::Cloud::Firestore::V1::StructuredQuery
 
         ##
         # @private
@@ -987,7 +1079,7 @@ module Google
         end
 
         def order_direction direction
-          return :DESCENDING if direction.to_s.downcase.start_with? "d".freeze
+          return :DESCENDING if direction.to_s.downcase.start_with? "d"
           :ASCENDING
         end
 
@@ -1014,7 +1106,7 @@ module Google
             Convert.raw_to_value value
           end
 
-          Google::Firestore::V1::Cursor.new values: values
+          Google::Cloud::Firestore::V1::Cursor.new values: values
         end
 
         def snapshot_to_cursor snapshot, query