gapic-generator 0.6.14 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f60a6a6ecef9fec2b409d2315e747ad7684917ddf2dfcd170c65bc27c75c97c2
-  data.tar.gz: 1cc2af07ea8cb245160cc449a5c268310ee362a4239b268aff2be4f0ef63ae9c
+  metadata.gz: 521fdaba6a16a4e80df5aff2ea8c8de3d1edbd8800faae175f0b906f3990b369
+  data.tar.gz: 013d293b84fc4bd68ef5ca12ff7bb5e375889b90df6f4ec58f10a7f995329ac3
 SHA512:
-  metadata.gz: b3c156a63cdb3241cfbd0cf4a470c795a103d749e2502a73bdc215961797636bcbc89aa7152678527e0d36d380c54ac1ca765c30761e7fe77ad7f19889bac7f3
-  data.tar.gz: 789d09c785b46936121d3b9373abcb14cfdedd72ae684a36bf37336209be9a697f03087226ab276c48b67238ea7cc6508c3957cb2eb9d60fb4e75a9c3e6b1552
+  metadata.gz: f59f4c117eb0fccd24a79cfb34c3995e6bbaa1dfa242b10673551cb5a73cc2feaebc09ff735e1411846a1fb42560a3094d8475d016966eb30c143a47efab9d6e
+  data.tar.gz: 6b46bba4dc50049901472aa123b7292f47495607d84b94f2c819703bdd82c0d5e61b3f9d073ac33380314d63e16bf20d135f13e35c05fdbb24d22020efb28c98

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # 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.
+
+### 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.
+* Update supported Rubocop to 1.x for generated libraries.
+
+### 0.6.15 / 2021-02-22
+
+* Really fixed encoding arguments in executable entrypoints
+
 ### 0.6.14 / 2021-02-22
 
 * Fixed encoding arguments in executable entrypoints

data/bin/protoc-gen-ruby_gapic

@@ -1,4 +1,4 @@
-#!/usr/bin/env -S ruby --encoding UTF-8
+#!/usr/bin/env -S ruby -EUTF-8
 # frozen_string_literal: true
 
 # Copyright 2018 Google LLC
@@ -15,19 +15,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-$LOAD_PATH.unshift ::File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift ::File.expand_path("../lib", __dir__)
 require "gapic/runner"
 require "google/protobuf/compiler/plugin.pb"
 
 # Ensure that no encoding conversions are done on STDIN and STDOUT
 # since we are passing binary data back and forth. Otherwise these
 # streams will be mangled on Windows.
-STDIN.binmode
-STDOUT.binmode
+$stdin.binmode
+$stdout.binmode
 
-request = Google::Protobuf::Compiler::CodeGeneratorRequest.decode STDIN.read
+request = Google::Protobuf::Compiler::CodeGeneratorRequest.decode $stdin.read
 
 # Run the request
 response = Gapic::Runner.run request
 
-STDOUT.print response.serialize
+$stdout.print response.serialize

data/lib/gapic/file_formatter.rb

@@ -21,7 +21,8 @@ module Gapic
   ##
   # File Formatter
   class FileFormatter
-    attr_reader :configuration, :files
+    attr_reader :configuration
+    attr_reader :files
 
     ##
     # Create a new file formatter object

data/lib/gapic/formatting_utils.rb

@@ -21,9 +21,9 @@ module Gapic
   # Various string formatting utils
   #
   module FormattingUtils
-    @brace_detector = /\A(?<pre>[^`]*(`[^`]*`[^`]*)*[^`\\])?\{(?<inside>[^\s][^}]*)\}(?<post>.*)\z/m
-    @xref_detector = /\A(?<pre>[^`]*(`[^`]*`[^`]*)*)?\[(?<text>[\w\. `-]+)\]\[(?<addr>[\w\.]+)\](?<post>.*)\z/m
-    @list_element_detector = /\A\s*(\*|\+|-|[0-9a-zA-Z]+\.)\s/
+    @brace_detector = /\A(?<pre>[^`]*(?:`[^`]*`[^`]*)*[^`\\])?\{(?<inside>[^\s][^}]*)\}(?<post>.*)\z/m
+    @xref_detector = /\A(?<pre>[^`]*(?:`[^`]*`[^`]*)*)?\[(?<text>[\w. `-]+)\]\[(?<addr>[\w.]+)\](?<post>.*)\z/m
+    @list_element_detector = /\A\s*(?:\*|\+|-|[0-9a-zA-Z]+\.)\s/
     @omit_lines = ["@InputOnly\n", "@OutputOnly\n"]
 
     class << self
@@ -76,7 +76,7 @@ module Gapic
       def format_number value
         return value.to_s if value.abs < 10_000
         str = value.is_a?(Integer) ? value.to_s : BigDecimal(value.to_f.to_s).to_s("F")
-        re = /^(-?\d+)(\d\d\d)([_\.][_\.\d]+)?$/
+        re = /^(-?\d+)(\d\d\d)([_.][_.\d]+)?$/
         while (m = re.match str)
           str = "#{m[1]}_#{m[2]}#{m[3]}"
         end

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.6.14"
+    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/grpc_service_config/method_config.rb

@@ -23,7 +23,8 @@ module Gapic
     # client-side timeout/retry policy
     #
     class MethodConfig
-      attr_reader :timeout_seconds, :retry_policy
+      attr_reader :timeout_seconds
+      attr_reader :retry_policy
 
       ##
       # Create new MethodConfig

data/lib/gapic/grpc_service_config/retry_policy.rb

@@ -21,7 +21,10 @@ module Gapic
     # for the GRPC method invocation. It is embedded into the MethodConfig
     #
     class RetryPolicy
-      attr_reader :initial_delay_seconds, :max_delay_seconds, :multiplier, :status_codes
+      attr_reader :initial_delay_seconds
+      attr_reader :max_delay_seconds
+      attr_reader :multiplier
+      attr_reader :status_codes
 
       ##
       # Create new ParsedRetryPolicy.

data/lib/gapic/grpc_service_config/service_config.rb

@@ -22,7 +22,8 @@ module Gapic
     # applied to the specific methods
     #
     class ServiceConfig
-      attr_reader :service_level_configs, :service_method_level_configs
+      attr_reader :service_level_configs
+      attr_reader :service_method_level_configs
 
       ##
       # Create new ServiceConfig.

data/lib/gapic/path_pattern/parser.rb

@@ -87,7 +87,7 @@ module Gapic
       # @private
       def self.try_capture_complex_resource_id_segment url_pattern
         complex_resource_id_regex =
-          %r/^(?<segment_pattern>{(?<name_first>[^\/}]+?)}(?:(?<separator>[_\-~\.]){(?<name_seq>[^\/}]+?)})+)(?:\/|$)/
+          %r/^(?<segment_pattern>{(?<name_first>[^\/}]+?)}(?:(?<separator>[_\-~.]){(?<name_seq>[^\/}]+?)})+)(?:\/|$)/
 
         return nil, url_pattern unless complex_resource_id_regex.match? url_pattern
 

data/lib/gapic/path_pattern/pattern.rb

@@ -29,7 +29,8 @@ module Gapic
     #   @return [Array<PositionalSegment|ResourceIdSegment|CollectionIdSegment>]
     #     The parsed segments of the path pattern
     class Pattern
-      attr_reader :path_pattern, :segments
+      attr_reader :path_pattern
+      attr_reader :segments
 
       def initialize path_pattern, segments
         @path_pattern = path_pattern

data/lib/gapic/path_pattern/segment.rb

@@ -29,7 +29,10 @@ module Gapic
     #   @return [String] The pattern of the segment, for the positional segment it is also
     #     a pattern of its resource
     class PositionalSegment
-      attr_reader :type, :position, :pattern
+      attr_reader :type
+      attr_reader :position
+      attr_reader :pattern
+
       def initialize position, pattern
         @type       = :positional
         @position   = position
@@ -117,7 +120,10 @@ module Gapic
     #   @return [Array<String>] The resource patterns associated with
     #     the resource_names of this segment
     class ResourceIdSegment
-      attr_reader :type, :pattern, :resource_names, :resource_patterns
+      attr_reader :type
+      attr_reader :pattern
+      attr_reader :resource_names
+      attr_reader :resource_patterns
 
       def initialize type, pattern, resource_names, resource_patterns = []
         @type              = type
@@ -216,7 +222,8 @@ module Gapic
     #   @return [String] The pattern of the segment, for the positional segment it is also
     #     a pattern of its resource
     class CollectionIdSegment
-      attr_reader :type, :pattern
+      attr_reader :type
+      attr_reader :pattern
 
       def initialize pattern
         @type     = :collection_id

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