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
|
# Copyright 2015 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.
require "google/cloud/config"
require "google/cloud/core/version"
##
# # Google Cloud
#
# The google-cloud library is the official library for interacting with Google
# Cloud Platform. Google Cloud Platform is a set of modular cloud-based services
# that allow you to create anything from simple websites to complex
# applications.
#
# The goal of google-cloud is to provide an API that is comfortable to
# Rubyists. Your authentication credentials are detected automatically in
# Google Cloud Platform environments such as Google Compute Engine, Google
# App Engine and Google Kubernetes Engine. In other environments you can
# configure authentication easily, either directly in your code or via
# environment variables. Read more about the options for connecting in the
# [Authentication
# Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
#
# You can learn more about various options for connection on the [Authentication
# Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
#
module Google
module Cloud
##
# Creates a new object for connecting to Google Cloud.
#
# For more information on connecting to Google Cloud see the [Authentication
# Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
#
# @param [String] project_id Project identifier for the service you are
# connecting to.
# @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.
# @param [Integer] retries Number of times to retry requests on server
# error. The default value is `3`. Optional.
# @param [Integer] timeout Default timeout to use in requests. Optional.
#
# @return [Google::Cloud]
#
# @example
# require "google/cloud"
#
# gcloud = Google::Cloud.new
# datastore = gcloud.datastore
# pubsub = gcloud.pubsub
# storage = gcloud.storage
#
def self.new project_id = nil, credentials = nil, retries: nil, timeout: nil
gcloud = Object.new
gcloud.instance_variable_set :@project, project_id
gcloud.instance_variable_set :@keyfile, credentials
gcloud.instance_variable_set :@retries, retries
gcloud.instance_variable_set :@timeout, timeout
gcloud.extend Google::Cloud
gcloud
end
##
# Configure the default parameter for Google::Cloud. The values defined on
# this top level will be shared across all Google::Cloud libraries, which
# may also add fields to this object or add sub configuration options under
# this object.
#
# Possible configuration parameters:
#
# * `project_id`: The Google Cloud Project ID. Automatically discovered
# when running from GCP environments.
# * `credentials`: The service account JSON file path. Automatically
# discovered when running from GCP environments.
#
# @return [Google::Cloud::Config] The top-level configuration object for
# Google::Cloud libraries.
#
def self.configure
@config ||= Config.create
yield @config if block_given?
@config
end
end
end
# Set the default top-level configuration
Google::Cloud.configure do |config|
default_project = Google::Cloud::Config.deferred do
ENV["GOOGLE_CLOUD_PROJECT"] || ENV["GCLOUD_PROJECT"]
end
default_creds = Google::Cloud::Config.deferred do
Google::Cloud::Config.credentials_from_env \
"GOOGLE_CLOUD_CREDENTIALS", "GOOGLE_CLOUD_CREDENTIALS_JSON",
"GOOGLE_CLOUD_KEYFILE", "GOOGLE_CLOUD_KEYFILE_JSON",
"GCLOUD_KEYFILE", "GCLOUD_KEYFILE_JSON"
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: Object
config.add_alias! :keyfile, :credentials
end
# Auto-load all Google Cloud service gems.
Gem.find_files("google-cloud-*.rb").each do |google_cloud_service|
require google_cloud_service
end
|
