gapic-generator 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f7df8b22a84359c27f6074aee1ac25ebdddf7838b8e420a908f9381df4c3217
-  data.tar.gz: dc71fcaf60829fed44ceca3bc9d878a2d6d0787a2e01be0dfbc42d9693ebe6d1
+  metadata.gz: 5c8a401f416529802324b86833c5c3a9fcef01afd699439053ce868a7862c5c8
+  data.tar.gz: 6f794cc05eb33a4c201bdcc62dc62524406ae2fb003f0b2d9c536482517a4109
 SHA512:
-  metadata.gz: cf3382a6c2303247e82b69030eead4bd8f97101b95d34ce00b043d4036ad95eafcd0688e5e79fcea93264d294f530f4453dc5138c73ed76aa1a1e01d273fb666
-  data.tar.gz: 361aa578ba1afdc3fe27d7b617c36926b77458b48a080d03d0f568c9d2a60cb2410a6aa2870acb874a2c963ebed26f8c9e811ba2006473175cf83e02e6ee1ad7
+  metadata.gz: 536731d9a866b0c58540b6eb6f62469eef75f10f82a9fba3c45e0e5a2c5d08b7f5b97b0b385b3e6063e418e0faba687faf45c44cc700ab69da554c9d28a46049
+  data.tar.gz: c1b99ad4ebfae8c4085522924ba4fd11f1a2628b67d64dfc549f22df40aadf5d79ae127bcac73ca5fe2795937f29556b6f656d5b86c66aaef43c78ec644b6772

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Release History for gapic-generator
 
+### 0.8.0 / 2021-06-16
+
+* Initial implementation of standalone snippet generation.
+* Updated gapic-common dependencies to require at least 0.5 and to support future 1.x versions.
+* Generated unit tests for REST clients.
+* Generated proper x-goog-api-client headers for REST clients.
+* Added generation arguments to generated repo metadata.
+* Allow multiple versions in the extra-dependency command line argument.
+* Fixed treatment of boolean-valued command line arguments to the generator.
+* Fixed behavior of wrapper-gem-override if given an empty value.
+* Fixed default env_prefix computation to avoid the version part of the proto namespace.
+* Fixed Bazel front-end to preserve file permissions.
+
+### 0.7.5 / 2021-05-18
+
+* Bazel jobs now provide a prebuilt ruby binary.
+* Fixed generated indentation for a few cases, by updating to Rubocop 1.15.
+* Added library_type to generated repo metadata files.
+
+### 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.
+
+### 0.7.1 / 2021-02-27
+
+* Update generated readmes to reflect that Ruby 2.5 or later is now required.
+
 ### 0.7.0 / 2021-02-27
 
 * Update minimum Ruby version to 2.5 for generated libraries.

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/gapic/generators/default_generator.rb

@@ -54,13 +54,24 @@ 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/rest/test/client.erb",       "test/#{service.rest.test_client_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?
+
+            if @api.generate_standalone_snippets?
+              service.methods.each do |method|
+                snippet = method.snippet
+                files << g("snippets/standalone.erb", "snippets/#{snippet.snippet_file_path}", snippet: snippet)
+              end
+            end
           end
         end
 
@@ -77,7 +88,9 @@ 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
+
+        files << g("snippets/gemfile.erb",          "snippets/Gemfile",             gem: gem) if @api.generate_standalone_snippets?
 
         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,13 @@ 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"
+require "gapic/presenters/snippet_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
@@ -124,7 +127,11 @@ module Gapic
       end
 
       def env_prefix
-        (gem_config(:env_prefix) || name.split("-").last).upcase
+        prefix = gem_config(:env_prefix) || begin
+          segs = name.split("-").reverse
+          segs.find { |seg| seg !~ /^v\d/ } || segs.first || "UNKNOWN"
+        end
+        prefix.upcase
       end
 
       def iam_dependency?
@@ -153,18 +160,26 @@ module Gapic
         gem_config :issue_tracker_url
       end
 
+      ##
+      # @return [Boolean]
+      #
       def free_tier?
-        # Default to false unless the config is explicitly set to "true"
-        gem_config(:free_tier) == "true"
+        gem_config(:free_tier) || false
       end
 
+      ##
+      # @return [Boolean]
+      #
       def yard_strict?
         # Default to true unless the config is explicitly set to "false"
-        gem_config(:yard_strict) != "false"
+        gem_config(:yard_strict).nil? || gem_config(:yard_strict)
       end
 
+      ##
+      # @return [Boolean]
+      #
       def generic_endpoint?
-        gem_config(:generic_endpoint) == "true"
+        gem_config(:generic_endpoint) || false
       end
 
       def entrypoint_require
@@ -180,11 +195,13 @@ module Gapic
       end
 
       def dependencies
-        deps = { "gapic-common" => "~> 0.3" }
-        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
-        deps
+        @dependencies ||= begin
+          deps = { "gapic-common" => [">= 0.5", "< 2.a"] }
+          deps["grpc-google-iam-v1"] = [">= 0.6.10", "< 2.a"] if iam_dependency?
+          extra_deps = gem_config_dependencies
+          deps.merge! extra_deps if extra_deps
+          deps
+        end
       end
 
       def dependency_list
@@ -222,6 +239,26 @@ module Gapic
         @api.configuration[:gem][key]
       end
 
+      ##
+      # There is a special case (from PoV of generator parameters)
+      # in gem dependencies where a dependency needs to be an array of strings
+      # e.g. ">= 1.6", "< 2.a"
+      # Rather than creating a special generator param case for this I will special-case it here.
+      # '|' is the separator.
+      # The above would be represented as ">= 1.6|< 2.a"
+      #
+      # @return [Hash<String, String>, Hash{String=>Array<String>}, nil]
+      def gem_config_dependencies
+        return unless gem_config :extra_dependencies
+        gem_config(:extra_dependencies).map do |dep_name, dep_versions|
+          if dep_versions.include? "|"
+            [dep_name, dep_versions.split("|")]
+          else
+            [dep_name, dep_versions]
+          end
+        end.to_h
+      end
+
       def blacklist_protos
         blacklist = gem_config :blacklist
 

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,16 +26,34 @@ 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
 
+      def snippet
+        SnippetPresenter.new self, @api
+      end
+
       def name
         @name ||= begin
           candidate = ActiveSupport::Inflector.underscore @method.name
@@ -195,15 +212,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 +236,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 +298,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,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