gapic-generator 0.7.1 → 0.9.0

data/lib/gapic/presenters/method_rest_presenter.rb

@@ -0,0 +1,194 @@
+# 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 "gapic/uri_template"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for rpc methods (REST submethods)
+    #
+    class MethodRestPresenter
+      def initialize main_method
+        @main_method = main_method
+        @proto_method = main_method.method
+      end
+
+      ##
+      # @return [Boolean] Whether a http verb is present for this method
+      #
+      def verb?
+        !verb.nil?
+      end
+
+      ##
+      # @return [Symbol] a http verb for this method
+      #
+      def verb
+        return nil if @proto_method.http.nil?
+
+        method = {
+          get:    @proto_method.http.get,
+          post:   @proto_method.http.post,
+          put:    @proto_method.http.put,
+          patch:  @proto_method.http.patch,
+          delete: @proto_method.http.delete
+        }.find { |_, value| !value.empty? }
+
+        method[0] unless method.nil?
+      end
+
+      ##
+      # @return [Boolean] Whether a method path is present and non-empty
+      #
+      def path?
+        !path.empty?
+      end
+
+      ##
+      # @return [String] A method path or an empty string if not present
+      #
+      def path
+        return "" if @proto_method.http.nil?
+
+        verb_path = [
+          @proto_method.http.get, @proto_method.http.post, @proto_method.http.put,
+          @proto_method.http.patch, @proto_method.http.delete
+        ].find { |x| !x.empty? }
+
+        verb_path || @proto_method.http.custom&.path || ""
+      end
+
+      ##
+      # @return [Boolean] Whether any routing params are present
+      #
+      def routing_params?
+        routing_params.any?
+      end
+
+      ##
+      # @return [Array<String>] The segment key names.
+      #
+      def routing_params
+        Gapic::UriTemplate.parse_arguments path
+      end
+
+      ##
+      # Performs a limited version of grpc transcoding to create a string that will interpolate
+      # the values from the request object to create a request URI at runtime.
+      # Currently only supports "value" into "request_object.value"
+      # @param [String] request_obj_name the name of the request object for the interpolation
+      #   defaults to "request_pb"
+      # @return [String] A string to interpolate values from the request object into URI
+      #
+      def uri_interpolated request_obj_name = "request_pb"
+        return path unless routing_params?
+
+        routing_params.reduce path do |uri, param|
+          param_esc = Regexp.escape param
+          uri.gsub(/{#{param_esc}[^}]*}/, "\#{#{request_obj_name}.#{param}}")
+        end
+      end
+
+      ##
+      # @return [Boolean] Whether method has body specified in proto
+      #
+      def body?
+        return false if @proto_method.http.nil?
+
+        !@proto_method.http.body.empty?
+      end
+
+      ##
+      # Name of the variable to use for storing the body result of the transcoding call
+      # Normally "body" but use "_body" for discarding the result for
+      # the calls that do not send body
+      # @return [String]
+      def body_var_name
+        body? ? "body" : "_body"
+      end
+
+      ##
+      # @return [String] A body specified for the given method in proto or an empty string if not specified
+      #
+      def body
+        @proto_method.http&.body || ""
+      end
+
+      ##
+      # @return [Boolean] True if body contains full request object (`*` in the annotation), false otherwise
+      #
+      def body_is_request_object?
+        body == "*"
+      end
+
+      ##
+      # Performs a limited version of grpc transcoding to create a string that will interpolate
+      # the values from the request object to create a request body at runtime.
+      # Currently only supports either "*" for "the whole request object" or
+      # "value" for "request_object.value"
+      #
+      # @param [String] request_obj_name the name of the request object for the interpolation
+      #   defaults to "request_pb"
+      #
+      # @return [String] A string to interpolate values from the request object into body
+      #
+      def body_interpolated request_obj_name = "request_pb"
+        return "\"\"" unless body?
+
+        return "#{request_obj_name}.to_json" if body_is_request_object?
+
+        "#{request_obj_name}.#{body}.to_json"
+      end
+
+      ##
+      # @return [Boolean] whether any query string parameters are present
+      #
+      def query_string_params?
+        query_string_params.any?
+      end
+
+      # @return [Array<String>]
+      def query_string_params
+        return [] if body_is_request_object?
+
+        routing_params_set = routing_params.to_set
+        @main_method.arguments
+                    .reject { |arg| routing_params_set.include? arg.name }
+                    .reject { |arg| body == arg.name }
+                    .reject(&:message?)
+                    .reject { |arg| arg.default_value_for_type.nil? }
+      end
+
+      ##
+      # Name of the variable to use for storing the query_string_params result of the transcoding call
+      # Normally "query_string_params" but use "_query_string_params" for discarding the result for
+      # the calls that do not sent query_string_params
+      # @return [String]
+      def query_string_params_var_name
+        query_string_params? ? "query_string_params" : "_query_string_params"
+      end
+
+      ##
+      # Name for the GRPC transcoding helper method
+      #
+      # @return [String]
+      def transcoding_helper_name
+        "transcode_#{@main_method.name}"
+      end
+    end
+  end
+end

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_config_presenter.rb

@@ -0,0 +1,48 @@
+# 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.
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for grpc service config.
+    #
+    class ServiceConfigPresenter
+      def initialize grpc_service_config
+        @grpc_service_config = grpc_service_config
+      end
+
+      attr_reader :grpc_service_config
+
+      def retry_policy_fields
+        elems = []
+        retry_policy = grpc_service_config&.retry_policy
+        if retry_policy&.initial_delay_seconds
+          elems << "initial_delay: #{Gapic::FormattingUtils.format_number retry_policy.initial_delay_seconds}"
+        end
+        if retry_policy&.max_delay_seconds
+          elems << "max_delay: #{Gapic::FormattingUtils.format_number retry_policy.max_delay_seconds}"
+        end
+        if retry_policy&.multiplier
+          elems << "multiplier: #{Gapic::FormattingUtils.format_number retry_policy.multiplier}"
+        end
+        if retry_policy&.status_codes
+          elems << "retry_codes: #{retry_policy.status_codes}"
+        end
+        elems.empty? ? "{}" : "{\n  #{elems.join ', '}\n}"
+      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
@@ -333,6 +361,10 @@ module Gapic
         @api.grpc_service_config.service_level_configs[grpc_full_name]
       end
 
+      def service_config_presenter
+        ServiceConfigPresenter.new grpc_service_config
+      end
+
       ##
       # The short proto name for this service
       #
@@ -361,12 +393,36 @@ 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
+
+      ##
+      # The method to use for quick start samples. Normally this is simply the
+      # first non-client-streaming method defined, but it can be overridden via
+      # a gem config.
+      #
+      # @return [Gapic::Presenters::MethodPresenter]
+      #
+      def quick_start_method
+        gem_config = @api.configuration[:gem]
+        preferred_method = gem_config[:quick_start_method] if gem_config
+        result = methods.find { |meth| meth.name == preferred_method } if preferred_method
+        result || methods.find { |meth| !meth.client_streaming? }
+      end
+
       private
 
       def default_config key

data/lib/gapic/presenters/service_rest_presenter.rb

@@ -0,0 +1,139 @@
+# 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
+
+      ##
+      # @return [String]
+      #
+      def create_client_call
+        "#{client_name_full}.new"
+      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
+
+      ##
+      # @return [String]
+      #
+      def test_client_file_path
+        main_service.service_file_path.sub ".rb", "_test.rb"
+      end
+
+
+      private
+
+      # @return [Gapic::Presenters::ServicePresenter]
+      attr_reader :main_service
+      # @return [Gapic::Schema::Api]
+      attr_reader :api
+    end
+  end
+end