google-iam-client 0.a → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a3df1ba388d98c2746d4b8362f02f33326bc263ff50b238fd48b597b2fec179
-  data.tar.gz: 056551fce55dcbb5313f21d99202919860f3c4afe8aec1c130bf307db745c709
+  metadata.gz: 91fd5d6b297b117c92984c10e775641a8d1f06d1cd60d6c262997529b00c96f0
+  data.tar.gz: dc9b650b67e8d88d9373ce4e2e23d31fac2cb1009270293cc163ac55627d771c
 SHA512:
-  metadata.gz: edf525e3f07ddbba6888bf0bbedcc312768f3de7360edd733ab88874378354d62a6ec481fe09dee4620843d51ef3181d8bf59abef263a2837e853dea7b315fa8
-  data.tar.gz: cac95bcd65718e8502a0e70518670940f2ad4441a718f6517d5a7c579bfbbf5e924b65bf998897240a0de536a9460e7aab4493a2a2e1ff2156f822ea8651b053
+  metadata.gz: 2559f065cb77e8629bdfbbeaf4009f07c54d0572dd1c6227525d44aeabc85efd203d4fc8f6a51e10f76f89715d9a96acb93b8459e11a58a408446291f4db8191
+  data.tar.gz: d4afc000ae365f04e3024add15a9a6c79fb7e1589bb81b1a61d6bff295f998f5995164bb62f3fb3ad6eca780bfcb09da5516fd7938be9021876aee3c803dd564

data/.yardopts

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

data/AUTHENTICATION.md

@@ -0,0 +1,149 @@
+# Authentication
+
+In general, the google-iam-client 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/iam"
+
+client = Google::Iam.policies
+```
+
+## Credential Lookup
+
+The google-iam-client 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-iam-client
+checks for credentials are configured on the service Credentials class (such as
+`::Google::Iam::V2::Policies::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/iam"
+
+ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
+
+client = Google::Iam.policies
+```
+
+### 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/iam"
+
+client = Google::Iam.policies do |config|
+  config.credentials = "path/to/keyfile.json"
+end
+```
+
+Or globally for all clients:
+
+```ruby
+require "google/iam"
+
+Google::Iam.configure do |config|
+  config.credentials = "path/to/keyfile.json"
+end
+
+client = Google::Iam.policies
+```
+
+### 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-iam-client.
+
+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,130 @@
-# Placeholder for Ruby gem google-iam-client
-
-This is a placeholder for the future Google-authored gem google-iam-client.
-This placeholder is being released on 2022-09-14 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 IAM API
+
+API Client library for the IAM API
+
+Manages identity and access control policies for Google Cloud Platform resources.
+
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `google-iam-v*`.
+The gem `google-iam-client` 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://googleapis.dev/ruby/google-iam-client/latest)
+for this library, google-iam-client, 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-iam-v2](https://googleapis.dev/ruby/google-iam-v2/latest).
+
+See also the [Product Documentation](https://cloud.google.com/iam)
+for more usage information.
+
+## Quick Start
+
+```
+$ gem install google-iam-client
+```
+
+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/iam.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/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/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.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-iam-client`,
+and lower-level _versioned_ client libraries with names such as
+`google-iam-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-iam-client`.
+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-iam-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/iam/client/version.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # Copyright 2022 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,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Google
   module Iam
     module Client
-      VERSION = "0.a"
+      VERSION = "0.1.0"
     end
   end
 end

data/lib/google/iam.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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/iam/client/version"
+
+require "googleauth"
+
+module Google
+  module Iam
+    ##
+    # Create a new client object for Policies.
+    #
+    # By default, this returns an instance of
+    # [Google::Iam::V2::Policies::Client](https://googleapis.dev/ruby/google-iam-v2/latest/Google/Iam/V2/Policies/Client.html)
+    # for version V2 of the API.
+    # However, you can specify specify a different API version by passing it in the
+    # `version` parameter. If the Policies service is
+    # supported by that API version, and the corresponding gem is available, the
+    # appropriate versioned client will be returned.
+    #
+    # ## About Policies
+    #
+    # An interface for managing Identity and Access Management (IAM) policies.
+    #
+    # @param version [::String, ::Symbol] The API version to connect to. Optional.
+    #   Defaults to `:v2`.
+    # @return [Policies::Client] A client object for the specified version.
+    #
+    def self.policies version: :v2, &block
+      require "google/iam/#{version.to_s.downcase}"
+
+      package_name = Google::Iam
+                     .constants
+                     .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                     .first
+      package_module = Google::Iam.const_get package_name
+      package_module.const_get(:Policies).const_get(:Client).new(&block)
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "iam", "helpers.rb"
+require "google/iam/helpers" if ::File.file? helper_path

data/lib/google-iam-client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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/iam" unless defined? Google::Iam::Client::VERSION

metadata

@@ -1,33 +1,180 @@
 --- !ruby/object:Gem::Specification
 name: google-iam-client
 version: !ruby/object:Gem::Version
-  version: 0.a
+  version: 0.1.0
 platform: ruby
 authors:
 - Google LLC
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2022-09-14 00:00:00.000000000 Z
-dependencies: []
-description: Placeholder for the future Google-authored gem google-iam-client. This
-  placeholder is being released on 2022-09-14 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.
+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-iam-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
+- !ruby/object:Gem::Dependency
+  name: google-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Manages identity and access control policies for Google Cloud Platform
+  resources.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- AUTHENTICATION.md
 - LICENSE.md
 - README.md
+- lib/google-iam-client.rb
+- lib/google/iam.rb
 - lib/google/iam/client/version.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -35,15 +182,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.14
+signing_key: 
 specification_version: 4
-summary: Placeholder for the future Google-authored gem google-iam-client
+summary: API Client library for the IAM API
 test_files: []