gapic-generator 0.4.0 → 0.6.1

data/lib/gapic/schema/api.rb

@@ -91,6 +91,13 @@ module Gapic
         configuration[:overrides][:namespace].fetch str, str
       end
 
+      def fix_service_name str
+        str = String str
+        return str if configuration[:overrides].nil?
+        return str if configuration[:overrides][:service].nil?
+        configuration[:overrides][:service].fetch str, str
+      end
+
       def generate_files
         @files.select(&:generate?)
       end

data/lib/gapic/schema/wrappers.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require "gapic/formatting_utils"
+require "gapic/path_pattern"
 
 module Gapic
   module Schema
@@ -761,30 +762,32 @@ module Gapic
     #   @return [Array<Gapic::Schema::ResourceDescriptor>] The resource
     #     descriptor.
     # @!attribute [r] parsed_patterns
-    #   @return [Array<Array<String>>] The normalized, segmented forms of the
-    #     patterns. Normalized means all ID segments are replaced by asterisks
+    #   @return [Array<String>] The template form of the
+    #     patterns. Template means all ID segments are replaced by asterisks
     #     to remove non-structural differences due to different names being
-    #     used. Segmented means simply split on slashes.
+    #     used.
     #     For example, if a pattern is `"projects/{project}""`, the
-    #     corresponding parsed pattern would be `["projects", "*"]`.
+    #     corresponding parsed pattern would be `"projects/*"]`.
+    # @!attribure [r] parsed_parent_patterns
+    #   return [Array<String>] Parsed patterns for the expected parents.
     # @!attribute [r] parent_resources
     #   @return [Array<Gapic::Schema::Resource>] Parent resources
     class Resource
       extend Forwardable
-      attr_reader :descriptor, :parsed_patterns, :parent_resources
+      attr_reader :descriptor, :parsed_patterns, :parsed_parent_patterns, :parent_resources
       attr_accessor :parent
 
       # Initializes a resource object.
-      # @param descriptor [Google::Protobuf::ResourceDescriptor] the protobuf
+      # @param descriptor [Google::Api::ResourceDescriptor] the protobuf
       #   representation of this resource.
       def initialize descriptor
         @parent = nil
         @descriptor = descriptor
-        @parsed_patterns = descriptor.pattern.map do |pattern|
-          pattern.split("/").map do |segment|
-            segment =~ %r{\{[^/\}]+(=[^\}]+)?\}} ? "*" : segment
-          end.freeze
+        patterns = descriptor.pattern.map do |pattern|
+          Gapic::PathPattern.parse pattern
         end.freeze
+        @parsed_patterns = patterns.map(&:template).compact.uniq.freeze
+        @parsed_parent_patterns = patterns.map(&:parent_template).compact.uniq.freeze
         @parent_resources = []
       end
 
@@ -800,15 +803,6 @@ module Gapic
         parent&.containing_file
       end
 
-      # Returns parsed patterns for the expected parents.
-      # @return [Array<Array<String>>]
-      def parsed_parent_patterns
-        @parsed_patterns.map do |pat|
-          parent = pat.last =~ /^\*\*?$/ ? pat[0...-2] : pat[0...-1]
-          parent.empty? ? nil : parent
-        end.compact.uniq
-      end
-
       # @!method type
       #   @return [String] the resource type string.
       # @!method pattern

data/lib/gapic/uri_template.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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/parser"
+
+module Gapic
+  # TODO: Enter docs
+  # Dooooooooocs!!!
+  module UriTemplate
+    # Parse arguments from a URI template.
+    # @see https://tools.ietf.org/html/rfc6570 URI Template
+    #
+    # used to satisfy AIP-4222 Routing headers
+    # @see https://google.aip.dev/client-libraries/4222
+    #
+    # @param uri_template [String] The URI template to be parsed.
+    #
+    # @return [Array<String>] The arguments of the URI template.
+    def self.parse_arguments uri_template
+      Parser.parse_arguments uri_template
+    end
+  end
+end

data/lib/gapic/uri_template/parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+module Gapic
+  module UriTemplate
+    # A URI template parser.
+    # see https://tools.ietf.org/html/rfc6570 URI Template
+    #
+    # @!attribute [r] path_pattern
+    #   @return [String] The path pattern to be parsed.
+    # @!attribute [r] segments
+    #   @return [Array<Segment|String>] The segments of the parsed path pattern.
+    module Parser
+      # @private
+      # /((?<positional>\*\*?)|{(?<name>[^\/]+?)(?:=(?<template>.+?))?})/
+      URI_TEMPLATE = %r{
+        (
+          (?<positional>\*\*?)
+          |
+          {(?<name>[^\/]+?)(?:=(?<template>.+?))?}
+        )
+      }x.freeze
+
+      def self.parse_arguments uri_template
+        arguments = []
+
+        while (match = URI_TEMPLATE.match uri_template)
+          # The String before the match needs to be added to the segments
+          arguments << match[:name] if match[:name]
+          uri_template = match.post_match
+        end
+
+        arguments
+      end
+    end
+  end
+end

data/templates/default/gem/gemfile.erb

@@ -2,3 +2,6 @@
 source "https://rubygems.org"
 
 gemspec
+
+# google-protobuf 3.12.0 requires Ruby 2.5 or later, so pin to 3.11 on older Rubies
+gem "google-protobuf", (RUBY_VERSION < "2.5" ? "~> 3.11.4" : "~> 3.12")

data/templates/default/gem/gemspec.erb

@@ -12,24 +12,25 @@ Gem::Specification.new do |gem|
   gem.description   = <%= gem.description.inspect %>
   gem.summary       = <%= gem.summary.inspect %>
   gem.homepage      = <%= gem.homepage.inspect %>
-  gem.license       = "MIT"
+  gem.license       = <%= gem.license_name.inspect %>
 
   gem.platform      = Gem::Platform::RUBY
 
   gem.files         = `git ls-files -- lib/*`.split("\n") +
                       `git ls-files -- proto_docs/*`.split("\n") +
-                      ["README.md", "LICENSE.md", ".yardopts"]
+                      <%= gem.extra_files.inspect %>
   gem.require_paths = ["lib"]
 
   gem.required_ruby_version = ">= 2.4"
 
-  gem.add_dependency "gapic-common", "~> 0.2"
-  <%- if gem.iam_dependency? -%>
-  gem.add_dependency "grpc-google-iam-v1", ">= 0.6.10", "< 2.0"
+  <%- 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 "minitest", "~> 5.10"
+  gem.add_development_dependency "minitest", "~> 5.14"
+  gem.add_development_dependency "minitest-focus", "~> 1.1"
+  gem.add_development_dependency "minitest-rg", "~> 5.2"
   gem.add_development_dependency "rake", ">= 12.0"
   gem.add_development_dependency "redcarpet", "~> 3.0"
   gem.add_development_dependency "simplecov", "~> 0.18"

data/templates/default/gem/rakefile.erb

@@ -10,6 +10,7 @@ RuboCop::RakeTask.new
 require "rake/testtask"
 desc "Run tests."
 Rake::TestTask.new do |t|
+  t.libs << "test"
   t.test_files = FileList["test/**/*_test.rb"]
   t.warning = false
 end

data/templates/default/gem/test_helper.erb

@@ -0,0 +1,8 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+require "simplecov"
+
+require "minitest/autorun"
+require "minitest/focus"
+require "minitest/rg"

data/templates/default/layouts/_ruby.erb

@@ -5,12 +5,13 @@
 <%= @requires -%>
 <%- end -%>
 
-<%- namespace.split("::").each_with_index do |ns, i| -%>
+<%- namespace_components = namespace.split("::").reject(&:empty?) -%>
+<%- namespace_components.each_with_index do |ns, i| -%>
 <%= indent "module #{ns}", i*2 %>
 <%- end -%>
-<%= indent yield, namespace.split("::").count*2 %>
-<%- namespace.split("::").count.times do |i| -%>
-<%= indent "end", (namespace.split("::").count-1-i)*2 %>
+<%= indent yield, namespace_components.count*2 %>
+<%- namespace_components.count.times do |i| -%>
+<%= indent "end", (namespace_components.count-1-i)*2 %>
 <%- end -%>
 <%- if instance_variable_defined? :@footer -%>
 

data/templates/default/lib/_service.erb

@@ -6,7 +6,9 @@ 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 -%>

data/templates/default/proto_docs/_message.erb

@@ -10,8 +10,8 @@
 <%- end -%>
 <%- end -%>
 class <%= message.name %>
-  include Google::Protobuf::MessageExts
-  extend Google::Protobuf::MessageExts::ClassMethods
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
   <%- message.nested_messages.each do |submsg| -%>
 
   <%= indent_tail render(partial: "proto_docs/message", locals: { message: submsg }), 2 %>

data/templates/default/service/client/_client.erb

@@ -29,7 +29,7 @@ class <%= service.client_name %>
   # To modify the configuration for all <%= service.name %> clients:
   #
   #     <%= service.client_name_full %>.configure do |config|
-  #       config.timeout = 10_000
+  #       config.timeout = 10.0
   #     end
   #
   # @yield [config] Configure the <%= service.client_name %> client.
@@ -75,7 +75,7 @@ class <%= service.client_name %>
   # configuration:
   #
   #     client = <%= service.client_name_full %>.new do |config|
-  #       config.timeout = 10_000
+  #       config.timeout = 10.0
   #     end
   #
   # @yield [config] Configure the <%= service.name %> client.
@@ -96,11 +96,14 @@ class <%= service.client_name %>
 
     # Create credentials
     credentials = @config.credentials
+    <%- unless service.generic_endpoint? -%>
     credentials ||= Credentials.default scope: @config.scope
     if credentials.is_a?(String) || credentials.is_a?(Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
-    @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
+    <%- end -%>
+    @quota_project_id = @config.quota_project
+    @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
     <%- if service.lro? -%>
     <%= service.lro_client_ivar %> = <%= service.operations_name %>.new do |config|
@@ -109,7 +112,7 @@ class <%= service.client_name %>
     end
 
     <%- end -%>
-    @<%= service.stub_name %> = Gapic::ServiceStub.new(
+    @<%= service.stub_name %> = ::Gapic::ServiceStub.new(
       <%= service.proto_service_stub_name_full %>,
       credentials:  credentials,
       endpoint:     @config.endpoint,

data/templates/default/service/client/_config.erb

@@ -20,22 +20,22 @@
 # to 20 seconds, and all remaining timeouts to 10 seconds:
 #
 #     <%= service.client_name_full %>.configure do |config|
-#       config.timeout = 10_000
-#       config.rpcs.<%= method_service.methods.first.name %>.timeout = 20_000
+#       config.timeout = 10.0
+#       config.rpcs.<%= method_service.methods.first.name %>.timeout = 20.0
 #     end
 #
 # To apply the above configuration only to a new client:
 #
 #     client = <%= service.client_name_full %>.new do |config|
-#       config.timeout = 10_000
-#       config.rpcs.<%= method_service.methods.first.name %>.timeout = 20_000
+#       config.timeout = 10.0
+#       config.rpcs.<%= method_service.methods.first.name %>.timeout = 20.0
 #     end
 #
 <%- end -%>
 # @!attribute [rw] endpoint
 #   The hostname or hostname:port of the service endpoint.
 #   Defaults to `<%= service.client_endpoint.inspect %>`.
-#   @return [String]
+#   @return [::String]
 # @!attribute [rw] credentials
 #   Credentials to send with calls. You may provide any of the following types:
 #    *  (`String`) The path to a service account key file in JSON format
@@ -47,29 +47,29 @@
 #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
 #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
 #    *  (`nil`) indicating no credentials
-#   @return [Object]
+#   @return [::Object]
 # @!attribute [rw] scope
 #   The OAuth scopes
-#   @return [Array<String>]
+#   @return [::Array<::String>]
 # @!attribute [rw] lib_name
 #   The library name as recorded in instrumentation and logging
-#   @return [String]
+#   @return [::String]
 # @!attribute [rw] lib_version
 #   The library version as recorded in instrumentation and logging
-#   @return [String]
+#   @return [::String]
 # @!attribute [rw] channel_args
 #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
 #   `GRPC::Core::Channel` object is provided as the credential.
-#   @return [Hash]
+#   @return [::Hash]
 # @!attribute [rw] interceptors
 #   An array of interceptors that are run before calls are executed.
-#   @return [Array<GRPC::ClientInterceptor>]
+#   @return [::Array<::GRPC::ClientInterceptor>]
 # @!attribute [rw] timeout
-#   The call timeout in milliseconds.
-#   @return [Numeric]
+#   The call timeout in seconds.
+#   @return [::Numeric]
 # @!attribute [rw] metadata
 #   Additional gRPC headers to be sent with the call.
-#   @return [Hash{Symbol=>String}]
+#   @return [::Hash{::Symbol=>::String}]
 # @!attribute [rw] retry_policy
 #   The retry policy. The value is a hash with the following keys:
 #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
@@ -77,25 +77,29 @@
 #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
 #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
 #       trigger a retry.
-#   @return [Hash]
+#   @return [::Hash]
+# @!attribute [rw] quota_project
+#   A separate project against which to charge quota.
+#   @return [::String]
 #
 class Configuration
-  extend Gapic::Config
+  extend ::Gapic::Config
 
-  config_attr :endpoint,     <%= service.client_endpoint.inspect %>, String
-  config_attr :credentials,  nil do |value|
+  config_attr :endpoint,      <%= service.client_endpoint.inspect %>, ::String
+  config_attr :credentials,   nil do |value|
     allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
     allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
     allowed.any? { |klass| klass === value }
   end
-  config_attr :scope,        nil, String, Array, nil
-  config_attr :lib_name,     nil, String, nil
-  config_attr :lib_version,  nil, String, nil
-  config_attr(:channel_args, <%= service.config_channel_args.inspect %>, Hash, nil)
-  config_attr :interceptors, nil, Array, nil
-  config_attr :timeout,      nil, Numeric, nil
-  config_attr :metadata,     nil, Hash, nil
-  config_attr :retry_policy, nil, Hash, Proc, nil
+  config_attr :scope,         nil, ::String, ::Array, nil
+  config_attr :lib_name,      nil, ::String, nil
+  config_attr :lib_version,   nil, ::String, nil
+  config_attr(:channel_args,  <%= service.config_channel_args.inspect %>, ::Hash, nil)
+  config_attr :interceptors,  nil, ::Array, nil
+  config_attr :timeout,       nil, ::Numeric, nil
+  config_attr :metadata,      nil, ::Hash, nil
+  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+  config_attr :quota_project, nil, ::String, nil
 
   # @private
   def initialize parent_config = nil
@@ -111,7 +115,7 @@ class Configuration
   def rpcs
     @rpcs ||= begin
       parent_rpcs = nil
-      parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
+      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
       Rpcs.new parent_rpcs
     end
   end
@@ -137,7 +141,7 @@ class Configuration
   <%- method_service.methods.each do |method| -%>
     ##
     # RPC-specific configuration for `<%= method.name %>`
-    # @return [Gapic::Config::Method]
+    # @return [::Gapic::Config::Method]
     #
     attr_reader :<%= method.name %>
   <%- end -%>
@@ -146,7 +150,7 @@ class Configuration
     def initialize parent_rpcs = nil
       <%- method_service.methods.each do |method| -%>
       <%= method.name %>_config = parent_rpcs&.<%= method.name %> if parent_rpcs&.respond_to? :<%= method.name %>
-      @<%= method.name %> = Gapic::Config::Method.new <%= method.name %>_config
+      @<%= method.name %> = ::Gapic::Config::Method.new <%= method.name %>_config
       <%- end -%>
 
       yield self if block_given?

data/templates/default/service/client/_credentials.erb

@@ -3,7 +3,7 @@
 require "googleauth"
 <% end %>
 # Credentials for the <%= service.name %> API.
-class <%= service.credentials_name %> < Google::Auth::Credentials
+class <%= service.credentials_name %> < ::Google::Auth::Credentials
   <%- if service.client_scopes.any? -%>
   self.scope = [
   <%- service.client_scopes.each_with_index do |client_scope, index| -%>