gapic-generator 0.7.0 → 0.8.0

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

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

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

@@ -0,0 +1,18 @@
+<%- assert_locals method -%>
+##
+<%- if method.doc_description -%>
+  <%= indent method.doc_description, "# " %>
+#
+<%- end -%>
+<%= render partial: "service/rest/client/method/docs/request", locals: { method: method } -%>
+<%= render partial: "service/rest/client/method/docs/result", locals: { method: method } -%>
+#
+<%= render partial: "service/rest/client/method/docs/error", 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/rest/client/method/def/options_defaults", locals: { method: method }), 2 %>
+
+<%= indent render(partial: "service/rest/client/method/def/response_normal", 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

@@ -0,0 +1,15 @@
+<%- 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
+call_metadata = {}
+
+# Set x-goog-api-client header
+call_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 %>,
+  transports_version_send: [:rest]
+
+options.apply_defaults timeout:      @config.timeout,
+                       metadata:     call_metadata

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

@@ -0,0 +1,3 @@
+<%- assert_locals method -%>
+rescue ::Faraday::Error => e
+  raise ::Gapic::Rest::Error.wrap_faraday_error e

data/templates/default/service/rest/client/method/def/_response_normal.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
+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/client/method/docs/_error.erb

@@ -0,0 +1,2 @@
+<%- assert_locals method -%>
+# @raise [::Gapic::Rest::Error] if the REST call is aborted.

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

@@ -0,0 +1,27 @@
+<%- assert_locals method -%>
+# @overload <%= method.name %>(request, options = nil)
+#   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]
+#     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]
+#     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+#     Note: currently retry functionality is not implemented. While it is possible
+#     to set it using ::Gapic::CallOptions, it will not be applied
+<%-if method.arguments.any?-%>
+#
+<%- arg_list = method.arguments.map { |arg| "#{arg.name}: nil"}.join ", " -%>
+# @overload <%= method.name %>(<%= arg_list %>)
+#   Pass arguments to `<%= method.name %>` via keyword arguments. Note that at
+#   least one keyword argument is required. To specify no parameters, or to keep all
+#   the default parameter values, pass an empty Hash as a request object (see above).
+#
+<%- 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/rest/client/method/docs/_result.erb

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

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

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

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

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

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

@@ -0,0 +1,21 @@
+<%- assert_locals method -%>
+# @param request_pb [<%= method.request_type %>]
+#   A request object representing the call parameters. Required.
+# @return [Array(String, [String, nil], Hash{String => String})] 
+#   Uri, Body, Query string parameters
+def <%= method.rest.transcoding_helper_name %> request_pb
+  uri = "<%= method.rest.uri_interpolated %>"
+  <%- if method.rest.body? -%>
+  body = <%= method.rest.body_interpolated %>
+  <%- else -%>
+  body = nil
+  <%- end -%>
+  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 } -%>
+  <%- end -%>
+  <%- end -%>
+
+  [uri, body, query_string_params]
+end

data/templates/default/service/rest/grpc_transcoding/method/def/_query_string_param.erb

@@ -0,0 +1,8 @@
+<%- assert_locals field -%>
+<%- field_name_interpolated = "request_pb.#{field.name}" -%>
+<%- has_field_name_interpolated = "request_pb.has_#{field.name}?" -%>
+<%- if field.proto3_optional? -%>
+query_string_params["<%= field.camel_name %>"] = <%= field_name_interpolated %>.to_s if <%= has_field_name_interpolated %>
+<%- else -%>
+query_string_params["<%= field.camel_name %>"] = <%= field_name_interpolated %>.to_s
+<%- end -%>

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

@@ -0,0 +1,18 @@
+<%- assert_locals service -%>
+<%= render partial: "shared/header" %>
+require "helper"
+
+require "<%= service.proto_service_require %>"
+require "<%= service.service_require %>"
+
+
+class <%= service.client_name_full %>Test < Minitest::Test
+<%= indent render(partial: "service/rest/test/method/setup"), 2 %>
+
+<% service.methods.each do |method| %>
+<%= indent render(partial: "service/rest/test/method/#{method.kind}",
+                  locals: { method: method }), 2 %>
+
+<% end %>
+<%= indent render(partial: "service/rest/test/method/configure", locals: { service: service }), 2 %>
+end

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

@@ -0,0 +1,2 @@
+<%- assert_locals method -%>
+assert_equal http_response, response

data/templates/default/service/rest/test/method/_configure.erb

@@ -0,0 +1,19 @@
+<%- assert_locals service -%>
+<%- full_client_name = defined?(client_name_full) ? client_name_full : service.rest.client_name_full -%>
+def test_configure
+  credentials_token = :dummy_value
+
+  client = block_config = config = nil
+  Gapic::Rest::ClientStub.stub :new, nil do
+    client = <%= full_client_name =%>.new do |config|
+      config.credentials = credentials_token
+    end
+  end
+
+  config = client.configure do |c|
+    block_config = c
+  end
+
+  assert_same block_config, config
+  assert_kind_of <%= full_client_name %>::Configuration, config
+end

data/templates/default/service/rest/test/method/_normal.erb

@@ -0,0 +1,71 @@
+<%- assert_locals method -%>
+<%- full_client_name = defined?(client_name_full) ? client_name_full : method.service.rest.client_name_full -%>
+<%- fields = method.fields_with_first_oneof -%>
+def test_<%= method.name %>
+  # Create test objects.
+  client_result = <%= method.return_type %>.new
+  http_response = OpenStruct.new body: client_result.to_json
+
+  call_options = {}
+
+  # Create request parameters for a unary method.
+  <%- fields.each do |field| -%>
+  <%= field.name %> = <%= field.default_value %>
+  <%- end -%>
+
+  <%= method.name %>_client_stub = ClientStub.new http_response do |verb, uri:, body:, params:, options:|
+    assert_equal :<%= method.rest.verb %>, verb
+
+    assert options.metadata.key? :"x-goog-api-client"
+    assert options.metadata[:"x-goog-api-client"].include? "rest"
+    refute options.metadata[:"x-goog-api-client"].include? "grpc"
+
+    <%- if method.rest.query_string_params? -%>
+    <%- method.rest.query_string_params.each do |field| -%>
+    assert params.key? "<%= field.camel_name %>"
+    <%- end -%>
+    <%- end -%>
+    <%- if method.rest.body? %>
+    refute_nil body
+    <%- else -%>
+    assert_nil body
+    <%- end -%>
+  end
+
+  Gapic::Rest::ClientStub.stub :new, <%= method.name %>_client_stub do
+    # Create client
+    client = <%= full_client_name %>.new do  |config|
+      config.credentials = :dummy_value
+    end
+
+    # Use hash object
+    client.<%= method.name %>({ <%= fields.map(&:as_kwarg).join ", " %> }) do |result, response|
+      <%= indent_tail render(partial: "service/rest/test/method/assert_response", locals: { method: method }), 6 %>
+    end
+
+    <%- if fields.any? -%>
+    # Use named arguments
+    client.<%= method.name %> <%= fields.map(&:as_kwarg).join ", " %> do |result, response|
+      <%= indent_tail render(partial: "service/rest/test/method/assert_response", locals: { method: method }), 6 %>
+    end
+
+    <%- end -%>
+    # Use protobuf object
+    client.<%= method.name %> <%= method.request_type %>.new(<%= fields.map(&:as_kwarg).join ", " %>) do |result, response|
+      <%= indent_tail render(partial: "service/rest/test/method/assert_response", locals: { method: method }), 6 %>
+    end
+
+    # Use hash object with options
+    client.<%= method.name %>({ <%= fields.map(&:as_kwarg).join ", " %> }, call_options) do |result, response|
+      <%= indent_tail render(partial: "service/rest/test/method/assert_response", locals: { method: method }), 6 %>
+    end
+
+    # Use protobuf object with options
+    client.<%= method.name %>(<%= method.request_type %>.new(<%= fields.map(&:as_kwarg).join ", " %>), call_options) do |result, response|
+      <%= indent_tail render(partial: "service/rest/test/method/assert_response", locals: { method: method }), 6 %>
+    end
+
+    # Verify method calls
+    assert_equal <%= fields.any? ? 5 : 4 %>, <%= method.name %>_client_stub.call_count
+  end
+end

data/templates/default/service/rest/test/method/_setup.erb

@@ -0,0 +1,38 @@
+class ClientStub
+  attr_accessor :call_count, :requests
+
+  def initialize response, &block
+    @response = response
+    @block = block
+    @call_count = 0
+    @requests = []
+  end
+
+  def make_get_request uri:, params: {}, options: {}
+    make_http_request :get, uri: uri, body: nil, params: params, options: options
+  end
+
+  def make_delete_request uri:, params: {}, options: {}
+    make_http_request :delete, uri: uri, body: nil, params: params, options: options
+  end
+
+  def make_post_request uri:, body: nil, params: {}, options: {}
+    make_http_request :post, uri: uri, body: body, params: params, options: options
+  end
+
+  def make_patch_request uri:, body:, params: {}, options: {}
+    make_http_request :patch, uri: uri, body: body, params: params, options: options
+  end
+
+  def make_put_request uri:, body:, params: {}, options: {}
+    make_http_request :put, uri: uri, body: body, params: params, options: options
+  end
+
+  def make_http_request *args, **kwargs
+    @call_count += 1
+
+    @requests << @block&.call(*args, **kwargs)
+
+    @response
+  end
+end

data/templates/default/snippets/gemfile.erb

@@ -0,0 +1,17 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+source "https://rubygems.org"
+
+if ENV["GOOGLE_CLOUD_SAMPLES_TEST"] == "master"
+  gem "<%= gem.name %>", path: "../"
+else
+  gem "<%= gem.name %>"
+end
+
+group :test do
+  gem "google-style", "~> 1.25.1"
+  gem "minitest", "~> 5.14"
+  gem "minitest-focus", "~> 1.1"
+  gem "minitest-hooks", "~> 1.5"
+end

data/templates/default/snippets/snippet/_structure.erb

@@ -0,0 +1,71 @@
+<%- assert_locals snippet -%>
+require "<%= snippet.require_path %>"
+
+# Create a client object. The client can be reused for multiple calls.
+client = <%= snippet.client_type %>.new
+
+<%- if snippet.bidi_streaming? -%>
+# Create an input stream
+input = Gapic::StreamInput.new
+
+# Call the <%= snippet.method_name %> method to start streaming.
+output = client.<%= snippet.method_name %> input
+
+# Send requests on the stream. For each request, pass in keyword
+# arguments to set fields. Be sure to close the stream when done.
+input << <%= snippet.request_type %>.new
+input << <%= snippet.request_type %>.new
+input.close
+
+# Handle streamed responses. These may be interleaved with inputs.
+# Each response is of type <%= snippet.base_response_type %>.
+output.each do |response|
+  p response
+end
+<%- else -%>
+<%- if snippet.client_streaming? -%>
+# Create a stream of requests, as an Enumerator.
+# For each request, pass in keyword arguments to set fields.
+request = [
+  <%= snippet.request_type %>.new,
+  <%= snippet.request_type %>.new
+].to_enum
+<%- else -%>
+# Create a request. To set request fields, pass in keyword arguments.
+request = <%= snippet.request_type %>.new
+<%- end -%>
+
+# Call the <%= snippet.method_name %> method.
+result = client.<%= snippet.method_name %> request
+
+<%- case snippet.response_kind -%>
+<%- when :lro -%>
+# The returned object is of type Gapic::Operation. You can use this
+# object to check the status of an operation, cancel it, or wait
+# for results. Here is how to block until completion:
+result.wait_until_done! timeout: 60
+if result.response?
+  p result.response
+else
+  puts "Error!"
+end
+<%- when :paged -%>
+# The returned object is of type Gapic::PagedEnumerable. You can
+# iterate over all elements by calling #each, and the enumerable
+# will lazily make API calls to fetch subsequent pages. Other
+# methods are also available for managing paging directly.
+result.each do |response|
+  # Each element is of type <%= snippet.paged_response_type %>.
+  p response
+end
+<%- when :streaming -%>
+# The returned object is a streamed enumerable yielding elements of
+# type <%= snippet.base_response_type %>.
+result.each do |response|
+  p response
+end
+<%- else -%>
+# The returned object is of type <%= snippet.return_type %>.
+p result
+<%- end -%>
+<%- end -%>

data/templates/default/snippets/standalone.erb

@@ -0,0 +1,6 @@
+<%- assert_locals snippet -%>
+<%= render partial: "shared/header" -%>
+
+# [START <%= snippet.region_tag %>]
+<%= render partial: "snippets/snippet/structure", locals: { snippet: snippet} -%>
+# [END <%= snippet.region_tag %>]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -216,10 +216,13 @@ files:
 - lib/gapic/presenters/gem_presenter.rb
 - lib/gapic/presenters/message_presenter.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_presenter.rb
+- lib/gapic/presenters/service_rest_presenter.rb
+- lib/gapic/presenters/snippet_presenter.rb
 - lib/gapic/resource_lookup.rb
 - lib/gapic/ruby_info.rb
 - lib/gapic/runner.rb
@@ -263,6 +266,7 @@ files:
 - templates/default/layouts/_ruby.erb
 - templates/default/lib/_package.erb
 - templates/default/lib/_service.erb
+- templates/default/lib/rest/_rest.erb
 - templates/default/package.erb
 - templates/default/proto_docs/_enum.erb
 - templates/default/proto_docs/_message.erb
@@ -314,6 +318,27 @@ files:
 - templates/default/service/credentials.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_normal.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/test/client.erb
+- templates/default/service/rest/test/method/_assert_response.erb
+- templates/default/service/rest/test/method/_configure.erb
+- templates/default/service/rest/test/method/_normal.erb
+- templates/default/service/rest/test/method/_setup.erb
 - templates/default/service/test/_resource.erb
 - templates/default/service/test/client.erb
 - templates/default/service/test/client_operations.erb
@@ -329,6 +354,9 @@ files:
 - templates/default/shared/_header.erb
 - templates/default/shared/_license.erb
 - templates/default/shared/_warning.erb
+- templates/default/snippets/gemfile.erb
+- templates/default/snippets/snippet/_structure.erb
+- templates/default/snippets/standalone.erb
 homepage: https://github.com/googleapis/gapic-generator-ruby
 licenses:
 - Apache-2.0
@@ -348,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: An API Client Generator for Ruby in Ruby!