gapic-generator 0.7.1 → 0.9.0

data/templates/default/lib/_service.erb

@@ -1,4 +1,21 @@
 <%- assert_locals service -%>
+
+<%- if service.generate_rest_clients? -%>
+<% @requires = capture do %>
+require "gapic/config"
+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 -%>
+require "<%= service.rest.service_rest_require %>"
+<% end %>
+<%- else -%>
 <% @requires = capture do %>
 require "gapic/common"
 require "gapic/config"
@@ -22,13 +39,26 @@ require "<%= service.client_require %>"
 <%= indent service.doc_description, "# " %>
 #
 <%- end -%>
-# To load this service and instantiate a client:
+<%- end -%>
+<%- if service.generate_grpc_clients? -%>
+# To load this service and instantiate a <%= service.grpc_client_designation %>:
 #
 #     require "<%= service.service_require %>"
 #     client = <%= service.create_client_call %>
 #
+<%- end -%>
+<%- if service.generate_rest_clients? -%>
+# To load this service and instantiate a REST client:
+#
+#     require "<%= service.service_require %>"
+#     client = <%= service.rest.create_client_call %>
+#
+<%- end -%>
 module <%= service.module_name %>
 end
+
+
+
 <% @footer = capture do %>
 <%= render partial: "service/helpers", locals: { service: service} -%>
 <% end %>

data/templates/default/lib/rest/_rest.erb

@@ -0,0 +1,11 @@
+<%- assert_locals service -%>
+<% @requires = capture do %>
+require "gapic/rest"
+require "<%= service.rest.transcoding_helper_require %>"
+require "<%= service.rest.client_require %>"
+<% end %>
+module <%= service.module_name %>
+  # Client for the REST transport
+  module Rest
+  end
+end

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

@@ -104,7 +104,7 @@ class <%= service.client_name %>
                              !@config.endpoint.split(".").first.include?("-")
     credentials ||= Credentials.default scope: @config.scope,
                                         enable_self_signed_jwt: enable_self_signed_jwt
-    if credentials.is_a?(String) || credentials.is_a?(Hash)
+    if credentials.is_a?(::String) || credentials.is_a?(::Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
     <%- end -%>

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

@@ -12,10 +12,12 @@ class <%= service.credentials_name %> < ::Google::Auth::Credentials
   <%- end -%>
   ]
   <%- end -%>
+  <%- if service.gem.env_prefix -%>
   self.env_vars = [
     "<%= service.gem.env_prefix %>_CREDENTIALS",
     "<%= service.gem.env_prefix %>_KEYFILE",
     "<%= service.gem.env_prefix %>_CREDENTIALS_JSON",
     "<%= service.gem.env_prefix %>_KEYFILE_JSON"
   ]
+  <%- end -%>
 end

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

@@ -61,7 +61,7 @@ class <%= service.operations_name %>
     # Create credentials
     credentials = @config.credentials
     credentials ||= Credentials.default scope: @config.scope
-    if credentials.is_a?(String) || credentials.is_a?(Hash)
+    if credentials.is_a?(::String) || credentials.is_a?(::Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
     @quota_project_id = @config.quota_project

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

@@ -6,7 +6,7 @@
     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 %>
+    default_config.retry_policy = <%= indent_tail service.service_config_presenter.retry_policy_fields, 2 %>
   <%- end -%>
 <%- end -%>
 <%- method_service.methods.each do |method| -%>
@@ -16,7 +16,7 @@
       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 %>
+      default_config.rpcs.<%= method.name %>.retry_policy =<%= indent_tail method.service_config_presenter.retry_policy_fields, 2 %>
     <%- end -%>
   <%- end -%>
 <%- end -%>

data/templates/default/service/rest.erb

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

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

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

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

@@ -0,0 +1,115 @@
+<%- assert_locals service -%>
+<% @requires = capture do %>
+  <%= render partial: "service/client/requires", locals: { service: service} -%>
+  require "<%= service.proto_service_require %>"
+<% end %>
+##
+# REST client for the <%= service.name %> service.
+#
+<%- if service.doc_description -%>
+<%= indent service.doc_description, "# " %>
+#
+<%- end -%>
+class <%= service.rest.client_name %>
+  include <%= service.rest.transcoding_helper_name %>
+<%- if service.paths? -%>
+  include <%= service.paths_name %>
+<%- end -%>
+
+  # @private
+  attr_reader :<%= service.stub_name %>
+
+  ##
+  # Configure the <%= service.name %> <%= service.rest.client_name %> class.
+  #
+  # See {<%= service.rest.client_name_full %>::Configuration}
+  # for a description of the configuration fields.
+  #
+  # ## Example
+  #
+  # To modify the configuration for all <%= service.name %> clients:
+  #
+  #     <%= service.rest.client_name_full %>.configure do |config|
+  #       config.timeout = 10.0
+  #     end
+  #
+  # @yield [config] Configure the <%= service.rest.client_name %> client.
+  # @yieldparam config [<%= service.rest.client_name %>::Configuration]
+  #
+  # @return [<%= service.rest.client_name %>::Configuration]
+  #
+  def self.configure
+<%= indent render(partial: "service/client/self_configure", locals: { service: service }), 4 %>
+  end
+
+  ##
+  # Configure the <%= service.name %> <%= service.rest.client_name %> instance.
+  #
+  # The configuration is set to the derived mode, meaning that values can be changed,
+  # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+  # should be made on {<%= service.rest.client_name %>.configure}.
+  #
+  # See {<%= service.rest.client_name_full %>::Configuration}
+  # for a description of the configuration fields.
+  #
+  # @yield [config] Configure the <%= service.rest.client_name %> client.
+  # @yieldparam config [<%= service.rest.client_name %>::Configuration]
+  #
+  # @return [<%= service.rest.client_name %>::Configuration]
+  #
+  def configure
+    yield @config if block_given?
+    @config
+  end
+
+  ##
+  # Create a new <%= service.name %> REST client object.
+  #
+  # ## Examples
+  #
+  # To create a new <%= service.name %> REST client with the default
+  # configuration:
+  #
+  #     client = <%= service.rest.client_name_full %>.new
+  #
+  # To create a new <%= service.name %> REST client with a custom
+  # configuration:
+  #
+  #     client = <%= service.rest.client_name_full %>.new do |config|
+  #       config.timeout = 10.0
+  #     end
+  #
+  # @yield [config] Configure the <%= service.name %> client.
+  # @yieldparam config [<%= service.rest.client_name %>::Configuration]
+  #
+  def initialize
+    # These require statements are intentionally placed here to initialize
+    # the REST modules only when it's required.
+    require "gapic/rest"
+
+    # Create the configuration object
+    @config = Configuration.new <%= service.rest.client_name %>.configure
+
+    # Yield the configuration if needed
+    yield @config if block_given?
+
+    # 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
+    <%- end -%>
+    
+    @client_stub = ::Gapic::Rest::ClientStub.new endpoint: @config.endpoint, credentials: credentials
+  end
+
+  # Service calls
+  <%- service.methods.each do |method| -%>
+
+  <%= indent_tail render(partial: "service/rest/client/method/def", locals: { method: method }), 2 %>
+  <%- end %>
+
+  <%= indent_tail render(partial: "service/rest/client/config", locals: { service: service }), 2 %>
+end

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

@@ -0,0 +1,74 @@
+<%- assert_locals service -%>
+<%- method_service ||= service  -%>
+##
+# Configuration class for the <%= service.name %> REST API.
+#
+# This class represents the configuration for <%= service.name %> REST,
+# providing control over credentials, timeouts, retry behavior, logging. 
+#
+# Configuration can be applied globally to all clients, or to a single client
+# on construction.
+#
+<%- unless method_service.methods.empty? -%>
+# # Examples
+#
+# To modify the global config, setting the timeout for all calls to 10 seconds:
+#
+#     <%= service.client_name_full %>.configure do |config|
+#       config.timeout = 10.0
+#     end
+#
+# To apply the above configuration only to a new client:
+#
+#     client = <%= service.client_name_full %>.new do |config|
+#       config.timeout = 10.0
+#     end
+#
+<%- end -%>
+# @!attribute [rw] endpoint
+#   The hostname or hostname:port of the service endpoint.
+#   Defaults to `<%= service.client_endpoint.inspect %>`.
+#   @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
+#    *  (`Hash`) A service account key as a Hash
+#    *  (`Google::Auth::Credentials`) A googleauth credentials object
+#       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+#    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+#       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+#    *  (`nil`) indicating no credentials
+#   @return [::Object]
+# @!attribute [rw] scope
+#   The OAuth scopes
+#   @return [::Array<::String>]
+# @!attribute [rw] lib_name
+#   The library name as recorded in instrumentation and logging
+#   @return [::String]
+# @!attribute [rw] lib_version
+#   The library version as recorded in instrumentation and logging
+#   @return [::String]
+# @!attribute [rw] timeout
+#   The call timeout in seconds.
+#   @return [::Numeric]
+#
+class Configuration
+  extend ::Gapic::Config
+
+  config_attr :endpoint,      <%= service.client_endpoint.inspect %>, ::String
+  config_attr :credentials,   nil do |value|
+    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+    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 :timeout,       nil, ::Numeric, nil
+
+  # @private
+  def initialize parent_config = nil
+    @parent_config = parent_config unless parent_config.nil?
+
+    yield self if block_given?
+  end
+end

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