gapic-generator 0.9.1 → 0.10.0

data/templates/default/service/rest/client/_config.erb

@@ -51,6 +51,9 @@
 # @!attribute [rw] timeout
 #   The call timeout in seconds.
 #   @return [::Numeric]
+# @!attribute [rw] metadata
+#   Additional REST headers to be sent with the call.
+#   @return [::Hash{::Symbol=>::String}]
 #
 class Configuration
   extend ::Gapic::Config
@@ -64,6 +67,7 @@ class Configuration
   config_attr :lib_name,      nil, ::String, nil
   config_attr :lib_version,   nil, ::String, nil
   config_attr :timeout,       nil, ::Numeric, nil
+  config_attr :metadata,      nil, ::Hash, nil
 
   # @private
   def initialize parent_config = nil
@@ -71,4 +75,48 @@ class Configuration
 
     yield self if block_given?
   end
+
+  ##
+  # Configurations for individual RPCs
+  # @return [Rpcs]
+  #
+  def rpcs
+    @rpcs ||= begin
+      parent_rpcs = nil
+      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+      Rpcs.new parent_rpcs
+    end
+  end
+
+  ##
+  # Configuration RPC class for the <%= service.name %> API.
+  #
+  # Includes fields providing the configuration for each RPC in this service.
+  # Each configuration object is of type `Gapic::Config::Method` and includes
+  # the following configuration fields:
+  #
+  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+  #
+  # there is one other field (`retry_policy`) that can be set
+  # but is currently not supported for REST Gapic libraries.
+  # 
+  class Rpcs
+  <%- method_service.methods.each do |method| -%>
+    ##
+    # RPC-specific configuration for `<%= method.name %>`
+    # @return [::Gapic::Config::Method]
+    #
+    attr_reader :<%= method.name %>
+  <%- end -%>
+
+    # @private
+    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
+      <%- end -%>
+
+      yield self if block_given?
+    end
+  end
 end

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

@@ -13,6 +13,6 @@ def <%= method.name %> request, options = nil
 
 <%= indent render(partial: "service/rest/client/method/def/options_defaults", locals: { method: method }), 2 %>
 
-<%= indent render(partial: "service/rest/client/method/def/response_normal", locals: { method: method }), 2 %>
+<%= indent render(partial: "service/rest/client/method/def/response", locals: { method: method }), 2 %>
 <%= render partial: "service/rest/client/method/def/rescue", locals: { method: method } -%>
 end

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

@@ -3,7 +3,7 @@
 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
 # Customize the options with defaults
-call_metadata = {}
+call_metadata = @config.rpcs.<%= method.name %>.metadata.to_h
 
 # Set x-goog-api-client header
 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -11,5 +11,8 @@ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
   gapic_version: ::<%= method.service.gem.version_name_full %>,
   transports_version_send: [:rest]
 
-options.apply_defaults timeout:      @config.timeout,
+options.apply_defaults timeout:      @config.rpcs.<%= method.name %>.timeout,
                        metadata:     call_metadata
+
+options.apply_defaults timeout:      @config.timeout,
+                       metadata:     @config.metadata

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

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

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

@@ -1,17 +1,6 @@
 <%- assert_locals method -%>
 
-uri, <%= method.rest.body_var_name %>, <%= method.rest.query_string_params_var_name %> = <%= method.rest.transcoding_helper_name %> request
-response = @client_stub.make_<%= method.rest.verb %>_request(
-  uri:     uri,
-<%- if method.rest.body? -%>
-  body:    body,
-<%- end -%>
-<%- if method.rest.query_string_params? -%>
-  params:  query_string_params,
-<%- end -%>
-  options: options
-)
-result = <%= method.return_type %>.decode_json response.body, ignore_unknown_fields: true
-
-yield result, response if block_given?
-result
+@<%= method.service.stub_name %>.<%= method.name %> request, options do |result, response|
+  yield result, response if block_given?
+  return result
+end

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

@@ -0,0 +1,7 @@
+<%- assert_locals method -%>
+
+@<%= method.service.stub_name %>.<%= method.name %> request, options do |result, response|
+  result = ::Gapic::Rest::PagedEnumerable.new @<%= method.service.stub_name %>, :<%= method.name %>, "<%= method.rest.pagination.response_repeated_field_name %>", request, result, options
+  yield result, response if block_given?
+  return result
+end

data/templates/default/service/rest/client/method/docs/_result.erb

@@ -1,6 +1,6 @@
 <%- assert_locals method -%>
-# @yield [result, env] Access the result along with the Faraday environment object
-# @yieldparam result [<%= method.doc_response_type %>]
+# @yield [result, response] Access the result along with the Faraday response object
+# @yieldparam result [<%= method.rest.doc_response_type %>]
 # @yieldparam response [::Faraday::Response]
 #
-# @return [<%= method.doc_response_type %>]
+# @return [<%= method.rest.doc_response_type %>]

data/templates/default/service/rest/service_stub.erb

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

data/templates/default/service/rest/service_stub/_service_stub.erb

@@ -0,0 +1,25 @@
+<%- assert_locals service -%>
+<% @requires = capture do %>
+  require "<%= service.proto_service_require %>"
+<% end %>
+##
+# REST service stub for the <%= service.name %> service.
+# service stub contains baseline method implementations
+# including transcoding, making the REST call and deserialing the response
+#
+class <%= service.rest.service_stub_name %>
+  def initialize endpoint:, credentials:
+    # These require statements are intentionally placed here to initialize
+    # the REST modules only when it's required.
+    require "gapic/rest"
+
+    @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
+  end
+
+  <%- service.methods.each do |method| -%>
+
+  <%= indent_tail render(partial: "service/rest/service_stub/method/def", locals: { method: method }), 2 %>
+
+  <%= indent_tail render(partial: "service/rest/service_stub/grpc_transcoding_method/def", locals: { method: method }), 2 %>
+  <%- end %>
+end

data/templates/default/service/rest/{grpc_transcoding/method → service_stub/grpc_transcoding_method}/_def.erb

@@ -1,4 +1,7 @@
 <%- assert_locals method -%>
+##
+# GRPC transcoding helper method for the <%= method.name %> REST call
+#
 # @param request_pb [<%= method.request_type %>]
 #   A request object representing the call parameters. Required.
 # @return [Array(String, [String, nil], Hash{String => String})] 
@@ -13,7 +16,7 @@ def <%= method.rest.transcoding_helper_name %> request_pb
   query_string_params = {}
   <%- if method.rest.query_string_params? -%>
   <%- method.rest.query_string_params.each do |field| -%>
-  <%= render partial: "service/rest/grpc_transcoding/method/def/query_string_param", locals: { field: field } -%>
+  <%= render partial: "service/rest/service_stub/grpc_transcoding_method/def/query_string_param", locals: { field: field } -%>
   <%- end -%>
   <%- end -%>
 

data/templates/default/service/rest/service_stub/method/_def.erb

@@ -0,0 +1,20 @@
+<%- assert_locals method -%>
+##
+# Baseline implementation for the <%= method.name %> REST call
+#
+# @param request_pb [<%= method.rest.request_type %>]
+#   A request object representing the call parameters. Required.
+# @param options [::Gapic::CallOptions]
+#   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+#
+# @yield [result, response] Access the result along with the Faraday response object
+# @yieldparam result [<%= method.rest.return_type %>]
+# @yieldparam response [::Faraday::Response]
+#
+# @return [<%= method.rest.return_type %>]
+#   A result object deserialized from the server's reply
+def <%= method.name %> request_pb, options = nil
+<%= indent render(partial: "service/rest/service_stub/method/def/request", locals: { method: method }), 2 %>
+
+<%= indent render(partial: "service/rest/service_stub/method/def/response", locals: { method: method }), 2 %>
+end

data/templates/default/service/rest/service_stub/method/def/_request.erb

@@ -0,0 +1,2 @@
+<%- assert_locals method -%>
+raise ::ArgumentError, "request must be provided" if request_pb.nil?

data/templates/default/service/rest/service_stub/method/def/_response.erb

@@ -0,0 +1,17 @@
+<%- assert_locals method -%>
+
+uri, <%= method.rest.body_var_name %>, <%= method.rest.query_string_params_var_name %> = <%= method.rest.transcoding_helper_name %> request_pb
+response = @client_stub.make_<%= method.rest.verb %>_request(
+  uri:     uri,
+<%- if method.rest.body? -%>
+  body:    body,
+<%- end -%>
+<%- if method.rest.query_string_params? -%>
+  params:  query_string_params,
+<%- end -%>
+  options: options
+)
+result = <%= method.return_type %>.decode_json response.body, ignore_unknown_fields: true
+
+yield result, response if block_given?
+result

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

@@ -1,7 +1,7 @@
 <%- assert_locals service -%>
 <%= render partial: "shared/header" %>
 require "helper"
-
+require "gapic/rest"
 require "<%= service.proto_service_require %>"
 require "<%= service.service_require %>"
 

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

@@ -7,7 +7,7 @@ require "gapic/grpc/service_stub"
 require "<%= service.service_require %>"
 
 class <%= service.client_name_full %>PathsTest < Minitest::Test
-<%- service.references.each do |resource| -%>
+<%- service.deduped_references.each do |resource| -%>
 <%= indent render(partial: "service/test/resource",
                   locals: { resource: resource, service: service }), 2 %>
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Ernest Landrito
 - Chris Smith
 - Mike Moore
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -152,7 +152,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description:
 email:
 - landrito@google.com
 - quartzmo@gmail.com
@@ -215,6 +215,7 @@ files:
 - lib/gapic/presenters/file_presenter.rb
 - lib/gapic/presenters/gem_presenter.rb
 - lib/gapic/presenters/message_presenter.rb
+- lib/gapic/presenters/method/rest_pagination_info.rb
 - lib/gapic/presenters/method_presenter.rb
 - lib/gapic/presenters/method_rest_presenter.rb
 - lib/gapic/presenters/package_presenter.rb
@@ -295,6 +296,7 @@ files:
 - templates/default/service/client/method/def/_response.erb
 - templates/default/service/client/method/def/_response_normal.erb
 - templates/default/service/client/method/def/_response_paged.erb
+- templates/default/service/client/method/docs/_deprecated.erb
 - templates/default/service/client/method/docs/_error.erb
 - templates/default/service/client/method/docs/_request.erb
 - templates/default/service/client/method/docs/_request_field.erb
@@ -304,6 +306,7 @@ files:
 - templates/default/service/client/method/docs/_sample.erb
 - templates/default/service/client/method/docs/_sample_response.erb
 - templates/default/service/client/method/docs/_samples.erb
+- templates/default/service/client/method/docs/_snippets.erb
 - templates/default/service/client/method/docs/request_field/_arg.erb
 - templates/default/service/client/method/docs/request_field/_hash.erb
 - templates/default/service/client/method/docs/sample_response/_comment.erb
@@ -322,18 +325,23 @@ files:
 - templates/default/service/rest/client.erb
 - templates/default/service/rest/client/_client.erb
 - templates/default/service/rest/client/_config.erb
-- templates/default/service/rest/client/_requires.erb
 - templates/default/service/rest/client/method/_def.erb
 - templates/default/service/rest/client/method/def/_options_defaults.erb
 - templates/default/service/rest/client/method/def/_rescue.erb
+- templates/default/service/rest/client/method/def/_response.erb
 - templates/default/service/rest/client/method/def/_response_normal.erb
+- templates/default/service/rest/client/method/def/_response_paged.erb
 - templates/default/service/rest/client/method/docs/_error.erb
 - templates/default/service/rest/client/method/docs/_request.erb
 - templates/default/service/rest/client/method/docs/_result.erb
 - templates/default/service/rest/grpc_transcoding.erb
-- templates/default/service/rest/grpc_transcoding/_grpc_transcoding.erb
-- templates/default/service/rest/grpc_transcoding/method/_def.erb
-- templates/default/service/rest/grpc_transcoding/method/def/_query_string_param.erb
+- templates/default/service/rest/service_stub.erb
+- templates/default/service/rest/service_stub/_service_stub.erb
+- templates/default/service/rest/service_stub/grpc_transcoding_method/_def.erb
+- templates/default/service/rest/service_stub/grpc_transcoding_method/def/_query_string_param.erb
+- templates/default/service/rest/service_stub/method/_def.erb
+- templates/default/service/rest/service_stub/method/def/_request.erb
+- templates/default/service/rest/service_stub/method/def/_response.erb
 - templates/default/service/rest/test/client.erb
 - templates/default/service/rest/test/method/_assert_response.erb
 - templates/default/service/rest/test/method/_configure.erb
@@ -361,7 +369,7 @@ homepage: https://github.com/googleapis/gapic-generator-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -376,8 +384,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: An API Client Generator for Ruby in Ruby!
 test_files: []

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

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

data/templates/default/service/rest/grpc_transcoding/_grpc_transcoding.erb

@@ -1,9 +0,0 @@
-<%- assert_locals service -%>
-# GRPC transcoding helper methods for the <%= service.name %> REST API.
-module GrpcTranscoding
-<%- service.methods.each do |method| -%>
-
-  <%= indent_tail render(partial: "service/rest/grpc_transcoding/method/def", locals: { method: method }), 2 %>
-<%- end %>
-  extend self
-end