gapic-generator 0.2.2 → 0.4.0

data/templates/default/gem/entrypoint.erb

@@ -0,0 +1,8 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+<%- gem.packages.each do |package| -%>
+# require "<%= package.package_require %>"
+<%- end -%>

data/templates/default/gem/gemspec.erb

@@ -25,7 +25,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "gapic-common", "~> 0.2"
   <%- 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/default/gem/readme.erb

@@ -1,4 +1,4 @@
-# <%= gem.title %>
+# Ruby Client for the <%= gem.title %> API
 
 <%= gem.summary %>
 
@@ -12,6 +12,20 @@
 $ gem install <%= gem.name %>
 ```
 
+## Quick Start
+
+```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 -%>
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.4+.

data/templates/default/gem/rubocop.erb

@@ -9,53 +9,25 @@ AllCops:
     - "test/**/*"
 
 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 -%>
+  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/ModuleLength:
+  Enabled: false
 Metrics/PerceivedComplexity:
+  Enabled: false
+Naming/FileName:
   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 %>.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 -%>
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
 Style/ModuleFunction:
   Enabled: false

data/templates/default/lib/_package.erb

@@ -0,0 +1,17 @@
+<%- assert_locals package -%>
+<% @requires = capture do %>
+<%- package.services.each do |service| -%>
+require "<%= service.service_require %>"
+<%- end -%>
+require "<%= package.gem.version_require %>"
+<% end %>
+<%- unless package.empty? -%>
+##
+# To load this package, including all its services, and instantiate a client:
+#
+#     require "<%= package.package_require %>"
+#     client = <%= package.services.first.create_client_call %>
+#
+<%- end -%>
+module <%= package.module_name %>
+end

data/templates/default/lib/_service.erb

@@ -0,0 +1,32 @@
+<%- assert_locals service -%>
+<% @requires = capture do %>
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "<%= service.gem.version_require %>"
+
+require "<%= service.credentials_require %>"
+<%- if service.paths? -%>
+require "<%= service.paths_require %>"
+<%- end -%>
+<%- if service.lro? -%>
+require "<%= service.operations_require %>"
+<%- end -%>
+require "<%= service.client_require %>"
+<% end %>
+##
+<%- if service.doc_description -%>
+<%= indent service.doc_description, "# " %>
+#
+<%- end -%>
+# To load this service and instantiate a client:
+#
+#     require "<%= service.service_require %>"
+#     client = <%= service.create_client_call %>
+#
+module <%= service.module_name %>
+end
+<% @footer = capture do %>
+<%= render partial: "service/helpers", locals: { service: service} -%>
+<% end %>

data/templates/default/package.erb

@@ -1,6 +1,6 @@
 <%- assert_locals package -%>
-<%= render partial: "shared/header" -%>
-
-<% package.services.each do |service| %>
-require "<%= service.service_require %>"
-<% end %>
+<%= render partial: "lib/package",
+           layout: "layouts/ruby",
+           locals: { package: package,
+                     namespace: package.parent_namespace }
+%>

data/templates/default/service.erb

@@ -1,8 +1,6 @@
 <%- assert_locals service -%>
-<%= render partial: "shared/header" -%>
-
-require "<%= service.client_require %>"
-<%- if service.lro? -%>
-require "<%= service.operations_require %>"
-<%- end -%>
-require "<%= service.credentials_require %>"
+<%= render partial: "lib/service",
+           layout: "layouts/ruby",
+           locals: { service: service,
+                     namespace: service.namespace }
+%>

data/templates/default/service/_helpers.erb

@@ -0,0 +1,3 @@
+<%- assert_locals service -%>
+helper_path = ::File.join __dir__, "<%= service.service_directory_name%>", "helpers.rb"
+require "<%= service.helpers_require %>" if ::File.file? helper_path

data/templates/default/service/client.erb

@@ -2,5 +2,5 @@
 <%= render partial: "service/client/client",
            layout: "layouts/ruby",
            locals: { service: service,
-                     namespace: service.proto_service_name_full }
+                     namespace: service.service_name_full }
 %>

data/templates/default/service/client/_client.erb

@@ -1,19 +1,7 @@
 <%- assert_locals service -%>
 <% @requires = capture do %>
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 <%= render partial: "service/client/requires", locals: { service: service} -%>
-require "<%= service.gem.version_require %>"
 require "<%= service.proto_service_require %>"
-require "<%= service.credentials_require %>"
-<%- if service.paths? -%>
-require "<%= service.paths_require %>"
-<%- end -%>
-<%- if service.lro? -%>
-require "<%= service.operations_require %>"
-<%- end -%>
 <% end %>
 ##
 # Client for the <%= service.name %> service.
@@ -117,6 +105,7 @@ class <%= service.client_name %>
     <%- if service.lro? -%>
     <%= service.lro_client_ivar %> = <%= service.operations_name %>.new do |config|
       config.credentials = credentials
+      config.endpoint = @config.endpoint
     end
 
     <%- end -%>
@@ -129,6 +118,15 @@ class <%= service.client_name %>
     )
   end
 
+<%- if service.lro? -%>
+  ##
+  # Get the associated client for long-running operations.
+  #
+  # @return [<%= service.operations_name_full %>]
+  #
+  attr_reader :<%= service.lro_client_var %>
+
+<%- end -%>
   # Service calls
   <%- service.methods.each do |method| -%>
 
@@ -137,7 +135,3 @@ class <%= service.client_name %>
 
   <%= indent_tail render(partial: "service/client/config", locals: { service: service }), 2 %>
 end
-
-<% @footer = capture do %>
-<%= render partial: "service/client/helpers", locals: { service: service} %>
-<% end %>

data/templates/default/service/client/_operations.erb

@@ -1,10 +1,6 @@
 <%- assert_locals service -%>
 <% @requires = capture do %>
-require "gapic/common"
 require "gapic/operation"
-
-require "<%= service.gem.version_require %>"
-require "<%= service.client_require %>"
 require "<%= service.lro_service.proto_service_require %>"
 <% end %>
 # Service that implements Longrunning Operations API.

data/templates/default/service/client/_resource.erb

@@ -1,6 +1,6 @@
 <%- assert_locals resource -%>
 <%- if resource.patterns.count == 1 -%>
 <%= render partial: "service/client/resource/single", locals: { resource: resource } %>
-<%- else -%>
+<%- elsif !resource.patterns.empty? -%>
 <%= render partial: "service/client/resource/multi", locals: { resource: resource } %>
 <%- end -%>

data/templates/default/service/client/method/docs/_request_normal.erb

@@ -1,15 +1,21 @@
 <%- assert_locals method -%>
 # @overload <%= method.name %>(request, options = nil)
-#   @param request [<%= method.request_type %> | Hash]
-<%- if method.doc_description -%>
-<%= indent method.doc_description, "#     " %>
-<%- end -%>
+#   Pass arguments to `<%= method.name %>` via a request object, either of type
+#   {<%= method.request_type %>} or an equivalent Hash.
+#
+#   @param request [<%= method.request_type %>, Hash]
+#     A request object representing the call parameters. Required. To specify no
+#     parameters, or to keep all the default parameter values, pass an empty Hash.
 #   @param options [Gapic::CallOptions, Hash]
 #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
 <%-if method.arguments.any?-%>
 #
 <%- arg_list = method.arguments.map { |arg| "#{arg.name}: nil"}.join ", " -%>
 # @overload <%= method.name %>(<%= arg_list %>)
+#   Pass arguments to `<%= method.name %>` via keyword arguments. Note that at
+#   least one keyword argument is required. To specify no parameters, or to keep all
+#   the default parameter values, pass an empty Hash as a request object (see above).
+#
 <%- method.arguments.each do |arg| -%>
 #   @param <%= arg.name %> [<%= arg.doc_types %>]
 <%- if arg.doc_description -%>
@@ -17,4 +23,3 @@
 <%- end -%>
 <%- end -%>
 <%- end -%>
-#

data/templates/default/service/client/method/docs/_request_streaming.erb

@@ -1,5 +1,5 @@
 <%- assert_locals method -%>
-# @param request [Gapic::StreamInput, Enumerable<<%= method.request_type %> | Hash>]
+# @param request [Gapic::StreamInput, Enumerable<<%= method.request_type %>, Hash>]
 #   An enumerable of {<%= method.request_type %>} instances.
 # @param options [Gapic::CallOptions, Hash]
 #   Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

data/templates/default/service/credentials.erb

@@ -2,5 +2,5 @@
 <%= render partial: "service/client/credentials",
            layout: "layouts/ruby",
            locals: { service: service,
-                     namespace: service.proto_service_name_full }
+                     namespace: service.service_name_full }
 %>

data/templates/default/service/operations.erb

@@ -2,5 +2,5 @@
 <%= render partial: "service/client/operations",
            layout: "layouts/ruby",
            locals: { service: service,
-                     namespace: service.proto_service_name_full }
+                     namespace: service.service_name_full }
 %>

data/templates/default/service/paths.erb

@@ -2,5 +2,5 @@
 <%= render partial: "service/client/paths",
            layout: "layouts/ruby",
            locals: { service: service,
-                     namespace: service.proto_service_name_full }
+                     namespace: service.service_name_full }
 %>

data/templates/default/service/test/client.erb

@@ -17,8 +17,22 @@ class <%= service.client_name_full %>Test < Minitest::Test
 <% service.methods.each do |method| %>
 <%= indent render(partial: "service/test/method/#{method.kind}",
                   locals: { method: method }), 2 %>
-<% if method != service.methods.last %>
 
 <% end %>
-<% end %>
+<%= indent render(partial: "service/test/method/configure", locals: { service: service }), 2 %>
+<%- if service.lro? -%>
+
+  def test_<%= service.lro_client_var %>
+    grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
+
+    client = nil
+    Gapic::ServiceStub.stub :new, nil do
+      client = <%= service.client_name_full =%>.new do |config|
+        config.credentials = grpc_channel
+      end
+    end
+
+    assert_kind_of <%= service.operations_name_full %>, client.<%= service.lro_client_var %>
+  end
+<%- end -%>
 end

data/templates/default/service/test/client_operations.erb

@@ -17,8 +17,8 @@ class <%= service.operations_name_full %>Test < Minitest::Test
 <% service.lro_service.methods.each do |method| %>
 <%= indent render(partial: "service/test/method/#{method.kind}",
                   locals: { client_name_full: service.operations_name_full, method: method }), 2 %>
-<% if method != service.lro_service.methods.last %>
 
 <% end %>
-<% end %>
+<%= indent render(partial: "service/test/method/configure",
+                  locals: { service: service, client_name_full: service.operations_name_full }), 2 %>
 end

data/templates/default/service/test/method/_configure.erb

@@ -0,0 +1,19 @@
+<%- assert_locals service -%>
+<%- full_client_name = defined?(client_name_full) ? client_name_full : service.client_name_full -%>
+def test_configure
+  grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
+
+  client = block_config = config = nil
+  Gapic::ServiceStub.stub :new, nil do
+    client = <%= full_client_name =%>.new do |config|
+      config.credentials = grpc_channel
+    end
+  end
+
+  config = client.configure do |c|
+    block_config = c
+  end
+
+  assert_same block_config, config
+  assert_kind_of <%= full_client_name %>::Configuration, config
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -233,6 +233,7 @@ files:
 - lib/gapic/presenters/sample_presenter.rb
 - lib/gapic/presenters/service_presenter.rb
 - lib/gapic/resource_lookup.rb
+- lib/gapic/ruby_info.rb
 - lib/gapic/runner.rb
 - lib/gapic/schema.rb
 - lib/gapic/schema/api.rb
@@ -251,6 +252,7 @@ files:
 - lib/google/rpc/status.pb.rb
 - templates/default/gem/_version.erb
 - templates/default/gem/changelog.erb
+- templates/default/gem/entrypoint.erb
 - templates/default/gem/gemfile.erb
 - templates/default/gem/gemspec.erb
 - templates/default/gem/gitignore.erb
@@ -264,6 +266,8 @@ files:
 - templates/default/helpers/filepath_helper.rb
 - templates/default/helpers/namespace_helper.rb
 - templates/default/layouts/_ruby.erb
+- templates/default/lib/_package.erb
+- templates/default/lib/_service.erb
 - templates/default/package.erb
 - templates/default/proto_docs/_enum.erb
 - templates/default/proto_docs/_message.erb
@@ -271,11 +275,11 @@ files:
 - templates/default/proto_docs/proto_file.erb
 - templates/default/proto_docs/readme.erb
 - templates/default/service.erb
+- templates/default/service/_helpers.erb
 - templates/default/service/client.erb
 - templates/default/service/client/_client.erb
 - templates/default/service/client/_config.erb
 - templates/default/service/client/_credentials.erb
-- templates/default/service/client/_helpers.erb
 - templates/default/service/client/_operations.erb
 - templates/default/service/client/_paths.erb
 - templates/default/service/client/_requires.erb
@@ -320,6 +324,7 @@ files:
 - templates/default/service/test/method/_assert_response.erb
 - templates/default/service/test/method/_bidi.erb
 - templates/default/service/test/method/_client.erb
+- templates/default/service/test/method/_configure.erb
 - templates/default/service/test/method/_normal.erb
 - templates/default/service/test/method/_server.erb
 - templates/default/service/test/method/_setup.erb