gapic-generator 0.7.1 → 0.9.0

data/lib/gapic/presenters/snippet_presenter.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "active_support/inflector"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for snippets.
+    #
+    class SnippetPresenter
+      def initialize method_presenter, api
+        @method_presenter = method_presenter
+        @api = api
+      end
+
+      def client_streaming?
+        @method_presenter.client_streaming?
+      end
+
+      def bidi_streaming?
+        @method_presenter.client_streaming? && @method_presenter.server_streaming?
+      end
+
+      def response_kind
+        if @method_presenter.server_streaming?
+          :streaming
+        elsif @method_presenter.paged?
+          :paged
+        elsif @method_presenter.lro?
+          :lro
+        else
+          :simple
+        end
+      end
+
+      def snippet_file_path
+        "#{@method_presenter.service.service_require.split('/').last}/#{@method_presenter.name}.rb"
+      end
+
+      def require_path
+        @method_presenter.service.service_require
+      end
+
+      def client_type
+        @method_presenter.service.client_name_full.sub(/^::/, "")
+      end
+
+      def request_type
+        @method_presenter.request_type.sub(/^::/, "")
+      end
+
+      def return_type
+        base_type = @method_presenter.return_type.sub(/^::/, "")
+        @method_presenter.server_streaming? ? "Enumerable<#{base_type}>" : base_type
+      end
+
+      def paged_response_type
+        @method_presenter.paged_response_type
+      end
+
+      def base_response_type
+        @method_presenter.return_type
+      end
+
+      # TODO: Determine type of LRO response
+
+      def method_name
+        @method_presenter.name
+      end
+
+      def region_tag
+        gem_presenter = @method_presenter.service.gem
+        api_id = gem_presenter.api_shortname || gem_presenter.api_id&.split(".")&.first
+        names = gem_presenter.name.split "-"
+        final_name = names.pop
+        if final_name =~ /^v\d/
+          api_version = final_name
+          api_id ||= names.last
+        else
+          api_id ||= final_name
+          api_version = "v0"
+        end
+        service_name = @method_presenter.service.module_name
+        method_name = @method_presenter.method.name
+        "#{api_id}_#{api_version}_generated_#{service_name}_#{method_name}_sync"
+      end
+    end
+  end
+end

data/lib/gapic/runner.rb

@@ -65,7 +65,8 @@ module Gapic
 
       # Create and write the response
       response = Google::Protobuf::Compiler::CodeGeneratorResponse.new file: output_files
-      response.supported_features = Google::Protobuf::Compiler::CodeGeneratorResponse::FEATURE_PROTO3_OPTIONAL
+      feature_set = Google::Protobuf::Compiler::CodeGeneratorResponse::Feature::FEATURE_PROTO3_OPTIONAL.to_i
+      response.supported_features = feature_set
       response
     end
 

data/lib/gapic/schema/api.rb

@@ -89,6 +89,10 @@ module Gapic
         matching_files.first
       end
 
+      def overrides_of key
+        configuration&.fetch(:overrides, nil)&.fetch(key, nil) || {}
+      end
+
       def fix_file_path str
         str = String str
         return str if configuration[:overrides].nil?
@@ -144,11 +148,9 @@ module Gapic
       # @return [Array<Hash>]
       #   An array of the sample file hashes.
       def samples
-        @samples ||= begin
-          protoc_options["samples"].to_s.split(";").flat_map do |sample_path|
-            YAML.load_file sample_path
-          end.compact
-        end
+        @samples ||= protoc_options["samples"].to_s.split(";").flat_map do |sample_path|
+          YAML.load_file sample_path
+        end.compact
       end
 
       # Structured representation of the standalone samples configuration files.
@@ -174,10 +176,10 @@ module Gapic
       #   An array of the standalone sample configuration hashes.
       def standalone_test_samples
         @standalone_test_samples ||= begin
-          samples.select { |sample| sample["type"] == "test/samples" }
-                 .select { |sample| sample["schema_version"] == "1" || sample["schema_version"] == 1 }
-                 .map { |sample| sample["samples"] }
-                 .flatten.compact
+          test_samples = samples.select { |sample| sample["type"] == "test/samples" }
+          test_samples.select { |sample| sample["schema_version"] == "1" || sample["schema_version"] == 1 }
+                      .map { |sample| sample["samples"] }
+                      .flatten.compact
         end
       end
 
@@ -231,6 +233,29 @@ module Gapic
         configuration[:generate_path_helpers_output] ||= false
       end
 
+      # Whether to generate REST clients
+      def generate_rest_clients?
+        return false if configuration[:transports].nil?
+        configuration[:transports].include? "rest"
+      end
+
+      # Whether to generate GRPC clients
+      def generate_grpc_clients?
+        return true if configuration[:transports].nil?
+        configuration[:transports].include? "grpc"
+      end
+
+      # Whether to generate standalone snippets
+      def generate_standalone_snippets?
+        configuration[:generate_standalone_snippets] ||= false
+      end
+
+      # Whether to generate gapic metadata (drift manifest) file
+      # @return [Boolean]
+      def generate_metadata
+        configuration[:generate_metadata] ||= false
+      end
+
       # Whether the override_proto_namespaces parameter was given in the configuration
       def override_proto_namespaces_defined?
         configuration.key? :override_proto_namespaces
@@ -260,9 +285,7 @@ module Gapic
 
       # Parsed grpc service config
       def grpc_service_config
-        @grpc_service_config ||= begin
-          Gapic::GrpcServiceConfig::Parser.parse grpc_service_config_raw
-        end
+        @grpc_service_config ||= Gapic::GrpcServiceConfig::Parser.parse grpc_service_config_raw
       end
 
       # Get a resource given its type string
@@ -272,10 +295,8 @@ module Gapic
 
       # Given a service, find all common services that use it as a delegate.
       def common_services_for delegate
-        @delegate_to_common ||= begin
-          (configuration[:common_services] || {}).each_with_object({}) do |(c, d), mapping|
-            (mapping[d] ||= []) << c
-          end
+        @delegate_to_common ||= (configuration[:common_services] || {}).each_with_object({}) do |(c, d), mapping|
+          (mapping[d] ||= []) << c
         end
         all_services = services
         @delegate_to_common.fetch(delegate.address.join("."), []).map do |addr|
@@ -292,6 +313,27 @@ module Gapic
         services.find { |s| s.address == addr }
       end
 
+      ##
+      # Whether configuration has an override for the wrapper gem name
+      # @return [Boolean]
+      def wrapper_gem_name_override?
+        configuration.key?(:overrides) &&
+          configuration[:overrides].key?(:wrapper_gem_name)
+      end
+
+      ##
+      # An override for the wrapper gem name in the configuration
+      # @return [String, Nil]
+      def wrapper_gem_name_override
+        return nil unless wrapper_gem_name_override?
+        return nil if configuration[:overrides][:wrapper_gem_name].nil?
+
+        wrapper_name_config = configuration[:overrides][:wrapper_gem_name].strip
+        return nil if wrapper_name_config.empty?
+
+        wrapper_name_config
+      end
+
       private
 
       # Perform a variety of sanity checks on the data, and prints errors to

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

@@ -16,12 +16,12 @@ $ gem install <%= gem.name %>
 
 ```ruby
 require "<%= gem.entrypoint_require %>"
-<%- service = gem.first_non_common_service -%>
-<%- method = service&.methods.first -%>
+<%- service = gem.quick_start_service -%>
+<%- method = service&.quick_start_method -%>
 <%- if service && method -%>
 
 client = <%= service.create_client_call %>
-request = my_create_request
+request = <%= method.request_type %>.new # (request fields as keyword arguments...)
 response = client.<%= method.name %> request
 <%- end -%>
 ```

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