google-cloud-location 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 263e927c45db3f3a53ff18879b05fc118ef31d050749cc64d75c081712456562
-  data.tar.gz: 20263758aa15afb8299bfd2fda154584a4bd7f0d07e004147bc4b8b2c13956ff
+  metadata.gz: dd1e233e4b343760b20564683d737b507605ad0ae4abc3eddc11299eaa89c4aa
+  data.tar.gz: 6791dbb00ce9f90a51142d523e25f2043d97c045e10485b1c499df7a0489b17b
 SHA512:
-  metadata.gz: 3ace33f3a9838f36047a2d698ed64ed8042d90d9832e1da13ff01d81e3432d8db15ef4bc9a09da11c837f4e8bddc186fbb89730fc516e5827afd0b4013eb1880
-  data.tar.gz: 1014849345a7f13a0aea722065e01b09c3c9d45c00000317bbd8921b71d202a2fdb3299f9fe3342e76fc0d3e09a6e5acb67932666bd309a512ecfccdcc04dd04
+  metadata.gz: 76cecd15fc50164e65f258cbcb8ff522a508c85753eba9a108511639ecfc36df7d51ded6d4e09a028cc81c93e1b7d152d088b2344ca3f7d9fb8785f2d95237de
+  data.tar.gz: 0351bf8233e91f436ddf9fd09ec59a7421c74f8ecb7a6b3f52a692b2db266e813d73a50c4a1748c2f5f1e24fb2f9b6a9bb1c54324172ea5b128af1fb843fce87

data/AUTHENTICATION.md

@@ -1,149 +1,122 @@
 # Authentication
 
-In general, the google-cloud-location library uses
-[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running within
-[Google Cloud Platform environments](#google-cloud-platform-environments) the
-credentials will be discovered automatically. When running on other
-environments, the Service Account credentials can be specified by providing the
-path to the
-[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
-for the account (or the JSON itself) in
-[environment variables](#environment-variables). Additionally, Cloud SDK
-credentials can also be discovered automatically, but this is only recommended
-during development.
+The recommended way to authenticate to the google-cloud-location library is to use
+[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
+To review all of your authentication options, see [Credentials lookup](#credential-lookup).
 
 ## Quickstart
 
-1. [Create a service account and credentials](#creating-a-service-account).
-2. Set the [environment variable](#environment-variables).
+The following example shows how to set up authentication for a local development
+environment with your user credentials. 
 
-```sh
-export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
-```
-
-3. Initialize the client.
+**NOTE:** This method is _not_ recommended for running in production. User credentials
+should be used only during development.
 
-```ruby
-require "google/cloud/location"
+1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
+2. Set up a local ADC file with your user credentials:
 
-client = ::Google::Cloud::Location::Locations::Client.new
+```sh
+gcloud auth application-default login
 ```
 
-## Credential Lookup
-
-The google-cloud-location library aims to make authentication
-as simple as possible, and provides several mechanisms to configure your system
-without requiring **Service Account Credentials** directly in code.
-
-**Credentials** are discovered in the following order:
-
-1. Specify credentials in method arguments
-2. Specify credentials in configuration
-3. Discover credentials path in environment variables
-4. Discover credentials JSON in environment variables
-5. Discover credentials file in the Cloud SDK's path
-6. Discover GCP credentials
-
-### Google Cloud Platform environments
+3. Write code as if already authenticated.
 
-When running on Google Cloud Platform (GCP), including Google Compute Engine
-(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
-Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
-Code should be written as if already authenticated.
+For more information about setting up authentication for a local development environment, see
+[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
 
-### Environment Variables
+## Credential Lookup
 
-The **Credentials JSON** can be placed in environment variables instead of
-declaring them directly in code. Each service has its own environment variable,
-allowing for different service accounts to be used for different services. (See
-the READMEs for the individual service gems for details.) The path to the
-**Credentials JSON** file can be stored in the environment variable, or the
-**Credentials JSON** itself can be stored for environments such as Docker
-containers where writing files is difficult or not encouraged.
+The google-cloud-location library provides several mechanisms to configure your system.
+Generally, using Application Default Credentials to facilitate automatic 
+credentials discovery is the easist method. But if you need to explicitly specify
+credentials, there are several methods available to you.
 
-The environment variables that google-cloud-location
-checks for credentials are configured on the service Credentials class (such as
-{::Google::Cloud::Location::Locations::Credentials}):
+Credentials are accepted in the following ways, in the following order or precedence:
 
-* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+1. Credentials specified in method arguments
+2. Credentials specified in configuration
+3. Credentials pointed to or included in environment variables
+4. Credentials found in local ADC file
+5. Credentials returned by the metadata server for the attached service account (GCP)
 
-```ruby
-require "google/cloud/location"
-
-ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
+### Configuration
 
-client = ::Google::Cloud::Location::Locations::Client.new
-```
+You can configure a path to a JSON credentials file, either for an individual client object or
+globally, for all client objects. The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
 
-### Configuration
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
 
-The path to the **Credentials JSON** file can be configured instead of storing
-it in an environment variable. Either on an individual client initialization:
+To configure a credentials file for an individual client initialization:
 
 ```ruby
 require "google/cloud/location"
 
 client = ::Google::Cloud::Location::Locations::Client.new do |config|
-  config.credentials = "path/to/keyfile.json"
+  config.credentials = "path/to/credentialfile.json"
 end
 ```
 
-Or globally for all clients:
+To configure a credentials file globally for all clients:
 
 ```ruby
 require "google/cloud/location"
 
 ::Google::Cloud::Location::Locations::Client.configure do |config|
-  config.credentials = "path/to/keyfile.json"
+  config.credentials = "path/to/credentialfile.json"
 end
 
 client = ::Google::Cloud::Location::Locations::Client.new
 ```
 
-### Cloud SDK
+### Environment Variables
 
-This option allows for an easy way to authenticate during development. If
-credentials are not provided in code or in environment variables, then Cloud SDK
-credentials are discovered.
+You can also use an environment variable to provide a JSON credentials file.
+The environment variable can contain a path to the credentials file or, for
+environments such as Docker containers where writing files is not encouraged,
+you can include the credentials file itself.
 
-To configure your system for this, simply:
+The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
 
-1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
-3. Write code as if already authenticated.
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
+
+The environment variables that google-cloud-location
+checks for credentials are:
 
-**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
-*should* only be used during development.
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
-## Creating a Service Account
+```ruby
+require "google/cloud/location"
 
-Google Cloud requires **Service Account Credentials** to
-connect to the APIs. You will use the **JSON key file** to
-connect to most services with google-cloud-location.
+ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
 
-If you are not running this client within
-[Google Cloud Platform environments](#google-cloud-platform-environments), you
-need a Google Developers service account.
+client = ::Google::Cloud::Location::Locations::Client.new
+```
 
-1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
-2. Create a new project or click on an existing project.
-3. Activate the menu in the upper left and select **APIs & Services**. From
-   here, you will enable the APIs that your application requires.
+### Local ADC file
 
-   *Note: You may need to enable billing in order to use these services.*
+You can set up a local ADC file with your user credentials for authentication during
+development. If credentials are not provided in code or in environment variables,
+then the local ADC credentials are discovered.
 
-4. Select **Credentials** from the side navigation.
+Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
 
-   Find the "Create credentials" drop down near the top of the page, and select
-   "Service account" to be guided through downloading a new JSON key file.
+### Google Cloud Platform environments
 
-   If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, click the pencil
-   tool on the right side to edit the service account, select the **Keys** tab,
-   and then select **Add Key**.
+When running on Google Cloud Platform (GCP), including Google Compute Engine
+(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
+Functions (GCF) and Cloud Run, credentials are retrieved from the attached
+service account automatically. Code should be written as if already authenticated.
 
-   The key file you download will be used by this library to authenticate API
-   requests and should be stored in a secure location.
+For more information, see
+[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).

data/lib/google/cloud/location/locations/client.rb

@@ -31,6 +31,9 @@ module Google
         # {::Google::Cloud::Location::Location#metadata Location.metadata} field.
         #
         class Client
+          # @private
+          DEFAULT_ENDPOINT_TEMPLATE = "cloud.$UNIVERSE_DOMAIN$"
+
           # @private
           attr_reader :locations_stub
 
@@ -89,6 +92,15 @@ module Google
             @config
           end
 
+          ##
+          # The effective universe domain
+          #
+          # @return [String]
+          #
+          def universe_domain
+            @locations_stub.universe_domain
+          end
+
           ##
           # Create a new Locations client object.
           #
@@ -122,8 +134,9 @@ module Google
             credentials = @config.credentials
             # Use self-signed JWT if the endpoint is unchanged from default,
             # but only if the default endpoint does not have a region prefix.
-            enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                     !@config.endpoint.split(".").first.include?("-")
+            enable_self_signed_jwt = @config.endpoint.nil? ||
+                                     (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                     !@config.endpoint.split(".").first.include?("-"))
             credentials ||= Credentials.default scope: @config.scope,
                                                 enable_self_signed_jwt: enable_self_signed_jwt
             if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -134,10 +147,13 @@ module Google
 
             @locations_stub = ::Gapic::ServiceStub.new(
               ::Google::Cloud::Location::Locations::Stub,
-              credentials:  credentials,
-              endpoint:     @config.endpoint,
+              credentials: credentials,
+              endpoint: @config.endpoint,
+              endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+              universe_domain: @config.universe_domain,
               channel_args: @config.channel_args,
-              interceptors: @config.interceptors
+              interceptors: @config.interceptors,
+              channel_pool_config: @config.channel_pool
             )
           end
 
@@ -354,9 +370,9 @@ module Google
           #   end
           #
           # @!attribute [rw] endpoint
-          #   The hostname or hostname:port of the service endpoint.
-          #   Defaults to `"cloud.googleapis.com"`.
-          #   @return [::String]
+          #   A custom service endpoint, as a hostname or hostname:port. The default is
+          #   nil, indicating to use the default endpoint in the current universe domain.
+          #   @return [::String,nil]
           # @!attribute [rw] credentials
           #   Credentials to send with calls. You may provide any of the following types:
           #    *  (`String`) The path to a service account key file in JSON format
@@ -402,13 +418,20 @@ module Google
           # @!attribute [rw] quota_project
           #   A separate project against which to charge quota.
           #   @return [::String]
+          # @!attribute [rw] universe_domain
+          #   The universe domain within which to make requests. This determines the
+          #   default endpoint URL. The default value of nil uses the environment
+          #   universe (usually the default "googleapis.com" universe).
+          #   @return [::String,nil]
           #
           class Configuration
             extend ::Gapic::Config
 
+            # @private
+            # The endpoint specific to the default "googleapis.com" universe. Deprecated.
             DEFAULT_ENDPOINT = "cloud.googleapis.com"
 
-            config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+            config_attr :endpoint,      nil, ::String, nil
             config_attr :credentials,   nil do |value|
               allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
               allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -423,6 +446,7 @@ module Google
             config_attr :metadata,      nil, ::Hash, nil
             config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
             config_attr :quota_project, nil, ::String, nil
+            config_attr :universe_domain, nil, ::String, nil
 
             # @private
             def initialize parent_config = nil
@@ -443,6 +467,14 @@ module Google
               end
             end
 
+            ##
+            # Configuration for the channel pool
+            # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+            #
+            def channel_pool
+              @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+            end
+
             ##
             # Configuration RPC class for the Locations API.
             #

data/lib/google/cloud/location/locations/rest/client.rb

@@ -33,6 +33,9 @@ module Google
           # {::Google::Cloud::Location::Location#metadata Location.metadata} field.
           #
           class Client
+            # @private
+            DEFAULT_ENDPOINT_TEMPLATE = "cloud.$UNIVERSE_DOMAIN$"
+
             # @private
             attr_reader :locations_stub
 
@@ -91,6 +94,15 @@ module Google
               @config
             end
 
+            ##
+            # The effective universe domain
+            #
+            # @return [String]
+            #
+            def universe_domain
+              @locations_stub.universe_domain
+            end
+
             ##
             # Create a new Locations REST client object.
             #
@@ -118,8 +130,9 @@ module Google
               credentials = @config.credentials
               # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                       !@config.endpoint.split(".").first.include?("-")
+              enable_self_signed_jwt = @config.endpoint.nil? ||
+                                       (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                       !@config.endpoint.split(".").first.include?("-"))
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
               if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -129,7 +142,12 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
-              @locations_stub = ::Google::Cloud::Location::Locations::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+              @locations_stub = ::Google::Cloud::Location::Locations::Rest::ServiceStub.new(
+                endpoint: @config.endpoint,
+                endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                universe_domain: @config.universe_domain,
+                credentials: credentials
+              )
             end
 
             # Service calls
@@ -167,6 +185,26 @@ module Google
             # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Location::Location>]
             #
             # @raise [::Google::Cloud::Error] if the REST call is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/location"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Location::Locations::Rest::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Location::ListLocationsRequest.new
+            #
+            #   # Call the list_locations method.
+            #   result = client.list_locations request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
+            #     # Each element is of type ::Google::Cloud::Location::Location.
+            #     p item
+            #   end
+            #
             def list_locations request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -232,6 +270,22 @@ module Google
             # @return [::Google::Cloud::Location::Location]
             #
             # @raise [::Google::Cloud::Error] if the REST call is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/location"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Location::Locations::Rest::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Location::GetLocationRequest.new
+            #
+            #   # Call the get_location method.
+            #   result = client.get_location request
+            #
+            #   # The returned object is of type Google::Cloud::Location::Location.
+            #   p result
+            #
             def get_location request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -299,9 +353,9 @@ module Google
             #   end
             #
             # @!attribute [rw] endpoint
-            #   The hostname or hostname:port of the service endpoint.
-            #   Defaults to `"cloud.googleapis.com"`.
-            #   @return [::String]
+            #   A custom service endpoint, as a hostname or hostname:port. The default is
+            #   nil, indicating to use the default endpoint in the current universe domain.
+            #   @return [::String,nil]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
             #    *  (`String`) The path to a service account key file in JSON format
@@ -338,13 +392,20 @@ module Google
             # @!attribute [rw] quota_project
             #   A separate project against which to charge quota.
             #   @return [::String]
+            # @!attribute [rw] universe_domain
+            #   The universe domain within which to make requests. This determines the
+            #   default endpoint URL. The default value of nil uses the environment
+            #   universe (usually the default "googleapis.com" universe).
+            #   @return [::String,nil]
             #
             class Configuration
               extend ::Gapic::Config
 
+              # @private
+              # The endpoint specific to the default "googleapis.com" universe. Deprecated.
               DEFAULT_ENDPOINT = "cloud.googleapis.com"
 
-              config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+              config_attr :endpoint,      nil, ::String, nil
               config_attr :credentials,   nil do |value|
                 allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed.any? { |klass| klass === value }
@@ -356,6 +417,7 @@ module Google
               config_attr :metadata,      nil, ::Hash, nil
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
+              config_attr :universe_domain, nil, ::String, nil
 
               # @private
               # Overrides for http bindings for the RPCs of this service

data/lib/google/cloud/location/locations/rest/service_stub.rb

@@ -29,16 +29,28 @@ module Google
           # including transcoding, making the REST call, and deserialing the response.
           #
           class ServiceStub
-            def initialize endpoint:, credentials:
+            def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
               # These require statements are intentionally placed here to initialize
               # the REST modules only when it's required.
               require "gapic/rest"
 
-              @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+              @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                           endpoint_template: endpoint_template,
+                                                           universe_domain: universe_domain,
+                                                           credentials: credentials,
                                                            numeric_enums: true,
                                                            raise_faraday_errors: false
             end
 
+            ##
+            # The effective universe domain
+            #
+            # @return [String]
+            #
+            def universe_domain
+              @client_stub.universe_domain
+            end
+
             ##
             # Baseline implementation for the list_locations REST call
             #

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Location
-      VERSION = "0.5.1"
+      VERSION = "0.7.0"
     end
   end
 end

data/proto_docs/google/api/client.rb

@@ -21,6 +21,7 @@ module Google
   module Api
     # Required information for every language.
     # @!attribute [rw] reference_docs_uri
+    #   @deprecated This field is deprecated and may be removed in the next major version update.
     #   @return [::String]
     #     Link to automatically generated reference documentation.  Example:
     #     https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
     #                seconds: 360 # 6 minutes
     #              total_poll_timeout:
     #                 seconds: 54000 # 90 minutes
+    # @!attribute [rw] auto_populated_fields
+    #   @return [::Array<::String>]
+    #     List of top-level fields of the request message, that should be
+    #     automatically populated by the client libraries based on their
+    #     (google.api.field_info).format. Currently supported format: UUID4.
+    #
+    #     Example of a YAML configuration:
+    #
+    #      publishing:
+    #        method_settings:
+    #          - selector: google.example.v1.ExampleService.CreateExample
+    #            auto_populated_fields:
+    #            - request_id
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-location
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.21.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.21.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: API Client library for the Locations API