gapic-generator 0.6.14 → 0.7.4

data/lib/gapic/schema/api.rb

@@ -39,7 +39,8 @@ module Gapic
     #   @return [Array<Enum>] The top level enums seen across all files in
     #     this API.
     class Api
-      attr_accessor :request, :files
+      attr_accessor :request
+      attr_accessor :files
 
       # Initializes an API object with the file descriptors that represent the
       # API.
@@ -50,7 +51,7 @@ module Gapic
       #   The request parameters schema to use
       # @param error_output [IO] An IO to write any errors/warnings to.
       # @param configuration [Hash] Optional override of configuration.
-      def initialize request, parameter_schema: nil, error_output: STDERR, configuration: nil
+      def initialize request, parameter_schema: nil, error_output: $stderr, configuration: nil
         @request = request
         loader = Loader.new
         @files = request.proto_file.map do |fd|
@@ -143,11 +144,9 @@ module Gapic
       # @return [Array<Hash>]
       #   An array of the sample file hashes.
       def samples
-        @samples ||= begin
-          protoc_options["samples"].to_s.split(";").flat_map do |sample_path|
-            YAML.load_file sample_path
-          end.compact
-        end
+        @samples ||= protoc_options["samples"].to_s.split(";").flat_map do |sample_path|
+          YAML.load_file sample_path
+        end.compact
       end
 
       # Structured representation of the standalone samples configuration files.
@@ -173,10 +172,10 @@ module Gapic
       #   An array of the standalone sample configuration hashes.
       def standalone_test_samples
         @standalone_test_samples ||= begin
-          samples.select { |sample| sample["type"] == "test/samples" }
-                 .select { |sample| sample["schema_version"] == "1" || sample["schema_version"] == 1 }
-                 .map { |sample| sample["samples"] }
-                 .flatten.compact
+          test_samples = samples.select { |sample| sample["type"] == "test/samples" }
+          test_samples.select { |sample| sample["schema_version"] == "1" || sample["schema_version"] == 1 }
+                      .map { |sample| sample["samples"] }
+                      .flatten.compact
         end
       end
 
@@ -230,6 +229,24 @@ module Gapic
         configuration[:generate_path_helpers_output] ||= false
       end
 
+      # Whether to generate REST clients
+      def generate_rest_clients?
+        return false if configuration[:transports].nil?
+        configuration[:transports].include? "rest"
+      end
+
+      # Whether to generate GRPC clients
+      def generate_grpc_clients?
+        return true if configuration[:transports].nil?
+        configuration[:transports].include? "grpc"
+      end
+
+      # Whether to generate gapic metadata (drift manifest) file
+      # @return [Boolean]
+      def generate_metadata
+        configuration[:generate_metadata] ||= false
+      end
+
       # Whether the override_proto_namespaces parameter was given in the configuration
       def override_proto_namespaces_defined?
         configuration.key? :override_proto_namespaces
@@ -259,9 +276,7 @@ module Gapic
 
       # Parsed grpc service config
       def grpc_service_config
-        @grpc_service_config ||= begin
-          Gapic::GrpcServiceConfig::Parser.parse grpc_service_config_raw
-        end
+        @grpc_service_config ||= Gapic::GrpcServiceConfig::Parser.parse grpc_service_config_raw
       end
 
       # Get a resource given its type string
@@ -271,10 +286,8 @@ module Gapic
 
       # Given a service, find all common services that use it as a delegate.
       def common_services_for delegate
-        @delegate_to_common ||= begin
-          (configuration[:common_services] || {}).each_with_object({}) do |(c, d), mapping|
-            (mapping[d] ||= []) << c
-          end
+        @delegate_to_common ||= (configuration[:common_services] || {}).each_with_object({}) do |(c, d), mapping|
+          (mapping[d] ||= []) << c
         end
         all_services = services
         @delegate_to_common.fetch(delegate.address.join("."), []).map do |addr|
@@ -291,6 +304,22 @@ module Gapic
         services.find { |s| s.address == addr }
       end
 
+      ##
+      # Whether configuration has an override for the wrapper gem name
+      # @return [Boolean]
+      def wrapper_gem_name_override?
+        configuration.key?(:overrides) &&
+          configuration[:overrides].key?(:wrapper_gem_name)
+      end
+
+      ##
+      # An override for the wrapper gem name in the configuration
+      # @return [String, Nil]
+      def wrapper_gem_name_override
+        return nil unless wrapper_gem_name_override?
+        configuration[:overrides][:wrapper_gem_name]
+      end
+
       private
 
       # Perform a variety of sanity checks on the data, and prints errors to
@@ -359,7 +388,7 @@ module Gapic
       # split the string on periods, but map backslash-escaped periods to
       # literal periods.
       def parse_key str
-        str.scan(/\.|\\.|[^\.\\]+/)
+        str.scan(/\.|\\.|[^.\\]+/)
            .each_with_object([String.new]) do |tok, arr|
              if tok == "."
                arr.append String.new

data/lib/gapic/schema/parameter_schema.rb

@@ -19,7 +19,10 @@ module Gapic
     # Contains information about known parameter names
     # and the types expected to be parsed from the request options string
     class ParameterSchema
-      attr_accessor :bool_params, :string_params, :array_params, :map_params
+      attr_accessor :bool_params
+      attr_accessor :string_params
+      attr_accessor :array_params
+      attr_accessor :map_params
 
       # Creates a schema with given alias-parameter maps
       # @param bool_params [Hash{String => String}]

data/lib/gapic/schema/request_param_parser.rb

@@ -67,14 +67,13 @@ module Gapic
             param_name_input = unescape param_name_input_esc
             param_type, param_config_name = param_schema.schema_name_type_for param_name_input
 
-            if param_type == :bool && !["true", "false"].include?(unescape(value_str))
-              error_str = "WARNING: parameter #{param_name_input} (recognised as bool " \
-                                          "#{param_config_name}) will be discarded because of " \
-                                          "invalid value. Value should be either 'true' or 'false'."
-              error_output&.puts error_str
-            end
-
-            param_value = parse_param_value param_type, value_str
+            param_value = parse_validate_param_value(
+              param_type,
+              param_name_input,
+              param_config_name,
+              value_str,
+              error_output
+            )
 
             if param_value
               RequestParameter.new param_val_input_str, param_name_input_esc, value_str, param_config_name, param_value
@@ -92,13 +91,48 @@ module Gapic
 
         private
 
+        # Parses and validates param value depending on type and name
+        # @param param_type [Symbol] type of the parameter
+        # @param param_name_input [String] name of the parameter as given in the config
+        # @param param_config_name [String] canonical configuration name of the parameter
+        # @param value_str [String] string representation of parameter's value
+        # @param error_output [IO] Stream to write outputs to.
+        # @return [String,Array<String>,Hash{String => String}]
+        def parse_validate_param_value param_type, param_name_input, param_config_name, value_str, error_output
+          if param_type == :bool && !["true", "false"].include?(unescape(value_str))
+            error_str = "WARNING: parameter #{param_name_input} (recognised as bool " \
+                                          "#{param_config_name}) will be discarded because of " \
+                                          "invalid value. Value should be either 'true' or 'false'."
+            error_output&.puts error_str
+          end
+
+          param_value = parse_param_value param_type, value_str
+
+          if param_config_name == ":transports"
+            allowed_transports = ["grpc", "rest"]
+            noncompliant_values = param_value.reject { |pv| allowed_transports.include? pv }
+            if noncompliant_values.any?
+              noncompliant_values_list = noncompliant_values.join ", "
+              error_str = "WARNING: parameter #{param_name_input} (recognised as string array " \
+                                          "#{param_config_name}) will be discarded because "\
+                                          "it contains invalid values: #{noncompliant_values_list}. "\
+                                          "#{param_config_name} can only contain 'grpc' and/or 'rest' or be empty."
+              error_output&.puts error_str
+              param_value = nil
+            end
+          end
+
+          param_value
+        end
+
         # Parses param value depending on type
-        # @param param_type [Symbol]
-        # @param value_str [String]
+        # @param param_type [Symbol] type of the parameter
+        # @param value_str [String] string representation of parameter's value
         # @return [String,Array<String>,Hash{String => String}]
         def parse_param_value param_type, value_str
           case param_type
           when :array
+            return [] if value_str.empty?
             # elements in the arrays are concatenated by `;`
             # e.g. foo;bar;baz
             array_value_strings = split_by_unescaped value_str, ";"

data/lib/gapic/schema/request_parameter.rb

@@ -19,7 +19,11 @@ module Gapic
     # Encapsulates information that is parsed from a single command line parameter
     # from the plugin_opt command line
     class RequestParameter
-      attr_reader :input_str, :input_name, :input_value, :config_name, :config_value
+      attr_reader :input_str
+      attr_reader :input_name
+      attr_reader :input_value
+      attr_reader :config_name
+      attr_reader :config_value
 
       # @param input_str [String] the input string containing parameter and value
       #   that the parameter and value were parsed from

data/lib/gapic/schema/wrappers.rb

@@ -80,7 +80,11 @@ module Gapic
     #       of locations could be recorded in the future.
     class Proto
       extend Forwardable
-      attr_reader :descriptor, :address, :docs
+
+      attr_reader :descriptor
+      attr_reader :address
+      attr_reader :docs
+
       attr_accessor :parent
 
       # Initializes a Proto object.
@@ -228,6 +232,7 @@ module Gapic
     #   @ return [Enumerable<Method>] The methods of this service.
     class Service < Proto
       extend Forwardable
+
       attr_reader :methods
 
       # Initializes a Service object.
@@ -292,7 +297,9 @@ module Gapic
     #   @ return [Message] The output message of this method.
     class Method < Proto
       extend Forwardable
-      attr_reader :input, :output
+
+      attr_reader :input
+      attr_reader :output
 
       # Initializes a method object.
       # @param descriptor [Google::Protobuf::MethodDescriptorProto] the
@@ -370,7 +377,12 @@ module Gapic
     #     this file.
     class File < Proto
       extend Forwardable
-      attr_reader :messages, :enums, :services, :resources, :registry
+
+      attr_reader :messages
+      attr_reader :enums
+      attr_reader :services
+      attr_reader :resources
+      attr_reader :registry
 
       # Initializes a message object.
       # @param descriptor [Google::Protobuf::DescriptorProto] the protobuf
@@ -447,6 +459,7 @@ module Gapic
     #   @ return [EnumValue] the EnumValues contained in this file.
     class Enum < Proto
       extend Forwardable
+
       attr_reader :values
 
       # Initializes a message object.
@@ -479,17 +492,6 @@ module Gapic
     class EnumValue < Proto
       extend Forwardable
 
-      # Initializes a message object.
-      # @param descriptor [Google::Protobuf::DescriptorProto] the protobuf
-      #   representation of this service.
-      # @param address [Enumerable<String>] The address of the proto. See
-      #   #address for more info.
-      # @param docs [Google::Protobuf::SourceCodeInfo::Location] The docs
-      #   of the proto. See #docs for more info.
-      def initialize descriptor, address, docs
-        super descriptor, address, docs
-      end
-
       # @!method name
       #   @return [String] the unqualified name of the EnumValue
       # @!method number
@@ -520,7 +522,12 @@ module Gapic
     #   @ return [Enumerable<Enum>] The nested enum declarations of a message.
     class Message < Proto
       extend Forwardable
-      attr_reader :fields, :extensions, :resource, :nested_messages, :nested_enums
+
+      attr_reader :fields
+      attr_reader :extensions
+      attr_reader :resource
+      attr_reader :nested_messages
+      attr_reader :nested_enums
 
       # Initializes a message object.
       # @param descriptor [Google::Protobuf::DescriptorProto] the protobuf
@@ -583,8 +590,9 @@ module Gapic
     #      otherwise.
     class Field < Proto
       extend Forwardable
-      attr_reader :message, :enum
-      attr_writer :message, :enum
+
+      attr_accessor :message
+      attr_accessor :enum
 
       # Initializes a message object.
       # @param descriptor [Google::Protobuf::FieldDescriptorProto] the
@@ -784,7 +792,12 @@ module Gapic
     #   @return [Array<Gapic::Schema::Resource>] Parent resources
     class Resource
       extend Forwardable
-      attr_reader :descriptor, :parsed_patterns, :parsed_parent_patterns, :parent_resources
+
+      attr_reader :descriptor
+      attr_reader :parsed_patterns
+      attr_reader :parsed_parent_patterns
+      attr_reader :parent_resources
+
       attr_accessor :parent
 
       # Initializes a resource object.

data/lib/gapic/uri_template/parser.rb

@@ -25,13 +25,11 @@ module Gapic
     #   @return [Array<Segment|String>] The segments of the parsed path pattern.
     module Parser
       # @private
-      # /((?<positional>\*\*?)|{(?<name>[^\/]+?)(?:=(?<template>.+?))?})/
+      # `/(?<positional>\*\*?)|{(?<name>[^\/]+?)(?:=(?<template>.+?))?}/`
       URI_TEMPLATE = %r{
-        (
-          (?<positional>\*\*?)
-          |
-          {(?<name>[^\/]+?)(?:=(?<template>.+?))?}
-        )
+        (?<positional>\*\*?)
+        |
+        {(?<name>[^/]+?)(?:=(?<template>.+?))?}
       }x.freeze
 
       def self.parse_arguments uri_template

data/templates/default/gem/gemspec.erb

@@ -21,13 +21,13 @@ Gem::Specification.new do |gem|
                       <%= gem.extra_files.inspect %>
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 2.4"
+  gem.required_ruby_version = ">= 2.5"
 
   <%- gem.dependency_list.each do |name, requirements| -%>
   gem.add_dependency <%= name.inspect %>, <%= requirements.map { |v| v.inspect }.join ", " %>
   <%- end -%>
 
-  gem.add_development_dependency "google-style", "~> 1.24.0"
+  gem.add_development_dependency "google-style", "~> 1.25.1"
   gem.add_development_dependency "minitest", "~> 5.14"
   gem.add_development_dependency "minitest-focus", "~> 1.1"
   gem.add_development_dependency "minitest-rg", "~> 5.2"

data/templates/default/gem/readme.erb

@@ -28,11 +28,11 @@ response = client.<%= method.name %> request
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.4+.
+This library is supported on Ruby 2.5+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.4
+in security maintenance, and not end of life. Currently, this means Ruby 2.5
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.

data/templates/default/gem/rubocop.erb

@@ -8,14 +8,14 @@ AllCops:
     - "proto_docs/**/*"
     - "test/**/*"
 
+Layout/LineLength:
+  Enabled: false
 Metrics/AbcSize:
   Enabled: false
 Metrics/ClassLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
 Metrics/MethodLength:
   Enabled: false
 Metrics/ModuleLength:
@@ -25,13 +25,3 @@ Metrics/PerceivedComplexity:
 Naming/FileName:
   Exclude:
     - "lib/<%= gem.name %>.rb"
-Naming/PredicateName:
-  Enabled: false
-Style/AsciiComments:
-  Enabled: false
-Style/CaseEquality:
-  Enabled: false
-Style/IfUnlessModifier:
-  Enabled: false
-Style/ModuleFunction:
-  Enabled: false

data/templates/default/lib/_package.erb

@@ -6,13 +6,23 @@ require "<%= service.service_require %>"
 require "<%= package.gem.version_require %>"
 <% end %>
 <%- unless package.empty? -%>
+<%- if package.services.first.generate_grpc_clients? -%>
 ##
-# To load this package, including all its services, and instantiate a client:
+# To load this package, including all its services, and instantiate a <%= package.grpc_client_designation %>:
 #
 #     require "<%= package.package_require %>"
 #     client = <%= package.services.first.create_client_call %>
 #
 <%- end -%>
+<%- if package.services.first.generate_rest_clients? -%>
+##
+# To load this package, including all its services, and instantiate a REST client:
+#
+#     require "<%= package.package_require %>"
+#     client = <%= package.services.first.rest.create_client_call %>
+#
+<%- end -%>
+<%- end -%>
 module <%= package.module_name %>
 end
 <% @footer = capture do %>

data/templates/default/lib/_service.erb

@@ -1,4 +1,21 @@
 <%- assert_locals service -%>
+
+<%- if service.generate_rest_clients? -%>
+<% @requires = capture do %>
+require "gapic/config"
+require "gapic/config/method"
+
+require "<%= service.gem.version_require %>"
+
+<%- unless service.generic_endpoint? -%>
+require "<%= service.credentials_require %>"
+<%- end -%>
+<%- if service.paths? -%>
+require "<%= service.paths_require %>"
+<%- end -%>
+require "<%= service.rest.service_rest_require %>"
+<% end %>
+<%- else -%>
 <% @requires = capture do %>
 require "gapic/common"
 require "gapic/config"
@@ -22,13 +39,26 @@ require "<%= service.client_require %>"
 <%= indent service.doc_description, "# " %>
 #
 <%- end -%>
-# To load this service and instantiate a client:
+<%- end -%>
+<%- if service.generate_grpc_clients? -%>
+# To load this service and instantiate a <%= service.grpc_client_designation %>:
 #
 #     require "<%= service.service_require %>"
 #     client = <%= service.create_client_call %>
 #
+<%- end -%>
+<%- if service.generate_rest_clients? -%>
+# To load this service and instantiate a REST client:
+#
+#     require "<%= service.service_require %>"
+#     client = <%= service.rest.create_client_call %>
+#
+<%- end -%>
 module <%= service.module_name %>
 end
+
+
+
 <% @footer = capture do %>
 <%= render partial: "service/helpers", locals: { service: service} -%>
 <% end %>