gapic-generator 0.7.2 → 0.7.4

data/lib/gapic/presenters/package_presenter.rb

@@ -54,7 +54,10 @@ module Gapic
         namespace.split("::").last
       end
 
+      ##
       # Services whose clients should be generated in this package namespace.
+      # @return [Enumerable<Gapic::Presenters::ServicePresenter>]
+      #
       def services
         @services ||= begin
           files = @api.generate_files.select { |f| f.package == @package }
@@ -117,6 +120,21 @@ module Gapic
           services:       services.map { |s| [s.grpc_service_name, s.drift_manifest] }.to_h
         }
       end
+
+      ##
+      # How comments in the generated libraries refer to the GRPC client
+      # if no REST code is generated, this should just be "client",
+      # if REST code is generated, this should be disambiguated into the "GRPC client"
+      #
+      # Since we are using first service for an indication of whether package generates
+      # REST code, it's OK to defer this to the first service as well.
+      # For packages with no services the value of this does not really matter as
+      # no client generation docs will be generated.
+      #
+      # @return [String]
+      def grpc_client_designation
+        services.first&.grpc_client_designation || ""
+      end
     end
   end
 end

data/lib/gapic/presenters/service_presenter.rb

@@ -27,11 +27,15 @@ module Gapic
       include Gapic::Helpers::FilepathHelper
       include Gapic::Helpers::NamespaceHelper
 
+      # @return [Gapic::Presenters::ServiceRestPresenter]
+      attr_reader :rest
+
       def initialize gem_presenter, api, service, parent_service: nil
         @gem_presenter = gem_presenter
         @api = api
         @service = service
         @parent_service = parent_service
+        @rest = ServiceRestPresenter.new self, api
       end
 
       def gem
@@ -46,10 +50,11 @@ module Gapic
         PackagePresenter.new @gem_presenter, @api, @service.parent.package
       end
 
+      ##
+      # @return [Enumerable<Gapic::Presenters::MethodPresenter>]
+      #
       def methods
-        @methods ||= begin
-          @service.methods.map { |m| MethodPresenter.new self, @api, m }
-        end
+        @methods ||= @service.methods.map { |m| MethodPresenter.new self, @api, m }
       end
 
       def address
@@ -271,6 +276,29 @@ module Gapic
         ruby_file_path @api, "#{service_name_full}::#{paths_name}"
       end
 
+      def generate_rest_clients?
+        @api.generate_rest_clients?
+      end
+
+      def generate_grpc_clients?
+        @api.generate_grpc_clients?
+      end
+
+      ##
+      # @return [Boolean] whether this service contains any methods with REST bindings
+      #
+      def methods_rest_bindings?
+        methods_rest_bindings.any?
+      end
+
+      ##
+      # @return [Enumerable<Gapic::Presenters::MethodPresenter>]
+      #   List of mods for which REST bindings are present and REST methods can be generated
+      #
+      def methods_rest_bindings
+        methods.select { |method| method.rest.path? && method.rest.verb? }
+      end
+
       def test_client_file_path
         service_file_path.sub ".rb", "_test.rb"
       end
@@ -361,12 +389,22 @@ module Gapic
               # their names are returned together in an array.
               # For Ruby currently we have 1:1 proto to code
               # correspondence for methods, so our generation is easier
-              methods:       methods.map { |m| [m.grpc_method_name, [m.name]] }.to_h
+              rpcs:       methods.map { |m| [m.grpc_method_name, m.drift_manifest] }.to_h
             }
           }
         }
       end
 
+      ##
+      # How comments in the generated libraries refer to the GRPC client
+      # if no REST code is generated, this should just be "client",
+      # if REST code is generated, this should be disambiguated into the "GRPC client"
+      #
+      # @return [String]
+      def grpc_client_designation
+        generate_rest_clients? ? "GRPC client" : "client"
+      end
+
       private
 
       def default_config key

data/lib/gapic/presenters/service_rest_presenter.rb

@@ -0,0 +1,157 @@
+# 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"
+require "gapic/helpers/filepath_helper"
+require "gapic/helpers/namespace_helper"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for proto service (REST submethods)
+    #
+    class ServiceRestPresenter
+      include Gapic::Helpers::FilepathHelper
+      include Gapic::Helpers::NamespaceHelper
+
+      ##
+      # @param main_service [Gapic::Presenters::ServicePresenter]
+      # @param api [Gapic::Schema::Api]
+      #
+      def initialize main_service, api
+        @main_service = main_service
+        @api = api
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_name_full
+        fix_namespace api, "#{main_service.service_name_full}::Rest"
+      end
+
+      ##
+      # @return [String]
+      #
+      def client_name
+        main_service.client_name
+      end
+
+      ##
+      # @return [String]
+      #
+      def client_name_full
+        fix_namespace api, "#{service_name_full}::#{client_name}"
+      end
+
+      ##
+      # @return [String]
+      #
+      def client_require
+        ruby_file_path api, client_name_full
+      end
+
+      ##
+      # @return [String]
+      #
+      def client_file_path
+        "#{client_require}.rb"
+      end
+
+      def create_client_call
+        "#{client_name_full}.new"
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_stub_name
+        "ServiceStub"
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_stub_name_full
+        fix_namespace api, "#{service_name_full}::#{service_stub_name}"
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_stub_require
+        ruby_file_path api, service_stub_name_full
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_stub_file_path
+        "#{service_stub_require}.rb"
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_rest_require
+        ruby_file_path api, service_name_full
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_rest_file_path
+        "#{service_rest_require}.rb"
+      end
+
+      ##
+      # @return [String]
+      #
+      def transcoding_helper_name
+        "GrpcTranscoding"
+      end
+
+      ##
+      # @return [String]
+      #
+      def transcoding_helper_name_full
+        fix_namespace api, "#{service_name_full}::#{transcoding_helper_name}"
+      end
+
+      ##
+      # @return [String]
+      #
+      def transcoding_helper_require
+        ruby_file_path api, transcoding_helper_name_full
+      end
+
+      ##
+      # @return [String]
+      #
+      def transcoding_helper_file_path
+        "#{transcoding_helper_require}.rb"
+      end
+
+
+      private
+
+      # @return [Gapic::Presenters::ServicePresenter]
+      attr_reader :main_service
+      # @return [Gapic::Schema::Api]
+      attr_reader :api
+    end
+  end
+end

data/lib/gapic/schema/api.rb

@@ -144,11 +144,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 +172,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 +229,24 @@ 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 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 +276,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 +286,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 +304,22 @@ 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?
+        configuration[:overrides][:wrapper_gem_name]
+      end
+
       private
 
       # Perform a variety of sanity checks on the data, and prints errors to

data/lib/gapic/schema/request_param_parser.rb

@@ -67,14 +67,13 @@ 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
               RequestParameter.new param_val_input_str, param_name_input_esc, value_str, param_config_name, param_value
@@ -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, ";"

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