google-cloud-os_login 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fcdbc78e5356eb22f0256703ea8da7e326dff1cf75602e6c9c27d83491e0c8e
-  data.tar.gz: 807062f3e5af1b4ae389831ae16a2f9b328c2ca5ba840797b3f5dc601ce309d8
+  metadata.gz: 3bb05e6e4b9504dc2201682cc2c8033222162dce9a4b53bc7e5e708b08adb2c5
+  data.tar.gz: e0331a575f3309fab23fada73e51532817d112d1052f54592c4c291b73245dc0
 SHA512:
-  metadata.gz: 5480243df42ffcdd3ddb7d6f430cc8eaf41abdcb7b8eb968f1cfe500cfea1bbb7ab7ef7038bf48d71b131459f466af0f16e9be9da0b88ef80d88eb0fa65b127b
-  data.tar.gz: c2e4c63e82d16225fe9e7bbbe5b773a58a5b69581986c14ab134f686dba82d46cf9a51328f9609a5f7c430483900af36c651c4b20aa58883e74803efa54e2b66
+  metadata.gz: 329d0d73690b45cfe7ced0ca7bcf2a9aac6ce2121a590fa4404228e85abb7f5743ce4cc7c4eedd2a1ac5e976a47ace9d2a60a0f707cea3729ba0541edaf2471b
+  data.tar.gz: 04d14aaf33ac1c1cea28163a204a732541b1436af297a20bb295a03317bab4672e4104ab58e746c197e6e79f4e2e78bdc2528043cbc4eef8d1700e33e3bf9778

data/.yardopts

@@ -2,6 +2,7 @@
 --title=Google Cloud OS Login API
 --exclude _pb\.rb$
 --markup markdown
+--markup-provider redcarpet
 
 ./lib/**/*.rb
 -

data/README.md

@@ -11,7 +11,7 @@ steps:
 
 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/api/oslogin)
+3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
 
 ### Installation
@@ -27,5 +27,42 @@ $ gem install google-cloud-os_login
 - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
   to see the full list of Cloud APIs that we cover.
 
-[Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-os_login/latest/google/cloud/oslogin
+[Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-os_login/latest/google/cloud/oslogin/
 [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
+
+## 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-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+that will write logs to [Stackdriver 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.3+.
+
+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. Currently, this means Ruby 2.3
+and later. 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.

data/lib/google/cloud/os_login.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@ module Google
     #
     # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
     # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/api/oslogin)
+    # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
     # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
     #
     # ### Next Steps
@@ -43,6 +43,31 @@ module Google
     #
     # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
     #
+    # ## 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-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+    # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+    # that will write logs to [Stackdriver 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
+    # ```
     #
     module OsLogin
       # rubocop:enable LineLength
@@ -62,7 +87,7 @@ module Google
       # public keys for logging into virtual machines on Google Cloud Platform.
       #
       # @param version [Symbol, String]
-      #   The major version of the service to be used. By default :v1beta
+      #   The major version of the service to be used. By default :v1
       #   is used.
       # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
       #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
@@ -89,7 +114,12 @@ module Google
       #     or the specified config is missing data points.
       #   @param timeout [Numeric]
       #     The default timeout, in seconds, for calls made through this client.
-      def self.new(*args, version: :v1beta, **kwargs)
+      #   @param metadata [Hash]
+      #     Default metadata to be sent with each request. This can be overridden on a per call basis.
+      #   @param exception_transformer [Proc]
+      #     An optional proc that intercepts any exceptions raised during an API call to inject
+      #     custom error handling.
+      def self.new(*args, version: :v1, **kwargs)
         unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
           raise "The version: #{version} is not available. The available versions " \
             "are: [#{AVAILABLE_VERSIONS.join(", ")}]"

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

@@ -0,0 +1,134 @@
+# Copyright 2018 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.
+
+require "google/cloud/os_login/v1/os_login_service_client"
+
+module Google
+  module Cloud
+    module OsLogin
+      # rubocop:disable LineLength
+
+      ##
+      # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+      #
+      # [Google Cloud OS Login API][Product Documentation]:
+      # Manages OS login configuration for Google account users.
+      # - [Product Documentation][]
+      #
+      # ## Quick Start
+      # 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)
+      # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+      # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
+      # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+      #
+      # ### Next Steps
+      # - Read the [Google Cloud OS Login API Product documentation][Product Documentation]
+      #   to learn more about the product and see How-to Guides.
+      # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+      #   to see the full list of Cloud APIs that we cover.
+      #
+      # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
+      #
+      # ## 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-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+      # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+      # that will write logs to [Stackdriver 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
+      # ```
+      #
+      module V1
+        # rubocop:enable LineLength
+
+        ##
+        # Cloud OS Login API
+        #
+        # The Cloud OS Login API allows you to manage users and their associated SSH
+        # public keys for logging into virtual machines on Google Cloud Platform.
+        #
+        # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+        #   Provides the means for authenticating requests made by the client. This parameter can
+        #   be many types.
+        #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+        #   authenticating requests made by this client.
+        #   A `String` will be treated as the path to the keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `GRPC::Core::Channel` will be used to make calls through.
+        #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+        #   should already be composed with a `GRPC::Core::CallCredentials` object.
+        #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+        #   metadata for requests, generally, to give OAuth credentials.
+        # @param scopes [Array<String>]
+        #   The OAuth scopes for this service. This parameter is ignored if
+        #   an updater_proc is supplied.
+        # @param client_config [Hash]
+        #   A Hash for call options for each method. See
+        #   Google::Gax#construct_settings for the structure of
+        #   this data. Falls back to the default config if not specified
+        #   or the specified config is missing data points.
+        # @param timeout [Numeric]
+        #   The default timeout, in seconds, for calls made through this client.
+        # @param metadata [Hash]
+        #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+        # @param exception_transformer [Proc]
+        #   An optional proc that intercepts any exceptions raised during an API call to inject
+        #   custom error handling.
+        def self.new \
+            credentials: nil,
+            scopes: nil,
+            client_config: nil,
+            timeout: nil,
+            metadata: nil,
+            exception_transformer: nil,
+            lib_name: nil,
+            lib_version: nil
+          kwargs = {
+            credentials: credentials,
+            scopes: scopes,
+            client_config: client_config,
+            timeout: timeout,
+            metadata: metadata,
+            exception_transformer: exception_transformer,
+            lib_name: lib_name,
+            lib_version: lib_version
+          }.select { |_, v| v != nil }
+          Google::Cloud::OsLogin::V1::OsLoginServiceClient.new(**kwargs)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# Copyright 2018 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.
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module OsLogin
+      module V1
+        class Credentials < Google::Auth::Credentials
+          SCOPE = [
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/cloud-platform.read-only",
+            "https://www.googleapis.com/auth/compute",
+            "https://www.googleapis.com/auth/compute.readonly"
+          ].freeze
+          PATH_ENV_VARS = %w(OS_LOGIN_CREDENTIALS
+                             OS_LOGIN_KEYFILE
+                             GOOGLE_CLOUD_CREDENTIALS
+                             GOOGLE_CLOUD_KEYFILE
+                             GCLOUD_KEYFILE)
+          JSON_ENV_VARS = %w(OS_LOGIN_CREDENTIALS_JSON
+                             OS_LOGIN_KEYFILE_JSON
+                             GOOGLE_CLOUD_CREDENTIALS_JSON
+                             GOOGLE_CLOUD_KEYFILE_JSON
+                             GCLOUD_KEYFILE_JSON)
+          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/os_login/v1/doc/google/cloud/oslogin/common/common.rb

@@ -0,0 +1,66 @@
+# Copyright 2018 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.
+
+module Google
+  module Cloud
+    module Oslogin
+      module Common
+        # The POSIX account information associated with a Google account.
+        # @!attribute [rw] primary
+        #   @return [true, false]
+        #     Only one POSIX account can be marked as primary.
+        # @!attribute [rw] username
+        #   @return [String]
+        #     The username of the POSIX account.
+        # @!attribute [rw] uid
+        #   @return [Integer]
+        #     The user ID.
+        # @!attribute [rw] gid
+        #   @return [Integer]
+        #     The default group ID.
+        # @!attribute [rw] home_directory
+        #   @return [String]
+        #     The path to the home directory for this account.
+        # @!attribute [rw] shell
+        #   @return [String]
+        #     The path to the logic shell for this account.
+        # @!attribute [rw] gecos
+        #   @return [String]
+        #     The GECOS (user information) entry for this account.
+        # @!attribute [rw] system_id
+        #   @return [String]
+        #     System identifier for which account the username or uid applies to.
+        #     By default, the empty value is used.
+        # @!attribute [rw] account_id
+        #   @return [String]
+        #     Output only. A POSIX account identifier.
+        class PosixAccount; end
+
+        # The SSH public key information associated with a Google account.
+        # @!attribute [rw] key
+        #   @return [String]
+        #     Public key text in SSH format, defined by
+        #     <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a>
+        #     section 6.6.
+        # @!attribute [rw] expiration_time_usec
+        #   @return [Integer]
+        #     An expiration time in microseconds since epoch.
+        # @!attribute [rw] fingerprint
+        #   @return [String]
+        #     Output only. The SHA-256 fingerprint of the SSH public key.
+        class SshPublicKey; end
+      end
+    end
+  end
+end

data/lib/google/cloud/os_login/v1/doc/google/cloud/oslogin/v1/oslogin.rb

@@ -0,0 +1,111 @@
+# Copyright 2018 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.
+
+module Google
+  module Cloud
+    module Oslogin
+      ##
+      # # Google Cloud OS Login API Contents
+      #
+      # | Class | Description |
+      # | ----- | ----------- |
+      # | [OsLoginServiceClient][] | Cloud OS Login API |
+      # | [Data Types][] | Data types for Google::Cloud::OsLogin::V1 |
+      #
+      # [OsLoginServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-os_login/latest/google/cloud/oslogin/v1/osloginserviceclient
+      # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-os_login/latest/google/cloud/oslogin/v1/datatypes
+      #
+      module V1
+        # The user profile information used for logging in to a virtual machine on
+        # Google Compute Engine.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The primary email address that uniquely identifies the user.
+        # @!attribute [rw] posix_accounts
+        #   @return [Array<Google::Cloud::Oslogin::Common::PosixAccount>]
+        #     The list of POSIX accounts associated with the user.
+        # @!attribute [rw] ssh_public_keys
+        #   @return [Hash{String => Google::Cloud::Oslogin::Common::SshPublicKey}]
+        #     A map from SSH public key fingerprint to the associated key object.
+        # @!attribute [rw] suspended
+        #   @return [true, false]
+        #     Indicates if the user is suspended. A suspended user cannot log in but
+        #     their profile information is retained.
+        class LoginProfile; end
+
+        # A request message for deleting a POSIX account entry.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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}+.
+        class DeletePosixAccountRequest; end
+
+        # A request message for deleting an SSH public key.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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}+.
+        class DeleteSshPublicKeyRequest; end
+
+        # A request message for retrieving the login profile information for a user.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The unique ID for the user in format +users/{user}+.
+        class GetLoginProfileRequest; end
+
+        # A request message for retrieving an SSH public key.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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}+.
+        class GetSshPublicKeyRequest; end
+
+        # A request message for importing an SSH public key.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     The unique ID for the user in format +users/{user}+.
+        # @!attribute [rw] ssh_public_key
+        #   @return [Google::Cloud::Oslogin::Common::SshPublicKey]
+        #     The SSH public key and expiration time.
+        # @!attribute [rw] project_id
+        #   @return [String]
+        #     The project ID of the Google Cloud Platform project.
+        class ImportSshPublicKeyRequest; end
+
+        # A response message for importing an SSH public key.
+        # @!attribute [rw] login_profile
+        #   @return [Google::Cloud::Oslogin::V1::LoginProfile]
+        #     The login profile information for the user.
+        class ImportSshPublicKeyResponse; end
+
+        # A request message for updating an SSH public key.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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}+.
+        # @!attribute [rw] ssh_public_key
+        #   @return [Google::Cloud::Oslogin::Common::SshPublicKey]
+        #     The SSH public key and expiration time.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Mask to control which fields get updated. Updates all if not present.
+        class UpdateSshPublicKeyRequest; end
+      end
+    end
+  end
+end