google-cloud-firestore-admin 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 703a49e7d0aef90b0a117c639d05206c8d7010349045676cecb31d5f5159d082
-  data.tar.gz: e3a2294faff16b2cf4578137f8a3e9fb81dc0d621713cfdc605680a2c3c77520
+  metadata.gz: 668fa8ec0674ae5cbf70c176f5381b6cdfb0f2bff23a03192396542887980b4f
+  data.tar.gz: 62a32952805059fecf1713598df0b507631f8e69cf8de9e2ee89eb2f4df816fe
 SHA512:
-  metadata.gz: bf6c9d798248681bc0ea82c99941501d5fb32319afcff51070420726fdb97250085bcb7f42e05a343436f6a8da2cae4ff77f1e00ade378a58770b0a167ca9e29
-  data.tar.gz: cdd845a88d6a5bae3c590ccac96623be94455c61f5ba356f51279793e80aaedaef65abce71a00983dc0e55ab60465c4a062e60db467b83c235a0bf611da03f4e
+  metadata.gz: 33ede97c3bd18c55c2d1207f02b1e894654ccd53c99149e4928aced25274396180ee75b1abd4c622e4474b9ada15feda507e9b377db3adcfc286e3ab8c5af6e9
+  data.tar.gz: 9ec0c3ffea3b9e831a51c256d71732c059e1ddf2a0484b1f31824d46c145fe575cbb5f34800711bfba713175935dac3f2af5c4f7022de10b2033d5dbe38e0091

data/README.md

@@ -7,7 +7,7 @@ Cloud Firestore is a NoSQL document database built for automatic scaling, high p
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-firestore-admin-v*`.
 The gem `google-cloud-firestore-admin` is the main client library that brings the
-verisoned gems in as dependencies, and provides high-level methods for
+versioned gems in as dependencies, and provides high-level methods for
 constructing clients. More information on versioned clients can be found below
 in the section titled *Which client should I use?*.
 
@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/firestore.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-firestore-admin-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Firestore
       module Admin
-        VERSION = "0.4.1"
+        VERSION = "0.5.1"
       end
     end
   end

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

@@ -59,6 +59,11 @@ module Google
         # You can also specify a different transport by passing `:rest` or `:grpc` in
         # the `transport` parameter.
         #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the given transport of the FirestoreAdmin service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Cloud::Firestore::Admin.firestore_admin_available?}.
+        #
         # ## About FirestoreAdmin
         #
         # The Cloud Firestore Admin API.
@@ -107,6 +112,37 @@ module Google
           service_module.const_get(:Client).new(&block)
         end
 
+        ##
+        # Determines whether the FirestoreAdmin service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Cloud::Firestore::Admin.firestore_admin}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the FirestoreAdmin service,
+        # or if the versioned client gem needs an update to support the FirestoreAdmin service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1`.
+        # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.firestore_admin_available? version: :v1, transport: :grpc
+          require "google/cloud/firestore/admin/#{version.to_s.downcase}"
+          package_name = Google::Cloud::Firestore::Admin
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Cloud::Firestore::Admin.const_get package_name
+          return false unless service_module.const_defined? :FirestoreAdmin
+          service_module = service_module.const_get :FirestoreAdmin
+          if transport == :rest
+            return false unless service_module.const_defined? :Rest
+            service_module = service_module.const_get :Rest
+          end
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
+
         ##
         # Configure the google-cloud-firestore-admin library.
         #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-admin
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -62,7 +61,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: API Client library for the Cloud Firestore Admin API
 test_files: []