google-cloud-firestore 1.4.4 → 2.0.0

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,65 +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 = {
+          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, **batch_get_args
-          end
+          firestore.batch_get_documents batch_get_req, call_options(parent: database_path)
         end
 
         ##
@@ -96,81 +73,72 @@ 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 = {
-            writes: writes
+          commit_req = {
+            database: database_path,
+            writes:   writes
           }
-          commit_args[:transaction] = transaction if transaction
-          commit_args[:options] = call_options parent: database_path
+          commit_req[:transaction] = transaction if transaction
 
-          execute do
-            firestore.commit database_path, **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)"
@@ -195,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? })
@@ -207,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

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

@@ -700,14 +700,14 @@ module Google
         # @private
         def transaction_opt
           read_write = \
-            Google::Firestore::V1::TransactionOptions::ReadWrite.new
+            Google::Cloud::Firestore::V1::TransactionOptions::ReadWrite.new
 
           if @previous_transaction
             read_write.retry_transaction = @previous_transaction
             @previous_transaction = nil
           end
 
-          Google::Firestore::V1::TransactionOptions.new(
+          Google::Cloud::Firestore::V1::TransactionOptions.new(
             read_write: read_write
           )
         end

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

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

data/lib/google/cloud/firestore/watch/listener.rb

@@ -34,12 +34,12 @@ module Google
             raise ArgumentError if doc_ref.nil?
             raise ArgumentError if callback.nil?
 
-            documents = Google::Firestore::V1::Target::DocumentsTarget.new(
+            documents = Google::Cloud::Firestore::V1::Target::DocumentsTarget.new(
               documents: [doc_ref.path]
             )
-            init_listen_req = Google::Firestore::V1::ListenRequest.new(
+            init_listen_req = Google::Cloud::Firestore::V1::ListenRequest.new(
               database:   doc_ref.client.path,
-              add_target: Google::Firestore::V1::Target.new(
+              add_target: Google::Cloud::Firestore::V1::Target.new(
                 documents: documents
               )
             )
@@ -51,10 +51,10 @@ module Google
             raise ArgumentError if query.nil?
             raise ArgumentError if callback.nil?
 
-            init_listen_req = Google::Firestore::V1::ListenRequest.new(
+            init_listen_req = Google::Cloud::Firestore::V1::ListenRequest.new(
               database:   query.client.path,
-              add_target: Google::Firestore::V1::Target.new(
-                query: Google::Firestore::V1::Target::QueryTarget.new(
+              add_target: Google::Cloud::Firestore::V1::Target.new(
+                query: Google::Cloud::Firestore::V1::Target::QueryTarget.new(
                   parent:           query.parent_path,
                   structured_query: query.query
                 )
@@ -223,7 +223,7 @@ module Google
                     raise RestartStream # Raise to restart the stream
                   end
                 when :document_change
-                  # A {Google::Firestore::V1::Document Document} has changed.
+                  # A {Google::Cloud::Firestore::V1::Document Document} has changed.
 
                   if response.document_change.removed_target_ids.any?
                     @inventory.delete response.document_change.document.name
@@ -231,12 +231,12 @@ module Google
                     @inventory.add response.document_change.document
                   end
                 when :document_delete
-                  # A {Google::Firestore::V1::Document Document} has been
+                  # A {Google::Cloud::Firestore::V1::Document Document} has been
                   # deleted.
 
                   @inventory.delete response.document_delete.document
                 when :document_remove
-                  # A {Google::Firestore::V1::Document Document} has been
+                  # A {Google::Cloud::Firestore::V1::Document Document} has been
                   # removed from a target (because it is no longer relevant to
                   # that target).