gapic-generator 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b183bf887e0c6df34d3374b75524ff8b1d4fc55cad3d54951de36fa3a9c58072
-  data.tar.gz: 1026bc4ec2ec151a363ce30ff75d7b37324d1f438ef44746ceaede0b482a1901
+  metadata.gz: 521fdaba6a16a4e80df5aff2ea8c8de3d1edbd8800faae175f0b906f3990b369
+  data.tar.gz: 013d293b84fc4bd68ef5ca12ff7bb5e375889b90df6f4ec58f10a7f995329ac3
 SHA512:
-  metadata.gz: 8451fc41ccc52620ed922d0e75c734f824f6f7c411402697332083554598e4add7c65dbd1edd6b1d6692b11b04aceb216f23bb3de96ebc0730334be8433dbeac
-  data.tar.gz: 46cc19f65b3f4c6de7ceda0af826828a94ab635ad673d94cc4df5a13c17f0055b43f4b62ff6e3ac0cc22c6f22edce88e88129e5368bf26c87b6fa189017dac4d
+  metadata.gz: f59f4c117eb0fccd24a79cfb34c3995e6bbaa1dfa242b10673551cb5a73cc2feaebc09ff735e1411846a1fb42560a3094d8475d016966eb30c143a47efab9d6e
+  data.tar.gz: 6b46bba4dc50049901472aa123b7292f47495607d84b94f2c819703bdd82c0d5e61b3f9d073ac33380314d63e16bf20d135f13e35c05fdbb24d22020efb28c98

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release History for gapic-generator
 
+### 0.7.4 / 2021-05-07
+
+* Fixed the broken link in the generated libraries' README.md
+* Generated libraries with REST transport now use presense testing instead of rejecting defaults to determine which fields to transcode into the query string parameters
+
+### 0.7.3 / 2021-03-24
+    
+* Fixed gapic metadata (drift manifest) generation
+* Gapic metadata generation is disabled by default in gapic-generator
+    (enabled by default in gapic-generator-cloud)
+* Can now generate libraries with REST transport in addition to GRPC
+* gapic-common 0.4 is the default version for the generated libraries now (was 0.3)
+    (required for the generated libraries with the REST transport) 
+
 ### 0.7.2 / 2021-03-05
 
 * No changes.

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.7.2"
+    VERSION = "0.7.4"
   end
 end

data/lib/gapic/generators/default_generator.rb

@@ -54,13 +54,16 @@ module Gapic
           package.services.each do |service|
             # Service level files
             files << g("service.erb",                        "lib/#{service.service_file_path}",                 service: service)
-            files << g("service/client.erb",                 "lib/#{service.client_file_path}",                  service: service)
+            files << g("service/rest.erb",                   "lib/#{service.rest.service_rest_file_path}",       service: service) if @api.generate_rest_clients? and service.methods_rest_bindings?
+            files << g("service/client.erb",                 "lib/#{service.client_file_path}",                  service: service) unless @api.generate_rest_clients?
             files << g("service/credentials.erb",            "lib/#{service.credentials_file_path}",             service: service) unless gem.generic_endpoint?
             files << g("service/paths.erb",                  "lib/#{service.paths_file_path}",                   service: service) if service.paths?
-            files << g("service/operations.erb",             "lib/#{service.operations_file_path}",              service: service) if service.lro?
-            files << g("service/test/client.erb",            "test/#{service.test_client_file_path}",            service: service)
+            files << g("service/operations.erb",             "lib/#{service.operations_file_path}",              service: service) if service.lro? && !@api.generate_rest_clients?
+            files << g("service/rest/client.erb",            "lib/#{service.rest.client_file_path}",             service: service) if @api.generate_rest_clients? and service.methods_rest_bindings?
+            files << g("service/rest/grpc_transcoding.erb",  "lib/#{service.rest.transcoding_helper_file_path}", service: service) if @api.generate_rest_clients? and service.methods_rest_bindings?
+            files << g("service/test/client.erb",            "test/#{service.test_client_file_path}",            service: service) unless @api.generate_rest_clients?
             files << g("service/test/client_paths.erb",      "test/#{service.test_paths_file_path}",             service: service) if service.paths?
-            files << g("service/test/client_operations.erb", "test/#{service.test_client_operations_file_path}", service: service) if service.lro?
+            files << g("service/test/client_operations.erb", "test/#{service.test_client_operations_file_path}", service: service) if service.lro? && !@api.generate_rest_clients?
           end
         end
 
@@ -77,7 +80,7 @@ module Gapic
         files << g("gem/yardopts.erb",              ".yardopts",                    gem: gem)
         files << g("gem/license.erb",               "LICENSE.md",                   gem: gem)
         files << g("gem/entrypoint.erb",            "lib/#{gem.name}.rb",           gem: gem)
-        files << g("gem/gapic_metadata_json.erb",   "gapic_metadata.json",          gem: gem)
+        files << g("gem/gapic_metadata_json.erb",   "gapic_metadata.json",          gem: gem) if @api.generate_metadata
 
         gem.proto_files.each do |proto_file|
           files << g("proto_docs/proto_file.erb", "proto_docs/#{proto_file.docs_file_path}", file: proto_file)

data/lib/gapic/generators/default_generator_parameters.rb

@@ -23,7 +23,8 @@ module Gapic
       BOOL_PARAMETERS = [
         ":gem.:free_tier",
         ":gem.:yard_strict",
-        ":gem.:generic_endpoint"
+        ":gem.:generic_endpoint",
+        ":generate_metadata"
       ].freeze
 
       STRING_PARAMETERS = [
@@ -42,11 +43,13 @@ module Gapic
         ":gem.:api_shortname",
         ":gem.:factory_method_suffix",
         ":defaults.:service.:default_host",
-        "grpc_service_config"
+        "grpc_service_config",
+        ":overrides.:wrapper_gem_name"
       ].freeze
 
       ARRAY_PARAMETERS = [
-        ":defaults.:service.:oauth_scopes"
+        ":defaults.:service.:oauth_scopes",
+        ":transports"
       ].freeze
 
       MAP_PARAMETERS = [
@@ -83,7 +86,8 @@ module Gapic
       }.freeze
 
       ARRAY_PARAMETERS_ALIASES = {
-        "default-oauth-scopes" => ":defaults.:service.:oauth_scopes"
+        "default-oauth-scopes" => ":defaults.:service.:oauth_scopes",
+        "transports" => ":transports"
       }.freeze
 
       MAP_PARAMETERS_ALIASES = {

data/lib/gapic/presenters.rb

@@ -21,10 +21,12 @@ require "gapic/presenters/file_presenter"
 require "gapic/presenters/gem_presenter"
 require "gapic/presenters/message_presenter"
 require "gapic/presenters/method_presenter"
+require "gapic/presenters/method_rest_presenter"
 require "gapic/presenters/package_presenter"
 require "gapic/presenters/resource_presenter"
 require "gapic/presenters/sample_presenter"
 require "gapic/presenters/service_presenter"
+require "gapic/presenters/service_rest_presenter"
 
 module Gapic
   ##

data/lib/gapic/presenters/field_presenter.rb

@@ -88,6 +88,10 @@ module Gapic
         @field.repeated?
       end
 
+      def required?
+        @field.required?
+      end
+
       def map?
         @field.map?
       end
@@ -100,6 +104,34 @@ module Gapic
         @message.oneof_decl[@field.oneof_index].name
       end
 
+      ##
+      # Returns a stringified default value for the protobuf types
+      # that are possible to fit into the query string parameter
+      # and nil for the other types (e.g. Messages)
+      #
+      # @return [String, nil]
+      #
+      def default_value_for_type
+        if @field.message?
+          nil
+        elsif @field.enum?
+          ":#{@field.enum.values.first.name}"
+        else
+          case @field.type
+          when 1, 2, 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "0" # floating point or integer
+          when 9, 12                                   then "\"\""
+          when 8                                       then "false"
+          end
+        end
+      end
+
+      ##
+      # Name of this field, camel-cased
+      # @return [String]
+      def camel_name
+        camel_name_for name
+      end
+
       protected
 
       def field_doc_types field, output
@@ -161,6 +193,18 @@ module Gapic
       def message_ruby_type message
         ruby_namespace @api, message.address.join(".")
       end
+
+      ##
+      # Converts a snake_case parameter name into camelCase for query string parameters
+      # @param attr_name [String]
+      # @return [String] camel-cased parameter name
+      def camel_name_for attr_name
+        parts = attr_name.split "_"
+        first_part = parts[0]
+        other_parts = parts[1..-1]
+        other_parts_pascal = other_parts.map(&:capitalize).join
+        "#{first_part}#{other_parts_pascal}"
+      end
     end
   end
 end

data/lib/gapic/presenters/gem_presenter.rb

@@ -32,6 +32,9 @@ module Gapic
         @api = api
       end
 
+      ##
+      # @return [Enumerable<Gapic::Presenters::PackagePresenter>]
+      #
       def packages
         @packages ||= begin
           packages = @api.generate_files.map(&:package).uniq.sort
@@ -180,7 +183,7 @@ module Gapic
       end
 
       def dependencies
-        deps = { "gapic-common" => "~> 0.3" }
+        deps = { "gapic-common" => "~> 0.4" }
         deps["grpc-google-iam-v1"] = [">= 0.6.10", "< 2.0"] if iam_dependency?
         extra_deps = gem_config :extra_dependencies
         deps.merge! extra_deps if extra_deps

data/lib/gapic/presenters/method_presenter.rb

@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require "active_support/inflector"
-require "gapic/uri_template"
 require "gapic/ruby_info"
 require "gapic/helpers/namespace_helper"
 
@@ -27,12 +26,26 @@ module Gapic
     class MethodPresenter
       include Gapic::Helpers::NamespaceHelper
 
+      # @return [Gapic::Schema::Method]
+      attr_accessor :method
+
+      # @return [Gapic::Presenters::MethodRestPresenter]
+      attr_accessor :rest
+
+      ##
+      # @param service_presenter [Gapic::Presenters::ServicePresenter]
+      # @param api [Gapic::Schema::Api]
+      # @param method [Gapic::Schema::Method]
       def initialize service_presenter, api, method
         @service_presenter = service_presenter
         @api = api
         @method = method
+        @rest = MethodRestPresenter.new self
       end
 
+      ##
+      # @return [Gapic::Presenters::ServicePresenter]
+      #
       def service
         @service_presenter
       end
@@ -195,15 +208,17 @@ module Gapic
       end
 
       ##
-      #
       # @return [Array<String>] The segment key names.
       #
       def routing_params
-        Gapic::UriTemplate.parse_arguments method_path
+        rest.routing_params
       end
 
+      ##
+      # @return [Boolean] Whether any routing params are present
+      #
       def routing_params?
-        routing_params.any?
+        rest.routing_params?
       end
 
       def grpc_service_config
@@ -217,6 +232,19 @@ module Gapic
         @method.name
       end
 
+      ##
+      # Returns a hash with a drift_manifest of this rpc method
+      # describing correspondence between the proto description
+      # of the rpc with the generated code for the method.
+      # For ruby currently [03/2021] only one method is generated per RPC,
+      # so the correspondence is very basic.
+      # See https://github.com/googleapis/googleapis/blob/master/gapic/metadata/gapic_metadata.proto
+      #
+      # @return [Hash]
+      def drift_manifest
+        { methods: [name] }
+      end
+
       protected
 
       def message_ruby_type message
@@ -266,18 +294,6 @@ module Gapic
         end
       end
 
-      def method_path
-        return "" if @method.http.nil?
-
-        method = [
-          @method.http.get, @method.http.post, @method.http.put,
-          @method.http.patch, @method.http.delete
-        ].find { |x| !x.empty? }
-        return method unless method.nil?
-
-        return @method.http.custom.path unless @method.http.custom.nil?
-      end
-
       def paged_request? request
         page_token = request.fields.find do |f|
           f.name == "page_token" && f.type == Google::Protobuf::FieldDescriptorProto::Type::TYPE_STRING

data/lib/gapic/presenters/method_rest_presenter.rb

@@ -0,0 +1,186 @@
+# 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
+
+      ##
+      # 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 == "*"
+
+        "#{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?
+
+        routing_params_set = routing_params.to_set
+        @main_method.arguments
+                    .reject { |arg| routing_params_set.include? 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