gapic-generator 0.6.3 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 745e30ea242120669b722820eaa82bfe276d83ae511865f7f9ba50ae8eac0fa3
-  data.tar.gz: 0dcdb8ac89fdaa5e568a09b5e0606e546211280844aba34c49c08662cc609dfc
+  metadata.gz: 7cb3044a15ef0354c0aa76903f7bf51e1218b96b0ba7b5923c1b996119dcc5c5
+  data.tar.gz: 4a6b8fa141b8474ed05188f097febfe550901d00b832b153b9fcd3710f01c7a1
 SHA512:
-  metadata.gz: 7e5d18b93ad455ac93e48f0650184c2d6e482f3c8cdd5abb8b4e3c1a3b08832d074b5424d9eafd0aa984669d8f5dae7b2375aece2897f7e253fbe35aa9909981
-  data.tar.gz: 495752c28967d05bc8f133b8248ab96cab896ae3406cd2ad60602c530b7f3a15ef149b8a079b76bbb876a2abf6f75c133cf396136bd09bf5bc8526efe7fc73b6
+  metadata.gz: d8680d28265909b97ca6071a0a28165368d68f861ec4d13615abdf9931b063dfa336e5e8c382a12be24daa4f34b247e1b3da3c28a8550ff27366493ae4a9d113
+  data.tar.gz: 95057a02f066f096c326020e4fbd83bf9ca24f279722812072eefd34df8e2184fe6b72c8d785c37596f0a626279d73fea810fd5c793e96b49c8cbfeb0148ac2e

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Release History for gapic-generator
 
+### 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.
+* Run the rubocop file formatting step without caching.
+* Fix an issue where generating a service with no options would fail.
+
 ### 0.6.3 / 2020-06-27
 
 * Fixes for generated tests for some cases involving proto maps.

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/file_formatter.rb

@@ -39,7 +39,7 @@ module Gapic
           write_file dir, file
         end
 
-        system "rubocop -x #{dir} -o #{dir}/rubocop.out -c #{configuration}"
+        system "rubocop --cache false -x #{dir} -o #{dir}/rubocop.out -c #{configuration}"
 
         files.each do |file|
           read_file dir, file

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.6.3"
+    VERSION = "0.6.8"
   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/service_presenter.rb

@@ -203,7 +203,8 @@ module Gapic
       def client_scopes
         common_service_delegate&.client_scopes ||
           @service.scopes ||
-          default_config(:oauth_scopes)
+          default_config(:oauth_scopes) ||
+          []
       end
 
       def credentials_name

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,8 @@ Metrics/PerceivedComplexity:
 Naming/FileName:
   Exclude:
     - "lib/<%= gem.name %>.rb"
+Style/AsciiComments:
+  Enabled: false
 Style/CaseEquality:
   Enabled: false
 Style/IfUnlessModifier:

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/client/resource/_multi.erb

@@ -13,7 +13,11 @@ 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 ? "" : "," -%>
+<%- if pattern.formal_arguments.empty? -%>
+    <%= pattern.arguments_key.inspect %> => (proc do
+<%- else -%>
     <%= pattern.arguments_key.inspect %> => (proc do |<%= pattern.formal_arguments %>|
+<%- end -%>
 <%= indent render(partial: "service/client/resource/def", locals: { pattern: pattern }), 6 %>
     end)<%= comma %>
 <%- end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.8
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.30.0.pre1
+        version: 1.30.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.30.0.pre1
+        version: 1.30.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement