gapic-generator 0.9.1 → 0.11.0

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

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

@@ -5,6 +5,9 @@ assert_equal grpc_response, response.response
 <%- elsif method.lro? %>
 assert_kind_of Gapic::Operation, response
 assert_equal grpc_response, response.grpc_op
+<%- elsif method.nonstandard_lro? %>
+assert_kind_of Gapic::GenericLRO::Operation, response
+assert_equal grpc_response, response.operation
 <%- else -%>
 assert_equal grpc_response, response
 <%- end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.41.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.41.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +110,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -197,13 +211,20 @@ files:
 - lib/gapic/generators/base_generator.rb
 - lib/gapic/generators/default_generator.rb
 - lib/gapic/generators/default_generator_parameters.rb
+- lib/gapic/grpc_service_config/config.rb
 - lib/gapic/grpc_service_config/method_config.rb
 - lib/gapic/grpc_service_config/parser.rb
 - lib/gapic/grpc_service_config/parsing_error.rb
 - lib/gapic/grpc_service_config/retry_policy.rb
-- lib/gapic/grpc_service_config/service_config.rb
 - lib/gapic/helpers/filepath_helper.rb
 - lib/gapic/helpers/namespace_helper.rb
+- lib/gapic/model.rb
+- lib/gapic/model/method/http_annotation.rb
+- lib/gapic/model/method/lro.rb
+- lib/gapic/model/method/routing.rb
+- lib/gapic/model/mixins.rb
+- lib/gapic/model/model_error.rb
+- lib/gapic/model/service/nonstandard_lro_provider.rb
 - lib/gapic/path_pattern.rb
 - lib/gapic/path_pattern/parser.rb
 - lib/gapic/path_pattern/pattern.rb
@@ -214,13 +235,15 @@ files:
 - lib/gapic/presenters/field_presenter.rb
 - lib/gapic/presenters/file_presenter.rb
 - lib/gapic/presenters/gem_presenter.rb
+- lib/gapic/presenters/grpc_service_config_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
 - lib/gapic/presenters/resource_presenter.rb
 - lib/gapic/presenters/sample_presenter.rb
-- lib/gapic/presenters/service_config_presenter.rb
+- lib/gapic/presenters/service/lro_client_presenter.rb
 - lib/gapic/presenters/service_presenter.rb
 - lib/gapic/presenters/service_rest_presenter.rb
 - lib/gapic/presenters/snippet_presenter.rb
@@ -233,19 +256,47 @@ files:
 - lib/gapic/schema/parameter_schema.rb
 - lib/gapic/schema/request_param_parser.rb
 - lib/gapic/schema/request_parameter.rb
+- lib/gapic/schema/service_config_parser.rb
 - lib/gapic/schema/wrappers.rb
 - lib/gapic/uri_template.rb
 - lib/gapic/uri_template/parser.rb
 - lib/google/api/annotations.pb.rb
+- lib/google/api/auth.pb.rb
+- lib/google/api/backend.pb.rb
+- lib/google/api/billing.pb.rb
 - lib/google/api/client.pb.rb
+- lib/google/api/context.pb.rb
+- lib/google/api/control.pb.rb
+- lib/google/api/documentation.pb.rb
+- lib/google/api/endpoint.pb.rb
 - lib/google/api/field_behavior.pb.rb
 - lib/google/api/http.pb.rb
+- lib/google/api/label.pb.rb
+- lib/google/api/launch_stage.pb.rb
+- lib/google/api/log.pb.rb
+- lib/google/api/logging.pb.rb
+- lib/google/api/metric.pb.rb
+- lib/google/api/monitored_resource.pb.rb
+- lib/google/api/monitoring.pb.rb
+- lib/google/api/quota.pb.rb
 - lib/google/api/resource.pb.rb
+- lib/google/api/routing.pb.rb
+- lib/google/api/service.pb.rb
+- lib/google/api/source_info.pb.rb
+- lib/google/api/system_parameter.pb.rb
+- lib/google/api/usage.pb.rb
+- lib/google/cloud/extended_operations.pb.rb
 - lib/google/longrunning/operations.pb.rb
 - lib/google/protobuf/any.pb.rb
+- lib/google/protobuf/api.pb.rb
 - lib/google/protobuf/compiler/plugin.pb.rb
 - lib/google/protobuf/descriptor.pb.rb
+- lib/google/protobuf/duration.pb.rb
 - lib/google/protobuf/empty.pb.rb
+- lib/google/protobuf/source_context.pb.rb
+- lib/google/protobuf/struct.pb.rb
+- lib/google/protobuf/type.pb.rb
+- lib/google/protobuf/wrappers.pb.rb
 - lib/google/rpc/status.pb.rb
 - templates/default/gem/_version.erb
 - templates/default/gem/changelog.erb
@@ -280,6 +331,7 @@ files:
 - templates/default/service/client/_client.erb
 - templates/default/service/client/_config.erb
 - templates/default/service/client/_credentials.erb
+- templates/default/service/client/_nonstandard_lro.erb
 - templates/default/service/client/_operations.erb
 - templates/default/service/client/_paths.erb
 - templates/default/service/client/_requires.erb
@@ -293,8 +345,11 @@ files:
 - templates/default/service/client/method/def/_request_streaming.erb
 - templates/default/service/client/method/def/_rescue.erb
 - templates/default/service/client/method/def/_response.erb
+- templates/default/service/client/method/def/_response_nonstandard_lro.erb
 - templates/default/service/client/method/def/_response_normal.erb
 - templates/default/service/client/method/def/_response_paged.erb
+- templates/default/service/client/method/def/_routing_params.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 +359,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
@@ -316,24 +372,31 @@ files:
 - templates/default/service/client/resource/_multi.erb
 - templates/default/service/client/resource/_single.erb
 - templates/default/service/credentials.erb
+- templates/default/service/nonstandard_lro.erb
 - templates/default/service/operations.erb
 - templates/default/service/paths.erb
 - templates/default/service/rest.erb
 - 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_nonstandard_lro.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
@@ -376,7 +439,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: An API Client Generator for Ruby in Ruby!

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