gapic-generator 0.11.0 → 0.45.2

data/lib/gapic/model/method/http_annotation.rb

@@ -23,99 +23,197 @@ module Gapic
       # The information used in the generation process that
       # can be gathered from the `google.api.http` annotation.
       # `google.api.http` is used in two distinct ways:
-      #   - the rest libs use it as part of the transcoding to set up the REST call
-      #   - both rest and grpc libs use it as a source of implicit routing headers
+      #   - REST libs use it as part of the transcoding to set up the REST call
+      #   - gRPC libs use it as a source of implicit routing headers
       #
       class HttpAnnotation
         ##
-        # @param proto_method [Gapic::Schema::Method]
+        # The Http bindings found in the annotation
+        # this includes main binding in the annotation itself,
+        # as well as those in the `additional_bindings`.
         #
-        def initialize proto_method
-          @proto_method = proto_method
+        # @return [Array<HttpBinding>]
+        attr_reader :bindings
+
+        ##
+        # @param proto_http [::Google::Api::HttpRule]
+        #   The base http annotation
+        #
+        def initialize proto_http
+          @bindings = parse_bindings proto_http
         end
 
         ##
-        # Whether a http verb is present for this method
+        # Whether any implicit routing parameters are present.
         #
         # @return [Boolean]
-        def verb?
-          !verb.nil?
+        def routing_params?
+          routing_params.any?
         end
 
         ##
-        # The http verb for this method
+        # The implicit routing parameter names.
         #
-        # @return [Symbol, Nil]
-        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?
+        # @return [Array<String>]
+        def routing_params
+          routing_params_with_patterns.map { |param, _| param }
         end
 
         ##
-        # Whether a method path is present and non-empty
+        # The implicit routing parameter names and their corresponding paterns,
+        # including the `*` pattern implied for the named segments
+        # without an explicitly specified pattern.
         #
-        # @return [Boolean]
-        def path?
-          !path.empty?
+        # @return [Array<Array<String>>]
+        def routing_params_with_patterns
+          bindings.first&.routing_params_with_patterns || []
         end
 
         ##
-        # A method path or an empty string if not present
+        # @param proto_method [::Gapic::Schema::Method]
+        #   The proto method this annotation model applies to
+        # @param service_config [::Google::Api::Service]
+        #   The service config that might contain an override for the http annotation.
+        #   This is used for mixins: when generating Operations sublients, and when
+        #   setting up overrides for other mixin clients in the host services's classes.
+        #   For non-mixin service generation
+        #   it is assumed that the service config is merged into protos before generation.
         #
-        # @return [String]
-        def path
-          return "" if @proto_method.http.nil?
+        def self.create_with_override proto_method, service_config = nil
+          proto_http = proto_method.http
 
-          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? }
+          http_override = service_config&.http&.rules&.find { |http_rule| http_rule.selector == proto_method.full_name }
 
-          verb_path || @proto_method.http.custom&.path || ""
+          http = http_override || proto_http
+          HttpAnnotation.new http
         end
 
         ##
-        # Whether any routing params are present
+        # A single Http binding.
         #
-        # @return [Boolean]
-        def routing_params?
-          routing_params.any?
+        class HttpBinding
+          ##
+          # @param binding [::Google::Api::HttpRule]
+          #   The baseline instance of the Http annotation
+          def initialize binding
+            @binding = binding
+          end
+
+          ##
+          # Whether a http verb is present for this method
+          #
+          # @return [Boolean]
+          def verb?
+            !verb.nil?
+          end
+
+          ##
+          # The http verb for this method
+          #
+          # @return [Symbol, nil]
+          def verb
+            verb_path[0] if verb_path
+          end
+
+          ##
+          # Whether a method path is present and non-empty
+          #
+          # @return [Boolean]
+          def path?
+            !path.empty?
+          end
+
+          ##
+          # A method path or an empty string if not present
+          #
+          # @return [String]
+          def path
+            return "" unless verb_path
+            verb_path[1]
+          end
+
+          ##
+          # Whether any routing params are present
+          #
+          # @return [Boolean]
+          def routing_params?
+            routing_params.any?
+          end
+
+          ##
+          # The segment key names and their corresponding paterns,
+          # including the `*` pattern implied for the named segments
+          # without pattern explicitly specified.
+          #
+          # @return [Array<Array<String>>]
+          def routing_params_with_patterns
+            @routing_params_with_patterns ||= begin
+              Gapic::UriTemplate.parse_arguments(path).map do |name, pattern|
+                [name, pattern.empty? ? "*" : pattern]
+              end
+            end
+          end
+
+          ##
+          # The segment key names.
+          #
+          # @return [Array<String>]
+          def routing_params
+            routing_params_with_patterns.map { |param, _| param }
+          end
+
+          ##
+          # Whether method has body specified in proto
+          #
+          # @return [Boolean]
+          def body?
+            !body.empty?
+          end
+
+          ##
+          # The body specified for the given method in proto
+          # or an empty string if not specified
+          #
+          # @return [String]
+          def body
+            @binding&.body || ""
+          end
+
+          private
+
+          ##
+          # The combination of verb and path found in the http annotation
+          # (or Nil if the annotation is Nil).
+          #
+          # @return [Array<Symbol, String>, Nil]
+          def verb_path
+            return nil if @binding.nil?
+
+            {
+              get:    @binding.get,
+              post:   @binding.post,
+              put:    @binding.put,
+              patch:  @binding.patch,
+              delete: @binding.delete
+            }.find { |_, value| !value.empty? }
+          end
         end
 
-        ##
-        # The segment key names.
-        #
-        # @return [Array<String>]
-        def routing_params
-          Gapic::UriTemplate.parse_arguments path
-        end
+        private
 
         ##
-        # Whether method has body specified in proto
+        # Parses http bindings from the `google.api.http` annotation, preserving order.
         #
-        # @return [Boolean]
-        def body?
-          return false if @proto_method.http.nil?
-
-          !@proto_method.http.body.empty?
-        end
-
-        ##
-        # The body specified for the given method in proto
-        # or an empty string if not specified
+        # @param http [::Google::Api::HttpRule]
+        #   The root instance of the HttpRule to parse.
         #
-        # @return [String]
-        def body
-          @proto_method.http&.body || ""
+        # @return Array<HttpBinding>
+        #  The parsed bindings.
+        def parse_bindings http
+          return [] if http.nil?
+
+          raw_binds = [http] + http.additional_bindings.to_a
+          raw_binds.map { |raw_bind| HttpBinding.new raw_bind }
         end
       end
     end

data/lib/gapic/model/method/lro.rb

@@ -14,6 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "singleton"
+
 require "gapic/path_pattern"
 
 module Gapic
@@ -55,9 +57,9 @@ module Gapic
             !f.operation_request_field.nil? && !f.operation_request_field.empty?
           end
 
-          @operation_request_fields = ops_request_fields.map do |field|
+          @operation_request_fields = ops_request_fields.to_h do |field|
             [field.name, field.operation_request_field]
-          end.to_h
+          end
         end
 
         ##
@@ -138,14 +140,15 @@ module Gapic
             ops_service_lro = api.nonstandard_lro_model_for service_full_name
             unless ops_service_lro.nonstandard_lro?
               error_text = "A service #{service_full_name} specified as a nonstandard LRO service for " \
-              "the method #{method.full_name} was not found."
+                           "the method #{method.full_name} was not found."
               raise ModelError, error_text
             end
 
             unless method.output.full_name == ops_service_lro.lro_object_full_name
               error_text = "A service #{service_full_name} specified as a nonstandard LRO service for " \
-              "the method #{method.full_name} has a different LRO object (#{ops_service_lro.lro_object_full_name}) " \
-              "from the method's return type (#{method.output.full_name})."
+                           "the method #{method.full_name} has a different LRO object " \
+                           "(#{ops_service_lro.lro_object_full_name}) from the method's return type " \
+                           "(#{method.output.full_name})."
               raise ModelError, error_text
             end
 

data/lib/gapic/model/method/routing.rb

@@ -175,8 +175,8 @@ module Gapic
             end
 
             @field_pattern = @path_pattern.simplified_pattern
-            @field_full_regex_str =  to_field_pattern @path_pattern
-            @field_regex_str = to_field_pattern Gapic::PathPattern.parse(@field_pattern)
+            @field_full_regex_str = @path_pattern.to_field_regex_str
+            @field_regex_str = Gapic::PathPattern.parse(@field_pattern).to_field_regex_str
 
             @key = resource_segment.arguments[0]
             @value_pattern = resource_segment.resource_patterns[0]
@@ -200,20 +200,6 @@ module Gapic
 
           private
 
-          # Makes a regex pattern match a field
-          # - adds markers for the beginning and end of the string
-          # - adds handling of an optional tail `/` if needed
-          # @param pattern [String]
-          # @return [String]
-          def to_field_pattern pattern
-            tail_slash_accept = if pattern.segments.last.simplified_pattern == "**"
-                                  ""
-                                else
-                                  "/?"
-                                end
-            "^#{pattern.to_regex_str}#{tail_slash_accept}$"
-          end
-
           # Converts path template simplified forms into canonical
           # ResourceId representations by adding a field as a Resource Id
           # @param template [String]
@@ -244,8 +230,7 @@ module Gapic
                        "it contains a multivariate ResourceId segment (e.g. `{foo}~{bar}`)"
                      end
 
-            "A routing header parameter with the path_template #{raw_template}\n " \
-                "is invalid: #{reason}"
+            "A routing header parameter with the path_template #{raw_template}\n is invalid: #{reason}"
           end
         end
 

data/lib/gapic/model/mixins.rb

@@ -36,9 +36,12 @@ module Gapic
       #   List of services from the  Api model
       # @param service_config [Google::Api::Service]
       #   The service config
-      def initialize api_services, service_config
+      # @param gem_name [String]
+      #   The name of the gem.
+      def initialize api_services, service_config, gem_name
         @api_services = api_services
         @service_config = service_config
+        @gem_name = gem_name
       end
 
       # @return [Boolean] Whether there are any mix-in services
@@ -50,13 +53,14 @@ module Gapic
       #   List of Mixin objects, providing the information that is needed
       #   to add the mixin service references to the generated library
       def mixins
-        @mixins ||= mixin_services.map { |service| create_mixin(service) }
+        @mixins ||= mixin_services.map { |service| create_mixin service }
       end
 
       # @return [Enumerable<String>] Full proto names of the mix-in services
       def mixin_services
-        @mixin_services ||= services_in_config.select do |service|
-          service != LRO_SERVICE && !@api_services.include?(service)
+        @mixin_services ||= begin
+          candidates = services_in_config & SERVICE_TO_DEPENDENCY.keys
+          candidates.reject { |name| SERVICE_TO_DEPENDENCY[name].include? @gem_name }
         end
       end
 
@@ -77,12 +81,21 @@ module Gapic
       # @!attribute [r] require_str
       #   Path to `require` the client of the service
       #   @return [String]
+      # @!attribute [r] require_str_rest
+      #   Path to `require` the REST client of the service
+      #   @return [String]
       # @!attribute [r] client_class_name
       #   Full name of the class of the client of the service
       #   @return [String]
+      # @!attribute [r] client_class_name_rest
+      #   Full name of the class of the REST 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_class_docname_rest
+      #   Name of the REST class as it should appear in the documentation
+      #   @return [String]
       # @!attribute [r] client_var_name
       #   Name for the variable for the client of the
       #   mixin service to use when generating library's service
@@ -91,8 +104,11 @@ module Gapic
         attr_reader :service
         attr_reader :dependency
         attr_reader :require_str
+        attr_reader :require_str_rest
         attr_reader :client_class_name
+        attr_reader :client_class_name_rest
         attr_reader :client_class_docname
+        attr_reader :client_class_docname_rest
         attr_reader :client_var_name
 
         # @param service [String]
@@ -102,17 +118,25 @@ module Gapic
         #   `{ gem_name => version pattern }` format
         # @param require_str [String]
         #   Path to require the client of the service
+        # @param require_str_rest [String]
+        #   Path to require the REST client of the service
         # @param client_class_name [String]
         #   Full name of the class of the client of the service
+        # @param client_class_name_rest [String]
+        #   Full name of the class of the REST client of the service
         # @param client_var_name [String]
         #   Name for the variable for the client of the mixin service
         #   to use when generating library's service
-        def initialize service, dependency, require_str, client_class_name, client_var_name
+        def initialize service, dependency, require_str, require_str_rest, client_class_name, client_class_name_rest,
+                       client_var_name
           @service = service
           @dependency = dependency
           @require_str = require_str
+          @require_str_rest = require_str_rest
           @client_class_name = client_class_name
+          @client_class_name_rest = client_class_name_rest
           @client_class_docname = client_class_name # For mixins, the doc name should be the full class name
+          @client_class_docname_rest = client_class_name_rest # For mixins, the doc name should be the full class name
           @client_var_name = client_var_name
         end
 
@@ -123,6 +147,21 @@ module Gapic
         end
       end
 
+      ##
+      # Returns true if the given service address is a mixin.
+      # This just checks the service against a (hard-coded) set of known mixins.
+      # If `gem_name` is provided, services that correspond to that gem_name are not considered mixins.
+      #
+      # @param service_address [String,Array<String>] The address (either array
+      #     or dot-delimited) of the service to check.
+      # @param gem_name [String] The name of the gem.
+      # @return [boolean]
+      #
+      def self.mixin_service_address? service_address, gem_name: nil
+        service_address = service_address.join "." unless service_address.is_a? String
+        MIXIN_GEM_NAMES.include?(service_address) && gem_name != MIXIN_GEM_NAMES[service_address]
+      end
+
       private
 
       # @return [Enumerable<String>] Names of all services that are specified
@@ -133,28 +172,51 @@ module Gapic
         @service_config.apis.map(&:name)
       end
 
+      MIXIN_GEM_NAMES = {
+        LOCATIONS_SERVICE => "google-cloud-location",
+        IAM_SERVICE => "google-iam-v1",
+        LRO_SERVICE => "google-longrunning-operations"
+      }.freeze
+      private_constant :MIXIN_GEM_NAMES
+
       # Since mixins are scope-limited to a couple of services, it is easier to
       # have these in lookup tables than to construct a ServicePresenter
 
       SERVICE_TO_DEPENDENCY = {
-        LOCATIONS_SERVICE => { "google-cloud-location" => "~> 0.1" },
-        IAM_SERVICE => { "google-iam-v1" => "~> 0.1" }
+        LOCATIONS_SERVICE => { "google-cloud-location" => ["~> 1.0"] },
+        IAM_SERVICE => { "google-iam-v1" => ["~> 1.3"] }
       }.freeze
+      private_constant :SERVICE_TO_DEPENDENCY
 
       SERVICE_TO_REQUIRE_STR = {
         LOCATIONS_SERVICE => "google/cloud/location",
-        IAM_SERVICE => "google/iam/v1/iam_policy"
+        IAM_SERVICE => "google/iam/v1"
+      }.freeze
+      private_constant :SERVICE_TO_REQUIRE_STR
+
+      SERVICE_TO_REQUIRE_STR_REST = {
+        LOCATIONS_SERVICE => "google/cloud/location/rest",
+        IAM_SERVICE => "google/iam/v1/rest"
       }.freeze
+      private_constant :SERVICE_TO_REQUIRE_STR_REST
 
       SERVICE_TO_CLIENT_CLASS_NAME = {
         LOCATIONS_SERVICE => "Google::Cloud::Location::Locations::Client",
         IAM_SERVICE => "Google::Iam::V1::IAMPolicy::Client"
       }.freeze
+      private_constant :SERVICE_TO_CLIENT_CLASS_NAME
+
+      SERVICE_TO_CLIENT_CLASS_NAME_REST = {
+        LOCATIONS_SERVICE => "Google::Cloud::Location::Locations::Rest::Client",
+        IAM_SERVICE => "Google::Iam::V1::IAMPolicy::Rest::Client"
+      }.freeze
+      private_constant :SERVICE_TO_CLIENT_CLASS_NAME_REST
 
       SERVICE_TO_CLIENT_ATTR_NAME = {
         LOCATIONS_SERVICE => "location_client",
         IAM_SERVICE => "iam_policy_client"
       }.freeze
+      private_constant :SERVICE_TO_CLIENT_ATTR_NAME
 
       # @param service [String] full grpc name of the service
       # @raise [ModelError]
@@ -162,8 +224,10 @@ module Gapic
       def create_mixin service
         unless SERVICE_TO_DEPENDENCY.key?(service) &&
                SERVICE_TO_REQUIRE_STR.key?(service) &&
-               SERVICE_TO_CLIENT_CLASS_NAME.key?(service)
-          SERVICE_TO_CLIENT_ATTR_NAME.key? service
+               SERVICE_TO_REQUIRE_STR_REST.key?(service) &&
+               SERVICE_TO_CLIENT_CLASS_NAME.key?(service) &&
+               SERVICE_TO_CLIENT_CLASS_NAME_REST.key?(service) &&
+               SERVICE_TO_CLIENT_ATTR_NAME.key?(service)
 
           error_text = "A mixin service #{service} is specified in service config, but " \
                        "the Generator does not know of it."
@@ -173,7 +237,9 @@ module Gapic
         Mixin.new service,
                   SERVICE_TO_DEPENDENCY[service],
                   SERVICE_TO_REQUIRE_STR[service],
+                  SERVICE_TO_REQUIRE_STR_REST[service],
                   SERVICE_TO_CLIENT_CLASS_NAME[service],
+                  SERVICE_TO_CLIENT_CLASS_NAME_REST[service],
                   SERVICE_TO_CLIENT_ATTR_NAME[service]
       end
     end

data/lib/gapic/model/service/nonstandard_lro_provider.rb

@@ -114,7 +114,6 @@ module Gapic
                        operation_err_code_field,
                        operation_err_msg_field,
                        operation_response_fields
-
           @service_full_name = service_full_name
           @polling_method_name = polling_method_name
           @lro_object_full_name = lro_object_full_name
@@ -166,11 +165,11 @@ module Gapic
           if nonstandard_lro_candidates.length.positive?
             ops_service_method = nonstandard_lro_candidates[0]
             error_text = "A service `#{service.name}` has a method annotated " \
-                        "with `polling_method` (`#{polling_method.name}`), and also a method annotated " \
-                        "with `operation_service` (`#{ops_service_method.name}`). "\
-                        "This means a grpc service tries to be a client " \
-                        "and a provider of the nonstandard LRO at the same time. " \
-                        "This is not supported."
+                         "with `polling_method` (`#{polling_method.name}`), and also a method annotated " \
+                         "with `operation_service` (`#{ops_service_method.name}`). " \
+                         "This means a grpc service tries to be a client " \
+                         "and a provider of the nonstandard LRO at the same time. " \
+                         "This is not supported."
             raise ModelError, error_text
           end
 
@@ -191,9 +190,9 @@ module Gapic
             !f.operation_response_field.nil? && !f.operation_response_field.empty?
           end
 
-          operation_response_fields = ops_response_fields.map do |field|
+          operation_response_fields = ops_response_fields.to_h do |field|
             [field.name, field.operation_response_field]
-          end.to_h
+          end
 
           NonstandardLroProvider.new service.full_name,
                                      polling_method.name,
@@ -221,7 +220,7 @@ module Gapic
           name_candidate = polling_method.output.fields.find do |f|
             f.operation_field == ops_response_field
           end
-          return name_candidate.name if name_candidate
+          name_candidate&.name
         end
 
         ##
@@ -242,7 +241,7 @@ module Gapic
           end
           if polling_method_candidates.length > 1
             error_text = "A service #{service.name} has more than one method annotated " \
-                        "with `operation_polling_method`. This should not happen."
+                         "with `operation_polling_method`. This should not happen."
             raise ModelError, error_text
           end
 
@@ -277,7 +276,7 @@ module Gapic
             raise ModelError, error_text
           end
 
-          if status_candidates.length.zero?
+          if status_candidates.empty?
             error_text = "A nonstandard LRO provider service `#{service.name}`'s " \
                          "polling method `#{polling_method.name}`'s output message " \
                          "`#{polling_method.output.name}` does not have any fields annotated " \