gapic-common 0.9.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4187157fccf115d742dc9e5b074feccf9b65a5dc241bab8214810b4c257288a8
-  data.tar.gz: 7160ec37659fd5bbffc3e517bd40a65295da42fad7743b38869b58d59a34b09f
+  metadata.gz: 4362fc972a82bd5c92fdf8172a0ad005f371ecfaf968d251e19bc64b73681652
+  data.tar.gz: 85ebd85fef5f54aecfec53ffba4a83e2d7b03ecc26c474ffe64f2644241ae74f
 SHA512:
-  metadata.gz: 71cdc0f8c19c10a51dee060c3048b8b13b8223c0e527e103629058504b60013180e24232ae729014943e1d4b66ba98563796f35558d0d2b5fd955a49f0abf720
-  data.tar.gz: 31b53d85d36746f58b17e778f8fd4b5469a782ae9a68c3847eee309dcb5b2b4ae068785e295763ac17d081518656427408142426cfa7b0f128287599df3e2c47
+  metadata.gz: c1b4b4844fbc1380ccb5e82098c9e8647437da5cbfea789d0eb94543c020b10e97187faf5ac600b6b83d8091172b14f29d9cf05bb93017369b8126af21e49415
+  data.tar.gz: d046faba797ec8b2d76ec66cc2deb12fca86c570a090c05e97ecb844c1aebe8591d56d84a3910a226a8895f0171b1d060ede34a8879c103a76a0ec7da5ad7c7d

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Release History
 
+### 0.11.1 (2022-08-03)
+
+#### Bug Fixes
+
+* error code of 0 is not an error, body template field can be nil ([#805](https://github.com/googleapis/gapic-generator-ruby/issues/805)) 
+
+### 0.11.0 (2022-07-27)
+
+#### Features
+
+* Add CallOptions#merge and CallOptions equality checking ([#802](https://github.com/googleapis/gapic-generator-ruby/issues/802)) 
+
+#### Bug Fixes
+
+* transcoder should always preserve slashes ([#795](https://github.com/googleapis/gapic-generator-ruby/issues/795)) 
+
+### 0.10.0 (2022-06-20)
+
+#### Features
+
+* Require at least Ruby 2.6
+* Support faraday 2.0
+#### Bug Fixes
+
+* Fix precision issues in protobuf timestamp conversion
+* Fix some Ruby 3.0 keyword argument usage errors
+
 ### 0.9.0 (2022-05-18)
 
 #### Features

data/README.md

@@ -15,11 +15,11 @@ convenient and idiomatic API surface to callers.
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.4+.
+This library is supported on Ruby 2.6+.
 
 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 and
+security maintenance, and not end of life. Currently, this means Ruby 2.6 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/lib/gapic/call_options/retry_policy.rb

@@ -74,6 +74,7 @@ module Gapic
       #
       # @param retry_policy [Hash] The policy for error retry. keys must match the arguments for
       #   {RpcCall::RetryPolicy.new}.
+      #
       def apply_defaults retry_policy
         return unless retry_policy.is_a? Hash
 
@@ -85,6 +86,21 @@ module Gapic
         self
       end
 
+      # @private Equality test
+      def eql? other
+        other.is_a?(RetryPolicy) &&
+          other.retry_codes == retry_codes &&
+          other.initial_delay == initial_delay &&
+          other.multiplier == multiplier &&
+          other.max_delay == max_delay
+      end
+      alias == eql?
+
+      # @private Hash code
+      def hash
+        [retry_codes, initial_delay, multiplier, max_delay].hash
+      end
+
       # @private
       # See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a
       # list of error codes.

data/lib/gapic/call_options.rb

@@ -61,12 +61,18 @@ module Gapic
     # @param retry_policy [Hash] the policy for error retry.
     # @param retry_policy [Hash] The policy for error retry. keys must match the arguments for
     #   {RetryPolicy.new}.
+    #
     def apply_defaults timeout: nil, metadata: nil, retry_policy: nil
       @timeout ||= timeout
       @metadata = metadata.merge @metadata if metadata
       @retry_policy.apply_defaults retry_policy if @retry_policy.respond_to? :apply_defaults
     end
 
+    ##
+    # Convert to hash form.
+    #
+    # @return [Hash]
+    #
     def to_h
       {
         timeout:      timeout,
@@ -74,5 +80,31 @@ module Gapic
         retry_policy: retry_policy
       }
     end
+
+    ##
+    # Return a new CallOptions with the given modifications. The current object
+    # is not modified.
+    #
+    # @param kwargs [keywords] Updated fields. See {#initialize} for details.
+    # @return [CallOptions] A new CallOptions object.
+    #
+    def merge **kwargs
+      kwargs = to_h.merge kwargs
+      CallOptions.new(**kwargs)
+    end
+
+    # @private Equality test
+    def eql? other
+      other.is_a?(CallOptions) &&
+        other.timeout == timeout &&
+        other.metadata == metadata &&
+        other.retry_policy == retry_policy
+    end
+    alias == eql?
+
+    # @private Hash code
+    def hash
+      to_h.hash
+    end
   end
 end

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.9.0".freeze
+    VERSION = "0.11.1".freeze
   end
 end

data/lib/gapic/generic_lro/operation.rb

@@ -140,7 +140,8 @@ module Gapic
       # @return [Boolean] Whether an error has been returned.
       #
       def error?
-        done? && (!err.nil? || !error_code.nil?)
+        no_error_code = error_code.nil? || error_code.zero?
+        done? && !(err.nil? && no_error_code)
       end
 
       ##
@@ -198,7 +199,7 @@ module Gapic
       # @yield operation [Gapic::GenericLRO::Operation] Yields the finished Operation.
       #
       def wait_until_done! retry_policy: nil
-        retry_policy = ::Gapic::Operation::RetryPolicy.new retry_policy if retry_policy.is_a? Hash
+        retry_policy = ::Gapic::Operation::RetryPolicy.new(**retry_policy) if retry_policy.is_a? Hash
         retry_policy ||= ::Gapic::Operation::RetryPolicy.new
 
         until done?

data/lib/gapic/operation.rb

@@ -253,7 +253,7 @@ module Gapic
     # @yield operation [Gapic::Operation] Yields the finished Operation.
     #
     def wait_until_done! retry_policy: nil
-      retry_policy = RetryPolicy.new retry_policy if retry_policy.is_a? Hash
+      retry_policy = RetryPolicy.new(**retry_policy) if retry_policy.is_a? Hash
       retry_policy ||= RetryPolicy.new
 
       until done?

data/lib/gapic/paged_enumerable.rb

@@ -181,8 +181,7 @@ module Gapic
 
       min_repeated_field_number = fields.map(&:number).min
       if min_repeated_field_number != repeated_field.number
-        raise ArgumentError, "#{@response.class} must have one primary repeated field " \
-          "by both position and number"
+        raise ArgumentError, "#{@response.class} must have one primary repeated field by both position and number"
       end
 
       # We have the correct repeated field, save the field's name

data/lib/gapic/protobuf.rb

@@ -134,7 +134,7 @@ module Gapic
     #
     # @return [Time] The converted Time.
     def self.timestamp_to_time timestamp
-      Time.at timestamp.nanos * 10**-9 + timestamp.seconds
+      Time.at timestamp.seconds, timestamp.nanos, :nanosecond
     end
 
     ##

data/lib/gapic/rest/client_stub.rb

@@ -14,6 +14,7 @@
 
 require "googleauth"
 require "gapic/rest/faraday_middleware"
+require "faraday/retry"
 
 module Gapic
   module Rest

data/lib/gapic/rest/grpc_transcoder.rb

@@ -49,8 +49,8 @@ module Gapic
         matches.each do |name, _regex, _preserve_slashes|
           unless uri_template =~ /({#{Regexp.quote name}})/
             err_msg = "Binding configuration is incorrect: missing parameter in the URI template.\n" \
-                      "Parameter `#{name}` is specified for matching but there is no corresponding parameter" \
-                      " `{#{name}}` in the URI template."
+                      "Parameter `#{name}` is specified for matching but there is no corresponding parameter " \
+                      "`{#{name}}` in the URI template."
             raise ::Gapic::Common::Error, err_msg
           end
 
@@ -60,8 +60,8 @@ module Gapic
         if template =~ /{([a-zA-Z_.]+)}/
           err_name = Regexp.last_match[1]
           err_msg = "Binding configuration is incorrect: missing match configuration.\n" \
-                    "Parameter `{#{err_name}}` is specified in the URI template but there is no" \
-                    " corresponding match configuration for `#{err_name}`."
+                    "Parameter `{#{err_name}}` is specified in the URI template but there is no " \
+                    "corresponding match configuration for `#{err_name}`."
           raise ::Gapic::Common::Error, err_msg
         end
 
@@ -108,12 +108,9 @@ module Gapic
           uri_values = bind_uri_values! http_binding, request_hash
           next if uri_values.any? { |_, value| value.nil? }
 
-          if http_binding.body && http_binding.body != "*"
-            # Note that the body template can only point to a top-level field,
-            # so there is no need to split the path.
-            body_binding_camel = camel_name_for http_binding.body
-            next unless request_hash.key? body_binding_camel
-          end
+          # Note that the body template can only point to a top-level field,
+          # so there is no need to split the path.
+          next if http_binding.body && http_binding.body != "*" && !(request.respond_to? http_binding.body.to_sym)
 
           method = http_binding.method
           uri = expand_template http_binding.template, uri_values
@@ -140,20 +137,16 @@ module Gapic
       #   Name to value hash of the variables for the uri template expansion.
       #   The values are percent-escaped with slashes potentially preserved.
       def bind_uri_values! http_binding, request_hash
-        http_binding.field_bindings.map do |field_binding|
+        http_binding.field_bindings.to_h do |field_binding|
           field_path_camel = field_binding.field_path.split(".").map { |part| camel_name_for part }.join(".")
           field_value = extract_scalar_value! request_hash, field_path_camel, field_binding.regex
 
           if field_value
-            field_value = if field_binding.preserve_slashes
-                            field_value.split("/").map { |segment| percent_escape(segment) }.join("/")
-                          else
-                            percent_escape field_value
-                          end
+            field_value = field_value.split("/").map { |segment| percent_escape(segment) }.join("/")
           end
 
           [field_binding.field_path, field_value]
-        end.to_h
+        end
       end
 
       # Percent-escapes a string.
@@ -186,9 +179,15 @@ module Gapic
           #
           # The `request_hash_without_uri` at this point was mutated to delete these fields.
           #
-          # Note that the body template can only point to a top-level field
-          request_hash_without_uri.delete camel_name_for body_template
-          body = request.send(body_template.to_sym).to_json(emit_defaults: true)
+          # Note 1: body template can only point to a top-level field.
+          # Note 2: The field that body template points to can be null, in which case
+          # an empty string should be sent. E.g. `Compute.Projects.SetUsageExportBucket`.
+          request_body_field = request.send body_template.to_sym if request.respond_to? body_template.to_sym
+          if request_body_field
+            request_hash_without_uri.delete camel_name_for body_template
+            body = request_body_field.to_json emit_defaults: true
+          end
+
           query_params = build_query_params request_hash_without_uri
         else
           query_params = build_query_params request_hash_without_uri
@@ -289,7 +288,7 @@ module Gapic
       def camel_name_for attr_name
         parts = attr_name.split "_"
         first_part = parts[0]
-        other_parts = parts[1..-1]
+        other_parts = parts[1..]
         other_parts_pascal = other_parts.map(&:capitalize).join
         "#{first_part}#{other_parts_pascal}"
       end

metadata

@@ -1,56 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 3.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 3.a
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos
+  name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.11
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: 3.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.11
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: 3.a
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos-types
+  name: googleapis-common-protos
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 1.3.12
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -60,17 +66,17 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 1.3.12
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
 - !ruby/object:Gem::Dependency
-  name: googleauth
+  name: googleapis-common-protos-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 1.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -80,10 +86,24 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 1.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -132,28 +152,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
@@ -306,14 +326,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Common code for GAPIC-generated API clients