gapic-generator 0.3.3 → 0.6.0

data/templates/default/gem/test_helper.erb

@@ -0,0 +1,8 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+require "simplecov"
+
+require "minitest/autorun"
+require "minitest/focus"
+require "minitest/rg"

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/_service.erb

@@ -6,7 +6,9 @@ require "gapic/config/method"
 
 require "<%= service.gem.version_require %>"
 
+<%- unless service.generic_endpoint? -%>
 require "<%= service.credentials_require %>"
+<%- end -%>
 <%- if service.paths? -%>
 require "<%= service.paths_require %>"
 <%- end -%>

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/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

@@ -29,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.
@@ -75,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.
@@ -96,19 +96,23 @@ class <%= service.client_name %>
 
     # Create credentials
     credentials = @config.credentials
+    <%- unless service.generic_endpoint? -%>
     credentials ||= Credentials.default scope: @config.scope
     if credentials.is_a?(String) || credentials.is_a?(Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
-    @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
+    <%- end -%>
+    @quota_project_id = @config.quota_project
+    @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
     <%- 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,
@@ -117,6 +121,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| -%>
 

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,25 +77,29 @@
 #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
 #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
 #       trigger a retry.
-#   @return [Hash]
+#   @return [::Hash]
+# @!attribute [rw] quota_project
+#   A separate project against which to charge quota.
+#   @return [::String]
 #
 class Configuration
-  extend Gapic::Config
+  extend ::Gapic::Config
 
-  config_attr :endpoint,     <%= service.client_endpoint.inspect %>, String
-  config_attr :credentials,  nil do |value|
+  config_attr :endpoint,      <%= service.client_endpoint.inspect %>, ::String
+  config_attr :credentials,   nil do |value|
     allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
     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
+  config_attr :quota_project, nil, ::String, nil
 
   # @private
   def initialize parent_config = nil
@@ -111,7 +115,7 @@ class Configuration
   def rpcs
     @rpcs ||= begin
       parent_rpcs = nil
-      parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
+      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
       Rpcs.new parent_rpcs
     end
   end
@@ -137,7 +141,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 +150,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

@@ -64,8 +64,10 @@ class <%= service.operations_name %>
     if credentials.is_a?(String) || credentials.is_a?(Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
+    @quota_project_id = @config.quota_project
+    @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
-    @<%= 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,

data/templates/default/service/client/method/def/_options_defaults.erb

@@ -1,12 +1,12 @@
 <%- assert_locals method -%>
 # Converts hash and nil to an options object
-options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
 # Customize the options with defaults
 metadata = @config.rpcs.<%= method.name %>.metadata.to_h
 
 # Set x-goog-api-client and x-goog-user-project headers
-metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
+metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
   lib_name: @config.lib_name, lib_version: @config.lib_version,
   gapic_version: ::<%= method.service.gem.version_name_full %>
 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

@@ -1,4 +1,4 @@
 <%- assert_locals method -%>
-raise ArgumentError, "request must be provided" if request.nil?
+raise ::ArgumentError, "request must be provided" if request.nil?
 
-request = Gapic::Protobuf.coerce request, to: <%= method.request_type %>
+request = ::Gapic::Protobuf.coerce request, to: <%= method.request_type %>

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

@@ -1,9 +1,9 @@
 <%- assert_locals method -%>
-unless request.is_a? Enumerable
-  raise ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
+unless request.is_a? ::Enumerable
+  raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
   request = request.to_enum
 end
 
 request = request.lazy.map do |req|
-  Gapic::Protobuf.coerce req, to: <%= method.request_type %>
+  ::Gapic::Protobuf.coerce req, to: <%= method.request_type %>
 end

data/templates/default/service/client/method/def/_response_normal.erb

@@ -1,7 +1,7 @@
 <%- assert_locals method -%>
 @<%= method.service.stub_name %>.call_rpc :<%= method.name %>, request, options: options do |response, operation|
   <%- if method.lro? -%>
-  response = Gapic::Operation.new response, <%= method.service.lro_client_ivar %>, options: options
+  response = ::Gapic::Operation.new response, <%= method.service.lro_client_ivar %>, options: options
   <%- end -%>
   yield response, operation if block_given?
   return response

data/templates/default/service/client/method/def/_response_paged.erb

@@ -1,9 +1,9 @@
 <%- assert_locals method -%>
 @<%= method.service.stub_name %>.call_rpc :<%= method.name %>, request, options: options do |response, operation|
   <%- if method.lro? -%>
-  wrap_lro_operation = ->(op_response) { Gapic::Operation.new op_response, <%= method.service.lro_client_ivar %> }
+  wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, <%= method.service.lro_client_ivar %> }
   <%- end -%>
-  response = Gapic::PagedEnumerable.new @<%= method.service.stub_name %>, :<%= method.name %>, request, response, operation, options<%- if method.lro? -%>, format_resource: wrap_lro_operation<%- end -%>
+  response = ::Gapic::PagedEnumerable.new @<%= method.service.stub_name %>, :<%= method.name %>, request, response, operation, options<%- if method.lro? -%>, format_resource: wrap_lro_operation<%- end -%>
   yield response, operation if block_given?
   return response
 end

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

@@ -1,2 +1,2 @@
 <%- assert_locals method -%>
-# @raise [GRPC::BadStatus] if the RPC is aborted.
+# @raise [::GRPC::BadStatus] if the RPC is aborted.

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

@@ -3,10 +3,10 @@
 #   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]
+#   @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]
+#   @param options [::Gapic::CallOptions, ::Hash]
 #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
 <%-if method.arguments.any?-%>
 #

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]
+# @param options [::Gapic::CallOptions, ::Hash]
 #   Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

@@ -1,6 +1,6 @@
 <%- assert_locals method -%>
 # @yield [response, operation] Access the result along with the RPC operation
 # @yieldparam response [<%= method.doc_response_type %>]
-# @yieldparam operation [GRPC::ActiveCall::Operation]
+# @yieldparam operation [::GRPC::ActiveCall::Operation]
 #
 # @return [<%= method.doc_response_type %>]

data/templates/default/service/client/resource/_def.erb

@@ -1,6 +1,6 @@
 <%- assert_locals pattern -%>
 <%- pattern.arguments[0...-1].each do |arg| -%>
-raise ArgumentError, "<%= arg %> cannot contain /" if <%= arg %>.to_s.include? "/"
+raise ::ArgumentError, "<%= arg %> cannot contain /" if <%= arg %>.to_s.include? "/"
 <%- end -%>
 
 "<%= pattern.path_string %>"

data/templates/default/service/client/resource/_multi.erb

@@ -3,26 +3,23 @@
 # Create a fully-qualified <%= resource.name %> resource string.
 #
 <%- resource.patterns.each do |pattern| -%>
-<%- args_doc_sig = pattern.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-# @overload <%= resource.path_helper %>(<%= args_doc_sig %>)
+# @overload <%= resource.path_helper %>(<%= pattern.formal_arguments %>)
 <%= indent render(partial: "service/client/resource/doc", locals: { pattern: pattern }), "#   " %>
 #
 <%- end -%>
-# @return [String]
+# @return [::String]
 def <%= resource.path_helper %> **args
   resources = {
 <%- last_pattern_index = resource.patterns.count - 1 -%>
 <%- resource.patterns.each_with_index do |pattern, index| -%>
 <%- comma = last_pattern_index == index ? "" : "," -%>
-<%- args_key = pattern.arguments.sort.join(":").inspect -%>
-<%- args_sig = pattern.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-    <%= args_key %> => (proc do |<%= args_sig %>|
+    <%= pattern.arguments_key.inspect %> => (proc do |<%= pattern.formal_arguments %>|
 <%= indent render(partial: "service/client/resource/def", locals: { pattern: pattern }), 6 %>
     end)<%= comma %>
 <%- end -%>
   }
 
   resource = resources[args.keys.sort.join(":")]
-  raise ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+  raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
   resource.call(**args)
 end

data/templates/default/service/client/resource/_single.erb

@@ -4,8 +4,7 @@
 #
 <%= indent render(partial: "service/client/resource/doc", locals: { pattern: resource.patterns.first }), "# " %>
 #
-# @return [String]
-<%- args = resource.patterns.first.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-def <%= resource.path_helper %> <%= args %>
+# @return [::String]
+def <%= resource.path_helper %> <%= resource.patterns.first.formal_arguments %>
 <%= indent render(partial: "service/client/resource/def", locals: { pattern: resource.patterns.first }), 2 %>
 end

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 }
 %>