google-cloud-os_login-v1 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c9a8886cf78b0627b5b23e6e50096465085723d0b9955ca71d8661d9c4cc99
-  data.tar.gz: 9a4280c321cb9b01dc44535f30e4527b07d1380b76839859c0b92d83b76315b4
+  metadata.gz: e4c709002d1b400fba3a1c212af14736200d8d09e07e25f0add825e5c5802a68
+  data.tar.gz: 9eeeeee9acc498e7b00abfca8ea376b974cf9a513c02f97049557f2a1d5f28a8
 SHA512:
-  metadata.gz: 022b9962038ac1f2a0192fe67dc1fd4ad26d34620ecc75f3ebd03a4b7980cbecf9ed28ffa9d8d87c2895767d056b14ef3f42072b1570bd0e84fca100a7e61a94
-  data.tar.gz: c262a3bb073ca57b5b0e1a65e6356ad3f2ec7c5858a9d83f52e2ea4189c7560b352d97f0b16ad22fbf513aaadd5121d1ee8d98a3d6a4f39b8a66cb367bd7d28d
+  metadata.gz: 6c74bca4bd419523a4a44f39bb76cb9a33f8c4dd5239d081a15237627448466c58274e62e429ee5cc134e71a4e83d478057529a87841ef99557acaa71e9e041a
+  data.tar.gz: 2913d6f6441c969cf2a6e48189b421cf9e4ba1c9e588f9c19bc78a00828db7f11bde22043e0b863b5491ddfa67470085dfa4285b548aace9c3b2b693bbc48d51

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ 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 login`
+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

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Cloud OS Login V1 API
 
-API Client library for the Cloud OS Login V1 API
+You can use OS Login to manage access to your VM instances using IAM roles.
 
 Use OS Login to manage SSH access to your instances using IAM without having to create and manage individual SSH keys. OS Login maintains a consistent Linux user identity across VM instances and is the recommended way to manage many users across multiple instances or projects.
 
@@ -33,8 +33,8 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/os_login/v1"
 
 client = ::Google::Cloud::OsLogin::V1::OsLoginService::Client.new
-request = ::Google::Cloud::OsLogin::V1::DeletePosixAccountRequest.new # (request fields as keyword arguments...)
-response = client.delete_posix_account request
+request = ::Google::Cloud::OsLogin::V1::CreateSshPublicKeyRequest.new # (request fields as keyword arguments...)
+response = client.create_ssh_public_key request
 ```
 
 View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-os_login-v1/latest)
@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+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://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.

data/lib/google/cloud/os_login/v1/os_login_service/client.rb

@@ -177,6 +177,93 @@ module Google
 
             # Service calls
 
+            ##
+            # Create an SSH public key
+            #
+            # @overload create_ssh_public_key(request, options = nil)
+            #   Pass arguments to `create_ssh_public_key` via a request object, either of type
+            #   {::Google::Cloud::OsLogin::V1::CreateSshPublicKeyRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::OsLogin::V1::CreateSshPublicKeyRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload create_ssh_public_key(parent: nil, ssh_public_key: nil)
+            #   Pass arguments to `create_ssh_public_key` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. The unique ID for the user in format `users/{user}`.
+            #   @param ssh_public_key [::Google::Cloud::OsLogin::Common::SshPublicKey, ::Hash]
+            #     Required. The SSH public key and expiration time.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::OsLogin::Common::SshPublicKey]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::OsLogin::Common::SshPublicKey]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/os_login/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::OsLogin::V1::OsLoginService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::OsLogin::V1::CreateSshPublicKeyRequest.new
+            #
+            #   # Call the create_ssh_public_key method.
+            #   result = client.create_ssh_public_key request
+            #
+            #   # The returned object is of type Google::Cloud::OsLogin::Common::SshPublicKey.
+            #   p result
+            #
+            def create_ssh_public_key request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::CreateSshPublicKeyRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.create_ssh_public_key.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::OsLogin::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.create_ssh_public_key.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.create_ssh_public_key.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @os_login_service_stub.call_rpc :create_ssh_public_key, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Deletes a POSIX account.
             #
@@ -196,9 +283,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. A reference to the POSIX account to update. POSIX accounts are identified
-            #     by the project ID they are associated with. A reference to the POSIX
-            #     account is in format `users/{user}/projects/{project}`.
+            #     Required. A reference to the POSIX account to update. POSIX accounts are
+            #     identified by the project ID they are associated with. A reference to the
+            #     POSIX account is in format `users/{user}/projects/{project}`.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -283,9 +370,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The fingerprint of the public key to update. Public keys are identified by
-            #     their SHA-256 fingerprint. The fingerprint of the public key is in format
-            #     `users/{user}/sshPublicKeys/{fingerprint}`.
+            #     Required. The fingerprint of the public key to update. Public keys are
+            #     identified by their SHA-256 fingerprint. The fingerprint of the public key
+            #     is in format `users/{user}/sshPublicKeys/{fingerprint}`.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -460,9 +547,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The fingerprint of the public key to retrieve. Public keys are identified
-            #     by their SHA-256 fingerprint. The fingerprint of the public key is in
-            #     format `users/{user}/sshPublicKeys/{fingerprint}`.
+            #     Required. The fingerprint of the public key to retrieve. Public keys are
+            #     identified by their SHA-256 fingerprint. The fingerprint of the public key
+            #     is in format `users/{user}/sshPublicKeys/{fingerprint}`.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::OsLogin::Common::SshPublicKey]
@@ -639,9 +726,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The fingerprint of the public key to update. Public keys are identified by
-            #     their SHA-256 fingerprint. The fingerprint of the public key is in format
-            #     `users/{user}/sshPublicKeys/{fingerprint}`.
+            #     Required. The fingerprint of the public key to update. Public keys are
+            #     identified by their SHA-256 fingerprint. The fingerprint of the public key
+            #     is in format `users/{user}/sshPublicKeys/{fingerprint}`.
             #   @param ssh_public_key [::Google::Cloud::OsLogin::Common::SshPublicKey, ::Hash]
             #     Required. The SSH public key and expiration time.
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
@@ -727,17 +814,17 @@ module Google
             # @example
             #
             #   # Modify the global config, setting the timeout for
-            #   # delete_posix_account to 20 seconds,
+            #   # create_ssh_public_key to 20 seconds,
             #   # and all remaining timeouts to 10 seconds.
             #   ::Google::Cloud::OsLogin::V1::OsLoginService::Client.configure do |config|
             #     config.timeout = 10.0
-            #     config.rpcs.delete_posix_account.timeout = 20.0
+            #     config.rpcs.create_ssh_public_key.timeout = 20.0
             #   end
             #
             #   # Apply the above configuration only to a new client.
             #   client = ::Google::Cloud::OsLogin::V1::OsLoginService::Client.new do |config|
             #     config.timeout = 10.0
-            #     config.rpcs.delete_posix_account.timeout = 20.0
+            #     config.rpcs.create_ssh_public_key.timeout = 20.0
             #   end
             #
             # @!attribute [rw] endpoint
@@ -846,6 +933,11 @@ module Google
               #         trigger a retry.
               #
               class Rpcs
+                ##
+                # RPC-specific configuration for `create_ssh_public_key`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :create_ssh_public_key
                 ##
                 # RPC-specific configuration for `delete_posix_account`
                 # @return [::Gapic::Config::Method]
@@ -879,6 +971,8 @@ module Google
 
                 # @private
                 def initialize parent_rpcs = nil
+                  create_ssh_public_key_config = parent_rpcs.create_ssh_public_key if parent_rpcs.respond_to? :create_ssh_public_key
+                  @create_ssh_public_key = ::Gapic::Config::Method.new create_ssh_public_key_config
                   delete_posix_account_config = parent_rpcs.delete_posix_account if parent_rpcs.respond_to? :delete_posix_account
                   @delete_posix_account = ::Gapic::Config::Method.new delete_posix_account_config
                   delete_ssh_public_key_config = parent_rpcs.delete_ssh_public_key if parent_rpcs.respond_to? :delete_ssh_public_key

data/lib/google/cloud/os_login/v1/os_login_service/credentials.rb

@@ -27,7 +27,9 @@ module Google
           class Credentials < ::Google::Auth::Credentials
             self.scope = [
               "https://www.googleapis.com/auth/cloud-platform",
-              "https://www.googleapis.com/auth/compute"
+              "https://www.googleapis.com/auth/cloud-platform.read-only",
+              "https://www.googleapis.com/auth/compute",
+              "https://www.googleapis.com/auth/compute.readonly"
             ]
             self.env_vars = [
               "OS_LOGIN_CREDENTIALS",