gapic-generator 0.7.5 → 0.10.0

data/lib/gapic/presenters/method_presenter.rb

@@ -40,7 +40,7 @@ module Gapic
         @service_presenter = service_presenter
         @api = api
         @method = method
-        @rest = MethodRestPresenter.new self
+        @rest = MethodRestPresenter.new self, api
       end
 
       ##
@@ -50,6 +50,14 @@ module Gapic
         @service_presenter
       end
 
+      def snippet
+        SnippetPresenter.new self, @api
+      end
+
+      def generate_yardoc_snippets?
+        @api.generate_yardoc_snippets?
+      end
+
       def name
         @name ||= begin
           candidate = ActiveSupport::Inflector.underscore @method.name
@@ -89,6 +97,13 @@ module Gapic
         ret
       end
 
+      ##
+      # @return [Boolean]
+      #
+      def is_deprecated?
+        @method.is_deprecated?
+      end
+
       def arguments
         arguments = @method.input.fields.reject(&:output_only?)
         arguments.map { |arg| FieldPresenter.new @api, @method.input, arg }
@@ -171,7 +186,7 @@ module Gapic
       def lro?
         return paged_response_type == "::Google::Longrunning::Operation" if paged?
 
-        message_ruby_type(@method.output) == "::Google::Longrunning::Operation"
+        return_type == "::Google::Longrunning::Operation"
       end
 
       def client_streaming?
@@ -228,6 +243,10 @@ module Gapic
         end
       end
 
+      def service_config_presenter
+        ServiceConfigPresenter.new grpc_service_config
+      end
+
       def grpc_method_name
         @method.name
       end

data/lib/gapic/presenters/method_rest_presenter.rb

@@ -14,6 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "gapic/presenters/method/rest_pagination_info"
 require "gapic/uri_template"
 
 module Gapic
@@ -22,9 +23,19 @@ module Gapic
     # A presenter for rpc methods (REST submethods)
     #
     class MethodRestPresenter
-      def initialize main_method
+      # @return [Gapic::Presenters::Method::RestPaginationInfo]
+      attr_reader :pagination
+
+      ##
+      # @param main_method [Gapic::Presenters::MethodPresenter] the main presenter for this method.
+      # @param api [Gapic::Schema::Api]
+      #
+      def initialize main_method, api
+        @api = api
         @main_method = main_method
         @proto_method = main_method.method
+
+        @pagination = Gapic::Presenters::Method::RestPaginationInfo.new @proto_method, api
       end
 
       ##
@@ -128,6 +139,13 @@ module Gapic
         @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.
@@ -142,7 +160,7 @@ module Gapic
       def body_interpolated request_obj_name = "request_pb"
         return "\"\"" unless body?
 
-        return "#{request_obj_name}.to_json" if body == "*"
+        return "#{request_obj_name}.to_json" if body_is_request_object?
 
         "#{request_obj_name}.#{body}.to_json"
       end
@@ -156,11 +174,12 @@ module Gapic
 
       # @return [Array<String>]
       def query_string_params
-        return [] if body?
+        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
@@ -179,7 +198,54 @@ module Gapic
       #
       # @return [String]
       def transcoding_helper_name
-        "transcode_#{@main_method.name}"
+        "transcode_#{name}_request"
+      end
+
+      ##
+      # Method name
+      #
+      # @return [String]
+      #
+      def name
+        @main_method.name
+      end
+
+      ##
+      # Full class name of the request type
+      #
+      # @return [String]
+      #
+      def request_type
+        @main_method.request_type
+      end
+
+      ##
+      # Full class name of the raw return type of the RPC
+      #
+      # @return [String]
+      #
+      def return_type
+        @main_method.return_type
+      end
+
+      ##
+      # Full class name of the return type of the method
+      # (including LRO and Paged cases)
+      #
+      # @return [String]
+      #
+      def doc_response_type
+        return "::Gapic::Rest::PagedEnumerable<#{pagination.paged_element_doc_type}>" if paged?
+        return_type
+      end
+
+      ##
+      # Whether the REGAPIC method should be rendered as paged
+      #
+      # @return [Boolean]
+      #
+      def paged?
+        @pagination.paged?
       end
     end
   end

data/lib/gapic/presenters/resource_presenter.rb

@@ -33,6 +33,10 @@ module Gapic
         @patterns.filter!(&:useful_for_helpers?)
       end
 
+      def dup
+        ResourcePresenter.new @resource
+      end
+
       def name
         @resource.type.split("/").delete_if(&:empty?).last
       end
@@ -62,6 +66,10 @@ module Gapic
         attr_reader :pattern
         attr_reader :path_string
 
+        def pattern_template
+          @parsed_pattern.template
+        end
+
         def useful_for_helpers?
           !@parsed_pattern.positional_segments? && !@parsed_pattern.nontrivial_pattern_segments?
         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

@@ -50,6 +50,13 @@ module Gapic
         PackagePresenter.new @gem_presenter, @api, @service.parent.package
       end
 
+      ##
+      # @return [Boolean]
+      #
+      def is_deprecated?
+        @service.is_deprecated?
+      end
+
       ##
       # @return [Enumerable<Gapic::Presenters::MethodPresenter>]
       #
@@ -252,6 +259,34 @@ module Gapic
         @references ||= @service.resources.map { |resource| ResourcePresenter.new resource }.sort_by(&:name)
       end
 
+      ##
+      # Deduplicate resource presenters by combining resources with the same
+      # name. If multiple resources have the same name (though possibly
+      # different namespaces, e.g. `location.googleapis.com/Location` vs
+      # `documentai.googleapis.com/Location`), this combines (and dedups) their
+      # patterns into a single resource presenter.
+      #
+      # Used for generating path helpers while avoiding duplicate method names.
+      #
+      def deduped_references
+        @deduped_references ||= begin
+          hash = {}
+          references.each do |resource|
+            if hash.key? resource.name
+              existing = hash[resource.name]
+              resource.patterns.each do |pat|
+                unless existing.patterns.any? { |epat| epat.pattern_template == pat.pattern_template }
+                  existing.patterns << pat
+                end
+              end
+            else
+              hash[resource.name] = resource.dup
+            end
+          end
+          hash.values
+        end
+      end
+
       def paths?
         references.any?
       end
@@ -361,6 +396,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
       #
@@ -405,6 +444,36 @@ module Gapic
         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
+
+      ##
+      # Returns this service presenter if there is a grpc client. Otherwise,
+      # returns the corresponding rest service presenter if there isn't a grpc
+      # client but there is a rest client. Otherwise, returns nil if there is
+      # neither client.
+      #
+      # @return [ServicePresenter,ServiceRestPresenter,nil]
+      #
+      def usable_service_presenter
+        if @api.generate_grpc_clients?
+          self
+        elsif @api.generate_rest_clients? && methods_rest_bindings?
+          rest
+        end
+      end
+
       private
 
       def default_config key

data/lib/gapic/presenters/service_rest_presenter.rb

@@ -46,61 +46,64 @@ module Gapic
       ##
       # @return [String]
       #
-      def client_name
-        main_service.client_name
+      def service_stub_name
+        "ServiceStub"
       end
 
       ##
       # @return [String]
       #
-      def client_name_full
-        fix_namespace api, "#{service_name_full}::#{client_name}"
+      def service_stub_name_full
+        fix_namespace api, "#{service_name_full}::#{service_stub_name}"
       end
 
       ##
       # @return [String]
       #
-      def client_require
-        ruby_file_path api, client_name_full
+      def service_stub_require
+        ruby_file_path api, service_stub_name_full
       end
 
       ##
       # @return [String]
       #
-      def client_file_path
-        "#{client_require}.rb"
+      def service_stub_file_path
+        "#{service_stub_require}.rb"
       end
 
-      def create_client_call
-        "#{client_name_full}.new"
+      ##
+      # @return [String]
+      #
+      def client_name
+        main_service.client_name
       end
 
       ##
       # @return [String]
       #
-      def service_stub_name
-        "ServiceStub"
+      def client_name_full
+        fix_namespace api, "#{service_name_full}::#{client_name}"
       end
 
       ##
       # @return [String]
       #
-      def service_stub_name_full
-        fix_namespace api, "#{service_name_full}::#{service_stub_name}"
+      def client_require
+        ruby_file_path api, client_name_full
       end
 
       ##
       # @return [String]
       #
-      def service_stub_require
-        ruby_file_path api, service_stub_name_full
+      def client_file_path
+        "#{client_require}.rb"
       end
 
       ##
       # @return [String]
       #
-      def service_stub_file_path
-        "#{service_stub_require}.rb"
+      def create_client_call
+        "#{client_name_full}.new"
       end
 
       ##
@@ -120,32 +123,37 @@ module Gapic
       ##
       # @return [String]
       #
-      def transcoding_helper_name
-        "GrpcTranscoding"
+      def test_client_file_path
+        main_service.service_file_path.sub ".rb", "_test.rb"
       end
 
       ##
       # @return [String]
       #
-      def transcoding_helper_name_full
-        fix_namespace api, "#{service_name_full}::#{transcoding_helper_name}"
+      def credentials_class_xref
+        main_service.credentials_class_xref
       end
 
       ##
       # @return [String]
       #
-      def transcoding_helper_require
-        ruby_file_path api, transcoding_helper_name_full
+      def configure_client_call
+        "#{client_name_full}.configure"
       end
 
       ##
-      # @return [String]
+      # 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.
       #
-      def transcoding_helper_file_path
-        "#{transcoding_helper_require}.rb"
+      # @return [Gapic::Presenters::MethodRestPresenter] if there is a method
+      #     appropriatke for quick start
+      # @return [nil] if there is no method appropriate for quick start
+      #
+      def quick_start_method
+        main_service.quick_start_method&.rest
       end
 
-
       private
 
       # @return [Gapic::Presenters::ServicePresenter]