gapic-generator 0.10.1 → 0.11.0

data/lib/gapic/presenters/method_presenter.rb

@@ -32,6 +32,15 @@ module Gapic
       # @return [Gapic::Presenters::MethodRestPresenter]
       attr_accessor :rest
 
+      # @return [Gapic::Model::Method::Routing]
+      attr_accessor :routing
+
+      # @return [Gapic::Model::Method::HttpAnnotation]
+      attr_accessor :http
+
+      # @return [Gapic::Model::Method::AipLro, Gapic::Model::Method::NonStandardLro, Gapic::Model::Method::NoLro]
+      attr_accessor :lro
+
       ##
       # @param service_presenter [Gapic::Presenters::ServicePresenter]
       # @param api [Gapic::Schema::Api]
@@ -40,6 +49,10 @@ module Gapic
         @service_presenter = service_presenter
         @api = api
         @method = method
+        @http = Gapic::Model::Method::HttpAnnotation.new @method
+        @routing = Gapic::Model::Method::Routing.new @method.routing, http
+        @lro = Gapic::Model::Method.parse_lro @method, api
+
         @rest = MethodRestPresenter.new self, api
       end
 
@@ -50,6 +63,9 @@ module Gapic
         @service_presenter
       end
 
+      ##
+      # @return [Gapic::Presenters::SnippetPresenter]
+      #
       def snippet
         SnippetPresenter.new self, @api
       end
@@ -183,12 +199,36 @@ module Gapic
         sample_configs.map { |sample_config| SamplePresenter.new @api, sample_config }
       end
 
+      ##
+      # Whether this method uses standard (AIP-151) LROs
+      #
+      # @return [Boolean]
+      #
       def lro?
         return paged_response_type == "::Google::Longrunning::Operation" if paged?
 
         return_type == "::Google::Longrunning::Operation"
       end
 
+      ##
+      # Whether this method uses nonstandard LROs
+      #
+      # @return [Boolean]
+      #
+      def nonstandard_lro?
+        @lro.nonstandard_lro?
+      end
+
+      ##
+      # The presenter for the nonstandard LRO client of the kind this method uses
+      #
+      # @return [Gapic::Presenters::Service::LroClientPresenter, nil]
+      #
+      def nonstandard_lro_client
+        return unless nonstandard_lro?
+        service.nonstandard_lros.find { |model| model.service == @lro.service_full_name }
+      end
+
       def client_streaming?
         @method.client_streaming
       end
@@ -233,7 +273,7 @@ module Gapic
       # @return [Boolean] Whether any routing params are present
       #
       def routing_params?
-        rest.routing_params?
+        @routing.routing_params?
       end
 
       def grpc_service_config
@@ -243,8 +283,8 @@ module Gapic
         end
       end
 
-      def service_config_presenter
-        ServiceConfigPresenter.new grpc_service_config
+      def grpc_service_config_presenter
+        GrpcServiceConfigPresenter.new grpc_service_config
       end
 
       def grpc_method_name

data/lib/gapic/presenters/method_rest_presenter.rb

@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require "gapic/presenters/method/rest_pagination_info"
-require "gapic/uri_template"
 
 module Gapic
   module Presenters
@@ -34,6 +33,7 @@ module Gapic
         @api = api
         @main_method = main_method
         @proto_method = main_method.method
+        @http = main_method.http
 
         @pagination = Gapic::Presenters::Method::RestPaginationInfo.new @proto_method, api
       end
@@ -42,59 +42,42 @@ module Gapic
       # @return [Boolean] Whether a http verb is present for this method
       #
       def verb?
-        !verb.nil?
+        @http.verb?
       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?
+        @http.verb
       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 || ""
+        @http.path?
       end
 
       ##
       # @return [Boolean] Whether any routing params are present
       #
       def routing_params?
-        routing_params.any?
+        @http.routing_params?
       end
 
       ##
       # @return [Array<String>] The segment key names.
       #
       def routing_params
-        Gapic::UriTemplate.parse_arguments path
+        @http.routing_params
+      end
+
+      ##
+      # @return [Boolean] Whether method has body specified in proto
+      #
+      def body?
+        @http.body?
       end
 
       ##
@@ -114,15 +97,6 @@ module Gapic
         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
@@ -132,13 +106,6 @@ module Gapic
         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
       #
@@ -236,7 +203,7 @@ module Gapic
       #
       def doc_response_type
         return "::Gapic::Rest::PagedEnumerable<#{pagination.paged_element_doc_type}>" if paged?
-        return "::Gapic::Rest::BaseOperation" if lro?
+        return "::Gapic::GenericLRO::Operation" if nonstandard_lro?
         return_type
       end
 
@@ -250,17 +217,28 @@ module Gapic
       end
 
       ##
-      # Whether the REGAPIC method should be rendered as LRO
-      # [TODO (virost, 2021-08) Update this when DiReGapic LRO annotations are added to the Compute protos]
+      # Whether this method uses nonstandard LROs
       #
       # @return [Boolean]
       #
-      def lro?
-        return_type == "::Google::Cloud::Compute::V1::Operation" &&
-          @main_method.service.name != "ZoneOperations" &&
-          @main_method.service.name != "RegionOperations" &&
-          @main_method.service.name != "GlobalOperations" &&
-          @main_method.service.name != "GlobalOrganizationOperations"
+      def nonstandard_lro?
+        @main_method.nonstandard_lro?
+      end
+
+      private
+
+      ##
+      # @return [String] A method path or an empty string if not present
+      #
+      def path
+        @http.path
+      end
+
+      ##
+      # @return [String] A body specified for the given method in proto or an empty string if not specified
+      #
+      def body
+        @http.body
       end
     end
   end

data/lib/gapic/presenters/service/lro_client_presenter.rb

@@ -0,0 +1,90 @@
+# 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
+    module Service
+      ##
+      # Presenter for the generation of the client for nonstandard LROs
+      #
+      # @!attribute [r] service
+      #   Full name of the service providing the nonstandard LRO functionality
+      #   @return [String]
+      # @!attribute [r] client_class_name
+      #   Full name of the class of the client of the service
+      #   @return [String]
+      # @!attribute [r] client_class_docname
+      #   Name of the class as it should appear in the documentation
+      #   @return [String]
+      # @!attribute [r] client_var_name
+      #   Name for the variable for the client of the service
+      #   @return [String]
+      # @!attribute [r] require_str
+      #   Path to `require` the client of the service
+      #   @return [String]
+      # @!attribute [r] service_description
+      #   The description to place in the comments to this client's
+      #   attribute in the library services's client class
+      #   @return [String]
+      # @!attribute [r] helper_type
+      #   The type of a helper generated for this service if any
+      #   @return [String. nil]
+      #
+      class LroClientPresenter
+        attr_reader :service
+        attr_reader :client_class_name
+        attr_reader :client_class_docname
+        attr_reader :client_var_name
+        attr_reader :require_str
+        attr_reader :service_description
+        attr_reader :helper_type
+
+        ##
+        # @param service [String]
+        #   Full name of the service providing the nonstandard LRO functionality
+        # @param client_class_name [String]
+        #   Full name of the class of the client of the service
+        # @param client_class_docname [String]
+        #   Name of the class as it should appear in the documentation
+        # @param client_var_name [String]
+        #   Name for the variable for the client of the service
+        # @param require_str [String]
+        #   Path to `require` the client of the service
+        # @param service_description [String]
+        #   The description to place in the comments to this client's
+        #   attribute in the library services's client class
+        # @param helper_type [String, nil]
+        #   The type of a helper generated for this service if any
+        #
+        def initialize service:,
+                       client_class_name:,
+                       client_class_docname:,
+                       client_var_name:,
+                       require_str:,
+                       service_description:,
+                       helper_type: nil
+          @service = service
+          @client_class_name = client_class_name
+          @client_class_docname = client_class_docname
+          @client_var_name = client_var_name
+          @require_str = require_str
+          @service_description = service_description
+          @helper_type = helper_type
+        end
+      end
+    end
+  end
+end

data/lib/gapic/presenters/service_presenter.rb

@@ -36,6 +36,7 @@ module Gapic
         @service = service
         @parent_service = parent_service
         @rest = ServiceRestPresenter.new self, api
+        @nonstandard_lro = api.nonstandard_lro_model_for service.full_name
       end
 
       def gem
@@ -350,18 +351,44 @@ module Gapic
         "#{ActiveSupport::Inflector.underscore name}_stub"
       end
 
+      ##
+      # Whether an AIP-151 LRO subclient needs to be generated for this service
+      #
+      # @return [Boolean]
       def lro?
         methods.find(&:lro?)
       end
 
+      ##
+      # A variable name used for the AIP-151 LRO subclients
+      #
+      # @return [String]
       def lro_client_var
         "operations_client"
       end
 
+      ##
+      # An instance variable name used for the AIP-151 LRO subclients
+      #
+      # @return [String]
       def lro_client_ivar
         "@#{lro_client_var}"
       end
 
+      ##
+      # A presenter for the LRO subclient if needed
+      #
+      # @return [Gapic::Presenters::Service::LroClientPresenter, nil]
+      def lro_client_presenter
+        return nil unless lro?
+        Gapic::Presenters::Service::LroClientPresenter.new service: "google.longrunning.operations",
+                                                           client_class_name: "Operations",
+                                                           client_class_docname: operations_name_full,
+                                                           client_var_name: lro_client_var,
+                                                           require_str: operations_file_path,
+                                                           service_description: "long-running operations"
+      end
+
       def operations_name
         "Operations"
       end
@@ -396,8 +423,8 @@ module Gapic
         @api.grpc_service_config.service_level_configs[grpc_full_name]
       end
 
-      def service_config_presenter
-        ServiceConfigPresenter.new grpc_service_config
+      def grpc_service_config_presenter
+        GrpcServiceConfigPresenter.new grpc_service_config
       end
 
       ##
@@ -408,8 +435,12 @@ module Gapic
         @service.name
       end
 
+      ##
+      # The full proto name for this service
+      #
+      # @return [String]
       def grpc_full_name
-        @service.address.join "."
+        @service.full_name
       end
 
       ##
@@ -474,8 +505,159 @@ module Gapic
         end
       end
 
+      ##
+      # Whether there are mixin services that should be referenced
+      # in the client for this service
+      #
+      # @return [Boolean]
+      #
+      def mixins?
+        @gem_presenter.mixins?
+      end
+
+      ##
+      # The mixin services that should be referenced
+      # in the client for this service
+      #
+      # @return [Enumerable<Gapic::Model::Mixins::Mixin>]
+      #
+      def mixins
+        @gem_presenter.mixins_model.mixins
+      end
+
+      ##
+      # Name of the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_name
+        "NonstandardLro"
+      end
+
+      ##
+      # Full name of the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_name_full
+        fix_namespace @api, "#{service_name_full}::#{nonstandard_lro_name}"
+      end
+
+      ##
+      # Full file path to the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_file_path
+        "#{nonstandard_lro_require}.rb"
+      end
+
+      ##
+      # File name of the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_file_name
+        nonstandard_lro_file_path.split("/").last
+      end
+
+      ##
+      # The require string for the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_require
+        ruby_file_path @api, "#{service_name_full}::#{nonstandard_lro_name}"
+      end
+
+      ##
+      # Nonstandard lro model for this service
+      #
+      # @return [Gapic::Model::Service::NonstandardLro, Gapic::Model::Service::NoLro]
+      def nonstandard_lro
+        @nonstandard_lro
+      end
+
+      ##
+      # The Ruby name for the polling method of the nonstandard LRO provided by this service
+      #
+      # @return [String]
+      def nonstandard_lro_polling_method_name
+        return unless nonstandard_lro_provider?
+        methods.find { |m| m.grpc_method_name == nonstandard_lro.polling_method_name }.name
+      end
+
+      ##
+      # Whether this service is a provider of the nonstandard LRO functionality
+      #
+      # @return [Boolean]
+      def nonstandard_lro_provider?
+        @nonstandard_lro.nonstandard_lro?
+      end
+
+      ##
+      # Whether one or more methods of this service use the nonstandard LRO functionality
+      #
+      # @return [Boolean]
+      def nonstandard_lro_consumer?
+        methods.find(&:nonstandard_lro?) || false
+      end
+
+      ##
+      # The client presenters of the nonstandard LROs that are used by the methods of this service
+      #
+      # @return [Enumerable<Gapic::Presenters::Service::LroClientPresenter>]
+      def nonstandard_lros
+        return [] unless nonstandard_lro_consumer?
+        nonstandard_lros_models.map do |lro|
+          lro_wrapper = @api.lookup lro.service_full_name
+          lro_service = ServicePresenter.new(@gem_presenter, @api, lro_wrapper).usable_service_presenter
+
+          service_description = "long-running operations via #{lro_service.name}"
+          Gapic::Presenters::Service::LroClientPresenter.new service: lro.service_full_name,
+                                                             client_class_name: lro_service.client_name_full,
+                                                             client_class_docname: lro_service.client_name_full,
+                                                             client_var_name: lro_service.service_directory_name,
+                                                             require_str: lro_service.service_require,
+                                                             service_description: service_description,
+                                                             helper_type: lro_service.nonstandard_lro_name_full
+        end
+      end
+
+      ##
+      # Whether there are any subclients to generate with this service.
+      # Subclients are the clients to other services (e.g. an LRO provider service).
+      #
+      # @return [Boolean]
+      def subclients?
+        subclients.any?
+      end
+
+      ##
+      # Subclients for this service
+      # Subclients are the clients to other services (e.g. an LRO provider service).
+      #
+      # The following is typically generated for a subclient:
+      # - a require statement for the subclient's class
+      # - a class-level variable in the host service's client
+      # - a code to initialize this variable with a subclient's class instance in the host service's constructor
+      #
+      # @return [Enumerable<Gapic::Presenters::Service::LroClientPresenter, Gapic::Model::Mixins::Mixin>]
+      def subclients
+        ([] << lro_client_presenter << mixins << nonstandard_lros).flatten.compact
+      end
+
       private
 
+      ##
+      # The nonstandard LRO models for the nonstandard LROs that are used by the methods of this service
+      #
+      # @return [Enumerable<Gapic::Model::Method::Lro>]
+      def nonstandard_lros_models
+        return [] unless nonstandard_lro_consumer?
+        methods.select(&:nonstandard_lro?).map(&:lro).uniq(&:service_full_name)
+      end
+
       def default_config key
         return unless @service.parent.parent.configuration[:defaults]
         return unless @service.parent.parent.configuration[:defaults][:service]

data/lib/gapic/presenters/service_rest_presenter.rb

@@ -37,12 +37,41 @@ module Gapic
       end
 
       ##
+      # Ruby name of this service
+      #
+      # @return [String]
+      #
+      def name
+        main_service.name
+      end
+
+      ##
+      # Full Ruby name of this service
+      #
       # @return [String]
       #
       def service_name_full
         fix_namespace api, "#{main_service.service_name_full}::Rest"
       end
 
+      ##
+      # Require path for this service
+      #
+      # @return [String]
+      #
+      def service_require
+        ruby_file_path @api, service_name_full
+      end
+
+      ##
+      # Folder name for this service
+      #
+      # @return [String]
+      #
+      def service_directory_name
+        service_require.split("/")[-2]
+      end
+
       ##
       # @return [String]
       #
@@ -141,6 +170,51 @@ module Gapic
         "#{client_name_full}.configure"
       end
 
+      ##
+      # Name of the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_name
+        "NonstandardLro"
+      end
+
+      ##
+      # Full name of the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_name_full
+        fix_namespace @api, "#{service_name_full}::#{nonstandard_lro_name}"
+      end
+
+      ##
+      # Full file path to the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_file_path
+        "#{nonstandard_lro_require}.rb"
+      end
+
+      ##
+      # File name of the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_file_name
+        nonstandard_lro_file_path.split("/").last
+      end
+
+      ##
+      # The require string for the nonstandard LRO module
+      #
+      # @return [String]
+      #
+      def nonstandard_lro_require
+        ruby_file_path @api, "#{service_name_full}::#{nonstandard_lro_name}"
+      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
@@ -154,6 +228,13 @@ module Gapic
         main_service.quick_start_method&.rest
       end
 
+      ##
+      # @return [Enumerable<Gapic::Presenters::MethodPresenter>]
+      #
+      def methods
+        main_service.methods
+      end
+
       private
 
       # @return [Gapic::Presenters::ServicePresenter]

data/lib/gapic/presenters/snippet_presenter.rb

@@ -94,6 +94,7 @@ module Gapic
           api_id ||= final_name
           api_version = "v0"
         end
+        api_id = api_id.downcase.gsub(/[^a-z0-9]/, "")
         service_name = @method_presenter.service.module_name
         method_name = @method_presenter.method.name
         "#{api_id}_#{api_version}_generated_#{service_name}_#{method_name}_sync"