/
google-cloud-spanner.rb
175 lines (167 loc) · 7.65 KB
/
google-cloud-spanner.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# Copyright 2016 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.
##
# This file is here to be autorequired by bundler, so that the
# Google::Cloud.spanner and Google::Cloud#spanner methods can be available, but
# the library and all dependencies won't be loaded until required and used.
gem "google-cloud-core"
require "google/cloud" unless defined? Google::Cloud.new
require "google/cloud/config"
require "googleauth"
module Google
module Cloud
##
# Creates a new object for connecting to the Spanner service.
# Each call creates a new connection.
#
# For more information on connecting to Google Cloud see the
# {file:AUTHENTICATION.md Authentication Guide}.
#
# @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
# set of resources and operations that the connection can access. See
# [Using OAuth 2.0 to Access Google
# APIs](https://developers.google.com/identity/protocols/OAuth2).
#
# The default scopes are:
#
# * `https://www.googleapis.com/auth/spanner`
# * `https://www.googleapis.com/auth/spanner.data`
# @param [Integer] timeout Default timeout to use in requests. Optional.
# @param [Hash] client_config A hash of values to override the default
# behavior of the API client. Optional.
# @param [String] lib_name Library name. This will be added as a prefix
# to the API call tracking header `x-goog-api-client` with provided
# lib version for telemetry. Optional. For example prefix looks like
# `spanner-activerecord/0.0.1 gccl/1.13.1`. Here,
# `spanner-activerecord/0.0.1` is provided custom library name and
# version and `gccl/1.13.1` represents the Cloud Spanner Ruby library
# with version.
# @param [String] lib_version Library version. This will be added as a
# prefix to the API call tracking header `x-goog-api-client` with
# provided lib name for telemetry. Optional. For example prefix look like
# `spanner-activerecord/0.0.1 gccl/1.13.1`. Here,
# `spanner-activerecord/0.0.1` is provided custom library name and
# version and `gccl/1.13.1` represents the Cloud Spanner Ruby library
# with version.
#
# @return [Google::Cloud::Spanner::Project]
#
# @example
# require "google/cloud"
#
# gcloud = Google::Cloud.new
# spanner = gcloud.spanner
#
# @example The default scope can be overridden with the `scope` option:
# require "google/cloud"
#
# gcloud = Google::Cloud.new
# platform_scope = "https://www.googleapis.com/auth/cloud-platform"
# spanner = gcloud.spanner scope: platform_scope
#
def spanner scope: nil, timeout: nil, client_config: nil, lib_name: nil,
lib_version: nil
Google::Cloud.spanner @project, @keyfile, scope: scope,
timeout: (timeout || @timeout),
client_config: client_config,
lib_name: lib_name,
lib_version: lib_version
end
##
# Creates a new object for connecting to the Spanner service.
# Each call creates a new connection.
#
# For more information on connecting to Google Cloud see the
# {file:AUTHENTICATION.md Authentication Guide}.
#
# @param [String] project_id Project identifier for the Spanner service you
# are connecting to. If not present, the default project for the
# credentials is used.
# @param [String, Hash, Google::Auth::Credentials] credentials The path to
# the keyfile as a String, the contents of the keyfile as a Hash, or a
# Google::Auth::Credentials object. (See {Spanner::Credentials})
# @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
# set of resources and operations that the connection can access. See
# [Using OAuth 2.0 to Access Google
# APIs](https://developers.google.com/identity/protocols/OAuth2).
#
# The default scopes are:
#
# * `https://www.googleapis.com/auth/spanner`
# * `https://www.googleapis.com/auth/spanner.data`
# @param [Integer] timeout Default timeout to use in requests. Optional.
# @param [Hash] client_config A hash of values to override the default
# behavior of the API client. Optional.
# @param [String] lib_name Library name. This will be added as a prefix
# to the API call tracking header `x-goog-api-client` with provided
# lib version for telemetry. Optional. For example prefix looks like
# `spanner-activerecord/0.0.1 gccl/1.13.1`. Here,
# `spanner-activerecord/0.0.1` is provided custom library name and
# version and `gccl/1.13.1` represents the Cloud Spanner Ruby library
# with version.
# @param [String] lib_version Library version. This will be added as a
# prefix to the API call tracking header `x-goog-api-client` with
# provided lib name for telemetry. Optional. For example prefix look like
# `spanner-activerecord/0.0.1 gccl/1.13.1`. Here,
# `spanner-activerecord/0.0.1` is provided custom library name and
# version and `gccl/1.13.1` represents the Cloud Spanner Ruby library
# with version.
#
# @return [Google::Cloud::Spanner::Project]
#
# @example
# require "google/cloud"
#
# spanner = Google::Cloud.spanner
#
def self.spanner project_id = nil, credentials = nil, scope: nil,
timeout: nil, client_config: nil, lib_name: nil,
lib_version: nil
require "google/cloud/spanner"
Google::Cloud::Spanner.new project_id: project_id,
credentials: credentials,
scope: scope, timeout: timeout,
client_config: client_config,
lib_name: lib_name, lib_version: lib_version
end
end
end
# Set the default spanner configuration
Google::Cloud.configure.add_config! :spanner do |config|
default_project = Google::Cloud::Config.deferred do
ENV["SPANNER_PROJECT"]
end
default_creds = Google::Cloud::Config.deferred do
Google::Cloud::Config.credentials_from_env(
"SPANNER_CREDENTIALS", "SPANNER_CREDENTIALS_JSON",
"SPANNER_KEYFILE", "SPANNER_KEYFILE_JSON"
)
end
default_emulator = Google::Cloud::Config.deferred do
ENV["SPANNER_EMULATOR_HOST"]
end
config.add_field! :project_id, default_project, match: String, allow_nil: true
config.add_alias! :project, :project_id
config.add_field! :credentials, default_creds,
match: [String, Hash, Google::Auth::Credentials],
allow_nil: true
config.add_alias! :keyfile, :credentials
config.add_field! :scope, nil, match: [String, Array]
config.add_field! :timeout, nil, match: Integer
config.add_field! :client_config, nil, match: Hash
config.add_field! :endpoint, nil, match: String
config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
config.add_field! :lib_name, nil, match: String, allow_nil: true
config.add_field! :lib_version, nil, match: String, allow_nil: true
end