google-iam-credentials-v1 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bcdff65225fc2594b6e0427766c37b87151ee903af416e879ed574b2cd9ff9b
-  data.tar.gz: 4d586030e4ebded7e69978643bbdb7ba432a7ecaa99bd69d68d81c526faac57f
+  metadata.gz: 32ebcaa119129846f5efcf7ccc67a4afb30cd9c31bb40bbe22fe5554802a974f
+  data.tar.gz: 82c01a857dcee4191007c0e6001dbf222bd09122243710cdbc77580b8535ab1a
 SHA512:
-  metadata.gz: c6bc55a5cdb5a2cec035fe931d3e5f3f914d11754f4e310f429e384acba7a242e5c5b18a792a83fbd27bf7d3d0ac2be5b5fd2f94e747d99490773160cb6f7b01
-  data.tar.gz: 7bbddbc4b48d62c6da8c693252f389cda12d500cfbe211ded69b5ab562c09b3f65925e77db401a631368bc27b7635d4a12fd9c507c4d6071eff45e5b7fea3334
+  metadata.gz: 41abed950fcf8faa82e3e5fd85209529934ff261b7c3883dc7634e4fc31a1c76f14fc3026c789408053b1acee1a1c88802a6aeee83b66a964e2d4b6d27f5cb82
+  data.tar.gz: 675651dea7cd62a4cc7098821fe44fad9cb76200d3b8e37b8297c3373c24c91038cef9df4dc4263888e517f067f1c02b0ae1c1fc9f0040c27e97f5d49e5fc1d9

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-iam-credentials-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Iam::Credentials::V1::IAMCredentials::Credentials}):
 
-1. `IAM_CREDENTIALS_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `IAM_CREDENTIALS_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `IAM_CREDENTIALS_CREDENTIALS` - Path to JSON file, or JSON contents
+* `IAM_CREDENTIALS_KEYFILE` - Path to JSON file, or JSON contents
+* `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/credentials/v1"
@@ -82,8 +82,8 @@ client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+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/credentials/v1"
@@ -93,7 +93,7 @@ client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/iam/credentials/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/iam/credentials/v1"
 
 client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new
-request = my_create_request
+request = ::Google::Iam::Credentials::V1::GenerateAccessTokenRequest.new # (request fields as keyword arguments...)
 response = client.generate_access_token request
 ```
 

data/lib/google/iam/credentials/v1/common_pb.rb

@@ -1,12 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/iam/credentials/v1/common.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/duration_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/iam/credentials/v1/common.proto", :syntax => :proto3) do
     add_message "google.iam.credentials.v1.GenerateAccessTokenRequest" do

data/lib/google/iam/credentials/v1/iam_credentials/client.rb

@@ -49,13 +49,12 @@ module Google
             # See {::Google::Iam::Credentials::V1::IAMCredentials::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all IAMCredentials clients:
-            #
-            #     ::Google::Iam::Credentials::V1::IAMCredentials::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all IAMCredentials clients
+            #   ::Google::Iam::Credentials::V1::IAMCredentials::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -75,34 +74,22 @@ module Google
 
                 default_config.rpcs.generate_access_token.timeout = 60.0
                 default_config.rpcs.generate_access_token.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.generate_id_token.timeout = 60.0
                 default_config.rpcs.generate_id_token.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.sign_blob.timeout = 60.0
                 default_config.rpcs.sign_blob.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.sign_jwt.timeout = 60.0
                 default_config.rpcs.sign_jwt.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -134,19 +121,15 @@ module Google
             ##
             # Create a new IAMCredentials client object.
             #
-            # ## Examples
-            #
-            # To create a new IAMCredentials client with the default
-            # configuration:
-            #
-            #     client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new
+            # @example
             #
-            # To create a new IAMCredentials client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new
             #
-            #     client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the IAMCredentials client.
             # @yieldparam config [Client::Configuration]
@@ -166,14 +149,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -243,6 +225,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/iam/credentials/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Iam::Credentials::V1::IAMCredentials::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Iam::Credentials::V1::GenerateAccessTokenRequest.new
+            #
+            #   # Call the generate_access_token method.
+            #   result = client.generate_access_token request
+            #
+            #   # The returned object is of type Google::Iam::Credentials::V1::GenerateAccessTokenResponse.
+            #   p result
+            #
             def generate_access_token request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -260,16 +257,20 @@ module Google
                 gapic_version: ::Google::Iam::Credentials::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.generate_access_token.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.generate_access_token.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @iam_credentials_stub.call_rpc :generate_access_token, request, options: options do |response, operation|
@@ -329,6 +330,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/iam/credentials/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Iam::Credentials::V1::IAMCredentials::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Iam::Credentials::V1::GenerateIdTokenRequest.new
+            #
+            #   # Call the generate_id_token method.
+            #   result = client.generate_id_token request
+            #
+            #   # The returned object is of type Google::Iam::Credentials::V1::GenerateIdTokenResponse.
+            #   p result
+            #
             def generate_id_token request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -346,16 +362,20 @@ module Google
                 gapic_version: ::Google::Iam::Credentials::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.generate_id_token.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.generate_id_token.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @iam_credentials_stub.call_rpc :generate_id_token, request, options: options do |response, operation|
@@ -411,6 +431,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/iam/credentials/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Iam::Credentials::V1::IAMCredentials::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Iam::Credentials::V1::SignBlobRequest.new
+            #
+            #   # Call the sign_blob method.
+            #   result = client.sign_blob request
+            #
+            #   # The returned object is of type Google::Iam::Credentials::V1::SignBlobResponse.
+            #   p result
+            #
             def sign_blob request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -428,16 +463,20 @@ module Google
                 gapic_version: ::Google::Iam::Credentials::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.sign_blob.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.sign_blob.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @iam_credentials_stub.call_rpc :sign_blob, request, options: options do |response, operation|
@@ -493,6 +532,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/iam/credentials/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Iam::Credentials::V1::IAMCredentials::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Iam::Credentials::V1::SignJwtRequest.new
+            #
+            #   # Call the sign_jwt method.
+            #   result = client.sign_jwt request
+            #
+            #   # The returned object is of type Google::Iam::Credentials::V1::SignJwtResponse.
+            #   p result
+            #
             def sign_jwt request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -510,16 +564,20 @@ module Google
                 gapic_version: ::Google::Iam::Credentials::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.sign_jwt.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.sign_jwt.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @iam_credentials_stub.call_rpc :sign_jwt, request, options: options do |response, operation|
@@ -543,22 +601,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for generate_access_token
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Iam::Credentials::V1::IAMCredentials::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.generate_access_token.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.generate_access_token.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # generate_access_token to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Iam::Credentials::V1::IAMCredentials::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.generate_access_token.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Iam::Credentials::V1::IAMCredentials::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.generate_access_token.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/iam/credentials/v1/iamcredentials_pb.rb

@@ -1,11 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/iam/credentials/v1/iamcredentials.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/iam/credentials/v1/common_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/iam/credentials/v1/iamcredentials.proto", :syntax => :proto3) do
   end

data/lib/google/iam/credentials/v1/iamcredentials_services_pb.rb

@@ -35,7 +35,7 @@ module Google
           # more.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/iam/credentials/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Iam
     module Credentials
       module V1
-        VERSION = "0.3.0"
+        VERSION = "0.3.4"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-iam-credentials-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -200,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the IAM Service Account Credentials V1 API