gapic-generator-cloud 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa40108edbcc0c4837ddd71c24a8524e11d55a37793c14608e03a9106e63d88b
-  data.tar.gz: a8e291c06bdc9bdf3f0e801a45c8b089d0cd170cd4e2762cc5b12ab2eb0240b1
+  metadata.gz: 68f8ebe0dac34e3d97e12368cdfc6cf1a39b1b62cc88efd0ed84c3a5331b4263
+  data.tar.gz: b81c314a23ddd49d65a9987ffadf6a296de351b97690c874be0cc825a8080b14
 SHA512:
-  metadata.gz: 7a50e21c3c649b6c8b46316f3b91c23f3bc3476be1a17f7fdc4b034003aee7687fe3a8ac7692308f26dd8c5634d20f70c85ddef4bf2d19e165a2083e80d1afea
-  data.tar.gz: d4a51eab2725e0e32a13757b33b49b9aac4b4efc433b1545341dbca5e4b9d947b0df9116d5e7de13cace00cbb78d75e1c4816c5eeaa9ab22383085ff8e717ac8
+  metadata.gz: ed45770c75247968a0600b210fe25eb14334560266c003fee38fabc486db1d2ca2f83290d6b3e0b9d7aba4d90266833e7b02238dd7b7e6947a13e21262ee576e
+  data.tar.gz: 6000c4fac479e42e5e672a5ac6caeb70b3827ed9c68aa214f1603cac54a37885725a1741a523368fe86596a50e82a37a7dbf068632774f8c07eb5fa6a32e9589

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History for gapic-generator-cloud
 
+### 0.3.0 / 2020-04-10
+
+* Includes changes from gapic-generator 0.3.0
+* Generated readmes include quickstart, project/auth/billing setup instructions, and logging instructions.
+
 ### 0.2.3 / 2020-04-06
 
 * Includes changes from gapic-generator 0.2.3

data/lib/gapic/generator/cloud/version.rb

@@ -17,7 +17,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.2.3"
+      VERSION = "0.3.0"
     end
   end
 end

data/lib/gapic/generators/cloud_generator.rb

@@ -55,7 +55,6 @@ module Gapic
         # Additional Gem level files
         cloud_files << g("gem/repo-metadata.erb",  ".repo-metadata.json", gem: gem)
         cloud_files << g("gem/authentication.erb", "AUTHENTICATION.md",   gem: gem) unless gem.services.empty?
-        cloud_files << g("gem/dashed.erb",         "lib/#{gem.name}.rb",  gem: gem)
 
         format_files cloud_files
 
@@ -87,7 +86,7 @@ module Gapic
         files << g("wrapper_gem/rakefile.erb",     "Rakefile",                                      gem: gem)
         files << g("wrapper_gem/readme.erb",       "README.md",                                     gem: gem)
         files << g("wrapper_gem/gemspec.erb",      "#{gem.name}.gemspec",                           gem: gem)
-        files << g("wrapper_gem/dashed.erb",       "lib/#{gem.name}.rb",                            gem: gem) if gem.needs_dashed_ruby_file?
+        files << g("wrapper_gem/entrypoint.erb",   "lib/#{gem.name}.rb",                            gem: gem) if gem.needs_entrypoint?
         files << g("wrapper_gem/main.erb",         "lib/#{gem.namespace_file_path}",                gem: gem)
         files << g("gem/version.erb",              "lib/#{gem.version_file_path}",                  gem: gem)
         files << g("wrapper_gem/test_helper.erb",  "test/helper.rb",                                gem: gem)

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -42,10 +42,14 @@ module Gapic
         "#{namespace_require}.rb"
       end
 
-      def needs_dashed_ruby_file?
+      def needs_entrypoint?
         name != namespace_file_path
       end
 
+      def needs_default_config_block?
+        needs_entrypoint? && !google_cloud_short_name.nil?
+      end
+
       def migration_version
         gem_config :migration_version
       end

data/templates/cloud/gem/gemspec.erb

@@ -26,7 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "gapic-common", "~> 0.2"
   gem.add_dependency "google-cloud-errors", "~> 1.0"
   <%- if gem.iam_dependency? -%>
-  gem.add_dependency "grpc-google-iam-v1", "~> 0.6.9"
+  gem.add_dependency "grpc-google-iam-v1", ">= 0.6.10", "< 2.0"
   <%- end -%>
 
   gem.add_development_dependency "google-style", "~> 1.24.0"

data/templates/cloud/gem/readme.erb

@@ -0,0 +1,93 @@
+# Ruby Client for the <%= gem.title %> API
+
+<%= gem.summary %>
+
+<%= gem.description %>
+
+<%= gem.homepage %>
+
+## Installation
+
+```
+$ gem install <%= gem.name %>
+```
+
+## Before You Begin
+
+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.}
+
+## Quick Start
+
+<%- if gem.packages? -%>
+```ruby
+require "<%= gem.entrypoint_require %>"
+<%- service = gem.packages.first.services.first -%>
+<%- method = service&.methods.first -%>
+<%- if service && method -%>
+
+client = <%= service.create_client_call %>
+request = my_create_request
+response = client.<%= method.name %> request
+<%- end -%>
+```
+
+<%- end -%>
+<%- unless gem.library_documentation_url.to_s.empty? -%>
+View the [Client Library Documentation](<%= gem.library_documentation_url %>)
+for class and method documentation.
+
+<%- end -%>
+<%- if gem.product_documentation_url -%>
+See also the [Product Documentation](<%= gem.product_documentation_url %>)
+for general usage 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/gem/rubocop.erb

@@ -12,58 +12,23 @@ AllCops:
     - "Rakefile"
 
 Metrics/AbcSize:
-  Exclude:
-    <%- gem.packages.each do |package| -%>
-    <%- package.services.each do |service| -%>
-    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
-    <%- end -%>
-    <%- end -%>
+  Enabled: false
 Metrics/ClassLength:
-  Exclude:
-    <%- gem.packages.each do |package| -%>
-    <%- package.services.each do |service| -%>
-    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
-    <%- end -%>
-    <%- end -%>
+  Enabled: false
 Metrics/CyclomaticComplexity:
-  Exclude:
-    <%- gem.packages.each do |package| -%>
-    <%- package.services.each do |service| -%>
-    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
-    <%- end -%>
-    <%- end -%>
+  Enabled: false
 Metrics/LineLength:
-  Exclude:
-    <%- gem.packages.each do |package| -%>
-    <%- package.services.each do |service| -%>
-    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
-    <%- end -%>
-    <%- end -%>
-    - "<%= gem.name %>.gemspec"
+  Enabled: false
 Metrics/MethodLength:
-  Exclude:
-    <%- gem.packages.each do |package| -%>
-    <%- package.services.each do |service| -%>
-    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
-    <%- end -%>
-    <%- end -%>
+  Enabled: false
 Metrics/PerceivedComplexity:
-  Exclude:
-    <%- gem.packages.each do |package| -%>
-    <%- package.services.each do |service| -%>
-    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
-    <%- end -%>
-    <%- end -%>
+  Enabled: false
 Naming/FileName:
   Exclude:
     - "lib/<%= gem.name %>.rb"
 Style/CaseEquality:
-  Exclude:
-    <%- gem.packages.each do |package| -%>
-    <%- package.services.each do |service| -%>
-    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
-    <%- end -%>
-    <%- end -%>
-    - "lib/<%= gem.name.tr "-", "/" %>.rb"
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
 Style/ModuleFunction:
   Enabled: false

data/templates/cloud/wrapper_gem/_main.erb

@@ -1,7 +1,22 @@
 <%- assert_locals gem -%>
 <% @requires = capture do %>
-<%- if gem.needs_dashed_ruby_file? -%>
-require "<%= gem.name %>"
+require "<%= gem.version_require %>"
+require "googleauth"
+<%- if gem.needs_default_config_block? -%>
+gem "google-cloud-core"
+require "google/cloud" unless defined? Google::Cloud.new
+require "google/cloud/config"
+
+# Set the default configuration
+Google::Cloud.configure.add_config! :<%= gem.google_cloud_short_name %> do |config|
+  config.add_field! :credentials,  nil, match: [String, Hash, Google::Auth::Credentials]
+  config.add_field! :lib_name,     nil, match: String
+  config.add_field! :lib_version,  nil, match: String
+  config.add_field! :interceptors, nil, match: Array
+  config.add_field! :timeout,      nil, match: Numeric
+  config.add_field! :metadata,     nil, match: Hash
+  config.add_field! :retry_policy, nil, match: [Hash, Proc]
+end
 <%- end -%>
 <% end %>
 <%- gem.services.each do |service| -%>

data/templates/cloud/wrapper_gem/entrypoint.erb

@@ -0,0 +1,4 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+require "<%= gem.namespace_require %>"

data/templates/cloud/wrapper_gem/readme.erb

@@ -62,7 +62,7 @@ See the {file:MIGRATING.md MIGRATING.md} document for more information.
 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 [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+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:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -175,11 +175,11 @@ files:
 - lib/gapic/presenters/wrapper_gem_presenter.rb
 - lib/gapic/presenters/wrapper_service_presenter.rb
 - templates/cloud/gem/authentication.erb
-- templates/cloud/gem/dashed.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
@@ -191,7 +191,7 @@ files:
 - templates/cloud/shared/_license.erb
 - templates/cloud/wrapper_gem/_main.erb
 - templates/cloud/wrapper_gem/client_test.erb
-- templates/cloud/wrapper_gem/dashed.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

data/templates/cloud/gem/dashed.erb

@@ -1,2 +0,0 @@
-<%- assert_locals gem -%>
-require "<%= gem.version_require %>"

data/templates/cloud/wrapper_gem/dashed.erb

@@ -1,22 +0,0 @@
-<%- assert_locals gem -%>
-<%= render partial: "shared/header" -%>
-
-<%- if gem.google_cloud_short_name -%>
-gem "google-cloud-core"
-require "google/cloud" unless defined? Google::Cloud.new
-require "google/cloud/config"
-require "googleauth"
-
-# Set the default configuration
-Google::Cloud.configure.add_config! :<%= gem.google_cloud_short_name %> do |config|
-  config.add_field! :credentials,  nil, match: [String, Hash, Google::Auth::Credentials]
-  config.add_field! :lib_name,     nil, match: String
-  config.add_field! :lib_version,  nil, match: String
-  config.add_field! :interceptors, nil, match: Array
-  config.add_field! :timeout,      nil, match: Numeric
-  config.add_field! :metadata,     nil, match: Hash
-  config.add_field! :retry_policy, nil, match: [Hash, Proc]
-end
-
-<%- end -%>
-require "<%= gem.version_require %>"