google-cloud-firestore 2.10.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f5f652c19f42202037ab6ea3281e24a0a78a73749b9ad0a3eea4e5028c934d
-  data.tar.gz: b8f499a9749fe11b7eabe4998e2b51660c85083edadf89bc5aeedcdd60c0e363
+  metadata.gz: c8fe0d4f3e79da21256a4495d0a19da58febfaf27298ea1735fef2042c8c7281
+  data.tar.gz: 10e4929cd461e369991e153356d3878add4b179c972715880734456b566832ca
 SHA512:
-  metadata.gz: 8c482b86c7d6a2f6fab119cb6056d2d9e34a45449496b154ed023bb81fec17a54a597cee2be7708ab6b630d5b46f76fe406899fcd3b8389a177199ac46f009a8
-  data.tar.gz: '0944612066e1adcf21269961ec377e9b6ca3e809058328e5b002cfc0b80c5303c233420316ead38df278615092b6c3752fa47f55942054d378d2f4d9cd9f18f8'
+  metadata.gz: 7491e2f8033a2e2033e37e77b16e0401f9ecd77e9e357ecf47c72ab55204df6a7b8aa0a8bdf508d58215c3f6e3818a3ffaa7eebd0cc425e9355fe987df1bc478
+  data.tar.gz: 0f92c886ee8ba0043782aae64166947efd7d5ea1ccd0968fd21fa1bc2e7936f2eba3cb4805853a569d3631e221415fb2649a9c6a5aac101c87cdab1976558472

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.11.0 (2023-02-23)
+
+#### Features
+
+* Support REST transport ([#20446](https://github.com/googleapis/google-cloud-ruby/issues/20446)) 
+
 ### 2.10.1 (2023-02-16)
 
 #### Bug Fixes

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

@@ -34,17 +34,19 @@ module Google
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, host: nil, timeout: nil, database: nil
+        def initialize project, credentials, host: nil, timeout: nil, database: nil, transport: :grpc
           @project = project
           @credentials = credentials
           @host = host
           @timeout = timeout
           @database = database
+          @transport = transport
         end
 
         def firestore
-          @firestore ||= \
-            V1::Firestore::Client.new do |config|
+          @firestore ||= begin
+            client_class = @transport == :rest ? V1::Firestore::Rest::Client : V1::Firestore::Client
+            client_class.new do |config|
               config.credentials = credentials if credentials
               config.timeout = timeout if timeout
               config.endpoint = host if host
@@ -52,6 +54,7 @@ module Google
               config.lib_version = Google::Cloud::Firestore::VERSION
               config.metadata = { "google-cloud-resource-prefix": "projects/#{@project}/databases/#{@database}" }
             end
+          end
         end
 
         def get_documents document_paths, mask: nil, transaction: nil, read_time: nil

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

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

data/lib/google/cloud/firestore.rb

@@ -61,6 +61,8 @@ module Google
       #   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.
@@ -79,6 +81,7 @@ module Google
                    endpoint: nil,
                    emulator_host: nil,
                    database_id: nil,
+                   transport: nil,
                    project: nil,
                    keyfile: nil
         project_id ||= (project || default_project_id)
@@ -87,13 +90,14 @@ module Google
         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, database: database_id
+                                           timeout: timeout, database: database_id, transport: transport
           return Firestore::Client.new service
         end
 
@@ -109,7 +113,7 @@ module Google
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
         service = Firestore::Service.new project_id, credentials, host: endpoint,
-                                         timeout: timeout, database: database_id
+                                         timeout: timeout, database: database_id, transport: transport
         Firestore::Client.new service
       end
 

data/lib/google-cloud-firestore.rb

@@ -44,6 +44,8 @@ module Google
     # @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]
     #
@@ -67,8 +69,16 @@ module Google
     #   database_id = "my-todo-database"
     #   firestore = gcloud.firestore database_id: database_id
     #
-    def firestore scope: nil, timeout: nil, database_id: nil
-      Google::Cloud.firestore @project, @keyfile, scope: scope, timeout: (timeout || @timeout), database_id: database_id
+    def firestore scope: nil,
+                  timeout: nil,
+                  database_id: nil,
+                  transport: nil
+      transport ||= Google::Cloud.configure.firestore.transport
+      Google::Cloud.firestore @project, @keyfile,
+                              scope: scope,
+                              timeout: (timeout || @timeout),
+                              database_id: database_id,
+                              transport: transport
     end
 
     ##
@@ -94,6 +104,8 @@ module Google
     # @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]
     #
@@ -102,17 +114,26 @@ module Google
     #
     #   firestore = Google::Cloud.firestore
     #
-    def self.firestore project_id = nil, credentials = nil, scope: nil, timeout: nil, database_id: nil
+    def self.firestore project_id = nil,
+                       credentials = nil,
+                       scope: nil,
+                       timeout: nil,
+                       database_id: nil,
+                       transport: nil
       require "google/cloud/firestore"
+      transport ||= Google::Cloud.configure.firestore.transport
       Google::Cloud::Firestore.new project_id: project_id,
                                    credentials: credentials,
                                    scope: scope,
                                    timeout: timeout,
-                                   database_id: database_id
+                                   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
@@ -141,4 +162,7 @@ Google::Cloud.configure.add_config! :firestore do |config|
   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.10.1
+  version: 2.11.0
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-02-23 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.8'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement