gapic-generator 0.6.4 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dc10e022bdc300aff2d3f5cb95686c3deae5cd4ab3068dc621771ab716137d2
-  data.tar.gz: '048e93d769f582f002d59be693b3f49818cefb205db30bc70969994edb0880bf'
+  metadata.gz: d1b218438104bc5239538c96e90d05a84591a7517c7f8e3e01009b0a7c47bb76
+  data.tar.gz: dcfea920e8b059e62df55e305ee956182101e0531ea7c207d9a6d45589982d00
 SHA512:
-  metadata.gz: '0496b671939b2290d878ce0ba38e3d6cc2499e483c018d7a1b62ad99f629c506c261b6108d4d5a5cd82f82dd40050b374a7a059a03b3fad1b5951256dd940b1c'
-  data.tar.gz: b521992f0db776914b9a4f035bcc3fb76ecb57f0bd005f2ff0fc6c744410d48f787fd648bfb218a88d93ecc12cfa86bdccd63557ddbe63aa962f3d4994e8a3ca
+  metadata.gz: ef95a59c0f4bfabaa7a479ddaf9eab02739c18e345fc03d33b8e4f50c9676c5aafb9facedfdb4cc2202e269c7724bf497297c72c67b48763fea251330315547f
+  data.tar.gz: cecd8d4c13b61a1be2578cee67b7f5601a83b6d4795228fce3c5d89f572351a773830a6fca6af07defcf3274633fecddbf23cb02a45503be64082d0296fd317d

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Release History for gapic-generator
 
+### 0.6.9 / 2020-12-07
+
+* Load package-level handwritten helpers.
+* Disable Names/PredicateName rubocop rule.
+* Fix generated client tests when a request field name collides with a Ruby superclass method.
+
+### 0.6.8 / 2020-09-16
+
+* Add samples tasks to generated gapic rakefiles.
+* Disable Style/AsciiComments rule.
+
+### 0.6.7 / 2020-08-07
+
+* Generated credentials config allows symbols.
+
+### 0.6.6 / 2020-08-05
+
+* Use numeric error codes rather than strings in generated retry configs.
+
+### 0.6.5 / 2020-07-16
+
+* Examples in auth, rakefile, and readme should pick a non-common service.
+* Emit a warning if common_services config references a nonexistent service.
+
 ### 0.6.4 / 2020-07-13
 
 * Fix rubocop warning on a generated multi-path helper if it could take no arguments.

data/gem_templates/dockerfile.erb

@@ -30,7 +30,7 @@ COPY --from=gcr.io/gapic-images/api-common-protos:beta /protos/ /workspace/commo
 COPY --from=builder /workspace/*.gem /workspace/
 
 # Install the subgenerator and other needed tools.
-RUN gem install --pre grpc-tools gapic-generator-<%= gem_name %>.gem \
+RUN gem install grpc-tools gapic-generator-<%= gem_name %>.gem \
     && rm gapic-generator-<%= gem_name %>.gem \
     && mkdir -p --mode=777 /.cache
 

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.6.4"
+    VERSION = "0.6.9"
   end
 end

data/lib/gapic/grpc_service_config/parser.rb

@@ -40,6 +40,31 @@ module Gapic
       MULTIPLIER_JSON_KEY = "backoffMultiplier"
       STATUS_CODES_JSON_KEY = "retryableStatusCodes"
 
+      # See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a
+      # list of error codes.
+      ERROR_CODE_MAPPING = [
+        "OK",
+        "CANCELLED",
+        "UNKNOWN",
+        "INVALID_ARGUMENT",
+        "DEADLINE_EXCEEDED",
+        "NOT_FOUND",
+        "ALREADY_EXISTS",
+        "PERMISSION_DENIED",
+        "RESOURCE_EXHAUSTED",
+        "FAILED_PRECONDITION",
+        "ABORTED",
+        "OUT_OF_RANGE",
+        "UNIMPLEMENTED",
+        "INTERNAL",
+        "UNAVAILABLE",
+        "DATA_LOSS",
+        "UNAUTHENTICATED"
+      ].freeze
+
+      ERROR_STRING_MAPPING = ERROR_CODE_MAPPING.each_with_index.each_with_object({}) do |(str, num), hash|
+        hash[str] = num
+      end.freeze
 
       ##
       # Parses ServiceConfig from a json of a GRPC service config
@@ -146,11 +171,26 @@ module Gapic
         initial_delay_seconds = parse_interval_seconds get(retry_policy_json, INITIAL_DELAY_JSON_KEY)
         max_delay_seconds = parse_interval_seconds get(retry_policy_json, MAX_DELAY_JSON_KEY)
         multiplier = get retry_policy_json, MULTIPLIER_JSON_KEY
-        status_codes = get retry_policy_json, STATUS_CODES_JSON_KEY
+        status_codes = convert_codes get retry_policy_json, STATUS_CODES_JSON_KEY
 
         RetryPolicy.new initial_delay_seconds, max_delay_seconds, multiplier, status_codes
       end
 
+      ##
+      # Interpret input status codes. Convert strings to their associated integer codes.
+      #
+      def self.convert_codes input_codes
+        return nil if input_codes.nil?
+        Array(input_codes).map do |obj|
+          case obj
+          when String
+            ERROR_STRING_MAPPING[obj]
+          when Integer
+            obj
+          end
+        end.compact
+      end
+
       ##
       # Parses time expressed in secondds from the GRPC service config json
       # The time is encoded is a string as float or integer with a letter 's' afterwards
@@ -212,7 +252,7 @@ module Gapic
       end
 
       private_class_method :parse_service_names, :filter_service_method_names, :parse_config,
-                           :parse_retry_policy, :parse_interval_seconds, :valid_float?
+                           :parse_retry_policy, :parse_interval_seconds, :valid_float?, :convert_codes
     end
   end
 end

data/lib/gapic/presenters/gem_presenter.rb

@@ -48,6 +48,10 @@ module Gapic
         end
       end
 
+      def first_non_common_service
+        services.find { |service| service.common_service_delegate.nil? }
+      end
+
       def proto_files
         @proto_files ||= begin
           files = @api.files

data/lib/gapic/presenters/package_presenter.rb

@@ -80,9 +80,25 @@ module Gapic
         package_require + ".rb"
       end
 
+      def package_directory_name
+        package_require.split("/").last
+      end
+
       def empty?
         services.empty?
       end
+
+      def helpers_file_path
+        helpers_require + ".rb"
+      end
+
+      def helpers_file_name
+        "_helpers.rb"
+      end
+
+      def helpers_require
+        package_require + "/_helpers"
+      end
     end
   end
 end

data/lib/gapic/schema/api.rb

@@ -44,14 +44,18 @@ module Gapic
       #
       # @param request [Google::Protobuf::Compiler::CodeGeneratorRequest]
       #   The request object.
-      def initialize request
+      # @param error_output [IO] An IO to write any errors/warnings to.
+      # @param configuration [Hash] Optional override of configuration.
+      def initialize request, error_output: STDERR, configuration: nil
         @request = request
         loader = Loader.new
         @files = request.proto_file.map do |fd|
           loader.load_file fd, request.file_to_generate.include?(fd.name)
         end
         @files.each { |f| f.parent = self }
+        @configuration = configuration
         @resource_types = analyze_resources
+        sanity_checks error_output
       end
 
       def containing_api
@@ -295,6 +299,18 @@ module Gapic
 
       private
 
+      # Perform a variety of sanity checks on the data, and prints errors to
+      # the given output as appropriate.
+      #
+      # @param output [IO] Stream to write outputs to.
+      def sanity_checks output
+        addrs = services.map { |service| service.address.join "." }
+        configuration[:common_services]&.each do |k, v|
+          output.puts "WARNING: configured common service #{k} is not present" unless addrs.include? k
+          output.puts "WARNING: configured common service delegate #{v} is not present" unless addrs.include? v
+        end
+      end
+
       # Does a pre-analysis of all resources defined in the job. This has
       # two effects:
       # * Side effect: each resource has its parent_resources field set.

data/templates/default/gem/readme.erb

@@ -16,7 +16,7 @@ $ gem install <%= gem.name %>
 
 ```ruby
 require "<%= gem.entrypoint_require %>"
-<%- service = gem.packages.first&.services.first -%>
+<%- service = gem.first_non_common_service -%>
 <%- method = service&.methods.first -%>
 <%- if service && method -%>
 

data/templates/default/gem/rubocop.erb

@@ -25,6 +25,10 @@ Metrics/PerceivedComplexity:
 Naming/FileName:
   Exclude:
     - "lib/<%= gem.name %>.rb"
+Naming/PredicateName:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
 Style/CaseEquality:
   Enabled: false
 Style/IfUnlessModifier:

data/templates/default/lib/_package.erb

@@ -15,3 +15,7 @@ require "<%= package.gem.version_require %>"
 <%- end -%>
 module <%= package.module_name %>
 end
+<% @footer = capture do %>
+helper_path = ::File.join __dir__, "<%= package.package_directory_name %>", "<%= package.helpers_file_name %>"
+require "<%= package.helpers_require %>" if ::File.file? helper_path
+<% end %>

data/templates/default/service/_helpers.erb

@@ -1,3 +1,3 @@
 <%- assert_locals service -%>
-helper_path = ::File.join __dir__, "<%= service.service_directory_name%>", "helpers.rb"
+helper_path = ::File.join __dir__, "<%= service.service_directory_name %>", "<%= service.helpers_file_name %>"
 require "<%= service.helpers_require %>" if ::File.file? helper_path

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

@@ -87,7 +87,7 @@ class Configuration
 
   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 = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
     allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
     allowed.any? { |klass| klass === value }
   end

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

@@ -87,13 +87,13 @@ def test_<%= method.name %>
         assert_kind_of <%= method.request_type %>, r
         <%- fields.each do |field| -%>
         <%- if field.message? && field.repeated? && !field.map? -%>
-        assert_kind_of <%= field.type_name_full %>, r.<%= field.name %>.first
+        assert_kind_of <%= field.type_name_full %>, r["<%= field.name %>"].first
         <%- elsif field.map? -%>
-        assert_equal(<%= field.default_value %>, r.<%= field.name %>.to_h)
+        assert_equal(<%= field.default_value %>, r["<%= field.name %>"].to_h)
         <%- elsif field.message? -%>
-        assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), r.<%= field.name %>
+        assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), r["<%= field.name %>"]
         <%- else -%>
-        assert_equal <%= field.default_value %>, r.<%= field.name %>
+        assert_equal <%= field.default_value %>, r["<%= field.name %>"]
         <%- end -%>
         <%- if field.oneof? && !field.proto3_optional? -%>
         assert_equal :<%= field.name %>, r.<%= field.oneof_name %>

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

@@ -71,13 +71,13 @@ def test_<%= method.name %>
         assert_kind_of <%= method.request_type %>, r
         <%- fields.each do |field| -%>
         <%- if field.message? && field.repeated? && !field.map? -%>
-        assert_kind_of <%= field.type_name_full %>, r.<%= field.name %>.first
+        assert_kind_of <%= field.type_name_full %>, r["<%= field.name %>"].first
         <%- elsif field.map? -%>
-        assert_equal(<%= field.default_value %>, r.<%= field.name %>.to_h)
+        assert_equal(<%= field.default_value %>, r["<%= field.name %>"].to_h)
         <%- elsif field.message? -%>
-        assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), r.<%= field.name %>
+        assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), r["<%= field.name %>"]
         <%- else -%>
-        assert_equal <%= field.default_value %>, r.<%= field.name %>
+        assert_equal <%= field.default_value %>, r["<%= field.name %>"]
         <%- end -%>
         <%- if field.oneof? && !field.proto3_optional? -%>
         assert_equal :<%= field.name %>, r.<%= field.oneof_name %>

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

@@ -18,13 +18,13 @@ def test_<%= method.name %>
     assert_kind_of <%= method.request_type %>, request
     <%- fields.each do |field| -%>
     <%- if field.message? && field.repeated? && !field.map? -%>
-    assert_kind_of <%= field.type_name_full %>, request.<%= field.name %>.first
+    assert_kind_of <%= field.type_name_full %>, request["<%= field.name %>"].first
     <%- elsif field.map? -%>
-    assert_equal(<%= field.default_value %>, request.<%= field.name %>.to_h)
+    assert_equal(<%= field.default_value %>, request["<%= field.name %>"].to_h)
     <%- elsif field.message? -%>
-    assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), request.<%= field.name %>
+    assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), request["<%= field.name %>"]
     <%- else -%>
-    assert_equal <%= field.default_value %>, request.<%= field.name %>
+    assert_equal <%= field.default_value %>, request["<%= field.name %>"]
     <%- end -%>
     <%- if field.oneof? && !field.proto3_optional? -%>
     assert_equal :<%= field.name %>, request.<%= field.oneof_name %>

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

@@ -18,13 +18,13 @@ def test_<%= method.name %>
     assert_kind_of <%= method.request_type %>, request
     <%- fields.each do |field| -%>
     <%- if field.message? && field.repeated? && !field.map? -%>
-    assert_kind_of <%= field.type_name_full %>, request.<%= field.name %>.first
+    assert_kind_of <%= field.type_name_full %>, request["<%= field.name %>"].first
     <%- elsif field.map? -%>
-    assert_equal(<%= field.default_value %>, request.<%= field.name %>.to_h)
+    assert_equal(<%= field.default_value %>, request["<%= field.name %>"].to_h)
     <%- elsif field.message? -%>
-    assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), request.<%= field.name %>
+    assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), request["<%= field.name %>"]
     <%- else -%>
-    assert_equal <%= field.default_value %>, request.<%= field.name %>
+    assert_equal <%= field.default_value %>, request["<%= field.name %>"]
     <%- end -%>
     <%- if field.oneof? && !field.proto3_optional? -%>
     assert_equal :<%= field.name %>, request.<%= field.oneof_name %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.9
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack