gapic-generator 0.11.0 → 0.45.1

data/lib/google/protobuf/wrappers.pb.rb

@@ -1,80 +0,0 @@
-# encoding: utf-8
-
-##
-# This file is auto-generated. DO NOT EDIT!
-#
-require 'protobuf'
-
-module Google
-  module Protobuf
-    ::Protobuf::Optionable.inject(self) { ::Google::Protobuf::FileOptions }
-
-    ##
-    # Message Classes
-    #
-    class DoubleValue < ::Protobuf::Message; end
-    class FloatValue < ::Protobuf::Message; end
-    class Int64Value < ::Protobuf::Message; end
-    class UInt64Value < ::Protobuf::Message; end
-    class Int32Value < ::Protobuf::Message; end
-    class UInt32Value < ::Protobuf::Message; end
-    class BoolValue < ::Protobuf::Message; end
-    class StringValue < ::Protobuf::Message; end
-    class BytesValue < ::Protobuf::Message; end
-
-
-    ##
-    # File Options
-    #
-    set_option :java_package, "com.google.protobuf"
-    set_option :java_outer_classname, "WrappersProto"
-    set_option :java_multiple_files, true
-    set_option :go_package, "github.com/golang/protobuf/ptypes/wrappers"
-    set_option :cc_enable_arenas, true
-    set_option :objc_class_prefix, "GPB"
-    set_option :csharp_namespace, "Google.Protobuf.WellKnownTypes"
-
-
-    ##
-    # Message Fields
-    #
-    class DoubleValue
-      optional :double, :value, 1
-    end
-
-    class FloatValue
-      optional :float, :value, 1
-    end
-
-    class Int64Value
-      optional :int64, :value, 1
-    end
-
-    class UInt64Value
-      optional :uint64, :value, 1
-    end
-
-    class Int32Value
-      optional :int32, :value, 1
-    end
-
-    class UInt32Value
-      optional :uint32, :value, 1
-    end
-
-    class BoolValue
-      optional :bool, :value, 1
-    end
-
-    class StringValue
-      optional :string, :value, 1
-    end
-
-    class BytesValue
-      optional :bytes, :value, 1
-    end
-
-  end
-
-end
-

data/lib/google/rpc/status.pb.rb

@@ -1,46 +0,0 @@
-# encoding: utf-8
-
-##
-# This file is auto-generated. DO NOT EDIT!
-#
-require 'protobuf'
-
-
-##
-# Imports
-#
-require 'google/protobuf/any.pb'
-
-module Google
-  module Rpc
-    ::Protobuf::Optionable.inject(self) { ::Google::Protobuf::FileOptions }
-
-    ##
-    # Message Classes
-    #
-    class Status < ::Protobuf::Message; end
-
-
-    ##
-    # File Options
-    #
-    set_option :java_package, "com.google.rpc"
-    set_option :java_outer_classname, "StatusProto"
-    set_option :java_multiple_files, true
-    set_option :go_package, "google.golang.org/genproto/googleapis/rpc/status;status"
-    set_option :objc_class_prefix, "RPC"
-
-
-    ##
-    # Message Fields
-    #
-    class Status
-      optional :int32, :code, 1
-      optional :string, :message, 2
-      repeated ::Google::Protobuf::Any, :details, 3
-    end
-
-  end
-
-end
-

data/templates/default/gem/gemfile.erb

@@ -1,4 +0,0 @@
-<%- assert_locals gem -%>
-source "https://rubygems.org"
-
-gemspec

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

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

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

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

@@ -1,9 +0,0 @@
-<%- 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/docs/_deprecated.erb

@@ -1,5 +0,0 @@
-<%- assert_locals method -%>
-<%- if method.is_deprecated? -%>
-# @deprecated This method is deprecated and may be removed in the next major version update.
-#
-<%- end -%>

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

@@ -1,6 +0,0 @@
-<%- assert_locals method -%>
-<%- if method.generate_yardoc_snippets? -%>
-# @example Basic example
-<%= indent render(partial: "snippets/snippet/structure", locals: { snippet: method.snippet }), "#   " %>
-#
-<%- end -%>

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

@@ -1,6 +0,0 @@
-<%- 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/rest/client/_config.erb

@@ -1,122 +0,0 @@
-<%- 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]
-# @!attribute [rw] metadata
-#   Additional REST headers to be sent with the call.
-#   @return [::Hash{::Symbol=>::String}]
-#
-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
-  config_attr :metadata,      nil, ::Hash, nil
-
-  # @private
-  def initialize parent_config = nil
-    @parent_config = parent_config unless parent_config.nil?
-
-    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/_response_normal.erb

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

@@ -1,7 +0,0 @@
-<%- 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 +0,0 @@
-<%- assert_locals method -%>
-# @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.rest.doc_response_type %>]

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

@@ -1,25 +0,0 @@
-<%- 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/service_stub/grpc_transcoding_method/_def.erb

@@ -1,24 +0,0 @@
-<%- 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})] 
-#   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/service_stub/grpc_transcoding_method/def/query_string_param", locals: { field: field } -%>
-  <%- end -%>
-  <%- end -%>
-
-  [uri, body, query_string_params]
-end

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

@@ -1,20 +0,0 @@
-<%- 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/_response.erb

@@ -1,17 +0,0 @@
-<%- 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/method/_assert_response.erb

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

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

@@ -1,71 +0,0 @@
-<%- 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/test/client_paths.erb

@@ -1,15 +0,0 @@
-<%- assert_locals service -%>
-<%= render partial: "shared/header" %>
-require "helper"
-
-require "gapic/grpc/service_stub"
-
-require "<%= service.service_require %>"
-
-class <%= service.client_name_full %>PathsTest < Minitest::Test
-<%- service.deduped_references.each do |resource| -%>
-<%= indent render(partial: "service/test/resource",
-                  locals: { resource: resource, service: service }), 2 %>
-
-<%- end %>
-end

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

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