google-cloud-iot 1.2.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -103
- data/lib/google/cloud/iot/version.rb +3 -8
- metadata +16 -159
- data/.yardopts +0 -11
- data/AUTHENTICATION.md +0 -151
- data/lib/google/cloud/iot.rb +0 -119
- data/lib/google-cloud-iot.rb +0 -19
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f4a54fb60fa5f1e93b622e969a647faa25267d326836a74a782a0ac6eee22ad2
|
4
|
+
data.tar.gz: ed8fe62eae9a67c11b6968751f2efc226dfb8474cec6f1488810030997df2c94
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 00a6ae87219395d53806ea9617f0f3364a2066a2257d81e40c0c3d2955add3e73943736638d421699b6c5e3841d688a320f963c78d3527c4a9edf679d9ce5728
|
7
|
+
data.tar.gz: 89683ec3c67a4eb9f83453c1386611a49e3bb5e5ded99ffc7da6593d3757a0ed6141871db566041a39afddf9c5ec95882e3d93b6cf1847510dd3d3a28d1e93a5
|
data/README.md
CHANGED
@@ -1,104 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# Tombstone for Ruby gem google-cloud-iot
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.
|
6
|
-
|
7
|
-
Actual client classes for the various versions of this API are defined in
|
8
|
-
_versioned_ client gems, with names of the form `google-cloud-iot-v*`.
|
9
|
-
The gem `google-cloud-iot` is the main client library that brings the
|
10
|
-
verisoned gems in as dependencies, and provides high-level methods for
|
11
|
-
constructing clients. More information on versioned clients can be found below
|
12
|
-
in the section titled *Which client should I use?*.
|
13
|
-
|
14
|
-
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-iot/latest)
|
15
|
-
for this library, google-cloud-iot, to see the convenience methods for
|
16
|
-
constructing client objects. Reference documentation for the client objects
|
17
|
-
themselves can be found in the client library documentation for the versioned
|
18
|
-
client gems:
|
19
|
-
[google-cloud-iot-v1](https://googleapis.dev/ruby/google-cloud-iot-v1/latest).
|
20
|
-
|
21
|
-
See also the [Product Documentation](https://cloud.google.com/iot)
|
22
|
-
for more usage information.
|
23
|
-
|
24
|
-
## Quick Start
|
25
|
-
|
26
|
-
```
|
27
|
-
$ gem install google-cloud-iot
|
28
|
-
```
|
29
|
-
|
30
|
-
In order to use this library, you first need to go through the following steps:
|
31
|
-
|
32
|
-
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
33
|
-
1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
34
|
-
1. [Enable the API.](https://console.cloud.google.com/apis/library/cloudiot.googleapis.com)
|
35
|
-
1. {file:AUTHENTICATION.md Set up authentication.}
|
36
|
-
|
37
|
-
## Supported Ruby Versions
|
38
|
-
|
39
|
-
This library is supported on Ruby 2.6+.
|
40
|
-
|
41
|
-
Google provides official support for Ruby versions that are actively supported
|
42
|
-
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
43
|
-
in security maintenance, and not end of life. Older versions of Ruby _may_
|
44
|
-
still work, but are unsupported and not recommended. See
|
45
|
-
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
46
|
-
support schedule.
|
47
|
-
|
48
|
-
## Which client should I use?
|
49
|
-
|
50
|
-
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
51
|
-
client library with a name such as `google-cloud-iot`,
|
52
|
-
and lower-level _versioned_ client libraries with names such as
|
53
|
-
`google-cloud-iot-v1`.
|
54
|
-
_In most cases, you should install the main client._
|
55
|
-
|
56
|
-
### What's the difference between the main client and a versioned client?
|
57
|
-
|
58
|
-
A _versioned client_ provides a basic set of data types and client classes for
|
59
|
-
a _single version_ of a specific service. (That is, for a service with multiple
|
60
|
-
versions, there might be a separate versioned client for each service version.)
|
61
|
-
Most versioned clients are written and maintained by a code generator.
|
62
|
-
|
63
|
-
The _main client_ is designed to provide you with the _recommended_ client
|
64
|
-
interfaces for the service. There will be only one main client for any given
|
65
|
-
service, even a service with multiple versions. The main client includes
|
66
|
-
factory methods for constructing the client objects we recommend for most
|
67
|
-
users. In some cases, those will be classes provided by an underlying versioned
|
68
|
-
client; in other cases, they will be handwritten higher-level client objects
|
69
|
-
with additional capabilities, convenience methods, or best practices built in.
|
70
|
-
Generally, the main client will default to a recommended service version,
|
71
|
-
although in some cases you can override this if you need to talk to a specific
|
72
|
-
service version.
|
73
|
-
|
74
|
-
### Why would I want to use the main client?
|
75
|
-
|
76
|
-
We recommend that most users install the main client gem for a service. You can
|
77
|
-
identify this gem as the one _without_ a version in its name, e.g.
|
78
|
-
`google-cloud-iot`.
|
79
|
-
The main client is recommended because it will embody the best practices for
|
80
|
-
accessing the service, and may also provide more convenient interfaces or
|
81
|
-
tighter integration into frameworks and third-party libraries. In addition, the
|
82
|
-
documentation and samples published by Google will generally demonstrate use of
|
83
|
-
the main client.
|
84
|
-
|
85
|
-
### Why would I want to use a versioned client?
|
86
|
-
|
87
|
-
You can use a versioned client if you are content with a possibly lower-level
|
88
|
-
class interface, you explicitly want to avoid features provided by the main
|
89
|
-
client, or you want to access a specific service version not be covered by the
|
90
|
-
main client. You can identify versioned client gems because the service version
|
91
|
-
is part of the name, e.g. `google-cloud-iot-v1`.
|
92
|
-
|
93
|
-
### What about the google-apis-<name> clients?
|
94
|
-
|
95
|
-
Client library gems with names that begin with `google-apis-` are based on an
|
96
|
-
older code generation technology. They talk to a REST/JSON backend (whereas
|
97
|
-
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
98
|
-
not offer the same performance, features, and ease of use provided by more
|
99
|
-
modern clients.
|
100
|
-
|
101
|
-
The `google-apis-` clients have wide coverage across Google services, so you
|
102
|
-
might need to use one if there is no modern client available for the service.
|
103
|
-
However, if a modern client is available, we generally recommend it over the
|
104
|
-
older `google-apis-` clients.
|
3
|
+
This gem is obsolete because the related Google backend is turned down.
|
4
|
+
For more information, see https://cloud.google.com/terms/deprecation.
|
@@ -1,12 +1,10 @@
|
|
1
|
-
#
|
2
|
-
|
3
|
-
# Copyright 2020 Google LLC
|
1
|
+
# Copyright 2024 Google LLC
|
4
2
|
#
|
5
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
4
|
# you may not use this file except in compliance with the License.
|
7
5
|
# You may obtain a copy of the License at
|
8
6
|
#
|
9
|
-
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
8
|
#
|
11
9
|
# Unless required by applicable law or agreed to in writing, software
|
12
10
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
@@ -14,13 +12,10 @@
|
|
14
12
|
# See the License for the specific language governing permissions and
|
15
13
|
# limitations under the License.
|
16
14
|
|
17
|
-
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
-
|
19
|
-
|
20
15
|
module Google
|
21
16
|
module Cloud
|
22
17
|
module Iot
|
23
|
-
VERSION = "
|
18
|
+
VERSION = "2.0.0"
|
24
19
|
end
|
25
20
|
end
|
26
21
|
end
|
metadata
CHANGED
@@ -1,180 +1,37 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-iot
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 2.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
12
|
-
dependencies:
|
13
|
-
|
14
|
-
|
15
|
-
requirement: !ruby/object:Gem::Requirement
|
16
|
-
requirements:
|
17
|
-
- - "~>"
|
18
|
-
- !ruby/object:Gem::Version
|
19
|
-
version: '1.6'
|
20
|
-
type: :runtime
|
21
|
-
prerelease: false
|
22
|
-
version_requirements: !ruby/object:Gem::Requirement
|
23
|
-
requirements:
|
24
|
-
- - "~>"
|
25
|
-
- !ruby/object:Gem::Version
|
26
|
-
version: '1.6'
|
27
|
-
- !ruby/object:Gem::Dependency
|
28
|
-
name: google-cloud-iot-v1
|
29
|
-
requirement: !ruby/object:Gem::Requirement
|
30
|
-
requirements:
|
31
|
-
- - ">="
|
32
|
-
- !ruby/object:Gem::Version
|
33
|
-
version: '0.6'
|
34
|
-
- - "<"
|
35
|
-
- !ruby/object:Gem::Version
|
36
|
-
version: 2.a
|
37
|
-
type: :runtime
|
38
|
-
prerelease: false
|
39
|
-
version_requirements: !ruby/object:Gem::Requirement
|
40
|
-
requirements:
|
41
|
-
- - ">="
|
42
|
-
- !ruby/object:Gem::Version
|
43
|
-
version: '0.6'
|
44
|
-
- - "<"
|
45
|
-
- !ruby/object:Gem::Version
|
46
|
-
version: 2.a
|
47
|
-
- !ruby/object:Gem::Dependency
|
48
|
-
name: google-style
|
49
|
-
requirement: !ruby/object:Gem::Requirement
|
50
|
-
requirements:
|
51
|
-
- - "~>"
|
52
|
-
- !ruby/object:Gem::Version
|
53
|
-
version: 1.26.1
|
54
|
-
type: :development
|
55
|
-
prerelease: false
|
56
|
-
version_requirements: !ruby/object:Gem::Requirement
|
57
|
-
requirements:
|
58
|
-
- - "~>"
|
59
|
-
- !ruby/object:Gem::Version
|
60
|
-
version: 1.26.1
|
61
|
-
- !ruby/object:Gem::Dependency
|
62
|
-
name: minitest
|
63
|
-
requirement: !ruby/object:Gem::Requirement
|
64
|
-
requirements:
|
65
|
-
- - "~>"
|
66
|
-
- !ruby/object:Gem::Version
|
67
|
-
version: '5.16'
|
68
|
-
type: :development
|
69
|
-
prerelease: false
|
70
|
-
version_requirements: !ruby/object:Gem::Requirement
|
71
|
-
requirements:
|
72
|
-
- - "~>"
|
73
|
-
- !ruby/object:Gem::Version
|
74
|
-
version: '5.16'
|
75
|
-
- !ruby/object:Gem::Dependency
|
76
|
-
name: minitest-focus
|
77
|
-
requirement: !ruby/object:Gem::Requirement
|
78
|
-
requirements:
|
79
|
-
- - "~>"
|
80
|
-
- !ruby/object:Gem::Version
|
81
|
-
version: '1.1'
|
82
|
-
type: :development
|
83
|
-
prerelease: false
|
84
|
-
version_requirements: !ruby/object:Gem::Requirement
|
85
|
-
requirements:
|
86
|
-
- - "~>"
|
87
|
-
- !ruby/object:Gem::Version
|
88
|
-
version: '1.1'
|
89
|
-
- !ruby/object:Gem::Dependency
|
90
|
-
name: minitest-rg
|
91
|
-
requirement: !ruby/object:Gem::Requirement
|
92
|
-
requirements:
|
93
|
-
- - "~>"
|
94
|
-
- !ruby/object:Gem::Version
|
95
|
-
version: '5.2'
|
96
|
-
type: :development
|
97
|
-
prerelease: false
|
98
|
-
version_requirements: !ruby/object:Gem::Requirement
|
99
|
-
requirements:
|
100
|
-
- - "~>"
|
101
|
-
- !ruby/object:Gem::Version
|
102
|
-
version: '5.2'
|
103
|
-
- !ruby/object:Gem::Dependency
|
104
|
-
name: rake
|
105
|
-
requirement: !ruby/object:Gem::Requirement
|
106
|
-
requirements:
|
107
|
-
- - ">="
|
108
|
-
- !ruby/object:Gem::Version
|
109
|
-
version: '13.0'
|
110
|
-
type: :development
|
111
|
-
prerelease: false
|
112
|
-
version_requirements: !ruby/object:Gem::Requirement
|
113
|
-
requirements:
|
114
|
-
- - ">="
|
115
|
-
- !ruby/object:Gem::Version
|
116
|
-
version: '13.0'
|
117
|
-
- !ruby/object:Gem::Dependency
|
118
|
-
name: redcarpet
|
119
|
-
requirement: !ruby/object:Gem::Requirement
|
120
|
-
requirements:
|
121
|
-
- - "~>"
|
122
|
-
- !ruby/object:Gem::Version
|
123
|
-
version: '3.0'
|
124
|
-
type: :development
|
125
|
-
prerelease: false
|
126
|
-
version_requirements: !ruby/object:Gem::Requirement
|
127
|
-
requirements:
|
128
|
-
- - "~>"
|
129
|
-
- !ruby/object:Gem::Version
|
130
|
-
version: '3.0'
|
131
|
-
- !ruby/object:Gem::Dependency
|
132
|
-
name: simplecov
|
133
|
-
requirement: !ruby/object:Gem::Requirement
|
134
|
-
requirements:
|
135
|
-
- - "~>"
|
136
|
-
- !ruby/object:Gem::Version
|
137
|
-
version: '0.9'
|
138
|
-
type: :development
|
139
|
-
prerelease: false
|
140
|
-
version_requirements: !ruby/object:Gem::Requirement
|
141
|
-
requirements:
|
142
|
-
- - "~>"
|
143
|
-
- !ruby/object:Gem::Version
|
144
|
-
version: '0.9'
|
145
|
-
- !ruby/object:Gem::Dependency
|
146
|
-
name: yard
|
147
|
-
requirement: !ruby/object:Gem::Requirement
|
148
|
-
requirements:
|
149
|
-
- - "~>"
|
150
|
-
- !ruby/object:Gem::Version
|
151
|
-
version: '0.9'
|
152
|
-
type: :development
|
153
|
-
prerelease: false
|
154
|
-
version_requirements: !ruby/object:Gem::Requirement
|
155
|
-
requirements:
|
156
|
-
- - "~>"
|
157
|
-
- !ruby/object:Gem::Version
|
158
|
-
version: '0.9'
|
159
|
-
description: Registers and manages IoT (Internet of Things) devices that connect to
|
160
|
-
the Google Cloud Platform.
|
11
|
+
date: 2024-02-07 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description: This gem is obsolete because the related Google backend is turned down.
|
14
|
+
For more information, see https://cloud.google.com/terms/deprecation.
|
161
15
|
email: googleapis-packages@google.com
|
162
16
|
executables: []
|
163
17
|
extensions: []
|
164
18
|
extra_rdoc_files: []
|
165
19
|
files:
|
166
|
-
- ".yardopts"
|
167
|
-
- AUTHENTICATION.md
|
168
20
|
- LICENSE.md
|
169
21
|
- README.md
|
170
|
-
- lib/google-cloud-iot.rb
|
171
|
-
- lib/google/cloud/iot.rb
|
172
22
|
- lib/google/cloud/iot/version.rb
|
173
23
|
homepage: https://github.com/googleapis/google-cloud-ruby
|
174
24
|
licenses:
|
175
25
|
- Apache-2.0
|
176
26
|
metadata: {}
|
177
|
-
post_install_message:
|
27
|
+
post_install_message: |2+
|
28
|
+
|
29
|
+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
30
|
+
The google-cloud-iot gem is OBSOLETE.
|
31
|
+
For more information, see:
|
32
|
+
https://cloud.google.com/terms/deprecation
|
33
|
+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
34
|
+
|
178
35
|
rdoc_options: []
|
179
36
|
require_paths:
|
180
37
|
- lib
|
@@ -182,15 +39,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
182
39
|
requirements:
|
183
40
|
- - ">="
|
184
41
|
- !ruby/object:Gem::Version
|
185
|
-
version: '2.
|
42
|
+
version: '2.0'
|
186
43
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
187
44
|
requirements:
|
188
45
|
- - ">="
|
189
46
|
- !ruby/object:Gem::Version
|
190
47
|
version: '0'
|
191
48
|
requirements: []
|
192
|
-
rubygems_version: 3.
|
49
|
+
rubygems_version: 3.5.3
|
193
50
|
signing_key:
|
194
51
|
specification_version: 4
|
195
|
-
summary:
|
52
|
+
summary: This gem is obsolete because the related backend is turned down.
|
196
53
|
test_files: []
|
data/.yardopts
DELETED
data/AUTHENTICATION.md
DELETED
@@ -1,151 +0,0 @@
|
|
1
|
-
# Authentication
|
2
|
-
|
3
|
-
In general, the google-cloud-iot library uses
|
4
|
-
[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
|
5
|
-
credentials to connect to Google Cloud services. When running within
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
7
|
-
credentials will be discovered automatically. When running on other
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
9
|
-
path to the
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
11
|
-
for the account (or the JSON itself) in
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
14
|
-
during development.
|
15
|
-
|
16
|
-
## Quickstart
|
17
|
-
|
18
|
-
1. [Create a service account and credentials](#creating-a-service-account).
|
19
|
-
2. Set the [environment variable](#environment-variables).
|
20
|
-
|
21
|
-
```sh
|
22
|
-
export IOT_CREDENTIALS=path/to/keyfile.json
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
26
|
-
|
27
|
-
```ruby
|
28
|
-
require "google/cloud/iot"
|
29
|
-
|
30
|
-
client = Google::Cloud::Iot.device_manager
|
31
|
-
```
|
32
|
-
|
33
|
-
## Credential Lookup
|
34
|
-
|
35
|
-
The google-cloud-iot library aims to make authentication
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
38
|
-
|
39
|
-
**Credentials** are discovered in the following order:
|
40
|
-
|
41
|
-
1. Specify credentials in method arguments
|
42
|
-
2. Specify credentials in configuration
|
43
|
-
3. Discover credentials path in environment variables
|
44
|
-
4. Discover credentials JSON in environment variables
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
46
|
-
6. Discover GCP credentials
|
47
|
-
|
48
|
-
### Google Cloud Platform environments
|
49
|
-
|
50
|
-
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
51
|
-
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
54
|
-
|
55
|
-
### Environment Variables
|
56
|
-
|
57
|
-
The **Credentials JSON** can be placed in environment variables instead of
|
58
|
-
declaring them directly in code. Each service has its own environment variable,
|
59
|
-
allowing for different service accounts to be used for different services. (See
|
60
|
-
the READMEs for the individual service gems for details.) The path to the
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
63
|
-
containers where writing files is difficult or not encouraged.
|
64
|
-
|
65
|
-
The environment variables that google-cloud-iot
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
`::Google::Cloud::Iot::V1::DeviceManager::Credentials`):
|
68
|
-
|
69
|
-
* `IOT_CREDENTIALS` - Path to JSON file, or JSON contents
|
70
|
-
* `IOT_KEYFILE` - Path to JSON file, or JSON contents
|
71
|
-
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
72
|
-
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
73
|
-
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
74
|
-
|
75
|
-
```ruby
|
76
|
-
require "google/cloud/iot"
|
77
|
-
|
78
|
-
ENV["IOT_CREDENTIALS"] = "path/to/keyfile.json"
|
79
|
-
|
80
|
-
client = Google::Cloud::Iot.device_manager
|
81
|
-
```
|
82
|
-
|
83
|
-
### Configuration
|
84
|
-
|
85
|
-
The path to the **Credentials JSON** file can be configured instead of storing
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
87
|
-
|
88
|
-
```ruby
|
89
|
-
require "google/cloud/iot"
|
90
|
-
|
91
|
-
client = Google::Cloud::Iot.device_manager do |config|
|
92
|
-
config.credentials = "path/to/keyfile.json"
|
93
|
-
end
|
94
|
-
```
|
95
|
-
|
96
|
-
Or globally for all clients:
|
97
|
-
|
98
|
-
```ruby
|
99
|
-
require "google/cloud/iot"
|
100
|
-
|
101
|
-
Google::Cloud::Iot.configure do |config|
|
102
|
-
config.credentials = "path/to/keyfile.json"
|
103
|
-
end
|
104
|
-
|
105
|
-
client = Google::Cloud::Iot.device_manager
|
106
|
-
```
|
107
|
-
|
108
|
-
### Cloud SDK
|
109
|
-
|
110
|
-
This option allows for an easy way to authenticate during development. If
|
111
|
-
credentials are not provided in code or in environment variables, then Cloud SDK
|
112
|
-
credentials are discovered.
|
113
|
-
|
114
|
-
To configure your system for this, simply:
|
115
|
-
|
116
|
-
1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
|
117
|
-
2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
|
118
|
-
3. Write code as if already authenticated.
|
119
|
-
|
120
|
-
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
121
|
-
*should* only be used during development.
|
122
|
-
|
123
|
-
## Creating a Service Account
|
124
|
-
|
125
|
-
Google Cloud requires **Service Account Credentials** to
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
127
|
-
connect to most services with google-cloud-iot.
|
128
|
-
|
129
|
-
If you are not running this client within
|
130
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
131
|
-
need a Google Developers service account.
|
132
|
-
|
133
|
-
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
134
|
-
2. Create a new project or click on an existing project.
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
136
|
-
here, you will enable the APIs that your application requires.
|
137
|
-
|
138
|
-
*Note: You may need to enable billing in order to use these services.*
|
139
|
-
|
140
|
-
4. Select **Credentials** from the side navigation.
|
141
|
-
|
142
|
-
Find the "Create credentials" drop down near the top of the page, and select
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
144
|
-
|
145
|
-
If you want to re-use an existing service account, you can easily generate a
|
146
|
-
new key file. Just select the account you wish to re-use, click the pencil
|
147
|
-
tool on the right side to edit the service account, select the **Keys** tab,
|
148
|
-
and then select **Add Key**.
|
149
|
-
|
150
|
-
The key file you download will be used by this library to authenticate API
|
151
|
-
requests and should be stored in a secure location.
|
data/lib/google/cloud/iot.rb
DELETED
@@ -1,119 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
# Copyright 2020 Google LLC
|
4
|
-
#
|
5
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
-
# you may not use this file except in compliance with the License.
|
7
|
-
# You may obtain a copy of the License at
|
8
|
-
#
|
9
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
-
#
|
11
|
-
# Unless required by applicable law or agreed to in writing, software
|
12
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
-
# See the License for the specific language governing permissions and
|
15
|
-
# limitations under the License.
|
16
|
-
|
17
|
-
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
-
|
19
|
-
# Require this file early so that the version constant gets defined before
|
20
|
-
# requiring "google/cloud". This is because google-cloud-core will load the
|
21
|
-
# entrypoint (gem name) file, which in turn re-requires this file (hence
|
22
|
-
# causing a require cycle) unless the version constant is already defined.
|
23
|
-
require "google/cloud/iot/version"
|
24
|
-
|
25
|
-
require "googleauth"
|
26
|
-
gem "google-cloud-core"
|
27
|
-
require "google/cloud" unless defined? ::Google::Cloud.new
|
28
|
-
require "google/cloud/config"
|
29
|
-
|
30
|
-
# Set the default configuration
|
31
|
-
::Google::Cloud.configure.add_config! :iot do |config|
|
32
|
-
config.add_field! :endpoint, "cloudiot.googleapis.com", match: ::String
|
33
|
-
config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
|
34
|
-
config.add_field! :scope, nil, match: [::Array, ::String]
|
35
|
-
config.add_field! :lib_name, nil, match: ::String
|
36
|
-
config.add_field! :lib_version, nil, match: ::String
|
37
|
-
config.add_field! :interceptors, nil, match: ::Array
|
38
|
-
config.add_field! :timeout, nil, match: ::Numeric
|
39
|
-
config.add_field! :metadata, nil, match: ::Hash
|
40
|
-
config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
|
41
|
-
config.add_field! :quota_project, nil, match: ::String
|
42
|
-
end
|
43
|
-
|
44
|
-
module Google
|
45
|
-
module Cloud
|
46
|
-
module Iot
|
47
|
-
##
|
48
|
-
# Create a new client object for DeviceManager.
|
49
|
-
#
|
50
|
-
# By default, this returns an instance of
|
51
|
-
# [Google::Cloud::Iot::V1::DeviceManager::Client](https://googleapis.dev/ruby/google-cloud-iot-v1/latest/Google/Cloud/Iot/V1/DeviceManager/Client.html)
|
52
|
-
# for a gRPC client for version V1 of the API.
|
53
|
-
# However, you can specify a different API version by passing it in the
|
54
|
-
# `version` parameter. If the DeviceManager service is
|
55
|
-
# supported by that API version, and the corresponding gem is available, the
|
56
|
-
# appropriate versioned client will be returned.
|
57
|
-
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
58
|
-
# the `transport` parameter.
|
59
|
-
#
|
60
|
-
# ## About DeviceManager
|
61
|
-
#
|
62
|
-
# Internet of Things (IoT) service. Securely connect and manage IoT devices.
|
63
|
-
#
|
64
|
-
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
65
|
-
# Defaults to `:v1`.
|
66
|
-
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
67
|
-
# @return [::Object] A client object for the specified version.
|
68
|
-
#
|
69
|
-
def self.device_manager version: :v1, transport: :grpc, &block
|
70
|
-
require "google/cloud/iot/#{version.to_s.downcase}"
|
71
|
-
|
72
|
-
package_name = Google::Cloud::Iot
|
73
|
-
.constants
|
74
|
-
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
75
|
-
.first
|
76
|
-
service_module = Google::Cloud::Iot.const_get(package_name).const_get(:DeviceManager)
|
77
|
-
service_module = service_module.const_get(:Rest) if transport == :rest
|
78
|
-
service_module.const_get(:Client).new(&block)
|
79
|
-
end
|
80
|
-
|
81
|
-
##
|
82
|
-
# Configure the google-cloud-iot library.
|
83
|
-
#
|
84
|
-
# The following configuration parameters are supported:
|
85
|
-
#
|
86
|
-
# * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
|
87
|
-
# The path to the keyfile as a String, the contents of the keyfile as a
|
88
|
-
# Hash, or a Google::Auth::Credentials object.
|
89
|
-
# * `lib_name` (*type:* `String`) -
|
90
|
-
# The library name as recorded in instrumentation and logging.
|
91
|
-
# * `lib_version` (*type:* `String`) -
|
92
|
-
# The library version as recorded in instrumentation and logging.
|
93
|
-
# * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
|
94
|
-
# An array of interceptors that are run before calls are executed.
|
95
|
-
# * `timeout` (*type:* `Numeric`) -
|
96
|
-
# Default timeout in seconds.
|
97
|
-
# * `metadata` (*type:* `Hash{Symbol=>String}`) -
|
98
|
-
# Additional headers to be sent with the call.
|
99
|
-
# * `retry_policy` (*type:* `Hash`) -
|
100
|
-
# The retry policy. The value is a hash with the following keys:
|
101
|
-
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
102
|
-
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
103
|
-
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
104
|
-
# * `:retry_codes` (*type:* `Array<String>`) -
|
105
|
-
# The error codes that should trigger a retry.
|
106
|
-
#
|
107
|
-
# @return [::Google::Cloud::Config] The default configuration used by this library
|
108
|
-
#
|
109
|
-
def self.configure
|
110
|
-
yield ::Google::Cloud.configure.iot if block_given?
|
111
|
-
|
112
|
-
::Google::Cloud.configure.iot
|
113
|
-
end
|
114
|
-
end
|
115
|
-
end
|
116
|
-
end
|
117
|
-
|
118
|
-
helper_path = ::File.join __dir__, "iot", "helpers.rb"
|
119
|
-
require "google/cloud/iot/helpers" if ::File.file? helper_path
|
data/lib/google-cloud-iot.rb
DELETED
@@ -1,19 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
# Copyright 2020 Google LLC
|
4
|
-
#
|
5
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
-
# you may not use this file except in compliance with the License.
|
7
|
-
# You may obtain a copy of the License at
|
8
|
-
#
|
9
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
-
#
|
11
|
-
# Unless required by applicable law or agreed to in writing, software
|
12
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
-
# See the License for the specific language governing permissions and
|
15
|
-
# limitations under the License.
|
16
|
-
|
17
|
-
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
-
|
19
|
-
require "google/cloud/iot" unless defined? Google::Cloud::Iot::VERSION
|