google-cloud-gsuite_add_ons 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e07cf79eed2c5eca8677762ad6f581e6e2ebbb11ec02cf2796e85f70881ee881
-  data.tar.gz: 28dac035906e4aa3f567398efeb173ba40cab176251b75e064d9420e7d53c4b5
+  metadata.gz: 1c2f8705c356ffe1c9b4a3611635ee30933502b6aa8d350e0de623efbed37478
+  data.tar.gz: c25b032fe84f49ce77cdb9d367e3e7ae1ac37c42279ff46202dc9f5c420885c2
 SHA512:
-  metadata.gz: 0e14c082f4d9a56424d75d692719cde077fc4c7731cc5030b141d8c1c2b653d8f4c0af85b636dfb2d164195f6001260b00a0075280f9b2cc688dd95b2af021f5
-  data.tar.gz: 2036a996d3c7d629e3ad347850e9084e63beb474ad71416d5f6b9d56f5da45acccf5afe3cf47fbfdf7ab1380722d3f5fd5cc4c742a72289094fa75267e0c082a
+  metadata.gz: 3c0a618b8058e290ada616bedd91f9c593697c66b3bc86a525e6d4ea0823f58bf1fe63c019d9badd7e62a1a1ac31247939883c7e0ac85574cab0277467547c55
+  data.tar.gz: 920c40f52b1449c484cd7eea180aceab1a0ba1ce2d28a4ead5b4c14b153b68c98c9a3960525769a34e7c23d104278785a1019bb465a354aae731c7c063ba7411

data/README.md

@@ -7,7 +7,7 @@ Add-ons are customized applications that integrate with Google Workspace product
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-gsuite_add_ons-v*`.
 The gem `google-cloud-gsuite_add_ons` 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/gsuiteaddons.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-gsuite_add_ons-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-gsuite_add_ons-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/gsuite_add_ons/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module GSuiteAddOns
-      VERSION = "1.0.1"
+      VERSION = "1.1.1"
     end
   end
 end

data/lib/google/cloud/gsuite_add_ons.rb

@@ -58,32 +58,37 @@ 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 GSuiteAddOns service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::GSuiteAddOns.gsuite_add_ons_available?}.
+      #
       # ## About GSuiteAddOns
       #
-      # A service for managing Google Workspace Add-ons deployments.
+      # A service for managing Google Workspace add-ons deployments.
       #
-      # A Google Workspace Add-on is a third-party embedded component that can be
+      # A Google Workspace add-on is a third-party embedded component that can be
       # installed in Google Workspace Applications like Gmail, Calendar, Drive, and
-      # the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can
+      # the Google Docs, Sheets, and Slides editors. Google Workspace add-ons can
       # display UI cards, receive contextual information from the host application,
       # and perform actions in the host application (See:
       # https://developers.google.com/gsuite/add-ons/overview for more information).
       #
-      # A Google Workspace Add-on deployment resource specifies metadata about the
+      # A Google Workspace add-on deployment resource specifies metadata about the
       # add-on, including a specification of the entry points in the host application
       # that trigger add-on executions (see:
       # https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests).
-      # Add-on deployments defined via the Google Workspace Add-ons API define their
+      # Add-on deployments defined via the Google Workspace add-ons API define their
       # entrypoints using HTTPS URLs (See:
       # https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),
       #
-      # A Google Workspace Add-on deployment can be installed in developer mode,
+      # A Google Workspace add-on deployment can be installed in developer mode,
       # which allows an add-on developer to test the experience an end-user would see
       # when installing and running the add-on in their G Suite applications.  When
       # running in developer mode, more detailed error messages are exposed in the
       # add-on UI to aid in debugging.
       #
-      # A Google Workspace Add-on deployment can be published to Google Workspace
+      # A Google Workspace add-on deployment can be published to Google Workspace
       # Marketplace, which allows other Google Workspace users to discover and
       # install the add-on.  See:
       # https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview
@@ -106,6 +111,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the GSuiteAddOns service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::GSuiteAddOns.gsuite_add_ons}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the GSuiteAddOns service,
+      # or if the versioned client gem needs an update to support the GSuiteAddOns 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.gsuite_add_ons_available? version: :v1, transport: :grpc
+        require "google/cloud/gsuite_add_ons/#{version.to_s.downcase}"
+        package_name = Google::Cloud::GSuiteAddOns
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::GSuiteAddOns.const_get package_name
+        return false unless service_module.const_defined? :GSuiteAddOns
+        service_module = service_module.const_get :GSuiteAddOns
+        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-gsuite_add_ons library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-gsuite_add_ons
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.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 Google Workspace Add-ons API
 test_files: []