feat: Initial generation of google-shopping-merchant-reports (#23455)

.release-please-manifest.json

@@ -737,6 +737,8 @@
   "google-shopping-merchant-inventories+FILLER": "0.0.0",
   "google-shopping-merchant-inventories-v1beta": "0.0.1",
   "google-shopping-merchant-inventories-v1beta+FILLER": "0.0.0",
+  "google-shopping-merchant-reports": "0.0.1",
+  "google-shopping-merchant-reports+FILLER": "0.0.0",
   "google-shopping-merchant-reports-v1beta": "0.0.1",
   "google-shopping-merchant-reports-v1beta+FILLER": "0.0.0",
   "grafeas": "1.2.0",

google-shopping-merchant-reports/.OwlBot.yaml

@@ -0,0 +1,3 @@
+deep-copy-regex:
+  - source: /google/shopping/merchant/reports/[^/]+-ruby/(.*)
+    dest: /owl-bot-staging/google-shopping-merchant-reports/$1

google-shopping-merchant-reports/.gitignore

@@ -0,0 +1,22 @@
+# Ignore bundler lockfiles
+Gemfile.lock
+gems.locked
+
+# Ignore documentation output
+doc/*
+.yardoc/*
+
+# Ignore test output
+coverage/*
+
+# Ignore build artifacts
+pkg/*
+
+# Ignore files commonly present in certain dev environments
+.vagrant
+.DS_STORE
+.idea
+*.iml
+
+# Ignore synth output
+__pycache__

google-shopping-merchant-reports/.owlbot-manifest.json

@@ -0,0 +1,24 @@
+{
+  "generated": [
+    ".gitignore",
+    ".repo-metadata.json",
+    ".rubocop.yml",
+    ".yardopts",
+    "AUTHENTICATION.md",
+    "CHANGELOG.md",
+    "Gemfile",
+    "LICENSE.md",
+    "README.md",
+    "Rakefile",
+    "google-shopping-merchant-reports.gemspec",
+    "lib/google-shopping-merchant-reports.rb",
+    "lib/google/shopping/merchant/reports.rb",
+    "lib/google/shopping/merchant/reports/version.rb",
+    "test/google/shopping/merchant/reports/client_test.rb",
+    "test/google/shopping/merchant/reports/version_test.rb",
+    "test/helper.rb"
+  ],
+  "static": [
+    ".OwlBot.yaml"
+  ]
+}

google-shopping-merchant-reports/.repo-metadata.json

@@ -0,0 +1,17 @@
+{
+    "api_id": "merchantapi.googleapis.com",
+    "api_shortname": "merchantapi",
+    "client_documentation": "https://rubydoc.info/gems/google-shopping-merchant-reports",
+    "distribution_name": "google-shopping-merchant-reports",
+    "is_cloud": false,
+    "language": "ruby",
+    "name": "merchantapi",
+    "name_pretty": "Merchant API",
+    "product_documentation": "https://developers.google.com/merchant/api",
+    "release_level": "unreleased",
+    "repo": "googleapis/google-cloud-ruby",
+    "requires_billing": true,
+    "ruby-cloud-description": "Programmatically manage your Merchant Center accounts.",
+    "ruby-cloud-product-url": "https://developers.google.com/merchant/api",
+    "library_type": "GAPIC_MANUAL"
+}

google-shopping-merchant-reports/.rubocop.yml

@@ -0,0 +1,39 @@
+inherit_gem:
+  google-style: google-style.yml
+
+AllCops:
+  Exclude:
+    - "google-shopping-merchant-reports.gemspec"
+    - "Rakefile"
+    - "acceptance/**/*"
+    - "test/**/*"
+
+Bundler/OrderedGems:
+  Enabled: false
+Documentation:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - "samples/**/acceptance/*.rb"
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - "lib/google-shopping-merchant-reports.rb"
+
+Style/BlockDelimiters:
+  Exclude:
+    - "samples/**/acceptance/*.rb"

google-shopping-merchant-reports/.yardopts

@@ -0,0 +1,11 @@
+--no-private
+--title="Merchant API"
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+
+./lib/**/*.rb
+-
+README.md
+AUTHENTICATION.md
+LICENSE.md

google-shopping-merchant-reports/AUTHENTICATION.md

@@ -0,0 +1,149 @@
+# Authentication
+
+In general, the google-shopping-merchant-reports library uses
+[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+credentials to connect to Google Cloud services. When running within
+[Google Cloud Platform environments](#google-cloud-platform-environments) the
+credentials will be discovered automatically. When running on other
+environments, the Service Account credentials can be specified by providing the
+path to the
+[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
+for the account (or the JSON itself) in
+[environment variables](#environment-variables). Additionally, Cloud SDK
+credentials can also be discovered automatically, but this is only recommended
+during development.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/shopping/merchant/reports"
+
+client = Google::Shopping::Merchant::Reports.report_service
+```
+
+## Credential Lookup
+
+The google-shopping-merchant-reports library aims to make authentication
+as simple as possible, and provides several mechanisms to configure your system
+without requiring **Service Account Credentials** directly in code.
+
+**Credentials** are discovered in the following order:
+
+1. Specify credentials in method arguments
+2. Specify credentials in configuration
+3. Discover credentials path in environment variables
+4. Discover credentials JSON in environment variables
+5. Discover credentials file in the Cloud SDK's path
+6. Discover GCP credentials
+
+### Google Cloud Platform environments
+
+When running on Google Cloud Platform (GCP), including Google Compute Engine
+(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
+Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
+Code should be written as if already authenticated.
+
+### Environment Variables
+
+The **Credentials JSON** can be placed in environment variables instead of
+declaring them directly in code. Each service has its own environment variable,
+allowing for different service accounts to be used for different services. (See
+the READMEs for the individual service gems for details.) The path to the
+**Credentials JSON** file can be stored in the environment variable, or the
+**Credentials JSON** itself can be stored for environments such as Docker
+containers where writing files is difficult or not encouraged.
+
+The environment variables that google-shopping-merchant-reports
+checks for credentials are configured on the service Credentials class (such as
+`::Google::Shopping::Merchant::Reports::V1beta::ReportService::Credentials`):
+
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/shopping/merchant/reports"
+
+ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
+
+client = Google::Shopping::Merchant::Reports.report_service
+```
+
+### Configuration
+
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
+
+```ruby
+require "google/shopping/merchant/reports"
+
+client = Google::Shopping::Merchant::Reports.report_service do |config|
+  config.credentials = "path/to/keyfile.json"
+end
+```
+
+Or globally for all clients:
+
+```ruby
+require "google/shopping/merchant/reports"
+
+Google::Shopping::Merchant::Reports.configure do |config|
+  config.credentials = "path/to/keyfile.json"
+end
+
+client = Google::Shopping::Merchant::Reports.report_service
+```
+
+### Cloud SDK
+
+This option allows for an easy way to authenticate during development. If
+credentials are not provided in code or in environment variables, then Cloud SDK
+credentials are discovered.
+
+To configure your system for this, simply:
+
+1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
+3. Write code as if already authenticated.
+
+**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
+*should* only be used during development.
+
+## Creating a Service Account
+
+Google Cloud requires **Service Account Credentials** to
+connect to the APIs. You will use the **JSON key file** to
+connect to most services with google-shopping-merchant-reports.
+
+If you are not running this client within
+[Google Cloud Platform environments](#google-cloud-platform-environments), you
+need a Google Developers service account.
+
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
+2. Create a new project or click on an existing project.
+3. Activate the menu in the upper left and select **APIs & Services**. From
+   here, you will enable the APIs that your application requires.
+
+   *Note: You may need to enable billing in order to use these services.*
+
+4. Select **Credentials** from the side navigation.
+
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
+
+   If you want to re-use an existing service account, you can easily generate a
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.

google-shopping-merchant-reports/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Release History
+

google-shopping-merchant-reports/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "google-shopping-merchant-reports-v1beta", path: "../google-shopping-merchant-reports-v1beta"