google-cloud-config-v1 0.a → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d82b7b5bd0998214b93958280648b52580ff4be8280e722e1344304ada241de
-  data.tar.gz: 3d8debdf93c54141c39b528ffb54a54bded174ca22683723c862f3397cb840bb
+  metadata.gz: fc3d9a9e865a8cfcab308c2166eef2a43a4a02eba5d7f5d1372b3df56957be9a
+  data.tar.gz: 264914ecac7b05cc9c5534cab32bb91331bd4d8c97e245adbaff521a9dd134be
 SHA512:
-  metadata.gz: b442555569f99508acecab06c97f5da4956874c8fab2b63919100257f6839179a4feb6530a9561b7cc2646ab8e230766659ae9183cbe21797a2d0ed9f7339599
-  data.tar.gz: 0a453d5ed1a5e6e1513ac1e972e1f81bfecae91a0841357fc269ddde20fcfaa3bf4b87967efa72f6ea7ee566774d4dfffa4dd6e3432d295dc8248ec0972aa732
+  metadata.gz: 0d32fa00a04e03f06a13a1e7b4a2754ec2684b1617fea2d636185bfa123d8e661c5c88f1eee983026fc41e2baaeaf928bd2cb83b126e68a606efb01feb65e53d
+  data.tar.gz: 0c4bff221133e248a1479ded636848e1b3a14d1f65c62d2683272fe9ce48b574330e983e6b994c251092ebe8f5de473a981e7f46ccb32e45f45a1fa5ffec1d84

data/.yardopts

@@ -0,0 +1,12 @@
+--no-private
+--title="Infrastructure Manager V1 API"
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+
+./lib/**/*.rb
+./proto_docs/**/*.rb
+-
+README.md
+LICENSE.md
+AUTHENTICATION.md

data/AUTHENTICATION.md

@@ -0,0 +1,149 @@
+# Authentication
+
+In general, the google-cloud-config-v1 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.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/config/v1"
+
+client = ::Google::Cloud::Config::V1::Config::Client.new
+```
+
+## Credential Lookup
+
+The google-cloud-config-v1 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
+
+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.
+
+### Environment Variables
+
+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 environment variables that google-cloud-config-v1
+checks for credentials are configured on the service Credentials class (such as
+{::Google::Cloud::Config::V1::Config::Credentials}):
+
+* `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
+
+```ruby
+require "google/cloud/config/v1"
+
+ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
+
+client = ::Google::Cloud::Config::V1::Config::Client.new
+```
+
+### Configuration
+
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
+
+```ruby
+require "google/cloud/config/v1"
+
+client = ::Google::Cloud::Config::V1::Config::Client.new do |config|
+  config.credentials = "path/to/keyfile.json"
+end
+```
+
+Or globally for all clients:
+
+```ruby
+require "google/cloud/config/v1"
+
+::Google::Cloud::Config::V1::Config::Client.configure do |config|
+  config.credentials = "path/to/keyfile.json"
+end
+
+client = ::Google::Cloud::Config::V1::Config::Client.new
+```
+
+### Cloud SDK
+
+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.
+
+To configure your system for this, simply:
+
+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:** This is _not_ recommended for running in production. The Cloud SDK
+*should* only be used during development.
+
+## Creating a Service Account
+
+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-config-v1.
+
+If you are not running this client within
+[Google Cloud Platform environments](#google-cloud-platform-environments), you
+need a Google Developers service account.
+
+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.
+
+   *Note: You may need to enable billing in order to use these services.*
+
+4. Select **Credentials** from the side navigation.
+
+   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.
+
+   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**.
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.

data/README.md

@@ -1,8 +1,144 @@
-# Placeholder for Ruby gem google-cloud-config-v1
-
-This is a placeholder for the future Google-authored gem google-cloud-config-v1.
-This placeholder is being released on 2023-08-21 in order to reserve the name.
-The final gem should be available shortly after that date. If it has not been
-released in a timely manner, or if this placeholder interferes with your work,
-you can contact the Google Ruby team by opening an issue in the GitHub
-repository https://github.com/googleapis/google-cloud-ruby.
+# Ruby Client for the Infrastructure Manager V1 API
+
+Creates and manages Google Cloud Platform resources and infrastructure.
+
+Creates and manages Google Cloud Platform resources and infrastructure.
+
+https://github.com/googleapis/google-cloud-ruby
+
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Infrastructure Manager V1 API. Most users should consider using
+the main client gem,
+[google-cloud-config](https://rubygems.org/gems/google-cloud-config).
+See the section below titled *Which client should I use?* for more information.
+
+## Installation
+
+```
+$ gem install google-cloud-config-v1
+```
+
+## Before You Begin
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/config.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/config/v1"
+
+client = ::Google::Cloud::Config::V1::Config::Client.new
+request = ::Google::Cloud::Config::V1::ListDeploymentsRequest.new # (request fields as keyword arguments...)
+response = client.list_deployments request
+```
+
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-config-v1/latest)
+for class and method documentation.
+
+See also the [Product Documentation](https://cloud.google.com/infrastructure-manager/docs/overview)
+for general usage information.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
+## Supported Ruby Versions
+
+This library is supported on Ruby 2.6+.
+
+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
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-config`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-config-v1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-config`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-config-v1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google/cloud/config/v1/bindings_override.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/config"
+
+module Google
+  module Cloud
+    module Config
+      ##
+      # @example Loading just the REST part of this package, including all its services, and instantiating a REST client
+      #
+      #     require "google/cloud/config/v1/rest"
+      #     client = ::Google::Cloud::Config::V1::Config::Rest::Client.new
+      #
+      module V1
+        ##
+        # @private
+        # Initialize the mixin bindings configuration
+        #
+        def self.configure
+          @configure ||= begin
+            namespace = ["Google", "Cloud", "Config"]
+            parent_config = while namespace.any?
+                              parent_name = namespace.join "::"
+                              parent_const = const_get parent_name
+                              break parent_const.configure if parent_const.respond_to? :configure
+                              namespace.pop
+                            end
+
+            default_config = Configuration.new parent_config
+            default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{name}",
+                matches: [
+                  ["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{name}/locations",
+                matches: [
+                  ["name", %r{^projects/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.iam.v1.IAMPolicy.GetIamPolicy"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{resource}:getIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/deployments/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.iam.v1.IAMPolicy.SetIamPolicy"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:setIamPolicy",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/deployments/[^/]+/?$}, false]
+                ],
+                body: "*"
+              )
+            ]
+            default_config.bindings_override["google.iam.v1.IAMPolicy.TestIamPermissions"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :post,
+                uri_template: "/v1/{resource}:testIamPermissions",
+                matches: [
+                  ["resource", %r{^projects/[^/]+/locations/[^/]+/deployments/[^/]+/?$}, false]
+                ],
+                body: "*"
+              )
+            ]
+            default_config
+          end
+          yield @configure if block_given?
+          @configure
+        end
+
+        ##
+        # @private
+        # Configuration class for the google.cloud.config.v1 package.
+        #
+        # This class contains common configuration for all services
+        # of the google.cloud.config.v1 package.
+        #
+        # This configuration is for internal use of the client library classes,
+        # and it is not intended that the end-users will read or change it.
+        #
+        class Configuration
+          extend ::Gapic::Config
+
+          # @private
+          # Overrides for http bindings for the RPC of the mixins for this package.
+          # Services in this package should use these when creating clients for the mixin services.
+          # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
+          config_attr :bindings_override, {}, ::Hash, nil
+
+          # @private
+          def initialize parent_config = nil
+            @parent_config = parent_config unless parent_config.nil?
+
+            yield self if block_given?
+          end
+        end
+      end
+    end
+  end
+end