google-cloud-firestore 2.7.2 → 2.15.0

data/lib/google/cloud/firestore.rb

@@ -59,6 +59,10 @@ module Google
       #   If the param is nil, uses the default endpoint.
       # @param [String] emulator_host Firestore emulator host. Optional.
       #   If the param is nil, uses the value of the `emulator_host` config.
+      # @param [String] database_id Identifier for a Firestore database. If not
+      #   present, the default database of the project is used.
+      # @param [:grpc,:rest] transport Which transport to use to communicate
+      #   with the server. Defaults to `:grpc`.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
       # @param [String] keyfile Alias for the `credentials` argument.
       #   Deprecated.
@@ -76,23 +80,28 @@ module Google
                    timeout: nil,
                    endpoint: nil,
                    emulator_host: nil,
+                   database_id: nil,
+                   transport: nil,
                    project: nil,
                    keyfile: nil
-        project_id    ||= (project || default_project_id)
-        scope         ||= configure.scope
-        timeout       ||= configure.timeout
-        endpoint      ||= configure.endpoint
+        project_id ||= project || default_project_id
+        scope ||= configure.scope
+        timeout ||= configure.timeout
+        endpoint ||= configure.endpoint
         emulator_host ||= configure.emulator_host
+        database_id ||= configure.database_id
+        transport ||= configure.transport
 
         if emulator_host
           project_id = project_id.to_s
           raise ArgumentError, "project_id is missing" if project_id.empty?
 
-          service = Firestore::Service.new project_id, :this_channel_is_insecure, host: emulator_host, timeout: timeout
+          service = Firestore::Service.new project_id, :this_channel_is_insecure, host: emulator_host,
+                                           timeout: timeout, database: database_id, transport: transport
           return Firestore::Client.new service
         end
 
-        credentials ||= (keyfile || default_credentials(scope: scope))
+        credentials ||= keyfile || default_credentials(scope: scope)
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Firestore::Credentials.new credentials, scope: scope
         end
@@ -103,7 +112,8 @@ module Google
         project_id = project_id.to_s
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        service = Firestore::Service.new project_id, credentials, host: endpoint, timeout: timeout
+        service = Firestore::Service.new project_id, credentials, host: endpoint,
+                                         timeout: timeout, database: database_id, transport: transport
         Firestore::Client.new service
       end
 

data/lib/google-cloud-firestore.rb

@@ -42,6 +42,10 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/datastore`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [String] database_id Identifier for a Firestore database. If not
+    #   present, the default database of the project is used.
+    # @param [:grpc,:rest] transport Which transport to use to communicate
+    #   with the server. Defaults to `:grpc`.
     #
     # @return [Google::Cloud::Firestore::Client]
     #
@@ -58,8 +62,24 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   firestore = gcloud.firestore scope: platform_scope
     #
-    def firestore scope: nil, timeout: nil
-      Google::Cloud.firestore @project, @keyfile, scope: scope, timeout: (timeout || @timeout)
+    # @example The default database can be overridden with the `database_id` option:
+    #   require "google/cloud"
+    #
+    #   gcloud  = Google::Cloud.new
+    #   database_id = "my-todo-database"
+    #   firestore = gcloud.firestore database_id: database_id
+    #
+    def firestore scope: nil,
+                  timeout: nil,
+                  database_id: nil,
+                  transport: nil
+      transport ||= Google::Cloud.configure.firestore.transport
+      timeout ||= @timeout
+      Google::Cloud.firestore @project, @keyfile,
+                              scope: scope,
+                              timeout: timeout,
+                              database_id: database_id,
+                              transport: transport
     end
 
     ##
@@ -83,6 +103,10 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/datastore`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [String] database_id Identifier for a Firestore database. If not
+    #   present, the default database of the project is used.
+    # @param [:grpc,:rest] transport Which transport to use to communicate
+    #   with the server. Defaults to `:grpc`.
     #
     # @return [Google::Cloud::Firestore::Client]
     #
@@ -91,16 +115,26 @@ module Google
     #
     #   firestore = Google::Cloud.firestore
     #
-    def self.firestore project_id = nil, credentials = nil, scope: nil, timeout: nil
+    def self.firestore project_id = nil,
+                       credentials = nil,
+                       scope: nil,
+                       timeout: nil,
+                       database_id: nil,
+                       transport: nil
       require "google/cloud/firestore"
-      Google::Cloud::Firestore.new project_id:  project_id,
+      transport ||= Google::Cloud.configure.firestore.transport
+      Google::Cloud::Firestore.new project_id: project_id,
                                    credentials: credentials,
-                                   scope:       scope,
-                                   timeout:     timeout
+                                   scope: scope,
+                                   timeout: timeout,
+                                   database_id: database_id,
+                                   transport: transport
     end
   end
 end
 
+# rubocop:disable Metrics/BlockLength
+
 # Set the default firestore configuration
 Google::Cloud.configure.add_config! :firestore do |config|
   default_project = Google::Cloud::Config.deferred do
@@ -116,8 +150,7 @@ Google::Cloud.configure.add_config! :firestore do |config|
     ENV["FIRESTORE_EMULATOR_HOST"]
   end
   default_scopes = [
-    "https://www.googleapis.com/auth/cloud-platform",
-    "https://www.googleapis.com/auth/datastore"
+    "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/datastore"
   ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
@@ -129,4 +162,8 @@ Google::Cloud.configure.add_config! :firestore do |config|
   config.add_field! :timeout, nil, match: Integer
   config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
   config.add_field! :endpoint, "firestore.googleapis.com", match: String
+  config.add_field! :database_id, "(default)", match: String
+  config.add_field! :transport, :grpc, match: Symbol
 end
+
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.15.0
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -66,146 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: google-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.26.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.26.1
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-- !ruby/object:Gem::Dependency
-  name: minitest-autotest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: autotest-suffix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard-doctest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
 description: google-cloud-firestore is the official library for Google Cloud Firestore
   API.
 email: googleapis-packages@google.com
@@ -225,7 +85,14 @@ files:
 - TROUBLESHOOTING.md
 - lib/google-cloud-firestore.rb
 - lib/google/cloud/firestore.rb
+- lib/google/cloud/firestore/aggregate_query.rb
+- lib/google/cloud/firestore/aggregate_query_snapshot.rb
 - lib/google/cloud/firestore/batch.rb
+- lib/google/cloud/firestore/bulk_commit_batch.rb
+- lib/google/cloud/firestore/bulk_writer.rb
+- lib/google/cloud/firestore/bulk_writer_exception.rb
+- lib/google/cloud/firestore/bulk_writer_operation.rb
+- lib/google/cloud/firestore/bulk_writer_scheduler.rb
 - lib/google/cloud/firestore/client.rb
 - lib/google/cloud/firestore/collection_group.rb
 - lib/google/cloud/firestore/collection_reference.rb
@@ -238,13 +105,17 @@ files:
 - 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/errors.rb
 - lib/google/cloud/firestore/field_path.rb
 - lib/google/cloud/firestore/field_value.rb
+- lib/google/cloud/firestore/filter.rb
 - lib/google/cloud/firestore/generate.rb
+- lib/google/cloud/firestore/promise/future.rb
 - lib/google/cloud/firestore/query.rb
 - lib/google/cloud/firestore/query_listener.rb
 - lib/google/cloud/firestore/query_partition.rb
 - lib/google/cloud/firestore/query_snapshot.rb
+- lib/google/cloud/firestore/rate_limiter.rb
 - lib/google/cloud/firestore/resource_path.rb
 - lib/google/cloud/firestore/service.rb
 - lib/google/cloud/firestore/transaction.rb
@@ -265,14 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Firestore API