google-cloud-storage-control 0.a → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26fc68a91118b88fd906bdb282fbc9da2d6221c9db3fd2a6c0ae531e551c6dbf
-  data.tar.gz: a7928b848228a96c105738d702fa458d99c05208af800419c34d1279861d1eaa
+  metadata.gz: 5c2d3e7be92081a7e02127bbefc968cca6b4aa86142704e812fdd3500503c002
+  data.tar.gz: c3973974f07988831f0ae9915c2a7bd07824ae7996e051004df36b6f1716e0a2
 SHA512:
-  metadata.gz: 8f2f1c3df264a22daf75836486cdd3b782d4b21df010d4cee6cbbe591de33eeb5f0499a9175a435cfa563a020256294d8c4e6268626d9d59c57c8ac2fe91fb35
-  data.tar.gz: 8107f782b3290e33f78e30af1ff99b599aef6645bec11ca30f78907d407aaac6985e8a38956552c3fcf7044f7e2ddd17e3e6f940beeff001dd203bef16de79d3
+  metadata.gz: 7cfbb17d4dd71fa2fbd350530a5599c7919b70fd5e45c6431db26c8f3cae3aead2109e7edb433bea1073c11edfe41ff7b7de888a2dbfea17c1e3296ad37d1264
+  data.tar.gz: b9aace1f61b9e5bc4fa41d2b3979ac6b30ec12df2bc82a52ebfcfb5e182c62ae11d0f1c49cfd99fecad5609b7c43abb63687871dd54739f1bed1d08617682dda

data/.yardopts

@@ -0,0 +1,11 @@
+--no-private
+--title="Storage Control 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-storage-control 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-storage-control 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/storage/control"
+
+client = Google::Cloud::Storage::Control.storage_control do |config|
+  config.credentials = "path/to/credentialfile.json"
+end
+```
+
+To configure a credentials file globally for all clients:
+
+```ruby
+require "google/cloud/storage/control"
+
+Google::Cloud::Storage::Control.configure do |config|
+  config.credentials = "path/to/credentialfile.json"
+end
+
+client = Google::Cloud::Storage::Control.storage_control
+```
+
+### 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-storage-control
+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/storage/control"
+
+ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
+
+client = Google::Cloud::Storage::Control.storage_control
+```
+
+### 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,130 @@
-# Placeholder for Ruby gem google-cloud-storage-control
-
-This is a placeholder for the future Google-authored gem google-cloud-storage-control.
-This placeholder is being released on 2024-04-18 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 Storage Control API
+
+The Storage Control API lets you perform metadata-specific, control plane, and long-running operations. The Storage Control API creates one space to perform metadata-specific, control plane, and long-running operations apart from the Storage API. Separating these operations from the Storage API improves API standardization and lets you run faster releases.
+
+The Google Cloud Storage API allows applications to read and write data through the abstractions of buckets and objects, which are similar to directories and files except that buckets cannot contain other buckets, and directory-level operations (like directory rename) are not supported. Buckets share a single global namespace, and each bucket belongs to a specific project that has an associated owner that pays for the data stored in the bucket. This API is accessed using standard gRPC requests.
+
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-cloud-storage-control-v*`.
+The gem `google-cloud-storage-control` 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-storage-control/latest)
+for this library, google-cloud-storage-control, 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-storage-control-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-storage-control-v2/latest).
+
+See also the [Product Documentation](https://cloud.google.com/storage/docs/overview)
+for more usage information.
+
+## Quick Start
+
+```
+$ gem install google-cloud-storage-control
+```
+
+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/storage.googleapis.com)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## 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
+```
+
+## 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-storage-control`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-storage-control-v2`.
+_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-storage-control`.
+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-storage-control-v2`.
+
+### 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/storage/control/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,11 +14,14 @@
 # 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 Storage
       module Control
-        VERSION = "0.a"
+        VERSION = "0.1.0"
       end
     end
   end

data/lib/google/cloud/storage/control.rb

@@ -0,0 +1,118 @@
+# 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/storage/control/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! :storage_control 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 Storage
+      module Control
+        ##
+        # Create a new client object for StorageControl.
+        #
+        # By default, this returns an instance of
+        # [Google::Cloud::Storage::Control::V2::StorageControl::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-storage-control-v2/latest/Google-Cloud-Storage-Control-V2-StorageControl-Client)
+        # for a gRPC client for version V2 of the API.
+        # However, you can specify a different API version by passing it in the
+        # `version` parameter. If the StorageControl service is
+        # supported by that API version, and the corresponding gem is available, the
+        # appropriate versioned client will be returned.
+        #
+        # ## About StorageControl
+        #
+        # StorageControl service includes selected control plane operations.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v2`.
+        # @return [::Object] A client object for the specified version.
+        #
+        def self.storage_control version: :v2, &block
+          require "google/cloud/storage/control/#{version.to_s.downcase}"
+
+          package_name = Google::Cloud::Storage::Control
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          service_module = Google::Cloud::Storage::Control.const_get(package_name).const_get(:StorageControl)
+          service_module.const_get(:Client).new(&block)
+        end
+
+        ##
+        # Configure the google-cloud-storage-control 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.storage_control if block_given?
+
+          ::Google::Cloud.configure.storage_control
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "control", "helpers.rb"
+require "google/cloud/storage/control/helpers" if ::File.file? helper_path

data/lib/google-cloud-storage-control.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/storage/control" unless defined? Google::Cloud::Storage::Control::VERSION

metadata

@@ -1,27 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage-control
 version: !ruby/object:Gem::Version
-  version: 0.a
+  version: 0.1.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
-dependencies: []
-description: Placeholder for the future Google-authored gem google-cloud-storage-control.
-  This placeholder is being released on 2024-04-18 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-04-23 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage-control-v2
+  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
+description: The Google Cloud Storage API allows applications to read and write data
+  through the abstractions of buckets and objects, which are similar to directories
+  and files except that buckets cannot contain other buckets, and directory-level
+  operations (like directory rename) are not supported. Buckets share a single global
+  namespace, and each bucket belongs to a specific project that has an associated
+  owner that pays for the data stored in the bucket. This API is accessed using standard
+  gRPC requests.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- AUTHENTICATION.md
 - LICENSE.md
 - README.md
+- lib/google-cloud-storage-control.rb
+- lib/google/cloud/storage/control.rb
 - lib/google/cloud/storage/control/version.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
@@ -35,7 +75,7 @@ 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:
   - - ">="
@@ -45,5 +85,9 @@ requirements: []
 rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
-summary: Placeholder for the future Google-authored gem google-cloud-storage-control
+summary: The Storage Control API lets you perform metadata-specific, control plane,
+  and long-running operations. The Storage Control API creates one space to perform
+  metadata-specific, control plane, and long-running operations apart from the Storage
+  API. Separating these operations from the Storage API improves API standardization
+  and lets you run faster releases.
 test_files: []