google-cloud-iot 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f019e090d538f71b375e816275b034ae546003ce1f4929d1e765d68a7a337778
-  data.tar.gz: 24d65ea26a2ad6cba23a45eaed98744b68948756c387d15cd3d11d3df0bbb20b
+  metadata.gz: f4a54fb60fa5f1e93b622e969a647faa25267d326836a74a782a0ac6eee22ad2
+  data.tar.gz: ed8fe62eae9a67c11b6968751f2efc226dfb8474cec6f1488810030997df2c94
 SHA512:
-  metadata.gz: 1fbc1c319a467775ba18e225d63e3d6927d79df196cb6f76a585bddbf328987b4e9b26ef900d9d76b19b5aab71c6727c2b47247d9ebcb7f10ec3c2a0b61538ac
-  data.tar.gz: eef9ef5a214ae643f537b969ec81255c8bfb3edbee8cc9358f56be812c053768022a2887a70a9a1c22f1806d70d1eaf52dccf59416e8e7f6cf5b79e19e96406f
+  metadata.gz: 00a6ae87219395d53806ea9617f0f3364a2066a2257d81e40c0c3d2955add3e73943736638d421699b6c5e3841d688a320f963c78d3527c4a9edf679d9ce5728
+  data.tar.gz: 89683ec3c67a4eb9f83453c1386611a49e3bb5e5ded99ffc7da6593d3757a0ed6141871db566041a39afddf9c5ec95882e3d93b6cf1847510dd3d3a28d1e93a5

data/README.md

@@ -1,104 +1,4 @@
-# Ruby Client for the Cloud IoT API
+# Tombstone for Ruby gem google-cloud-iot
 
-API Client library for the Cloud IoT API
-
-Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.
-
-Actual client classes for the various versions of this API are defined in
-_versioned_ client gems, with names of the form `google-cloud-iot-v*`.
-The gem `google-cloud-iot` 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://cloud.google.com/ruby/docs/reference/google-cloud-iot/latest)
-for this library, google-cloud-iot, 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-cloud-iot-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-iot-v1/latest).
-
-See also the [Product Documentation](https://cloud.google.com/iot)
-for more usage information.
-
-## Quick Start
-
-```
-$ gem install google-cloud-iot
-```
-
-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/cloudiot.googleapis.com)
-1. {file:AUTHENTICATION.md Set up authentication.}
-
-## 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-cloud-iot`,
-and lower-level _versioned_ client libraries with names such as
-`google-cloud-iot-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-iot`.
-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-iot-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.
+This gem is obsolete because the related Google backend is turned down.
+For more information, see https://cloud.google.com/terms/deprecation.

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

@@ -1,12 +1,10 @@
-# frozen_string_literal: true
-
-# Copyright 2020 Google LLC
+# Copyright 2024 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
+#     http://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,
@@ -14,13 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
-
-
 module Google
   module Cloud
     module Iot
-      VERSION = "1.3.0"
+      VERSION = "2.0.0"
     end
   end
 end

metadata

@@ -1,180 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-iot
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
-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-cloud-iot-v1
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    - - "<"
-      - !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: Registers and manages IoT (Internet of Things) devices that connect to
-  the Google Cloud Platform.
+date: 2024-02-07 00:00:00.000000000 Z
+dependencies: []
+description: This gem is obsolete because the related Google backend is turned down.
+  For more information, see https://cloud.google.com/terms/deprecation.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".yardopts"
-- AUTHENTICATION.md
 - LICENSE.md
 - README.md
-- lib/google-cloud-iot.rb
-- lib/google/cloud/iot.rb
 - lib/google/cloud/iot/version.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message: |2+
+
+  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+  The google-cloud-iot gem is OBSOLETE.
+  For more information, see:
+  https://cloud.google.com/terms/deprecation
+  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
 rdoc_options: []
 require_paths:
 - lib
@@ -182,7 +39,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -192,5 +49,5 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
-summary: API Client library for the Cloud IoT API
+summary: This gem is obsolete because the related backend is turned down.
 test_files: []

data/.yardopts

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

data/AUTHENTICATION.md

@@ -1,122 +0,0 @@
-# Authentication
-
-The recommended way to authenticate to the google-cloud-iot library is to use
-[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
-To review all of your authentication options, see [Credentials lookup](#credential-lookup).
-
-## Quickstart
-
-The following example shows how to set up authentication for a local development
-environment with your user credentials. 
-
-**NOTE:** This method is _not_ recommended for running in production. User credentials
-should be used only during development.
-
-1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
-2. Set up a local ADC file with your user credentials:
-
-```sh
-gcloud auth application-default login
-```
-
-3. Write code as if already authenticated.
-
-For more information about setting up authentication for a local development environment, see
-[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
-
-## Credential Lookup
-
-The google-cloud-iot library provides several mechanisms to configure your system.
-Generally, using Application Default Credentials to facilitate automatic 
-credentials discovery is the easist method. But if you need to explicitly specify
-credentials, there are several methods available to you.
-
-Credentials are accepted in the following ways, in the following order or precedence:
-
-1. Credentials specified in method arguments
-2. Credentials specified in configuration
-3. Credentials pointed to or included in environment variables
-4. Credentials found in local ADC file
-5. Credentials returned by the metadata server for the attached service account (GCP)
-
-### Configuration
-
-You can configure a path to a JSON credentials file, either for an individual client object or
-globally, for all client objects. The JSON file can contain credentials created for
-[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
-[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
-[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
-
-Note: Service account keys are a security risk if not managed correctly. You should
-[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
-whenever possible.
-
-To configure a credentials file for an individual client initialization:
-
-```ruby
-require "google/cloud/iot"
-
-client = Google::Cloud::Iot.device_manager do |config|
-  config.credentials = "path/to/credentialfile.json"
-end
-```
-
-To configure a credentials file globally for all clients:
-
-```ruby
-require "google/cloud/iot"
-
-Google::Cloud::Iot.configure do |config|
-  config.credentials = "path/to/credentialfile.json"
-end
-
-client = Google::Cloud::Iot.device_manager
-```
-
-### Environment Variables
-
-You can also use an environment variable to provide a JSON credentials file.
-The environment variable can contain a path to the credentials file or, for
-environments such as Docker containers where writing files is not encouraged,
-you can include the credentials file itself.
-
-The JSON file can contain credentials created for
-[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
-[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
-[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
-
-Note: Service account keys are a security risk if not managed correctly. You should
-[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
-whenever possible.
-
-The environment variables that google-cloud-iot
-checks for credentials are:
-
-* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
-
-```ruby
-require "google/cloud/iot"
-
-ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
-
-client = Google::Cloud::Iot.device_manager
-```
-
-### Local ADC file
-
-You can set up a local ADC file with your user credentials for authentication during
-development. If credentials are not provided in code or in environment variables,
-then the local ADC credentials are discovered.
-
-Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
-
-### 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 retrieved from the attached
-service account automatically. Code should be written as if already authenticated.
-
-For more information, see
-[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).

data/lib/google/cloud/iot.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2020 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/cloud/iot/version"
-
-require "googleauth"
-gem "google-cloud-core"
-require "google/cloud" unless defined? ::Google::Cloud.new
-require "google/cloud/config"
-
-# Set the default configuration
-::Google::Cloud.configure.add_config! :iot do |config|
-  config.add_field! :endpoint,      nil, 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
-  config.add_field! :universe_domain, nil, match: ::String
-end
-
-module Google
-  module Cloud
-    module Iot
-      ##
-      # Create a new client object for DeviceManager.
-      #
-      # By default, this returns an instance of
-      # [Google::Cloud::Iot::V1::DeviceManager::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-iot-v1/latest/Google-Cloud-Iot-V1-DeviceManager-Client)
-      # for a gRPC client for version V1 of the API.
-      # However, you can specify a different API version by passing it in the
-      # `version` parameter. If the DeviceManager service is
-      # supported by that API version, and the corresponding gem is available, the
-      # appropriate versioned client will be returned.
-      # You can also specify a different transport by passing `:rest` or `:grpc` in
-      # the `transport` parameter.
-      #
-      # ## About DeviceManager
-      #
-      # Internet of Things (IoT) service. Securely connect and manage IoT devices.
-      #
-      # @param version [::String, ::Symbol] The API version to connect to. Optional.
-      #   Defaults to `:v1`.
-      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
-      # @return [::Object] A client object for the specified version.
-      #
-      def self.device_manager version: :v1, transport: :grpc, &block
-        require "google/cloud/iot/#{version.to_s.downcase}"
-
-        package_name = Google::Cloud::Iot
-                       .constants
-                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
-                       .first
-        service_module = Google::Cloud::Iot.const_get(package_name).const_get(:DeviceManager)
-        service_module = service_module.const_get(:Rest) if transport == :rest
-        service_module.const_get(:Client).new(&block)
-      end
-
-      ##
-      # Configure the google-cloud-iot library.
-      #
-      # The following configuration parameters are supported:
-      #
-      # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
-      #   The path to the keyfile as a String, the contents of the keyfile as a
-      #   Hash, or a Google::Auth::Credentials object.
-      # * `lib_name` (*type:* `String`) -
-      #   The library name as recorded in instrumentation and logging.
-      # * `lib_version` (*type:* `String`) -
-      #   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:* `Numeric`) -
-      #   Default timeout in seconds.
-      # * `metadata` (*type:* `Hash{Symbol=>String}`) -
-      #   Additional headers to be sent with the call.
-      # * `retry_policy` (*type:* `Hash`) -
-      #   The retry policy. The value is a hash with the following keys:
-      #     * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
-      #     * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
-      #     * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
-      #     * `:retry_codes` (*type:* `Array<String>`) -
-      #       The error codes that should trigger a retry.
-      #
-      # @return [::Google::Cloud::Config] The default configuration used by this library
-      #
-      def self.configure
-        yield ::Google::Cloud.configure.iot if block_given?
-
-        ::Google::Cloud.configure.iot
-      end
-    end
-  end
-end
-
-helper_path = ::File.join __dir__, "iot", "helpers.rb"
-require "google/cloud/iot/helpers" if ::File.file? helper_path

data/lib/google-cloud-iot.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2020 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/cloud/iot" unless defined? Google::Cloud::Iot::VERSION