gapic-generator 0.2.3 → 0.4.2

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/layouts/_ruby.erb

@@ -5,12 +5,13 @@
 <%= @requires -%>
 <%- end -%>
 
-<%- namespace.split("::").each_with_index do |ns, i| -%>
+<%- namespace_components = namespace.split("::").reject(&:empty?) -%>
+<%- namespace_components.each_with_index do |ns, i| -%>
 <%= indent "module #{ns}", i*2 %>
 <%- end -%>
-<%= indent yield, namespace.split("::").count*2 %>
-<%- namespace.split("::").count.times do |i| -%>
-<%= indent "end", (namespace.split("::").count-1-i)*2 %>
+<%= indent yield, namespace_components.count*2 %>
+<%- namespace_components.count.times do |i| -%>
+<%= indent "end", (namespace_components.count-1-i)*2 %>
 <%- end -%>
 <%- if instance_variable_defined? :@footer -%>
 

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/proto_docs/_message.erb

@@ -10,8 +10,8 @@
 <%- end -%>
 <%- end -%>
 class <%= message.name %>
-  include Google::Protobuf::MessageExts
-  extend Google::Protobuf::MessageExts::ClassMethods
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
   <%- message.nested_messages.each do |submsg| -%>
 
   <%= indent_tail render(partial: "proto_docs/message", locals: { message: submsg }), 2 %>

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.
@@ -41,7 +29,7 @@ class <%= service.client_name %>
   # To modify the configuration for all <%= service.name %> clients:
   #
   #     <%= service.client_name_full %>.configure do |config|
-  #       config.timeout = 10_000
+  #       config.timeout = 10.0
   #     end
   #
   # @yield [config] Configure the <%= service.client_name %> client.
@@ -87,7 +75,7 @@ class <%= service.client_name %>
   # configuration:
   #
   #     client = <%= service.client_name_full %>.new do |config|
-  #       config.timeout = 10_000
+  #       config.timeout = 10.0
   #     end
   #
   # @yield [config] Configure the <%= service.name %> client.
@@ -117,10 +105,11 @@ 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 -%>
-    @<%= service.stub_name %> = Gapic::ServiceStub.new(
+    @<%= service.stub_name %> = ::Gapic::ServiceStub.new(
       <%= service.proto_service_stub_name_full %>,
       credentials:  credentials,
       endpoint:     @config.endpoint,
@@ -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/_config.erb

@@ -20,22 +20,22 @@
 # to 20 seconds, and all remaining timeouts to 10 seconds:
 #
 #     <%= service.client_name_full %>.configure do |config|
-#       config.timeout = 10_000
-#       config.rpcs.<%= method_service.methods.first.name %>.timeout = 20_000
+#       config.timeout = 10.0
+#       config.rpcs.<%= method_service.methods.first.name %>.timeout = 20.0
 #     end
 #
 # To apply the above configuration only to a new client:
 #
 #     client = <%= service.client_name_full %>.new do |config|
-#       config.timeout = 10_000
-#       config.rpcs.<%= method_service.methods.first.name %>.timeout = 20_000
+#       config.timeout = 10.0
+#       config.rpcs.<%= method_service.methods.first.name %>.timeout = 20.0
 #     end
 #
 <%- end -%>
 # @!attribute [rw] endpoint
 #   The hostname or hostname:port of the service endpoint.
 #   Defaults to `<%= service.client_endpoint.inspect %>`.
-#   @return [String]
+#   @return [::String]
 # @!attribute [rw] credentials
 #   Credentials to send with calls. You may provide any of the following types:
 #    *  (`String`) The path to a service account key file in JSON format
@@ -47,29 +47,29 @@
 #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
 #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
 #    *  (`nil`) indicating no credentials
-#   @return [Object]
+#   @return [::Object]
 # @!attribute [rw] scope
 #   The OAuth scopes
-#   @return [Array<String>]
+#   @return [::Array<::String>]
 # @!attribute [rw] lib_name
 #   The library name as recorded in instrumentation and logging
-#   @return [String]
+#   @return [::String]
 # @!attribute [rw] lib_version
 #   The library version as recorded in instrumentation and logging
-#   @return [String]
+#   @return [::String]
 # @!attribute [rw] channel_args
 #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
 #   `GRPC::Core::Channel` object is provided as the credential.
-#   @return [Hash]
+#   @return [::Hash]
 # @!attribute [rw] interceptors
 #   An array of interceptors that are run before calls are executed.
-#   @return [Array<GRPC::ClientInterceptor>]
+#   @return [::Array<::GRPC::ClientInterceptor>]
 # @!attribute [rw] timeout
-#   The call timeout in milliseconds.
-#   @return [Numeric]
+#   The call timeout in seconds.
+#   @return [::Numeric]
 # @!attribute [rw] metadata
 #   Additional gRPC headers to be sent with the call.
-#   @return [Hash{Symbol=>String}]
+#   @return [::Hash{::Symbol=>::String}]
 # @!attribute [rw] retry_policy
 #   The retry policy. The value is a hash with the following keys:
 #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
@@ -77,10 +77,10 @@
 #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
 #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
 #       trigger a retry.
-#   @return [Hash]
+#   @return [::Hash]
 #
 class Configuration
-  extend Gapic::Config
+  extend ::Gapic::Config
 
   config_attr :endpoint,     <%= service.client_endpoint.inspect %>, String
   config_attr :credentials,  nil do |value|
@@ -88,14 +88,14 @@ class Configuration
     allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
     allowed.any? { |klass| klass === value }
   end
-  config_attr :scope,        nil, String, Array, nil
-  config_attr :lib_name,     nil, String, nil
-  config_attr :lib_version,  nil, String, nil
-  config_attr(:channel_args, <%= service.config_channel_args.inspect %>, Hash, nil)
-  config_attr :interceptors, nil, Array, nil
-  config_attr :timeout,      nil, Numeric, nil
-  config_attr :metadata,     nil, Hash, nil
-  config_attr :retry_policy, nil, Hash, Proc, nil
+  config_attr :scope,        nil, ::String, ::Array, nil
+  config_attr :lib_name,     nil, ::String, nil
+  config_attr :lib_version,  nil, ::String, nil
+  config_attr(:channel_args, <%= service.config_channel_args.inspect %>, ::Hash, nil)
+  config_attr :interceptors, nil, ::Array, nil
+  config_attr :timeout,      nil, ::Numeric, nil
+  config_attr :metadata,     nil, ::Hash, nil
+  config_attr :retry_policy, nil, ::Hash, Proc, nil
 
   # @private
   def initialize parent_config = nil
@@ -137,7 +137,7 @@ class Configuration
   <%- method_service.methods.each do |method| -%>
     ##
     # RPC-specific configuration for `<%= method.name %>`
-    # @return [Gapic::Config::Method]
+    # @return [::Gapic::Config::Method]
     #
     attr_reader :<%= method.name %>
   <%- end -%>
@@ -146,7 +146,7 @@ class Configuration
     def initialize parent_rpcs = nil
       <%- method_service.methods.each do |method| -%>
       <%= method.name %>_config = parent_rpcs&.<%= method.name %> if parent_rpcs&.respond_to? :<%= method.name %>
-      @<%= method.name %> = Gapic::Config::Method.new <%= method.name %>_config
+      @<%= method.name %> = ::Gapic::Config::Method.new <%= method.name %>_config
       <%- end -%>
 
       yield self if block_given?

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

@@ -3,7 +3,7 @@
 require "googleauth"
 <% end %>
 # Credentials for the <%= service.name %> API.
-class <%= service.credentials_name %> < Google::Auth::Credentials
+class <%= service.credentials_name %> < ::Google::Auth::Credentials
   <%- if service.client_scopes.any? -%>
   self.scope = [
   <%- service.client_scopes.each_with_index do |client_scope, index| -%>

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.
@@ -69,7 +65,7 @@ class <%= service.operations_name %>
       credentials = Credentials.new credentials, scope: @config.scope
     end
 
-    @<%= service.lro_service.stub_name %> = Gapic::ServiceStub.new(
+    @<%= service.lro_service.stub_name %> = ::Gapic::ServiceStub.new(
       <%= service.lro_service.proto_service_stub_name_full %>,
       credentials:  credentials,
       endpoint:     @config.endpoint,