google-cloud-os_login 1.0.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 861c1617afdee3db50b52907396621a8c3ace4d5fcb983a955b336510b7ac192
-  data.tar.gz: 107df0bb491569bf1fcffd2247ce3000ef19f44ed662ffcb84a069446c738fbf
+  metadata.gz: de362b6f67e330088f114037ff26218b9799c8d41097cab63dcf0dcb3e44b539
+  data.tar.gz: 6396f90a00a98ef9857d05d781f6fe8d892b19d4e1bf1aac25a9e92587111d0d
 SHA512:
-  metadata.gz: 7bdaf5cb0e1e221df4f102873d06f291e82961b181404e13c9bb030ca3ef07b4c9f6e7d6def59badded6f99dca68b42ad452f47ccf71d1885f3814d678ae1362
-  data.tar.gz: 7781dd276864c89f2e7c62c739dcc21923745ebfa4b76e191a5a458d9099842b37f3e7c64e07f596787f03c3844e57ba7903ca597aa1fd531aa0c5fd0186929a
+  metadata.gz: c8190085fbd52cd49d69716d4dabb3f0378814034dce54ed30e08d5f5157f34efb9f4a71ef3efe932e0d29c2e8d938fbaf339685af9fcba1c3a419a40e9945a1
+  data.tar.gz: 7033f4e4ac16e2aae73d5d1e13a16085b53d6ca35b1fd13ad4d877228fb8c0c2c6812ff468a691e78148b8abcb1e60e73caa89b6f70cf7b4a82619197fabd96c

data/MIGRATING.md

@@ -11,7 +11,7 @@ To summarize:
 
  *  The library has been broken out into three libraries. The new gems
     `google-cloud-os_login-v1` and `google-cloud-os_login-v1beta` contain the
-    actual client classes for versions V1 and V1beta of the OSLogin
+    actual client classes for versions V1 and V1beta of the OS Login
     service, and the gem `google-cloud-os_login` now simply provides a
     convenience wrapper. See [Library Structure](#library-structure) for more
     info.
@@ -30,13 +30,17 @@ To summarize:
     resource paths. These paths are now instance methods on the client objects,
     and are also available in a separate paths module. See
     [Resource Path Helpers](#resource-path-helpers) for more info.
+ *  Previously, clients reported RPC errors by raising instances of
+    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
+    `Google::Cloud::Error` and its subclasses. See
+    [Handling Errors](#handling-errors) for more info.
  *  Some classes have moved into different namespaces. See
     [Class Namespaces](#class-namespaces) for more info.
 
 ### Library Structure
 
 Older 0.x releases of the `google-cloud-os_login` gem were all-in-one gems that
-included potentially multiple clients for multiple versions of the OSLogin
+included potentially multiple clients for multiple versions of the OS Login
 service. The `Google::Cloud::OsLogin.new` factory method would
 return you an instance of a `Google::Cloud::OsLogin::V1::OsLoginServiceClient`
 object for the V1 version of the service, or a
@@ -70,7 +74,7 @@ constructor. It was also extremely difficult to customize the default settings.
 With the 1.0 release, a configuration interface provides control over these
 parameters, including defaults for all instances of a client, and settings for
 each specific client instance. For example, to set default credentials and
-timeout for all OSLogin V1 clients:
+timeout for all OS Login V1 clients:
 
 ```
 Google::Cloud::OsLogin::V1::OsLoginService::Client.configure do |config|
@@ -88,11 +92,11 @@ Google::Cloud::OsLogin::V1::OsLoginService::Client.configure do |config|
 end
 ```
 
-Defaults for certain configurations can be set for all Redis versions
+Defaults for certain configurations can be set for all OS Login versions
 globally:
 
 ```
-Google::Cloud::Redis.configure do |config|
+Google::Cloud::OsLogin.configure do |config|
   config.credentials = "/path/to/credentials.json"
   config.timeout = 10.0
 end
@@ -238,7 +242,7 @@ In the 1.0 client, you can also use the paths module as a convenience module.
 
 New:
 ```
-# Bring the session_path method into the current class
+# Bring the path helper methods into the current class
 include Google::Cloud::OsLogin::V1::OsLoginService::Paths
 
 def foo
@@ -253,6 +257,48 @@ def foo
 end
 ```
 
+### Handling Errors
+
+The client reports standard
+[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
+by raising exceptions. In older releases, these exceptions were located in the
+`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
+exception class, defined in the `google-gax` gem. However, these classes were
+different from the standard exceptions (subclasses of `Google::Cloud::Error`)
+thrown by other client libraries such as `google-cloud-storage`.
+
+The 1.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
+for consistency across all the Google Cloud client libraries. In general, these
+exceptions have the same name as their counterparts from older releases, but
+are located in the `Google::Cloud` namespace rather than the `Google::Gax`
+namespace.
+
+Old:
+```
+client = Google::Cloud::OsLogin.new
+
+key_name = "users/my-user/sshPublicKeys/12345"
+
+begin
+  response = client.get_ssh_public_key key_name
+rescue Google::Gax::Error => e
+  # Handle exceptions that subclass Google::Gax::Error
+end
+```
+
+New:
+```
+client = Google::Cloud::OsLogin.os_login_service
+
+key_name = "users/my-user/sshPublicKeys/12345"
+
+begin
+  response = client.get_ssh_public_key name: key_name
+rescue Google::Cloud::Error => e
+  # Handle exceptions that subclass Google::Cloud::Error
+end
+```
+
 ### Class Namespaces
 
 In older releases, some data type (protobuf) classes were located under the

data/README.md

@@ -6,9 +6,10 @@ Use OS Login to manage SSH access to your instances using IAM without having to
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-os_login-v*`.
-The gem `google-cloud-os_login` is a convenience wrapper library that brings the
+The gem `google-cloud-os_login` is the main client library that brings the
 verisoned gems in as dependencies, and provides high-level methods for
-constructing clients.
+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-cloud-os_login/latest)
 for this library, google-cloud-os_login, to see the convenience methods for
@@ -78,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 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.
+
+## 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-os_login`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-os_login-v1`.
+_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-os_login`.
+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-os_login-v1`.
+
+### 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/os_login.rb

@@ -29,13 +29,16 @@ require "google/cloud/config"
 
 # Set the default configuration
 ::Google::Cloud.configure.add_config! :os_login do |config|
-  config.add_field! :credentials,  nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
-  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! :endpoint,      "oslogin.googleapis.com", 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
 end
 
 module Google
@@ -88,8 +91,8 @@ module Google
       #   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:* `Integer`) -
-      #   Default timeout in milliseconds.
+      # * `timeout` (*type:* `Numeric`) -
+      #   Default timeout in seconds.
       # * `metadata` (*type:* `Hash{Symbol=>String}`) -
       #   Additional gRPC headers to be sent with the call.
       # * `retry_policy` (*type:* `Hash`) -
@@ -110,3 +113,6 @@ module Google
     end
   end
 end
+
+helper_path = ::File.join __dir__, "os_login", "helpers.rb"
+require "google/cloud/os_login/helpers" if ::File.file? helper_path

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module OsLogin
-      VERSION = "1.0.0"
+      VERSION = "1.1.3"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-os_login
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: autotest-suffix
-  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: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.14'
-- !ruby/object:Gem::Dependency
-  name: minitest-autotest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -228,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud OS Login API