gapic-generator 0.1.4

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

@@ -0,0 +1,8 @@
+<%- assert_locals service -%>
+# Path helper methods for the <%= service.name %> API.
+module Paths
+<%- service.references.each do |resource| -%>
+<%= indent render(partial: "service/client/resource", locals: { resource: resource }), 2 %>
+
+<%- end %>
+end

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

@@ -0,0 +1 @@
+<%- assert_locals service -%>

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

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

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

@@ -0,0 +1,9 @@
+<%- assert_locals service -%>
+<%- method_service ||= service -%>
+@configure ||= begin
+  default_config = <%= service.client_name %>::Configuration.new
+  <%= render partial: "service/client/self_configure_defaults", locals: {service: service} %>
+  default_config
+end
+yield @configure if block_given?
+@configure

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

@@ -0,0 +1,22 @@
+<%- assert_locals service -%>
+<%- method_service ||= service -%>
+<%- if service.grpc_service_config && !service.grpc_service_config.empty? -%>
+
+  <%- if service.grpc_service_config.timeout_seconds -%>
+    default_config.timeout = <%= format_number service.grpc_service_config.timeout_seconds %>
+  <%- end -%>
+  <%- if service.grpc_service_config.retry_policy -%>
+    default_config.retry_policy = <%= indent_tail render(partial: "service/client/self_configure_retry_policy", locals: { retry_policy: service.grpc_service_config.retry_policy }), 2 %>
+  <%- end -%>
+<%- end -%>
+<%- method_service.methods.each do |method| -%>
+  <%- if method.grpc_service_config && !method.grpc_service_config.empty? -%>
+
+    <%- if method.grpc_service_config.timeout_seconds -%>
+      default_config.rpcs.<%= method.name %>.timeout = <%= format_number method.grpc_service_config.timeout_seconds %>
+    <%- end -%>
+    <%- if method.grpc_service_config.retry_policy -%>
+      default_config.rpcs.<%= method.name %>.retry_policy =<%= indent_tail render(partial: "service/client/self_configure_retry_policy", locals: { retry_policy: method.grpc_service_config.retry_policy }), 2 %>
+    <%- end -%>
+  <%- end -%>
+<%- end -%>

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

@@ -0,0 +1,15 @@
+<%- assert_locals retry_policy -%>
+{
+  <%- if retry_policy.initial_delay_seconds -%>
+  initial_delay: <%= format_number retry_policy.initial_delay_seconds %>,
+  <%- end -%>
+  <%- if retry_policy.max_delay_seconds -%>
+  max_delay: <%= format_number retry_policy.max_delay_seconds %>,
+  <%- end -%>
+  <%- if retry_policy.multiplier -%>
+  multiplier: <%= format_number retry_policy.multiplier %>,
+  <%- end-%>
+  <%- if retry_policy.status_codes -%>
+  retry_codes: <%= retry_policy.status_codes %>
+  <%- end -%>
+}

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

@@ -0,0 +1,21 @@
+<%- assert_locals method -%>
+##
+<%- if method.doc_description -%>
+<%= indent method.doc_description, "# " %>
+#
+<%- end -%>
+<%= render partial: "service/client/method/docs/request", locals: { method: method } -%>
+#
+<%= render partial: "service/client/method/docs/response", locals: { method: method } -%>
+#
+<%= render partial: "service/client/method/docs/error", locals: { method: method } -%>
+#
+<%= render partial: "service/client/method/docs/samples", locals: { method: method } -%>
+def <%= method.name %> request, options = nil
+<%= indent render(partial: "service/client/method/def/request", locals: { method: method }), 2 %>
+
+<%= indent render(partial: "service/client/method/def/options_defaults", locals: { method: method }), 2 %>
+
+<%= indent render(partial: "service/client/method/def/response", locals: { method: method }), 2 %>
+<%= render partial: "service/client/method/def/rescue", locals: { method: method } -%>
+end

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

@@ -0,0 +1,29 @@
+<%- assert_locals method -%>
+# Converts hash and nil to an options object
+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 \
+  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
+<%- if method.routing_params? && !method.client_streaming? -%>
+
+header_params = {
+<%- method.routing_params.each_with_index do |routing_param, index| -%>
+  <%- comma = index == method.routing_params.count - 1 ? "" : "," -%>
+  "<%= routing_param %>" => request.<%= routing_param %><%= comma %>
+<%- end -%>
+}
+request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+metadata[:"x-goog-request-params"] ||= request_params_header
+<%- end -%>
+
+options.apply_defaults timeout:      @config.rpcs.<%= method.name %>.timeout,
+                       metadata:     metadata,
+                       retry_policy: @config.rpcs.<%= method.name %>.retry_policy
+options.apply_defaults metadata:     @config.metadata,
+                       retry_policy: @config.retry_policy

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

@@ -0,0 +1,6 @@
+<%- assert_locals method -%>
+<%- if method.client_streaming? -%>
+<%= render partial: "service/client/method/def/request_streaming", locals: { method: method } -%>
+<%- else -%>
+<%= render partial: "service/client/method/def/request_normal", locals: { method: method } -%>
+<%- end -%>

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

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

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

@@ -0,0 +1,9 @@
+<%- assert_locals method -%>
+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 %>
+end

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

@@ -0,0 +1 @@
+<%- assert_locals method -%>

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

@@ -0,0 +1,6 @@
+<%- assert_locals method -%>
+<%- if method.paged? -%>
+<%= render partial: "service/client/method/def/response_paged", locals: { method: method } -%>
+<%- else -%>
+<%= render partial: "service/client/method/def/response_normal", locals: { method: method } -%>
+<%- end -%>

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

@@ -0,0 +1,8 @@
+<%- 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 %>
+  <%- end -%>
+  yield response, operation if block_given?
+  return response
+end

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

@@ -0,0 +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 %> }
+  <%- 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

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

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

@@ -0,0 +1,6 @@
+<%- assert_locals method -%>
+<%- if method.client_streaming? -%>
+<%= render partial: "service/client/method/docs/request_streaming", locals: { method: method } -%>
+<%- else -%>
+<%= render partial: "service/client/method/docs/request_normal", locals: { method: method } -%>
+<%- end -%>

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

@@ -0,0 +1,7 @@
+<%- assert_locals field -%>
+<%- _key, value = field -%>
+<%- if value.is_a? Hash -%>
+<%= render partial: "service/client/method/docs/request_field/hash", locals: { field: field, comma: false } -%>
+<%- else -%>
+<%= render partial: "service/client/method/docs/request_field/arg", locals: { field: field } -%>
+<%- end -%>

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

@@ -0,0 +1,20 @@
+<%- assert_locals method -%>
+# @overload <%= method.name %>(request, options = nil)
+#   @param request [<%= method.request_type %> | Hash]
+<%- if method.doc_description -%>
+<%= indent method.doc_description, "#     " %>
+<%- end -%>
+#   @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 %>)
+<%- method.arguments.each do |arg| -%>
+#   @param <%= arg.name %> [<%= arg.doc_types %>]
+<%- if arg.doc_description -%>
+<%= indent arg.doc_description, "#     " %>
+<%- end -%>
+<%- end -%>
+<%- end -%>
+#

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

@@ -0,0 +1,5 @@
+<%- assert_locals method -%>
+# @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/client/method/docs/_response.erb

@@ -0,0 +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]
+#
+# @return [<%= method.doc_response_type %>]

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

@@ -0,0 +1,20 @@
+<%- assert_locals method, sample -%>
+require "<%= method.service.service_require %>"
+
+client = <%= method.service.client_name_full %>.new
+<%- if sample.input_parameters.any? -%>
+
+<%- end -%>
+<%- sample.input_parameters.each do |field| -%>
+<%- if field.value_is_file -%>
+<%= field.input_parameter %> = File.read <%= field.value %>
+<%- else -%>
+<%= field.input_parameter %> = <%= field.value %>
+<%- end -%>
+<%- end -%>
+
+<%- sample.fields.each do |field| -%>
+<%= render partial: "service/client/method/docs/request_field", locals: { field: field } -%>
+<%- end -%>
+
+<%= render partial: "service/client/method/docs/sample_response", locals: { method: method, sample: sample } -%>

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

@@ -0,0 +1,24 @@
+<%- assert_locals method, sample -%>
+<%- if method.server_streaming? || method.paged? -%>
+responses = client.<%= method.name %> <%= sample.kwargs %>
+
+responses.each do |response|
+<%- if method.lro? -%>
+  # Wait until the long running operation is done
+  response.wait_until_done!
+<%- end -%>
+<%- sample.response_raw.each do |resp_hash| -%>
+<%= indent render(partial: "service/client/method/docs/sample_response/#{resp_hash.keys.first}", locals: { values: resp_hash.values.first }), "  " %>
+<%- end -%>
+end
+<%- else -%>
+response = client.<%= method.name %> <%= sample.kwargs %>
+<%- if method.lro? -%>
+
+# Wait until the long running operation is done
+response.wait_until_done!
+<%- end -%>
+<%- sample.response_raw.each do |resp_hash| -%>
+<%= render partial: "service/client/method/docs/sample_response/#{resp_hash.keys.first}", locals: { values: resp_hash.values.first } -%>
+<%- end -%>
+<%- end -%>

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

@@ -0,0 +1,6 @@
+<%- assert_locals method -%>
+<%- method.samples.each do |sample| -%>
+# @example <%= sample.description %>
+<%= indent render(partial: "service/client/method/docs/sample", locals: { method: method, sample: sample }), "#   " %>
+#
+<%- end -%>

data/templates/default/service/client/method/docs/request_field/_arg.erb

@@ -0,0 +1,10 @@
+<%- assert_locals field -%>
+<%- key, value = field -%>
+<%- if value.comment -%>
+<%= indent value.comment, "# " %>
+<%- end -%>
+<%- if value.value_is_file && !value.input_parameter -%>
+<%= key %> = File.read <%= value.value %>
+<%- else -%>
+<%= key %> = <%= value.input_parameter || value.value %>
+<%- end -%>

data/templates/default/service/client/method/docs/request_field/_hash.erb

@@ -0,0 +1,19 @@
+<%- assert_locals field, comma -%>
+<%- key, value = field -%>
+<%- if value.is_a? Hash -%>
+<%= key %> = {
+<%- value.each_with_index do |nested_field, index| -%>
+<%- nested_comma = index != value.count - 1 -%>
+<%= indent render(partial: "service/client/method/docs/request_field/hash", locals: { field: nested_field, comma: nested_comma }), "  " %>
+<%- end -%>
+}<%= "," if comma %>
+<%- else -%>
+<%- if value.comment -%>
+<%= indent value.comment, "# " %>
+<%- end -%>
+<%- if value.value_is_file && !value.input_parameter -%>
+<%= key %>: File.read(<%= value.value %>)<%= "," if comma %>
+<%- else -%>
+<%= key %>: <%= value.input_parameter || value.value %><%= "," if comma %>
+<%- end -%>
+<%- end -%>

data/templates/default/service/client/method/docs/sample_response/_comment.erb

@@ -0,0 +1,5 @@
+<%- assert_locals values -%>
+
+<%- Array(values).each do |comment| -%>
+# <%= comment %>
+<%- end -%>

data/templates/default/service/client/method/docs/sample_response/_define.erb

@@ -0,0 +1,2 @@
+<%- assert_locals values -%>
+<%= values.gsub "$resp", "response" %>

data/templates/default/service/client/method/docs/sample_response/_loop.erb

@@ -0,0 +1,12 @@
+<%- assert_locals values -%>
+<%- if values["map"] -%>
+<%= values["map"].gsub("$resp", "response") %>.each do |<%= values["key"] %>, <%= values["value"] %>|
+<%- elsif values["variable"] -%>
+<%= values["collection"].gsub("$resp", "response") %>.each do |<%= values["variable"] %>|
+<%- else -%>
+<%= values["collection"].gsub("$resp", "response") %>.each do |<%= values["key"] %>, <%= values["value"] %>|
+<%- end -%>
+<%- values["body"].each do |b| -%>
+<%= indent render(partial: "service/client/method/docs/sample_response/#{b.keys.first}", locals: { values: b.values.first }), "  " %>
+<%- end -%>
+end

data/templates/default/service/client/method/docs/sample_response/_print.erb

@@ -0,0 +1,2 @@
+<%- assert_locals values -%>
+puts "<%= values[0].gsub("%s", "\#{%s}") % values[1..-1].map { |value| value.gsub("$resp", "response") } %>"

data/templates/default/service/client/method/docs/sample_response/_write_file.erb

@@ -0,0 +1,2 @@
+<%- assert_locals values -%>
+File.write <%= values["file_name"].inspect %>, <%= values["contents"].gsub("$resp", "response") %>

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

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

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

@@ -0,0 +1,8 @@
+<%- assert_locals pattern -%>
+The resource will be in the following format:
+
+`<%= pattern.template %>`
+
+<%- pattern.arguments.each do |arg| -%>
+@param <%= arg %> [String]
+<%- end -%>

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

@@ -0,0 +1,28 @@
+<%- assert_locals resource -%>
+##
+# 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 %>)
+<%= indent render(partial: "service/client/resource/doc", locals: { pattern: pattern }), "#   " %>
+#
+<%- end -%>
+# @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 %>|
+<%= 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?
+  resource.call(**args)
+end

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

@@ -0,0 +1,11 @@
+<%- assert_locals resource -%>
+##
+# Create a fully-qualified <%= resource.name %> resource string.
+#
+<%= 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 %>
+<%= indent render(partial: "service/client/resource/def", locals: { pattern: resource.patterns.first }), 2 %>
+end

data/templates/default/service/credentials.erb

@@ -0,0 +1,6 @@
+<%- assert_locals service -%>
+<%= render partial: "service/client/credentials",
+           layout: "layouts/ruby",
+           locals: { service: service,
+                     namespace: service.proto_service_name_full }
+%>

data/templates/default/service/operations.erb

@@ -0,0 +1,6 @@
+<%- assert_locals service -%>
+<%= render partial: "service/client/operations",
+           layout: "layouts/ruby",
+           locals: { service: service,
+                     namespace: service.proto_service_name_full }
+%>

data/templates/default/service/paths.erb

@@ -0,0 +1,6 @@
+<%- assert_locals service -%>
+<%= render partial: "service/client/paths",
+           layout: "layouts/ruby",
+           locals: { service: service,
+                     namespace: service.proto_service_name_full }
+%>

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

@@ -0,0 +1,24 @@
+<%- assert_locals service -%>
+# frozen_string_literal: true
+
+<%= render partial: "shared/license" %>
+require "simplecov"
+require "minitest/autorun"
+
+require "gapic/grpc/service_stub"
+
+require "<%= service.proto_service_require %>"
+require "<%= service.proto_services_require %>"
+require "<%= service.service_require %>"
+
+class <%= service.client_name_full %>Test < Minitest::Test
+<%= indent render(partial: "service/test/method/setup"), 2 %>
+
+<% service.methods.each do |method| %>
+<%= indent render(partial: "service/test/method/#{method.kind}",
+                  locals: { method: method }), 2 %>
+<% if method != service.methods.last %>
+
+<% end %>
+<% end %>
+end