google-apps-meet 0.1.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -99
- data/README.md +4 -4
- data/lib/google/apps/meet/version.rb +1 -1
- data/lib/google/apps/meet.rb +8 -8
- metadata +5 -117
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f08eeccdaee5a1e7582c15d856885c83a9fb386e12d6a1f8c02f9acd25685698
|
4
|
+
data.tar.gz: 6b30ae92772532d2d7cf475959c5973cff7225dbdb61c0d324c99405baa80401
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: af81af296b61a2d739ff0731f2f19bd9ffb2122df21e2a0028a753a6d2bfa6a2bbb16548710645a6dc39e851abbeb246a57da4a029f3a731f4e17530ffe3cc19
|
7
|
+
data.tar.gz: dc3a5c009c0a01368b0320a663e92b0ae27d658fb10169c3e77c81107cd7a037a63b86f72ba26bdd211215a04284fc0bbbe7554411b0185a65bec970235bc222
|
data/AUTHENTICATION.md
CHANGED
@@ -1,149 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
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.
|
3
|
+
The recommended way to authenticate to the google-apps-meet library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
15
6
|
|
16
7
|
## Quickstart
|
17
8
|
|
18
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
26
14
|
|
27
|
-
|
28
|
-
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
29
17
|
|
30
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-apps-meet 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
|
22
|
+
3. Write code as if already authenticated.
|
49
23
|
|
50
|
-
|
51
|
-
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
54
26
|
|
55
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
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.
|
29
|
+
The google-apps-meet library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
64
33
|
|
65
|
-
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
`::Google::Apps::Meet::V2beta::SpacesService::Credentials`):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
72
41
|
|
73
|
-
|
74
|
-
require "google/apps/meet"
|
75
|
-
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
77
43
|
|
78
|
-
client
|
79
|
-
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
80
49
|
|
81
|
-
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
82
53
|
|
83
|
-
|
84
|
-
it in an environment variable. Either on an individual client initialization:
|
54
|
+
To configure a credentials file for an individual client initialization:
|
85
55
|
|
86
56
|
```ruby
|
87
57
|
require "google/apps/meet"
|
88
58
|
|
89
59
|
client = Google::Apps::Meet.spaces_service do |config|
|
90
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
91
61
|
end
|
92
62
|
```
|
93
63
|
|
94
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
95
65
|
|
96
66
|
```ruby
|
97
67
|
require "google/apps/meet"
|
98
68
|
|
99
69
|
Google::Apps::Meet.configure do |config|
|
100
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
101
71
|
end
|
102
72
|
|
103
73
|
client = Google::Apps::Meet.spaces_service
|
104
74
|
```
|
105
75
|
|
106
|
-
###
|
76
|
+
### Environment Variables
|
107
77
|
|
108
|
-
|
109
|
-
|
110
|
-
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
111
82
|
|
112
|
-
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
113
87
|
|
114
|
-
|
115
|
-
|
116
|
-
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-apps-meet
|
93
|
+
checks for credentials are:
|
117
94
|
|
118
|
-
|
119
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
120
97
|
|
121
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/apps/meet"
|
122
100
|
|
123
|
-
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
125
|
-
connect to most services with google-apps-meet.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
126
102
|
|
127
|
-
|
128
|
-
|
129
|
-
need a Google Developers service account.
|
103
|
+
client = Google::Apps::Meet.spaces_service
|
104
|
+
```
|
130
105
|
|
131
|
-
|
132
|
-
2. Create a new project or click on an existing project.
|
133
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
134
|
-
here, you will enable the APIs that your application requires.
|
106
|
+
### Local ADC file
|
135
107
|
|
136
|
-
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
137
111
|
|
138
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
139
113
|
|
140
|
-
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
142
115
|
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
147
120
|
|
148
|
-
|
149
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
data/README.md
CHANGED
@@ -16,7 +16,7 @@ for this library, google-apps-meet, to see the convenience methods for
|
|
16
16
|
constructing client objects. Reference documentation for the client objects
|
17
17
|
themselves can be found in the client library documentation for the versioned
|
18
18
|
client gems:
|
19
|
-
[google-apps-meet-
|
19
|
+
[google-apps-meet-v2](https://cloud.google.com/ruby/docs/reference/google-apps-meet-v2/latest).
|
20
20
|
|
21
21
|
See also the [Product Documentation](https://developers.google.com/meet/api/guides/overview)
|
22
22
|
for more usage information.
|
@@ -36,7 +36,7 @@ In order to use this library, you first need to go through the following steps:
|
|
36
36
|
|
37
37
|
## Supported Ruby Versions
|
38
38
|
|
39
|
-
This library is supported on Ruby 2.
|
39
|
+
This library is supported on Ruby 2.7+.
|
40
40
|
|
41
41
|
Google provides official support for Ruby versions that are actively supported
|
42
42
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
@@ -50,7 +50,7 @@ support schedule.
|
|
50
50
|
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
51
51
|
client library with a name such as `google-apps-meet`,
|
52
52
|
and lower-level _versioned_ client libraries with names such as
|
53
|
-
`google-apps-meet-
|
53
|
+
`google-apps-meet-v2`.
|
54
54
|
_In most cases, you should install the main client._
|
55
55
|
|
56
56
|
### What's the difference between the main client and a versioned client?
|
@@ -88,7 +88,7 @@ You can use a versioned client if you are content with a possibly lower-level
|
|
88
88
|
class interface, you explicitly want to avoid features provided by the main
|
89
89
|
client, or you want to access a specific service version not be covered by the
|
90
90
|
main client. You can identify versioned client gems because the service version
|
91
|
-
is part of the name, e.g. `google-apps-meet-
|
91
|
+
is part of the name, e.g. `google-apps-meet-v2`.
|
92
92
|
|
93
93
|
### What about the google-apis-<name> clients?
|
94
94
|
|
data/lib/google/apps/meet.rb
CHANGED
@@ -31,8 +31,8 @@ module Google
|
|
31
31
|
# Create a new client object for SpacesService.
|
32
32
|
#
|
33
33
|
# By default, this returns an instance of
|
34
|
-
# [Google::Apps::Meet::
|
35
|
-
# for a gRPC client for version
|
34
|
+
# [Google::Apps::Meet::V2::SpacesService::Client](https://cloud.google.com/ruby/docs/reference/google-apps-meet-v2/latest/Google-Apps-Meet-V2-SpacesService-Client)
|
35
|
+
# for a gRPC client for version V2 of the API.
|
36
36
|
# However, you can specify a different API version by passing it in the
|
37
37
|
# `version` parameter. If the SpacesService service is
|
38
38
|
# supported by that API version, and the corresponding gem is available, the
|
@@ -45,11 +45,11 @@ module Google
|
|
45
45
|
# REST API for services dealing with spaces.
|
46
46
|
#
|
47
47
|
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
48
|
-
# Defaults to `:
|
48
|
+
# Defaults to `:v2`.
|
49
49
|
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
50
50
|
# @return [::Object] A client object for the specified version.
|
51
51
|
#
|
52
|
-
def self.spaces_service version: :
|
52
|
+
def self.spaces_service version: :v2, transport: :grpc, &block
|
53
53
|
require "google/apps/meet/#{version.to_s.downcase}"
|
54
54
|
|
55
55
|
package_name = Google::Apps::Meet
|
@@ -65,8 +65,8 @@ module Google
|
|
65
65
|
# Create a new client object for ConferenceRecordsService.
|
66
66
|
#
|
67
67
|
# By default, this returns an instance of
|
68
|
-
# [Google::Apps::Meet::
|
69
|
-
# for a gRPC client for version
|
68
|
+
# [Google::Apps::Meet::V2::ConferenceRecordsService::Client](https://cloud.google.com/ruby/docs/reference/google-apps-meet-v2/latest/Google-Apps-Meet-V2-ConferenceRecordsService-Client)
|
69
|
+
# for a gRPC client for version V2 of the API.
|
70
70
|
# However, you can specify a different API version by passing it in the
|
71
71
|
# `version` parameter. If the ConferenceRecordsService service is
|
72
72
|
# supported by that API version, and the corresponding gem is available, the
|
@@ -79,11 +79,11 @@ module Google
|
|
79
79
|
# REST API for services dealing with conference records.
|
80
80
|
#
|
81
81
|
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
82
|
-
# Defaults to `:
|
82
|
+
# Defaults to `:v2`.
|
83
83
|
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
84
84
|
# @return [::Object] A client object for the specified version.
|
85
85
|
#
|
86
|
-
def self.conference_records_service version: :
|
86
|
+
def self.conference_records_service version: :v2, transport: :grpc, &block
|
87
87
|
require "google/apps/meet/#{version.to_s.downcase}"
|
88
88
|
|
89
89
|
package_name = Google::Apps::Meet
|
metadata
CHANGED
@@ -1,17 +1,17 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apps-meet
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.3.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: 2024-
|
11
|
+
date: 2024-02-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
|
-
name: google-apps-meet-
|
14
|
+
name: google-apps-meet-v2
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
@@ -44,118 +44,6 @@ dependencies:
|
|
44
44
|
- - "~>"
|
45
45
|
- !ruby/object:Gem::Version
|
46
46
|
version: '1.6'
|
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
47
|
description: Create and manage meetings in Google Meet.
|
160
48
|
email: googleapis-packages@google.com
|
161
49
|
executables: []
|
@@ -181,14 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
181
69
|
requirements:
|
182
70
|
- - ">="
|
183
71
|
- !ruby/object:Gem::Version
|
184
|
-
version: '2.
|
72
|
+
version: '2.7'
|
185
73
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
186
74
|
requirements:
|
187
75
|
- - ">="
|
188
76
|
- !ruby/object:Gem::Version
|
189
77
|
version: '0'
|
190
78
|
requirements: []
|
191
|
-
rubygems_version: 3.5.
|
79
|
+
rubygems_version: 3.5.6
|
192
80
|
signing_key:
|
193
81
|
specification_version: 4
|
194
82
|
summary: Create and manage meetings in Google Meet.
|