google-cloud-cloud_controls_partner 0.a → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caa0c6c32f5298c94e816da53e96734d926e4db97db3885915a3317cd3527484
-  data.tar.gz: 63d42adb5c23ecfa5eb20f158d0018144b0bf6fb5b91c926982f0e30dd940bd6
+  metadata.gz: 60200f53d028c1c3abc78fe135f426c003067318862bd0e7c93d8e54737aa50a
+  data.tar.gz: f8562b0f208349ef7ab5e1e7c2db7d850bd6cdef415ef756a6c8e45f71f0e533
 SHA512:
-  metadata.gz: 7daef5e6e50ffb6b0bd1abaa7ceef28f1f3af55124d543d8f355f21889486763ddcb14992f3c20f38fc2568c2122b1d8d822923ecfe3055100223026834d387a
-  data.tar.gz: 41e03a88683f23c86b15256f9b8019aa3258a04b278bd041ad6eddc6dc07bbaabf095137b5ad32f97d2abda08d7510de640a03f7f58fdf885080e741f930c59a
+  metadata.gz: cf6f083bf2c515605abc619d80e5b443b74eab7815ddfa5c5752336a255570ad50138c2768af7efb2dbc3bae0ce50c49414ce20aca4396e08b37eb98b3e95105
+  data.tar.gz: 0ae88e7bfe21d76bd0c5e2f864f57dc0d2ee0e5389ab628850c8d3c0f1c02af47961efe891cc60c5c0e81eedf842178799ca0ac9c7cf911aa2565f7ba9baffa4

data/.yardopts

@@ -0,0 +1,11 @@
+--no-private
+--title="Cloud Controls Partner API"
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+
+./lib/**/*.rb
+-
+README.md
+AUTHENTICATION.md
+LICENSE.md

data/AUTHENTICATION.md

@@ -0,0 +1,122 @@
+# Authentication
+
+The recommended way to authenticate to the google-cloud-cloud_controls_partner 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
+
+The following example shows how to set up authentication for a local development
+environment with your user credentials. 
+
+**NOTE:** This method is _not_ recommended for running in production. User credentials
+should be used only during development.
+
+1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
+2. Set up a local ADC file with your user credentials:
+
+```sh
+gcloud auth application-default login
+```
+
+3. Write code 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).
+
+## Credential Lookup
+
+The google-cloud-cloud_controls_partner 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.
+
+Credentials are accepted in the following ways, in the following order or precedence:
+
+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)
+
+### Configuration
+
+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).
+
+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.
+
+To configure a credentials file for an individual client initialization:
+
+```ruby
+require "google/cloud/cloud_controls_partner"
+
+client = Google::Cloud::CloudControlsPartner.cloud_controls_partner_core do |config|
+  config.credentials = "path/to/credentialfile.json"
+end
+```
+
+To configure a credentials file globally for all clients:
+
+```ruby
+require "google/cloud/cloud_controls_partner"
+
+Google::Cloud::CloudControlsPartner.configure do |config|
+  config.credentials = "path/to/credentialfile.json"
+end
+
+client = Google::Cloud::CloudControlsPartner.cloud_controls_partner_core
+```
+
+### Environment Variables
+
+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.
+
+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).
+
+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-cloud_controls_partner
+checks for credentials are:
+
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/cloud/cloud_controls_partner"
+
+ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
+
+client = Google::Cloud::CloudControlsPartner.cloud_controls_partner_core
+```
+
+### Local ADC file
+
+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.
+
+Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
+
+### 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 retrieved from the attached
+service account automatically. Code should be written as if already authenticated.
+
+For more information, see
+[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).

data/README.md

@@ -1,8 +1,104 @@
-# Placeholder for Ruby gem google-cloud-cloud_controls_partner
-
-This is a placeholder for the future Google-authored gem google-cloud-cloud_controls_partner.
-This placeholder is being released on 2024-02-23 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 Cloud Controls Partner API
+
+Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.
+
+Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.
+
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-cloud-cloud_controls_partner-v*`.
+The gem `google-cloud-cloud_controls_partner` is the main client library that brings the
+verisoned 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?*.
+
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_controls_partner/latest)
+for this library, google-cloud-cloud_controls_partner, to see the convenience methods for
+constructing client objects. Reference documentation for the client objects
+themselves can be found in the client library documentation for the versioned
+client gems:
+[google-cloud-cloud_controls_partner-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_controls_partner-v1/latest).
+
+See also the [Product Documentation](https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest)
+for more usage information.
+
+## Quick Start
+
+```
+$ gem install google-cloud-cloud_controls_partner
+```
+
+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/cloudcontrolspartner.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Supported Ruby Versions
+
+This library is supported on Ruby 2.7+.
+
+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-cloud_controls_partner`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-cloud_controls_partner-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-cloud_controls_partner`.
+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-cloud_controls_partner-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/cloud_controls_partner/version.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # Copyright 2024 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
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#     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,
@@ -12,10 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
 module Google
   module Cloud
     module CloudControlsPartner
-      VERSION = "0.a"
+      VERSION = "0.1.0"
     end
   end
 end

data/lib/google/cloud/cloud_controls_partner.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 this file early so that the version constant gets defined before
+# requiring "google/cloud". This is because google-cloud-core will load the
+# entrypoint (gem name) file, which in turn re-requires this file (hence
+# causing a require cycle) unless the version constant is already defined.
+require "google/cloud/cloud_controls_partner/version"
+
+require "googleauth"
+gem "google-cloud-core"
+require "google/cloud" unless defined? ::Google::Cloud.new
+require "google/cloud/config"
+
+# Set the default configuration
+::Google::Cloud.configure.add_config! :cloud_controls_partner do |config|
+  config.add_field! :endpoint,      nil, match: ::String
+  config.add_field! :credentials,   nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
+  config.add_field! :scope,         nil, match: [::Array, ::String]
+  config.add_field! :lib_name,      nil, match: ::String
+  config.add_field! :lib_version,   nil, match: ::String
+  config.add_field! :interceptors,  nil, match: ::Array
+  config.add_field! :timeout,       nil, match: ::Numeric
+  config.add_field! :metadata,      nil, match: ::Hash
+  config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
+  config.add_field! :quota_project, nil, match: ::String
+  config.add_field! :universe_domain, nil, match: ::String
+end
+
+module Google
+  module Cloud
+    module CloudControlsPartner
+      ##
+      # Create a new client object for CloudControlsPartnerCore.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerCore::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_controls_partner-v1/latest/Google-Cloud-CloudControlsPartner-V1-CloudControlsPartnerCore-Client)
+      # for a gRPC client for version V1 of the API.
+      # However, you can specify a different API version by passing it in the
+      # `version` parameter. If the CloudControlsPartnerCore service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      # You can also specify a different transport by passing `:rest` or `:grpc` in
+      # the `transport` parameter.
+      #
+      # ## About CloudControlsPartnerCore
+      #
+      # Service describing handlers for resources
+      #
+      # @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 [::Object] A client object for the specified version.
+      #
+      def self.cloud_controls_partner_core version: :v1, transport: :grpc, &block
+        require "google/cloud/cloud_controls_partner/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::CloudControlsPartner
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::CloudControlsPartner.const_get(package_name).const_get(:CloudControlsPartnerCore)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Create a new client object for CloudControlsPartnerMonitoring.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::CloudControlsPartner::V1::CloudControlsPartnerMonitoring::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_controls_partner-v1/latest/Google-Cloud-CloudControlsPartner-V1-CloudControlsPartnerMonitoring-Client)
+      # for a gRPC client for version V1 of the API.
+      # However, you can specify a different API version by passing it in the
+      # `version` parameter. If the CloudControlsPartnerMonitoring service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      # You can also specify a different transport by passing `:rest` or `:grpc` in
+      # the `transport` parameter.
+      #
+      # ## About CloudControlsPartnerMonitoring
+      #
+      # Service describing handlers for resources
+      #
+      # @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 [::Object] A client object for the specified version.
+      #
+      def self.cloud_controls_partner_monitoring version: :v1, transport: :grpc, &block
+        require "google/cloud/cloud_controls_partner/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::CloudControlsPartner
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::CloudControlsPartner.const_get(package_name).const_get(:CloudControlsPartnerMonitoring)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Configure the google-cloud-cloud_controls_partner library.
+      #
+      # The following configuration parameters are supported:
+      #
+      # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
+      #   The path to the keyfile as a String, the contents of the keyfile as a
+      #   Hash, or a Google::Auth::Credentials object.
+      # * `lib_name` (*type:* `String`) -
+      #   The library name as recorded in instrumentation and logging.
+      # * `lib_version` (*type:* `String`) -
+      #   The library version as recorded in instrumentation and logging.
+      # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
+      #   An array of interceptors that are run before calls are executed.
+      # * `timeout` (*type:* `Numeric`) -
+      #   Default timeout in seconds.
+      # * `metadata` (*type:* `Hash{Symbol=>String}`) -
+      #   Additional headers to be sent with the call.
+      # * `retry_policy` (*type:* `Hash`) -
+      #   The retry policy. The value is a hash with the following keys:
+      #     * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+      #     * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+      #     * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+      #     * `:retry_codes` (*type:* `Array<String>`) -
+      #       The error codes that should trigger a retry.
+      #
+      # @return [::Google::Cloud::Config] The default configuration used by this library
+      #
+      def self.configure
+        yield ::Google::Cloud.configure.cloud_controls_partner if block_given?
+
+        ::Google::Cloud.configure.cloud_controls_partner
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "cloud_controls_partner", "helpers.rb"
+require "google/cloud/cloud_controls_partner/helpers" if ::File.file? helper_path

data/lib/google-cloud-cloud_controls_partner.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 "google/cloud/cloud_controls_partner" unless defined? Google::Cloud::CloudControlsPartner::VERSION

metadata

@@ -1,27 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-cloud_controls_partner
 version: !ruby/object:Gem::Version
-  version: 0.a
+  version: 0.1.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
-dependencies: []
-description: Placeholder for the future Google-authored gem google-cloud-cloud_controls_partner.
-  This placeholder is being released on 2024-02-23 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.
+date: 2024-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-cloud_controls_partner-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+- !ruby/object:Gem::Dependency
+  name: google-cloud-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Provides insights about your customers and their Assured Workloads based
+  on your Sovereign Controls by Partners offering.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- AUTHENTICATION.md
 - LICENSE.md
 - README.md
+- lib/google-cloud-cloud_controls_partner.rb
+- lib/google/cloud/cloud_controls_partner.rb
 - lib/google/cloud/cloud_controls_partner/version.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
@@ -35,15 +70,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
-summary: Placeholder for the future Google-authored gem google-cloud-cloud_controls_partner
+summary: Provides insights about your customers and their Assured Workloads based
+  on your Sovereign Controls by Partners offering.
 test_files: []