google-shopping-merchant-data_sources 0.a → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f5ec6e38404e0dc920799a90ccd061f7ac1d15fdda4b34a9d1b5d16ffe54b140
4
- data.tar.gz: a24a826f0dd37eda5f8d1de3a50f45aab604e8f0cb826dd65ad2105a17574bc2
3
+ metadata.gz: 5946614ec6e2c7d14aaae2e28dc6e20a2fb85dc9f1f3149be6d4ac068f74927a
4
+ data.tar.gz: 37da46d9ebff96e4493067d4cb154efe7d732f3d51b1949f570406bce04189b1
5
5
  SHA512:
6
- metadata.gz: e1455b22217fd46e2a99573b78a9f852241ae95160d49e9d41c0ecfe6d47a24b5b62e9295764cd3ea2319e4e6d29428923f6394cf421cb91bb8e2f4903cd3fd4
7
- data.tar.gz: a2a4ab7f2a3f4d50f0b6d233cef263f36953b72b04aae208ea87e741dab32e17100465826da8e511a758e740117feeffb78728419a89ada6911fd267212649b7
6
+ metadata.gz: 5ee07a59792e23b89ff56f9c5d1022fdb87b62fe57d1acfbe0f437cb72b5edd0ff7908f87bd101d629d4c5d7215e6be4105beef8606d6f848d1fced3e7d040b9
7
+ data.tar.gz: 1b5ebb87af6aab700be2d3206b0d433772815e14726bf285fe92748f7c993352e541cb45904ea79d767844e6b7907a23fd4984d1739cd9ed3fb752a332f55125
data/.yardopts ADDED
@@ -0,0 +1,11 @@
1
+ --no-private
2
+ --title="Merchant API"
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ -
9
+ README.md
10
+ AUTHENTICATION.md
11
+ LICENSE.md
data/AUTHENTICATION.md ADDED
@@ -0,0 +1,122 @@
1
+ # Authentication
2
+
3
+ The recommended way to authenticate to the google-shopping-merchant-data_sources 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).
6
+
7
+ ## Quickstart
8
+
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
11
+
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
14
+
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:
17
+
18
+ ```sh
19
+ gcloud auth application-default login
20
+ ```
21
+
22
+ 3. Write code as if already authenticated.
23
+
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).
26
+
27
+ ## Credential Lookup
28
+
29
+ The google-shopping-merchant-data_sources 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.
33
+
34
+ Credentials are accepted in the following ways, in the following order or precedence:
35
+
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)
41
+
42
+ ### Configuration
43
+
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).
49
+
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.
53
+
54
+ To configure a credentials file for an individual client initialization:
55
+
56
+ ```ruby
57
+ require "google/shopping/merchant/data_sources"
58
+
59
+ client = Google::Shopping::Merchant::DataSources.data_sources_service do |config|
60
+ config.credentials = "path/to/credentialfile.json"
61
+ end
62
+ ```
63
+
64
+ To configure a credentials file globally for all clients:
65
+
66
+ ```ruby
67
+ require "google/shopping/merchant/data_sources"
68
+
69
+ Google::Shopping::Merchant::DataSources.configure do |config|
70
+ config.credentials = "path/to/credentialfile.json"
71
+ end
72
+
73
+ client = Google::Shopping::Merchant::DataSources.data_sources_service
74
+ ```
75
+
76
+ ### Environment Variables
77
+
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.
82
+
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).
87
+
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-shopping-merchant-data_sources
93
+ checks for credentials are:
94
+
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
97
+
98
+ ```ruby
99
+ require "google/shopping/merchant/data_sources"
100
+
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
102
+
103
+ client = Google::Shopping::Merchant::DataSources.data_sources_service
104
+ ```
105
+
106
+ ### Local ADC file
107
+
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.
111
+
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
113
+
114
+ ### Google Cloud Platform environments
115
+
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.
120
+
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
@@ -1,8 +1,104 @@
1
- # Placeholder for Ruby gem google-shopping-merchant-data_sources
2
-
3
- This is a placeholder for the future Google-authored gem google-shopping-merchant-data_sources.
4
- This placeholder is being released on 2024-06-04 in order to reserve the name.
5
- The final gem should be available shortly after that date. If it has not been
6
- released in a timely manner, or if this placeholder interferes with your work,
7
- you can contact the Google Ruby team by opening an issue in the GitHub
8
- repository https://github.com/googleapis/google-cloud-ruby.
1
+ # Ruby Client for the Merchant API
2
+
3
+ Programmatically manage your Merchant Center accounts.
4
+
5
+ Programmatically manage your Merchant Center accounts.
6
+
7
+ Actual client classes for the various versions of this API are defined in
8
+ _versioned_ client gems, with names of the form `google-shopping-merchant-data_sources-v*`.
9
+ The gem `google-shopping-merchant-data_sources` is the main client library that brings the
10
+ verisoned gems in as dependencies, and provides high-level methods for
11
+ constructing clients. More information on versioned clients can be found below
12
+ in the section titled *Which client should I use?*.
13
+
14
+ View the [Client Library Documentation](https://rubydoc.info/gems/google-shopping-merchant-data_sources)
15
+ for this library, google-shopping-merchant-data_sources, to see the convenience methods for
16
+ constructing client objects. Reference documentation for the client objects
17
+ themselves can be found in the client library documentation for the versioned
18
+ client gems:
19
+ [google-shopping-merchant-data_sources-v1beta](https://rubydoc.info/gems/google-shopping-merchant-data_sources-v1beta).
20
+
21
+ See also the [Product Documentation](https://developers.google.com/merchant/api)
22
+ for more usage information.
23
+
24
+ ## Quick Start
25
+
26
+ ```
27
+ $ gem install google-shopping-merchant-data_sources
28
+ ```
29
+
30
+ In order to use this library, you first need to go through the following steps:
31
+
32
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
33
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
34
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/merchantapi.googleapis.com)
35
+ 1. {file:AUTHENTICATION.md Set up authentication.}
36
+
37
+ ## Supported Ruby Versions
38
+
39
+ This library is supported on Ruby 2.7+.
40
+
41
+ Google provides official support for Ruby versions that are actively supported
42
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
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.
47
+
48
+ ## Which client should I use?
49
+
50
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
51
+ client library with a name such as `google-shopping-merchant-data_sources`,
52
+ and lower-level _versioned_ client libraries with names such as
53
+ `google-shopping-merchant-data_sources-v1beta`.
54
+ _In most cases, you should install the main client._
55
+
56
+ ### What's the difference between the main client and a versioned client?
57
+
58
+ A _versioned client_ provides a basic set of data types and client classes for
59
+ a _single version_ of a specific service. (That is, for a service with multiple
60
+ versions, there might be a separate versioned client for each service version.)
61
+ Most versioned clients are written and maintained by a code generator.
62
+
63
+ The _main client_ is designed to provide you with the _recommended_ client
64
+ interfaces for the service. There will be only one main client for any given
65
+ service, even a service with multiple versions. The main client includes
66
+ factory methods for constructing the client objects we recommend for most
67
+ users. In some cases, those will be classes provided by an underlying versioned
68
+ client; in other cases, they will be handwritten higher-level client objects
69
+ with additional capabilities, convenience methods, or best practices built in.
70
+ Generally, the main client will default to a recommended service version,
71
+ although in some cases you can override this if you need to talk to a specific
72
+ service version.
73
+
74
+ ### Why would I want to use the main client?
75
+
76
+ We recommend that most users install the main client gem for a service. You can
77
+ identify this gem as the one _without_ a version in its name, e.g.
78
+ `google-shopping-merchant-data_sources`.
79
+ The main client is recommended because it will embody the best practices for
80
+ accessing the service, and may also provide more convenient interfaces or
81
+ tighter integration into frameworks and third-party libraries. In addition, the
82
+ documentation and samples published by Google will generally demonstrate use of
83
+ the main client.
84
+
85
+ ### Why would I want to use a versioned client?
86
+
87
+ You can use a versioned client if you are content with a possibly lower-level
88
+ class interface, you explicitly want to avoid features provided by the main
89
+ client, or you want to access a specific service version not be covered by the
90
+ main client. You can identify versioned client gems because the service version
91
+ is part of the name, e.g. `google-shopping-merchant-data_sources-v1beta`.
92
+
93
+ ### What about the google-apis-<name> clients?
94
+
95
+ Client library gems with names that begin with `google-apis-` are based on an
96
+ older code generation technology. They talk to a REST/JSON backend (whereas
97
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
98
+ not offer the same performance, features, and ease of use provided by more
99
+ modern clients.
100
+
101
+ The `google-apis-` clients have wide coverage across Google services, so you
102
+ might need to use one if there is no modern client available for the service.
103
+ However, if a modern client is available, we generally recommend it over the
104
+ older `google-apis-` clients.
@@ -1,10 +1,12 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Copyright 2024 Google LLC
2
4
  #
3
5
  # Licensed under the Apache License, Version 2.0 (the "License");
4
6
  # you may not use this file except in compliance with the License.
5
7
  # You may obtain a copy of the License at
6
8
  #
7
- # http://www.apache.org/licenses/LICENSE-2.0
9
+ # https://www.apache.org/licenses/LICENSE-2.0
8
10
  #
9
11
  # Unless required by applicable law or agreed to in writing, software
10
12
  # distributed under the License is distributed on an "AS IS" BASIS,
@@ -12,11 +14,14 @@
12
14
  # See the License for the specific language governing permissions and
13
15
  # limitations under the License.
14
16
 
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
15
20
  module Google
16
21
  module Shopping
17
22
  module Merchant
18
23
  module DataSources
19
- VERSION = "0.a"
24
+ VERSION = "0.1.0"
20
25
  end
21
26
  end
22
27
  end
@@ -0,0 +1,72 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # Require this file early so that the version constant gets defined before
20
+ # requiring "google/cloud". This is because google-cloud-core will load the
21
+ # entrypoint (gem name) file, which in turn re-requires this file (hence
22
+ # causing a require cycle) unless the version constant is already defined.
23
+ require "google/shopping/merchant/data_sources/version"
24
+
25
+ require "googleauth"
26
+
27
+ module Google
28
+ module Shopping
29
+ module Merchant
30
+ module DataSources
31
+ ##
32
+ # Create a new client object for DataSourcesService.
33
+ #
34
+ # By default, this returns an instance of
35
+ # [Google::Shopping::Merchant::DataSources::V1beta::DataSourcesService::Client](https://rubydoc.info/gems/google-shopping-merchant-data_sources-v1beta/Google/Shopping/Merchant/DataSources/V1beta/DataSourcesService/Client)
36
+ # for a gRPC client for version V1beta of the API.
37
+ # However, you can specify a different API version by passing it in the
38
+ # `version` parameter. If the DataSourcesService service is
39
+ # supported by that API version, and the corresponding gem is available, the
40
+ # appropriate versioned client will be returned.
41
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
42
+ # the `transport` parameter.
43
+ #
44
+ # ## About DataSourcesService
45
+ #
46
+ # Service to manage primary, supplemental, inventory and other data sources.
47
+ # See more in the [Merchant
48
+ # Center](https://support.google.com/merchants/answer/7439058) help article.
49
+ #
50
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
51
+ # Defaults to `:v1beta`.
52
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
53
+ # @return [::Object] A client object for the specified version.
54
+ #
55
+ def self.data_sources_service version: :v1beta, transport: :grpc, &block
56
+ require "google/shopping/merchant/data_sources/#{version.to_s.downcase}"
57
+
58
+ package_name = Google::Shopping::Merchant::DataSources
59
+ .constants
60
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
61
+ .first
62
+ service_module = Google::Shopping::Merchant::DataSources.const_get(package_name).const_get(:DataSourcesService)
63
+ service_module = service_module.const_get(:Rest) if transport == :rest
64
+ service_module.const_get(:Client).new(&block)
65
+ end
66
+ end
67
+ end
68
+ end
69
+ end
70
+
71
+ helper_path = ::File.join __dir__, "data_sources", "helpers.rb"
72
+ require "google/shopping/merchant/data_sources/helpers" if ::File.file? helper_path
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/shopping/merchant/data_sources" unless defined? Google::Shopping::Merchant::DataSources::VERSION
metadata CHANGED
@@ -1,27 +1,61 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-shopping-merchant-data_sources
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.a
4
+ version: 0.1.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-06-04 00:00:00.000000000 Z
12
- dependencies: []
13
- description: Placeholder for the future Google-authored gem google-shopping-merchant-data_sources.
14
- This placeholder is being released on 2024-06-04 in order to reserve the name. The
15
- final gem should be available shortly after that date. If it has not been released
16
- in a timely manner, or if this placeholder interferes with your work, you can contact
17
- the Google Ruby team by opening an issue in the GitHub repository https://github.com/googleapis/google-cloud-ruby.
11
+ date: 2024-06-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-cloud-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.6'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: google-shopping-merchant-data_sources-v1beta
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0.0'
34
+ - - "<"
35
+ - !ruby/object:Gem::Version
36
+ version: 2.a
37
+ type: :runtime
38
+ prerelease: false
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: '0.0'
44
+ - - "<"
45
+ - !ruby/object:Gem::Version
46
+ version: 2.a
47
+ description: Programmatically manage your Merchant Center accounts.
18
48
  email: googleapis-packages@google.com
19
49
  executables: []
20
50
  extensions: []
21
51
  extra_rdoc_files: []
22
52
  files:
53
+ - ".yardopts"
54
+ - AUTHENTICATION.md
23
55
  - LICENSE.md
24
56
  - README.md
57
+ - lib/google-shopping-merchant-data_sources.rb
58
+ - lib/google/shopping/merchant/data_sources.rb
25
59
  - lib/google/shopping/merchant/data_sources/version.rb
26
60
  homepage: https://github.com/googleapis/google-cloud-ruby
27
61
  licenses:
@@ -35,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
35
69
  requirements:
36
70
  - - ">="
37
71
  - !ruby/object:Gem::Version
38
- version: '3.0'
72
+ version: '2.7'
39
73
  required_rubygems_version: !ruby/object:Gem::Requirement
40
74
  requirements:
41
75
  - - ">="
@@ -45,5 +79,5 @@ requirements: []
45
79
  rubygems_version: 3.5.6
46
80
  signing_key:
47
81
  specification_version: 4
48
- summary: Placeholder for the future Google-authored gem google-shopping-merchant-data_sources
82
+ summary: Programmatically manage your Merchant Center accounts.
49
83
  test_files: []