gapic-generator 0.4.2 → 0.6.2

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/lib/google/protobuf/compiler/plugin.pb.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 ##
-# This file is auto-generated. DO NOT EDIT!
+# This file was auto-generated initially but now is hand-edited to add support 
+# for response features and proto3_optional
 #
 require 'protobuf'
 
@@ -54,6 +55,8 @@ module Google
       end
 
       class CodeGeneratorResponse
+        FEATURE_PROTO3_OPTIONAL = 1
+
         class File
           optional :string, :name, 1
           optional :string, :insertion_point, 2
@@ -61,6 +64,7 @@ module Google
         end
 
         optional :string, :error, 1
+        optional :int32, :supported_features, 2
         repeated ::Google::Protobuf::Compiler::CodeGeneratorResponse::File, :file, 15
       end
 

data/lib/google/protobuf/descriptor.pb.rb

@@ -190,6 +190,7 @@ module Google
       optional :int32, :oneof_index, 9
       optional :string, :json_name, 10
       optional ::Google::Protobuf::FieldOptions, :options, 8
+      optional :bool, :proto3_optional, 17
     end
 
     class OneofDescriptorProto

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/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/service/client/_client.erb

@@ -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|

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

@@ -78,24 +78,28 @@
 #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
 #       trigger a retry.
 #   @return [::Hash]
+# @!attribute [rw] quota_project
+#   A separate project against which to charge quota.
+#   @return [::String]
 #
 class Configuration
   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

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

@@ -64,6 +64,8 @@ class <%= service.operations_name %>
     if credentials.is_a?(String) || credentials.is_a?(Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
+    @quota_project_id = @config.quota_project
+    @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
     @<%= service.lro_service.stub_name %> = ::Gapic::ServiceStub.new(
       <%= service.lro_service.proto_service_stub_name_full %>,

data/templates/default/service/client/resource/_doc.erb

@@ -1,7 +1,7 @@
 <%- assert_locals pattern -%>
 The resource will be in the following format:
 
-`<%= pattern.template %>`
+`<%= pattern.pattern %>`
 
 <%- pattern.arguments.each do |arg| -%>
 @param <%= arg %> [String]

data/templates/default/service/client/resource/_multi.erb

@@ -3,8 +3,7 @@
 # Create a fully-qualified <%= resource.name %> resource string.
 #
 <%- resource.patterns.each do |pattern| -%>
-<%- args_doc_sig = pattern.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-# @overload <%= resource.path_helper %>(<%= args_doc_sig %>)
+# @overload <%= resource.path_helper %>(<%= pattern.formal_arguments %>)
 <%= indent render(partial: "service/client/resource/doc", locals: { pattern: pattern }), "#   " %>
 #
 <%- end -%>
@@ -14,9 +13,7 @@ def <%= resource.path_helper %> **args
 <%- last_pattern_index = resource.patterns.count - 1 -%>
 <%- resource.patterns.each_with_index do |pattern, index| -%>
 <%- comma = last_pattern_index == index ? "" : "," -%>
-<%- args_key = pattern.arguments.sort.join(":").inspect -%>
-<%- args_sig = pattern.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-    <%= args_key %> => (proc do |<%= args_sig %>|
+    <%= pattern.arguments_key.inspect %> => (proc do |<%= pattern.formal_arguments %>|
 <%= indent render(partial: "service/client/resource/def", locals: { pattern: pattern }), 6 %>
     end)<%= comma %>
 <%- end -%>

data/templates/default/service/client/resource/_single.erb

@@ -5,7 +5,6 @@
 <%= indent render(partial: "service/client/resource/doc", locals: { pattern: resource.patterns.first }), "# " %>
 #
 # @return [::String]
-<%- args = resource.patterns.first.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-def <%= resource.path_helper %> <%= args %>
+def <%= resource.path_helper %> <%= resource.patterns.first.formal_arguments %>
 <%= indent render(partial: "service/client/resource/def", locals: { pattern: resource.patterns.first }), 2 %>
 end

data/templates/default/service/test/_resource.erb

@@ -0,0 +1,16 @@
+<%- assert_locals resource -%>
+<%- assert_locals service -%>
+<%- full_client_name = defined?(client_name_full) ? client_name_full : service.client_name_full -%>
+def test_<%= resource.path_helper%>
+  grpc_channel = ::GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
+  ::Gapic::ServiceStub.stub :new, nil do
+    client = <%= full_client_name %>.new do |config|
+      config.credentials = grpc_channel
+    end
+<%- resource.patterns.each do |pattern| -%>
+
+    path = client.<%= resource.path_helper%> <%= pattern.arguments_with_dummy_values %>
+    assert_equal <%= pattern.expected_path_for_dummy_values.inspect %>, path
+<%- end -%>
+  end
+end

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

@@ -1,9 +1,6 @@
 <%- assert_locals service -%>
-# frozen_string_literal: true
-
-<%= render partial: "shared/license" %>
-require "simplecov"
-require "minitest/autorun"
+<%= render partial: "shared/header" %>
+require "helper"
 
 require "gapic/grpc/service_stub"
 

data/templates/default/service/test/client_operations.erb

@@ -1,9 +1,6 @@
 <%- assert_locals service -%>
-# frozen_string_literal: true
-
-<%= render partial: "shared/license" %>
-require "simplecov"
-require "minitest/autorun"
+<%= render partial: "shared/header" %>
+require "helper"
 
 require "gapic/grpc/service_stub"
 

data/templates/default/service/test/client_paths.erb

@@ -0,0 +1,15 @@
+<%- assert_locals service -%>
+<%= render partial: "shared/header" %>
+require "helper"
+
+require "gapic/grpc/service_stub"
+
+require "<%= service.service_require %>"
+
+class <%= service.client_name_full %>PathsTest < Minitest::Test
+<%- service.references.each do |resource| -%>
+<%= indent render(partial: "service/test/resource",
+                  locals: { resource: resource, service: service }), 2 %>
+
+<%- end %>
+end

data/templates/default/service/test/method/_bidi.erb

@@ -93,6 +93,12 @@ def test_<%= method.name %>
         <%- else -%>
         assert_equal <%= field.default_value %>, r.<%= field.name %>
         <%- end -%>
+        <%- if field.oneof? && !field.proto3_optional? -%>
+        assert_equal :<%= field.name %>, r.<%= field.oneof_name %>
+        <%- end -%>
+        <%- if field.proto3_optional? -%>
+        assert r.has_<%= field.name %>?
+        <%- end -%>
         <%- end -%>
       end
     end

data/templates/default/service/test/method/_client.erb

@@ -77,6 +77,12 @@ def test_<%= method.name %>
         <%- else -%>
         assert_equal <%= field.default_value %>, r.<%= field.name %>
         <%- end -%>
+        <%- if field.oneof? && !field.proto3_optional? -%>
+        assert_equal :<%= field.name %>, r.<%= field.oneof_name %>
+        <%- end -%>
+        <%- if field.proto3_optional? -%>
+        assert r.has_<%= field.name %>?
+        <%- end -%>
         <%- end -%>
       end
     end

data/templates/default/service/test/method/_normal.erb

@@ -26,6 +26,12 @@ def test_<%= method.name %>
     <%- else -%>
     assert_equal <%= field.default_value %>, request.<%= field.name %>
     <%- end -%>
+    <%- if field.oneof? && !field.proto3_optional? -%>
+    assert_equal :<%= field.name %>, request.<%= field.oneof_name %>
+    <%- end -%>
+    <%- if field.proto3_optional? -%>
+    assert request.has_<%= field.name %>?
+    <%- end -%>
     <%- end -%>
     refute_nil options
   end

data/templates/default/service/test/method/_server.erb

@@ -24,6 +24,12 @@ def test_<%= method.name %>
     <%- else -%>
     assert_equal <%= field.default_value %>, request.<%= field.name %>
     <%- end -%>
+    <%- if field.oneof? && !field.proto3_optional? -%>
+    assert_equal :<%= field.name %>, request.<%= field.oneof_name %>
+    <%- end -%>
+    <%- if field.proto3_optional? -%>
+    assert request.has_<%= field.name %>?
+    <%- end -%>
     <%- end -%>
     refute_nil options
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.2
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -74,14 +74,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.30.0.pre1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.30.0.pre1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -217,9 +217,10 @@ files:
 - lib/gapic/grpc_service_config/service_config.rb
 - lib/gapic/helpers/filepath_helper.rb
 - lib/gapic/helpers/namespace_helper.rb
-- lib/gapic/path_template.rb
-- lib/gapic/path_template/parser.rb
-- lib/gapic/path_template/segment.rb
+- lib/gapic/path_pattern.rb
+- lib/gapic/path_pattern/parser.rb
+- lib/gapic/path_pattern/pattern.rb
+- lib/gapic/path_pattern/segment.rb
 - lib/gapic/presenters.rb
 - lib/gapic/presenters/enum_presenter.rb
 - lib/gapic/presenters/enum_value_presenter.rb
@@ -239,6 +240,8 @@ files:
 - lib/gapic/schema/api.rb
 - lib/gapic/schema/loader.rb
 - lib/gapic/schema/wrappers.rb
+- lib/gapic/uri_template.rb
+- lib/gapic/uri_template/parser.rb
 - lib/google/api/annotations.pb.rb
 - lib/google/api/client.pb.rb
 - lib/google/api/field_behavior.pb.rb
@@ -260,6 +263,7 @@ files:
 - templates/default/gem/rakefile.erb
 - templates/default/gem/readme.erb
 - templates/default/gem/rubocop.erb
+- templates/default/gem/test_helper.erb
 - templates/default/gem/version.erb
 - templates/default/gem/yardopts.erb
 - templates/default/helpers/default_helper.rb
@@ -319,8 +323,10 @@ files:
 - templates/default/service/credentials.erb
 - templates/default/service/operations.erb
 - templates/default/service/paths.erb
+- templates/default/service/test/_resource.erb
 - templates/default/service/test/client.erb
 - templates/default/service/test/client_operations.erb
+- templates/default/service/test/client_paths.erb
 - templates/default/service/test/method/_assert_response.erb
 - templates/default/service/test/method/_bidi.erb
 - templates/default/service/test/method/_client.erb