gapic-generator-cloud 0.5.0

data/templates/cloud/wrapper_gem/readme.erb

@@ -0,0 +1,95 @@
+# Ruby Client for the <%= gem.title %> API
+
+<%= gem.summary %>
+
+<%= gem.description %>
+
+Actual client classes for the various versions of this API are defined in
+_versioned_ client gems, with names of the form `<%= gem.name %>-v*`.
+The gem `<%= gem.name %>` is a convenience wrapper library that brings the
+verisoned gems in as dependencies, and provides high-level methods for
+constructing clients.
+
+View the [Client Library Documentation](<%= gem.library_documentation_url %>)
+for this library, <%= gem.name %>, to see the convenience methods for
+constructing client objects. Reference documentation for the client objects
+themselves can be found in the client library documentation for the versioned
+client gems:
+<%- last_index = gem.versioned_gems.size - 1 -%>
+<%- gem.versioned_gems.each_with_index do |name, i| -%>
+<%- sep = i == last_index ? "." : "," -%>
+[<%= name %>](https://googleapis.dev/ruby/<%= name %>/latest)<%= sep %>
+<%- end -%>
+
+<%- if gem.product_documentation_url -%>
+See also the [Product Documentation](<%= gem.product_documentation_url %>)
+for more usage information.
+
+<%- end -%>
+## Quick Start
+
+```
+$ gem install <%= gem.name %>
+```
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+<%- if gem.free_tier? -%>
+1. This API has a free tier. You may not need to
+   [enable billing](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+   to get started.
+<%- else -%>
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+<%- end -%>
+<%- if gem.api_id -%>
+1. [Enable the API.](https://console.cloud.google.com/apis/library/<%= gem.api_id %>.googleapis.com)
+<%- end -%>
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+<%- if gem.migration? %>
+## Migrating from <%= gem.pre_migration_version %> versions
+
+The <%= gem.migration_version %> release of the <%= gem.name %> client is a significant upgrade
+based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
+and includes substantial interface changes. Existing code written for earlier
+versions of this library will likely require updates to use this version.
+See the {file:MIGRATING.md MIGRATING.md} document for more information.
+
+<%- end -%>
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+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)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
+## Supported Ruby Versions
+
+This library is supported on Ruby 2.4+.
+
+Google provides official support for Ruby versions that are actively supported
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or
+in security maintenance, and not end of life. Currently, this means Ruby 2.4
+and later. Older versions of Ruby _may_ still work, but are unsupported and not
+recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
+about the Ruby support schedule.

data/templates/cloud/wrapper_gem/rubocop.erb

@@ -0,0 +1,23 @@
+<%- assert_locals gem -%>
+inherit_gem:
+  google-style: google-style.yml
+
+AllCops:
+  Exclude:
+    - "<%= gem.name %>.gemspec"
+    - "Rakefile"
+    - "acceptance/**/*"
+    - "test/**/*"
+
+Bundler/OrderedGems:
+  Enabled: false
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "samples/acceptance/*.rb"
+
+Naming/FileName:
+  Exclude:
+    - "lib/<%= gem.name %>.rb"

data/templates/cloud/wrapper_gem/version_test.erb

@@ -0,0 +1,11 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+require "helper"
+require "<%= gem.version_require %>"
+
+class <%= gem.namespace %>::VersionMinitest < Minitest::Test
+  def test_has_a_version
+    refute_nil  <%= gem.version_name_full %>
+  end
+end

data/templates/cloud/wrapper_gem/yardopts.erb

@@ -0,0 +1,15 @@
+<%- assert_locals gem -%>
+--no-private
+--title=<%= gem.title %> API
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+
+./lib/**/*.rb
+-
+README.md
+AUTHENTICATION.md
+<%- if gem.migration? -%>
+MIGRATING.md
+<%- end -%>
+LICENSE.md

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: gapic-generator-cloud
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Ernest Landrito
+- Chris Smith
+- Mike Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: gapic-generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: google-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+- !ruby/object:Gem::Dependency
+  name: protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: 
+email:
+- landrito@google.com
+- quartzmo@gmail.com
+- mike@blowmage.com
+executables:
+- protoc-gen-ruby_cloud
+- ruby-cloud-docker-entrypoint
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- bin/protoc-gen-ruby_cloud
+- bin/ruby-cloud-docker-entrypoint
+- cloud-rubocop.yml
+- lib/gapic/generator/cloud/version.rb
+- lib/gapic/generators/cloud_generator.rb
+- lib/gapic/presenters/wrapper_gem_presenter.rb
+- lib/gapic/presenters/wrapper_service_presenter.rb
+- templates/cloud/gem/authentication.erb
+- templates/cloud/gem/gemspec.erb
+- templates/cloud/gem/gitignore.erb
+- templates/cloud/gem/license.erb
+- templates/cloud/gem/rakefile.erb
+- templates/cloud/gem/readme.erb
+- templates/cloud/gem/repo-metadata.erb
+- templates/cloud/gem/rubocop.erb
+- templates/cloud/gem/yardopts.erb
+- templates/cloud/service/client/_credentials.erb
+- templates/cloud/service/client/_requires.erb
+- templates/cloud/service/client/_self_configure.erb
+- templates/cloud/service/client/method/def/_rescue.erb
+- templates/cloud/service/client/method/docs/_error.erb
+- templates/cloud/shared/_license.erb
+- templates/cloud/wrapper_gem/_main.erb
+- templates/cloud/wrapper_gem/client_test.erb
+- templates/cloud/wrapper_gem/entrypoint.erb
+- templates/cloud/wrapper_gem/gemfile.erb
+- templates/cloud/wrapper_gem/gemspec.erb
+- templates/cloud/wrapper_gem/main.erb
+- templates/cloud/wrapper_gem/rakefile.erb
+- templates/cloud/wrapper_gem/readme.erb
+- templates/cloud/wrapper_gem/rubocop.erb
+- templates/cloud/wrapper_gem/version_test.erb
+- templates/cloud/wrapper_gem/yardopts.erb
+homepage: https://github.com/googleapis/gapic-generator-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An API Client Generator for Ruby in Ruby!
+test_files: []