gapic-generator 0.7.0 → 0.8.0

data/lib/gapic/schema/request_param_parser.rb

@@ -67,16 +67,15 @@ module Gapic
             param_name_input = unescape param_name_input_esc
             param_type, param_config_name = param_schema.schema_name_type_for param_name_input
 
-            if param_type == :bool && !["true", "false"].include?(unescape(value_str))
-              error_str = "WARNING: parameter #{param_name_input} (recognised as bool " \
-                                          "#{param_config_name}) will be discarded because of " \
-                                          "invalid value. Value should be either 'true' or 'false'."
-              error_output&.puts error_str
-            end
-
-            param_value = parse_param_value param_type, value_str
+            param_value = parse_validate_param_value(
+              param_type,
+              param_name_input,
+              param_config_name,
+              value_str,
+              error_output
+            )
 
-            if param_value
+            unless param_value.nil?
               RequestParameter.new param_val_input_str, param_name_input_esc, value_str, param_config_name, param_value
             end
           end.compact # known bool parameters with invalid values will not be added so we have to compact
@@ -92,13 +91,48 @@ module Gapic
 
         private
 
+        # Parses and validates param value depending on type and name
+        # @param param_type [Symbol] type of the parameter
+        # @param param_name_input [String] name of the parameter as given in the config
+        # @param param_config_name [String] canonical configuration name of the parameter
+        # @param value_str [String] string representation of parameter's value
+        # @param error_output [IO] Stream to write outputs to.
+        # @return [String,Array<String>,Hash{String => String}]
+        def parse_validate_param_value param_type, param_name_input, param_config_name, value_str, error_output
+          if param_type == :bool && !["true", "false"].include?(unescape(value_str))
+            error_str = "WARNING: parameter #{param_name_input} (recognised as bool " \
+                                          "#{param_config_name}) will be discarded because of " \
+                                          "invalid value. Value should be either 'true' or 'false'."
+            error_output&.puts error_str
+          end
+
+          param_value = parse_param_value param_type, value_str
+
+          if param_config_name == ":transports"
+            allowed_transports = ["grpc", "rest"]
+            noncompliant_values = param_value.reject { |pv| allowed_transports.include? pv }
+            if noncompliant_values.any?
+              noncompliant_values_list = noncompliant_values.join ", "
+              error_str = "WARNING: parameter #{param_name_input} (recognised as string array " \
+                                          "#{param_config_name}) will be discarded because "\
+                                          "it contains invalid values: #{noncompliant_values_list}. "\
+                                          "#{param_config_name} can only contain 'grpc' and/or 'rest' or be empty."
+              error_output&.puts error_str
+              param_value = nil
+            end
+          end
+
+          param_value
+        end
+
         # Parses param value depending on type
-        # @param param_type [Symbol]
-        # @param value_str [String]
+        # @param param_type [Symbol] type of the parameter
+        # @param value_str [String] string representation of parameter's value
         # @return [String,Array<String>,Hash{String => String}]
         def parse_param_value param_type, value_str
           case param_type
           when :array
+            return [] if value_str.empty?
             # elements in the arrays are concatenated by `;`
             # e.g. foo;bar;baz
             array_value_strings = split_by_unescaped value_str, ";"
@@ -114,7 +148,7 @@ module Gapic
           when :bool
             # bools should be either `true` or `false`
             unesc_val = unescape value_str
-            unesc_val if ["true", "false"].include? unesc_val
+            (unesc_val == "true") if ["true", "false"].include? unesc_val
           else
             # if it's an unknown type, just escape it without attempting to parse anything
             unescape value_str

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

@@ -21,7 +21,7 @@ module Google
     set_option :java_package, "com.google.protobuf"
     set_option :java_outer_classname, "AnyProto"
     set_option :java_multiple_files, true
-    set_option :go_package, "github.com/golang/protobuf/ptypes/any"
+    set_option :go_package, "google.golang.org/protobuf/types/known/anypb"
     set_option :objc_class_prefix, "GPB"
     set_option :csharp_namespace, "Google.Protobuf.WellKnownTypes"
 

data/lib/google/protobuf/compiler/plugin.pb.rb

@@ -1,8 +1,7 @@
 # encoding: utf-8
 
 ##
-# This file was auto-generated initially but now is hand-edited to add support 
-# for response features and proto3_optional
+# This file is auto-generated. DO NOT EDIT!
 #
 require 'protobuf'
 
@@ -23,6 +22,11 @@ module Google
       class Version < ::Protobuf::Message; end
       class CodeGeneratorRequest < ::Protobuf::Message; end
       class CodeGeneratorResponse < ::Protobuf::Message
+        class Feature < ::Protobuf::Enum
+          define :FEATURE_NONE, 0
+          define :FEATURE_PROTO3_OPTIONAL, 1
+        end
+
         class File < ::Protobuf::Message; end
 
       end
@@ -34,7 +38,7 @@ module Google
       #
       set_option :java_package, "com.google.protobuf.compiler"
       set_option :java_outer_classname, "PluginProtos"
-      set_option :go_package, "github.com/golang/protobuf/protoc-gen-go/plugin;plugin_go"
+      set_option :go_package, "google.golang.org/protobuf/types/pluginpb"
 
 
       ##
@@ -55,16 +59,15 @@ module Google
       end
 
       class CodeGeneratorResponse
-        FEATURE_PROTO3_OPTIONAL = 1
-
         class File
           optional :string, :name, 1
           optional :string, :insertion_point, 2
           optional :string, :content, 15
+          optional ::Google::Protobuf::GeneratedCodeInfo, :generated_code_info, 16
         end
 
         optional :string, :error, 1
-        optional :int32, :supported_features, 2
+        optional :uint64, :supported_features, 2
         repeated ::Google::Protobuf::Compiler::CodeGeneratorResponse::File, :file, 15
       end
 

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

@@ -121,7 +121,7 @@ module Google
     set_option :java_package, "com.google.protobuf"
     set_option :java_outer_classname, "DescriptorProtos"
     set_option :optimize_for, ::Google::Protobuf::FileOptions::OptimizeMode::SPEED
-    set_option :go_package, "github.com/golang/protobuf/protoc-gen-go/descriptor;descriptor"
+    set_option :go_package, "google.golang.org/protobuf/types/descriptorpb"
     set_option :cc_enable_arenas, true
     set_option :objc_class_prefix, "GPB"
     set_option :csharp_namespace, "Google.Protobuf.Reflection"
@@ -245,7 +245,7 @@ module Google
       optional :bool, :py_generic_services, 18, :default => false
       optional :bool, :php_generic_services, 42, :default => false
       optional :bool, :deprecated, 23, :default => false
-      optional :bool, :cc_enable_arenas, 31, :default => false
+      optional :bool, :cc_enable_arenas, 31, :default => true
       optional :string, :objc_class_prefix, 36
       optional :string, :csharp_namespace, 37
       optional :string, :swift_prefix, 39

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

@@ -21,7 +21,7 @@ module Google
     set_option :java_package, "com.google.protobuf"
     set_option :java_outer_classname, "EmptyProto"
     set_option :java_multiple_files, true
-    set_option :go_package, "github.com/golang/protobuf/ptypes/empty"
+    set_option :go_package, "google.golang.org/protobuf/types/known/emptypb"
     set_option :cc_enable_arenas, true
     set_option :objc_class_prefix, "GPB"
     set_option :csharp_namespace, "Google.Protobuf.WellKnownTypes"

data/templates/default/gem/readme.erb

@@ -28,11 +28,11 @@ response = client.<%= method.name %> request
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.4+.
+This library is supported on Ruby 2.5+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.4
+in security maintenance, and not end of life. Currently, this means Ruby 2.5
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.

data/templates/default/lib/_package.erb

@@ -6,13 +6,23 @@ require "<%= service.service_require %>"
 require "<%= package.gem.version_require %>"
 <% end %>
 <%- unless package.empty? -%>
+<%- if package.services.first.generate_grpc_clients? -%>
 ##
-# To load this package, including all its services, and instantiate a client:
+# To load this package, including all its services, and instantiate a <%= package.grpc_client_designation %>:
 #
 #     require "<%= package.package_require %>"
 #     client = <%= package.services.first.create_client_call %>
 #
 <%- end -%>
+<%- if package.services.first.generate_rest_clients? -%>
+##
+# To load this package, including all its services, and instantiate a REST client:
+#
+#     require "<%= package.package_require %>"
+#     client = <%= package.services.first.rest.create_client_call %>
+#
+<%- end -%>
+<%- end -%>
 module <%= package.module_name %>
 end
 <% @footer = capture do %>

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