google-cloud-billing-budgets 2.1.0 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/README.md +2 -28
  4. data/lib/google/cloud/billing/budgets/version.rb +1 -1
  5. data/lib/google/cloud/billing/budgets.rb +14 -9
  6. metadata +7 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0ccf0bba5d871da0f3ed3813aed5c16cd0e86fe27770a25a9da6a514e63e99b4
4
- data.tar.gz: bff96b30afee27423359c114c0ccb2961cd573c3607b8cd7f5a41108342fb48a
3
+ metadata.gz: 23d899fbe237f4405426f8373fba5eb38c0f35ba489f9cd31b031ebc1f457c4d
4
+ data.tar.gz: fb044d6bf3bfdd80adbc9090d9519bdb0bde54bdbfa2e7c416e63411db93f7a5
5
5
  SHA512:
6
- metadata.gz: 163fd5079f02e1a9f420e7f9b5b2a5669e993e6b16051e1e9759602eb19a772548e539e3d544665f6acfe279ccd808eb0142b2b05c07ed72521a60d5b10a289e
7
- data.tar.gz: e7af1ba0f3c473ba91f49ad845d1ed5cb3a5002a3a22c643b8aa354b6ceaf9e06233952d9c37862b3f0320e6cbd24c93fb8fa8eee5919cb52523b808d0260917
6
+ metadata.gz: 41bcc320a7e440f7c05d01c00c8b4b04cb8f477a60b7fecc87891ad16db4941923c455bcc8f6b06218b47039a10e53466c714fe41bc2404f2867f4a19fc2af79
7
+ data.tar.gz: 03d161f2d3b10e321f76b27e6e683347ecc8b5d1438f8d0454a727b7020a45b2c038da4b05fc17947a50e4147b9105c2ff82509743d151150f7f7c8ed7d8fc56
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-billing-budgets 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.
3
+ The recommended way to authenticate to the google-cloud-billing-budgets 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
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export BILLING_BUDGETS_CREDENTIALS=path/to/keyfile.json
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
- ```ruby
28
- require "google/cloud/billing/budgets"
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
- client = Google::Cloud::Billing::Budgets.budget_service
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-billing-budgets 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
- 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.
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
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
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.
29
+ The google-cloud-billing-budgets 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
- The environment variables that google-cloud-billing-budgets
66
- checks for credentials are configured on the service Credentials class (such as
67
- `::Google::Cloud::Billing::Budgets::V1::BudgetService::Credentials`):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `BILLING_BUDGETS_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `BILLING_BUDGETS_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
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)
74
41
 
75
- ```ruby
76
- require "google/cloud/billing/budgets"
77
-
78
- ENV["BILLING_BUDGETS_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = Google::Cloud::Billing::Budgets.budget_service
81
- ```
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).
82
49
 
83
- ### Configuration
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.
84
53
 
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:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/billing/budgets"
90
58
 
91
59
  client = Google::Cloud::Billing::Budgets.budget_service do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/billing/budgets"
100
68
 
101
69
  Google::Cloud::Billing::Budgets.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = Google::Cloud::Billing::Budgets.budget_service
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
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.
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.
113
82
 
114
- To configure your system for this, simply:
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).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
118
- 3. Write code as if already authenticated.
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-cloud-billing-budgets
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/billing/budgets"
124
100
 
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-billing-budgets.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
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.
103
+ client = Google::Cloud::Billing::Budgets.budget_service
104
+ ```
132
105
 
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.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
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.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
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.
114
+ ### Google Cloud Platform environments
144
115
 
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**.
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.
149
120
 
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.
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,8 +16,8 @@ for this library, google-cloud-billing-budgets, to see the convenience methods f
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-cloud-billing-budgets-v1](https://googleapis.dev/ruby/google-cloud-billing-budgets-v1/latest),
20
- [google-cloud-billing-budgets-v1beta1](https://googleapis.dev/ruby/google-cloud-billing-budgets-v1beta1/latest).
19
+ [google-cloud-billing-budgets-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-billing-budgets-v1/latest),
20
+ [google-cloud-billing-budgets-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-billing-budgets-v1beta1/latest).
21
21
 
22
22
  See also the [Product Documentation](https://cloud.google.com/billing/docs/how-to/budget-api-overview)
23
23
  for more usage information.
@@ -35,32 +35,6 @@ In order to use this library, you first need to go through the following steps:
35
35
  1. [Enable the API.](https://console.cloud.google.com/apis/library/billingbudgets.googleapis.com)
36
36
  1. {file:AUTHENTICATION.md Set up authentication.}
37
37
 
38
- ## Enabling Logging
39
-
40
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
41
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
42
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
43
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
44
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
45
-
46
- Configuring a Ruby stdlib logger:
47
-
48
- ```ruby
49
- require "logger"
50
-
51
- module MyLogger
52
- LOGGER = Logger.new $stderr, level: Logger::WARN
53
- def logger
54
- LOGGER
55
- end
56
- end
57
-
58
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
59
- module GRPC
60
- extend MyLogger
61
- end
62
- ```
63
-
64
38
  ## Supported Ruby Versions
65
39
 
66
40
  This library is supported on Ruby 2.6+.
data/lib/google/cloud/billing/budgets/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Billing
23
23
  module Budgets
24
- VERSION = "2.1.0"
24
+ VERSION = "2.3.0"
25
25
  end
26
26
  end
27
27
  end
data/lib/google/cloud/billing/budgets.rb CHANGED
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :billing_budgets do |config|
32
- config.add_field! :endpoint, "billingbudgets.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -49,12 +50,14 @@ module Google
49
50
  # Create a new client object for BudgetService.
50
51
  #
51
52
  # By default, this returns an instance of
52
- # [Google::Cloud::Billing::Budgets::V1::BudgetService::Client](https://googleapis.dev/ruby/google-cloud-billing-budgets-v1/latest/Google/Cloud/Billing/Budgets/V1/BudgetService/Client.html)
53
- # for version V1 of the API.
54
- # However, you can specify specify a different API version by passing it in the
53
+ # [Google::Cloud::Billing::Budgets::V1::BudgetService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-billing-budgets-v1/latest/Google-Cloud-Billing-Budgets-V1-BudgetService-Client)
54
+ # for a gRPC client for version V1 of the API.
55
+ # However, you can specify a different API version by passing it in the
55
56
  # `version` parameter. If the BudgetService service is
56
57
  # supported by that API version, and the corresponding gem is available, the
57
58
  # appropriate versioned client will be returned.
59
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
60
+ # the `transport` parameter.
58
61
  #
59
62
  # ## About BudgetService
60
63
  #
@@ -63,17 +66,19 @@ module Google
63
66
  #
64
67
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
65
68
  # Defaults to `:v1`.
66
- # @return [BudgetService::Client] A client object for the specified version.
69
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
70
+ # @return [::Object] A client object for the specified version.
67
71
  #
68
- def self.budget_service version: :v1, &block
72
+ def self.budget_service version: :v1, transport: :grpc, &block
69
73
  require "google/cloud/billing/budgets/#{version.to_s.downcase}"
70
74
 
71
75
  package_name = Google::Cloud::Billing::Budgets
72
76
  .constants
73
77
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
74
78
  .first
75
- package_module = Google::Cloud::Billing::Budgets.const_get package_name
76
- package_module.const_get(:BudgetService).const_get(:Client).new(&block)
79
+ service_module = Google::Cloud::Billing::Budgets.const_get(package_name).const_get(:BudgetService)
80
+ service_module = service_module.const_get(:Rest) if transport == :rest
81
+ service_module.const_get(:Client).new(&block)
77
82
  end
78
83
 
79
84
  ##
@@ -93,7 +98,7 @@ module Google
93
98
  # * `timeout` (*type:* `Numeric`) -
94
99
  # Default timeout in seconds.
95
100
  # * `metadata` (*type:* `Hash{Symbol=>String}`) -
96
- # Additional gRPC headers to be sent with the call.
101
+ # Additional headers to be sent with the call.
97
102
  # * `retry_policy` (*type:* `Hash`) -
98
103
  # The retry policy. The value is a hash with the following keys:
99
104
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-billing-budgets
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.0
4
+ version: 2.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: 2022-07-01 00:00:00.000000000 Z
11
+ date: 2024-01-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-billing-budgets-v1
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.0'
19
+ version: '0.7'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.0'
29
+ version: '0.7'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -36,7 +36,7 @@ dependencies:
36
36
  requirements:
37
37
  - - ">="
38
38
  - !ruby/object:Gem::Version
39
- version: '0.0'
39
+ version: '0.11'
40
40
  - - "<"
41
41
  - !ruby/object:Gem::Version
42
42
  version: 2.a
@@ -46,7 +46,7 @@ dependencies:
46
46
  requirements:
47
47
  - - ">="
48
48
  - !ruby/object:Gem::Version
49
- version: '0.0'
49
+ version: '0.11'
50
50
  - - "<"
51
51
  - !ruby/object:Gem::Version
52
52
  version: 2.a
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
209
209
  - !ruby/object:Gem::Version
210
210
  version: '0'
211
211
  requirements: []
212
- rubygems_version: 3.3.14
212
+ rubygems_version: 3.5.3
213
213
  signing_key:
214
214
  specification_version: 4
215
215
  summary: API Client library for the Billing Budgets API