google-cloud-firestore 1.4.0 → 2.0.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,7 @@ module Google
         attr_accessor :parent_path
 
         ##
-        # @private The Google::Firestore::V1::StructuredQuery object.
+        # @private The Google::Cloud::Firestore::V1::StructuredQuery object.
         attr_accessor :query
 
         ##
@@ -883,7 +883,7 @@ module Google
 
         ##
         # @private
-        StructuredQuery = Google::Firestore::V1::StructuredQuery
+        StructuredQuery = Google::Cloud::Firestore::V1::StructuredQuery
 
         ##
         # @private
@@ -987,7 +987,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 +1014,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

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

@@ -26,63 +26,42 @@ module Google
       # @private Represents the gRPC Firestore service, including all the API
       # methods.
       class Service
-        attr_accessor :project, :credentials, :timeout, :client_config, :host
+        attr_accessor :project, :credentials, :timeout, :host
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, host: nil, timeout: nil,
-                       client_config: nil
+        def initialize project, credentials, host: nil, timeout: nil
           @project = project
           @credentials = credentials
-          @host = host || V1::FirestoreClient::SERVICE_ADDRESS
+          @host = host
           @timeout = timeout
-          @client_config = client_config || {}
-        end
-
-        def channel
-          require "grpc"
-          GRPC::Core::Channel.new host, chan_args, chan_creds
-        end
-
-        def chan_args
-          { "grpc.service_config_disable_resolution" => 1 }
-        end
-
-        def chan_creds
-          return credentials if insecure?
-          require "grpc"
-          GRPC::Core::ChannelCredentials.new.compose \
-            GRPC::Core::CallCredentials.new credentials.client.updater_proc
         end
 
         def firestore
           @firestore ||= \
-            V1::FirestoreClient.new(
-              credentials:   channel,
-              timeout:       timeout,
-              client_config: client_config,
-              lib_name:      "gccl",
-              lib_version:   Google::Cloud::Firestore::VERSION
-            )
-        end
-
-        def insecure?
-          credentials == :this_channel_is_insecure
+            V1::Firestore::Client.new do |config|
+              config.credentials = credentials if credentials
+              config.timeout = timeout if timeout
+              config.endpoint = host if host
+              config.lib_name = "gccl"
+              config.lib_version = Google::Cloud::Firestore::VERSION
+              config.metadata = { "google-cloud-resource-prefix": "projects/#{@project}" }
+            end
         end
 
         def get_documents document_paths, mask: nil, transaction: nil
-          batch_get_args = { mask: document_mask(mask) }
+          batch_get_req = {
+            database:  database_path,
+            documents: document_paths,
+            mask:      document_mask(mask)
+          }
           if transaction.is_a? String
-            batch_get_args[:transaction] = transaction
+            batch_get_req[:transaction] = transaction
           elsif transaction
-            batch_get_args[:new_transaction] = transaction
+            batch_get_req[:new_transaction] = transaction
           end
-          batch_get_args[:options] = call_options parent: database_path
 
-          execute do
-            firestore.batch_get_documents database_path, document_paths,
-                                          batch_get_args
-          end
+          firestore.batch_get_documents batch_get_req, call_options(parent: database_path)
         end
 
         ##
@@ -94,87 +73,82 @@ module Google
         # 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
-            list_args[:transaction] = transaction
-          elsif transaction
-            list_args[:new_transaction] = transaction
-          end
-          list_args[:options] = call_options parent: database_path
-
-          execute do
-            firestore.list_collection_ids parent, list_args
-          end
+          paged_enum = firestore.list_documents parent:        parent,
+                                                collection_id: collection_id,
+                                                page_size:     max,
+                                                page_token:    token,
+                                                mask:          mask,
+                                                show_missing:  true
+          paged_enum.response
+        end
+
+        def list_collections parent, token: nil, max: nil
+          firestore.list_collection_ids(
+            {
+              parent:     parent,
+              page_size:  max,
+              page_token: token
+            },
+            call_options(parent: database_path)
+          )
         end
 
         def run_query path, query_grpc, transaction: nil
-          run_query_args = { structured_query: query_grpc }
+          run_query_req = {
+            parent:           path,
+            structured_query: query_grpc
+          }
           if transaction.is_a? String
-            run_query_args[:transaction] = transaction
+            run_query_req[:transaction] = transaction
           elsif transaction
-            run_query_args[:new_transaction] = transaction
+            run_query_req[:new_transaction] = transaction
           end
-          run_query_args[:options] = call_options parent: database_path
 
-          execute do
-            firestore.run_query path, run_query_args
-          end
+          firestore.run_query run_query_req, call_options(parent: database_path)
         end
 
         def listen enum
-          options = call_options parent: database_path
-
-          execute do
-            firestore.listen enum, options: options
-          end
+          firestore.listen enum, call_options(parent: database_path)
         end
 
         def begin_transaction transaction_opt
-          options = call_options parent: database_path
-
-          execute do
-            firestore.begin_transaction database_path,
-                                        options_: transaction_opt,
-                                        options:  options
-          end
+          firestore.begin_transaction(
+            {
+              database: database_path,
+              options:  transaction_opt
+            },
+            call_options(parent: database_path)
+          )
         end
 
         def commit writes, transaction: nil
-          commit_args = {}
-          commit_args[:transaction] = transaction if transaction
-          commit_args[:options] = call_options parent: database_path
+          commit_req = {
+            database: database_path,
+            writes:   writes
+          }
+          commit_req[:transaction] = transaction if transaction
 
-          execute do
-            firestore.commit database_path, writes, commit_args
-          end
+          firestore.commit commit_req, call_options(parent: database_path)
         end
 
         def rollback transaction
-          options = call_options parent: database_path
-
-          execute do
-            firestore.rollback database_path, transaction, options: options
-          end
+          firestore.rollback(
+            {
+              database:    database_path,
+              transaction: transaction
+            },
+            call_options(parent: database_path)
+          )
         end
 
         def database_path project_id: project, database_id: "(default)"
-          V1::FirestoreClient.database_root_path project_id, database_id
+          # Originally used V1::FirestoreClient.database_root_path until it was removed in #5405.
+          "projects/#{project_id}/databases/#{database_id}"
         end
 
         def documents_path project_id: project, database_id: "(default)"
-          V1::FirestoreClient.document_root_path project_id, database_id
+          # Originally used V1::FirestoreClient.document_root_path until it was removed in #5405.
+          "projects/#{project_id}/databases/#{database_id}/documents"
         end
 
         def inspect
@@ -189,7 +163,7 @@ module Google
         end
 
         def call_options parent: nil, token: nil
-          Google::Gax::CallOptions.new({
+          Gapic::CallOptions.new(**{
             metadata:   default_headers(parent),
             page_token: token
           }.delete_if { |_, v| v.nil? })
@@ -201,16 +175,7 @@ module Google
           mask = Array(mask).map(&:to_s).reject(&:nil?).reject(&:empty?)
           return nil if mask.empty?
 
-          Google::Firestore::V1::DocumentMask.new field_paths: mask
-        end
-
-        def execute
-          yield
-        rescue Google::Gax::GaxError => e
-          # GaxError wraps BadStatus, but exposes it as #cause
-          raise Google::Cloud::Error.from_error(e.cause)
-        rescue GRPC::BadStatus => e
-          raise Google::Cloud::Error.from_error(e)
+          Google::Cloud::Firestore::V1::DocumentMask.new field_paths: mask
         end
       end
     end