google-cloud-recommendation_engine 0.2.3 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +1 -1
  3. data/README.md +6 -32
  4. data/lib/google/cloud/recommendation_engine/version.rb +1 -1
  5. data/lib/google/cloud/recommendation_engine.rb +41 -25
  6. metadata +12 -12
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e980cd31a7c52131eee9e0f4105725f43c0213caef112c0622d39ebfb8727074
4
- data.tar.gz: 695a40c7d61b75a908c930d8166ea9d87f4abd42e0286a0af773acbbcf1b9480
3
+ metadata.gz: 785dddb9ffef31f521286f811c3b7da82e9e6303b751c281d6ffcc715174f57e
4
+ data.tar.gz: c783221d0ebfed87a569f5b52b2457e4072743244032afa1e95e5cf214b0559f
5
5
  SHA512:
6
- metadata.gz: 6768c8a3dce48a704dc4a8221594c0410f3c3d24d6aa73dca40c6de5af3db27dc9719d3ed2bf60ac2842a1de1f6771cadd68ff9b90988fc0f49f51fd9be738c8
7
- data.tar.gz: 9fcde50761f1deca38960e916f6468371f4ccb1caf2b25842c5284b6fb51e547fa746aa6089a9c2db15695477ba6dc8da5ebcdcb66c91f36bc8487d68f04b849
6
+ metadata.gz: 24d528ba97e9fec5496f38fcaa00378f044b1b94f0513ab7697ca4cfd73cab4c49c84fe23d9806c7ce6f63049dec2221949d6e3bf74df6a6be5ad0ea9a301bde
7
+ data.tar.gz: a8599a2f78d53d3730220dd0b8366456977325946b31fa30d47f8d3069d4a45d32bf17521eaa2cbfafbed947f7a77cc6ca78a62d42d7a693fd5f21896da0c446
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
data/README.md CHANGED
@@ -11,7 +11,7 @@ verisoned gems in as dependencies, and provides high-level methods for
11
11
  constructing clients. More information on versioned clients can be found below
12
12
  in the section titled *Which client should I use?*.
13
13
 
14
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-recommendation_engine/latest)
14
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-recommendation_engine/latest)
15
15
  for this library, google-cloud-recommendation_engine, 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
@@ -34,42 +34,16 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/recommendationengine.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
- ## Enabling Logging
38
-
39
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
40
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
41
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
42
- 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)
43
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
44
-
45
- Configuring a Ruby stdlib logger:
46
-
47
- ```ruby
48
- require "logger"
49
-
50
- module MyLogger
51
- LOGGER = Logger.new $stderr, level: Logger::WARN
52
- def logger
53
- LOGGER
54
- end
55
- end
56
-
57
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
58
- module GRPC
59
- extend MyLogger
60
- end
61
- ```
62
-
63
37
  ## Supported Ruby Versions
64
38
 
65
- This library is supported on Ruby 2.5+.
39
+ This library is supported on Ruby 2.6+.
66
40
 
67
41
  Google provides official support for Ruby versions that are actively supported
68
42
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
69
- in security maintenance, and not end of life. Currently, this means Ruby 2.5
70
- and later. Older versions of Ruby _may_ still work, but are unsupported and not
71
- recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
72
- about the Ruby support schedule.
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.
73
47
 
74
48
  ## Which client should I use?
75
49
 
data/lib/google/cloud/recommendation_engine/version.rb CHANGED
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module RecommendationEngine
23
- VERSION = "0.2.3"
23
+ VERSION = "0.4.0"
24
24
  end
25
25
  end
26
26
  end
data/lib/google/cloud/recommendation_engine.rb CHANGED
@@ -49,11 +49,13 @@ module Google
49
49
  #
50
50
  # By default, this returns an instance of
51
51
  # [Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client](https://googleapis.dev/ruby/google-cloud-recommendation_engine-v1beta1/latest/Google/Cloud/RecommendationEngine/V1beta1/CatalogService/Client.html)
52
- # for version V1beta1 of the API.
53
- # However, you can specify specify a different API version by passing it in the
52
+ # for a gRPC client for version V1beta1 of the API.
53
+ # However, you can specify a different API version by passing it in the
54
54
  # `version` parameter. If the CatalogService service is
55
55
  # supported by that API version, and the corresponding gem is available, the
56
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.
57
59
  #
58
60
  # ## About CatalogService
59
61
  #
@@ -61,17 +63,19 @@ module Google
61
63
  #
62
64
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
63
65
  # Defaults to `:v1beta1`.
64
- # @return [CatalogService::Client] A client object for the specified version.
66
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
67
+ # @return [::Object] A client object for the specified version.
65
68
  #
66
- def self.catalog_service version: :v1beta1, &block
69
+ def self.catalog_service version: :v1beta1, transport: :grpc, &block
67
70
  require "google/cloud/recommendation_engine/#{version.to_s.downcase}"
68
71
 
69
72
  package_name = Google::Cloud::RecommendationEngine
70
73
  .constants
71
74
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
72
75
  .first
73
- package_module = Google::Cloud::RecommendationEngine.const_get package_name
74
- package_module.const_get(:CatalogService).const_get(:Client).new(&block)
76
+ service_module = Google::Cloud::RecommendationEngine.const_get(package_name).const_get(:CatalogService)
77
+ service_module = service_module.const_get(:Rest) if transport == :rest
78
+ service_module.const_get(:Client).new(&block)
75
79
  end
76
80
 
77
81
  ##
@@ -79,11 +83,13 @@ module Google
79
83
  #
80
84
  # By default, this returns an instance of
81
85
  # [Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Client](https://googleapis.dev/ruby/google-cloud-recommendation_engine-v1beta1/latest/Google/Cloud/RecommendationEngine/V1beta1/PredictionApiKeyRegistry/Client.html)
82
- # for version V1beta1 of the API.
83
- # However, you can specify specify a different API version by passing it in the
86
+ # for a gRPC client for version V1beta1 of the API.
87
+ # However, you can specify a different API version by passing it in the
84
88
  # `version` parameter. If the PredictionApiKeyRegistry service is
85
89
  # supported by that API version, and the corresponding gem is available, the
86
90
  # appropriate versioned client will be returned.
91
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
92
+ # the `transport` parameter.
87
93
  #
88
94
  # ## About PredictionApiKeyRegistry
89
95
  #
@@ -95,17 +101,19 @@ module Google
95
101
  #
96
102
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
97
103
  # Defaults to `:v1beta1`.
98
- # @return [PredictionApiKeyRegistry::Client] A client object for the specified version.
104
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
105
+ # @return [::Object] A client object for the specified version.
99
106
  #
100
- def self.prediction_api_key_registry version: :v1beta1, &block
107
+ def self.prediction_api_key_registry version: :v1beta1, transport: :grpc, &block
101
108
  require "google/cloud/recommendation_engine/#{version.to_s.downcase}"
102
109
 
103
110
  package_name = Google::Cloud::RecommendationEngine
104
111
  .constants
105
112
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
106
113
  .first
107
- package_module = Google::Cloud::RecommendationEngine.const_get package_name
108
- package_module.const_get(:PredictionApiKeyRegistry).const_get(:Client).new(&block)
114
+ service_module = Google::Cloud::RecommendationEngine.const_get(package_name).const_get(:PredictionApiKeyRegistry)
115
+ service_module = service_module.const_get(:Rest) if transport == :rest
116
+ service_module.const_get(:Client).new(&block)
109
117
  end
110
118
 
111
119
  ##
@@ -113,11 +121,13 @@ module Google
113
121
  #
114
122
  # By default, this returns an instance of
115
123
  # [Google::Cloud::RecommendationEngine::V1beta1::PredictionService::Client](https://googleapis.dev/ruby/google-cloud-recommendation_engine-v1beta1/latest/Google/Cloud/RecommendationEngine/V1beta1/PredictionService/Client.html)
116
- # for version V1beta1 of the API.
117
- # However, you can specify specify a different API version by passing it in the
124
+ # for a gRPC client for version V1beta1 of the API.
125
+ # However, you can specify a different API version by passing it in the
118
126
  # `version` parameter. If the PredictionService service is
119
127
  # supported by that API version, and the corresponding gem is available, the
120
128
  # appropriate versioned client will be returned.
129
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
130
+ # the `transport` parameter.
121
131
  #
122
132
  # ## About PredictionService
123
133
  #
@@ -125,17 +135,19 @@ module Google
125
135
  #
126
136
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
127
137
  # Defaults to `:v1beta1`.
128
- # @return [PredictionService::Client] A client object for the specified version.
138
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
139
+ # @return [::Object] A client object for the specified version.
129
140
  #
130
- def self.prediction_service version: :v1beta1, &block
141
+ def self.prediction_service version: :v1beta1, transport: :grpc, &block
131
142
  require "google/cloud/recommendation_engine/#{version.to_s.downcase}"
132
143
 
133
144
  package_name = Google::Cloud::RecommendationEngine
134
145
  .constants
135
146
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
136
147
  .first
137
- package_module = Google::Cloud::RecommendationEngine.const_get package_name
138
- package_module.const_get(:PredictionService).const_get(:Client).new(&block)
148
+ service_module = Google::Cloud::RecommendationEngine.const_get(package_name).const_get(:PredictionService)
149
+ service_module = service_module.const_get(:Rest) if transport == :rest
150
+ service_module.const_get(:Client).new(&block)
139
151
  end
140
152
 
141
153
  ##
@@ -143,11 +155,13 @@ module Google
143
155
  #
144
156
  # By default, this returns an instance of
145
157
  # [Google::Cloud::RecommendationEngine::V1beta1::UserEventService::Client](https://googleapis.dev/ruby/google-cloud-recommendation_engine-v1beta1/latest/Google/Cloud/RecommendationEngine/V1beta1/UserEventService/Client.html)
146
- # for version V1beta1 of the API.
147
- # However, you can specify specify a different API version by passing it in the
158
+ # for a gRPC client for version V1beta1 of the API.
159
+ # However, you can specify a different API version by passing it in the
148
160
  # `version` parameter. If the UserEventService service is
149
161
  # supported by that API version, and the corresponding gem is available, the
150
162
  # appropriate versioned client will be returned.
163
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
164
+ # the `transport` parameter.
151
165
  #
152
166
  # ## About UserEventService
153
167
  #
@@ -155,17 +169,19 @@ module Google
155
169
  #
156
170
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
157
171
  # Defaults to `:v1beta1`.
158
- # @return [UserEventService::Client] A client object for the specified version.
172
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
173
+ # @return [::Object] A client object for the specified version.
159
174
  #
160
- def self.user_event_service version: :v1beta1, &block
175
+ def self.user_event_service version: :v1beta1, transport: :grpc, &block
161
176
  require "google/cloud/recommendation_engine/#{version.to_s.downcase}"
162
177
 
163
178
  package_name = Google::Cloud::RecommendationEngine
164
179
  .constants
165
180
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
166
181
  .first
167
- package_module = Google::Cloud::RecommendationEngine.const_get package_name
168
- package_module.const_get(:UserEventService).const_get(:Client).new(&block)
182
+ service_module = Google::Cloud::RecommendationEngine.const_get(package_name).const_get(:UserEventService)
183
+ service_module = service_module.const_get(:Rest) if transport == :rest
184
+ service_module.const_get(:Client).new(&block)
169
185
  end
170
186
 
171
187
  ##
@@ -185,7 +201,7 @@ module Google
185
201
  # * `timeout` (*type:* `Numeric`) -
186
202
  # Default timeout in seconds.
187
203
  # * `metadata` (*type:* `Hash{Symbol=>String}`) -
188
- # Additional gRPC headers to be sent with the call.
204
+ # Additional headers to be sent with the call.
189
205
  # * `retry_policy` (*type:* `Hash`) -
190
206
  # The retry policy. The value is a hash with the following keys:
191
207
  # * `: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-recommendation_engine
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.3
4
+ version: 0.4.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-01-11 00:00:00.000000000 Z
11
+ date: 2023-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-core
@@ -30,7 +30,7 @@ dependencies:
30
30
  requirements:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: '0.0'
33
+ version: '0.5'
34
34
  - - "<"
35
35
  - !ruby/object:Gem::Version
36
36
  version: 2.a
@@ -40,7 +40,7 @@ dependencies:
40
40
  requirements:
41
41
  - - ">="
42
42
  - !ruby/object:Gem::Version
43
- version: '0.0'
43
+ version: '0.5'
44
44
  - - "<"
45
45
  - !ruby/object:Gem::Version
46
46
  version: 2.a
@@ -50,28 +50,28 @@ dependencies:
50
50
  requirements:
51
51
  - - "~>"
52
52
  - !ruby/object:Gem::Version
53
- version: 1.25.1
53
+ version: 1.26.1
54
54
  type: :development
55
55
  prerelease: false
56
56
  version_requirements: !ruby/object:Gem::Requirement
57
57
  requirements:
58
58
  - - "~>"
59
59
  - !ruby/object:Gem::Version
60
- version: 1.25.1
60
+ version: 1.26.1
61
61
  - !ruby/object:Gem::Dependency
62
62
  name: minitest
63
63
  requirement: !ruby/object:Gem::Requirement
64
64
  requirements:
65
65
  - - "~>"
66
66
  - !ruby/object:Gem::Version
67
- version: '5.14'
67
+ version: '5.16'
68
68
  type: :development
69
69
  prerelease: false
70
70
  version_requirements: !ruby/object:Gem::Requirement
71
71
  requirements:
72
72
  - - "~>"
73
73
  - !ruby/object:Gem::Version
74
- version: '5.14'
74
+ version: '5.16'
75
75
  - !ruby/object:Gem::Dependency
76
76
  name: minitest-focus
77
77
  requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
106
106
  requirements:
107
107
  - - ">="
108
108
  - !ruby/object:Gem::Version
109
- version: '12.0'
109
+ version: '13.0'
110
110
  type: :development
111
111
  prerelease: false
112
112
  version_requirements: !ruby/object:Gem::Requirement
113
113
  requirements:
114
114
  - - ">="
115
115
  - !ruby/object:Gem::Version
116
- version: '12.0'
116
+ version: '13.0'
117
117
  - !ruby/object:Gem::Dependency
118
118
  name: redcarpet
119
119
  requirement: !ruby/object:Gem::Requirement
@@ -183,14 +183,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
183
183
  requirements:
184
184
  - - ">="
185
185
  - !ruby/object:Gem::Version
186
- version: '2.5'
186
+ version: '2.6'
187
187
  required_rubygems_version: !ruby/object:Gem::Requirement
188
188
  requirements:
189
189
  - - ">="
190
190
  - !ruby/object:Gem::Version
191
191
  version: '0'
192
192
  requirements: []
193
- rubygems_version: 3.3.4
193
+ rubygems_version: 3.4.2
194
194
  signing_key:
195
195
  specification_version: 4
196
196
  summary: API Client library for the Recommendations AI API