gapic-common 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11f04f82fc6e98e5ca24d814d6162d68681999b6a7f2305cc32c77c597db2a88
-  data.tar.gz: a36c758ffd65878ac9809c0ecfc515e2c6e0e817f5ad679e8574e5dbeb8a03f6
+  metadata.gz: 3906b246e3ecacee83c366fee3cd10077a56a72b29c3490ca8ff01ac4e124d65
+  data.tar.gz: c0a72cf00fa758234a196d385f53303d41c82cd895a17a339b185b7db529cf3b
 SHA512:
-  metadata.gz: 8fb7d4c578dc4b44383ac18e33159fd824465e63df13b10ed2d2fe142c4a9743876d7a3a41cd00680dc3e44cab88f6d3d6185198a8b74a85ace1ff30ee6d9e4e
-  data.tar.gz: 3d508937a578e43a1fe8022557d08a7c01be477b9141a1d055c0d6a1df8e739eca0a9e2f14d178aa90c4b121d44dd12e437d73242250009916645948238af388
+  metadata.gz: 4aaff885138cd52a4f822ebb51af2f2c658700e7ba71d3b1199ada4c3871343e16cb66c1fc65a44606cf178316a07bb61f553a40bcf1ffd80e98a00758e18d51
+  data.tar.gz: 59232d7d58c9711b6e0e9e0b1da7ca3f0d69abbda9d10d4fa72412e463d8a57062a45f46131c5c24a392cbbc5e8e99be63b7491c4bcf668f77ed48b4e44a235f

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History
 
+### 1.5.1 (2026-09-30)
+
+#### Bug Fixes
+
+* tighten path template matching in the REST transcoder ([#83](https://github.com/googleapis/ruby-core-libraries/issues/83)) 
+
+### 1.5.0 (2026-09-29)
+
+#### Features
+
+* Resumable Media Upload functionality implementation ([#72](https://github.com/googleapis/ruby-core-libraries/issues/72)) 
+#### Documentation
+
+* remove stale preview notice and disclaimer from READMEs ([#77](https://github.com/googleapis/ruby-core-libraries/issues/77)) 
+
 ### 1.4.1 (2026-09-28)
 
 #### Bug Fixes

data/README.md

@@ -61,9 +61,6 @@ See the {file:CONTRIBUTING.md CONTRIBUTING} documentation for more information o
 
 ## Versioning
 
-This library is currently a **preview** with no guarantees of stability or support. Please get
-involved and let us know if you find it useful and we'll work towards a stable version.
+This library follows [Semantic Versioning](http://semver.org/).
 
-## Disclaimer
-
-This is not an official Google product.
+This library is considered to be stable and will not have backwards-incompatible changes introduced in subsequent minor releases.

data/lib/gapic/common/retry_policy.rb

@@ -19,6 +19,12 @@ module Gapic
     ##
     # Gapic Common retry policy base class.
     #
+    # A policy distinguishes "set to this value" from "never set". Every setting is stored as `nil`
+    # until someone supplies it, and the reader for each substitutes the corresponding `DEFAULT_`
+    # constant on the way out, so a reader can never say which of the two happened. That distinction is
+    # what lets {#apply_defaults} fill in gaps without overwriting a caller's choices, and {#overrides}
+    # report what a caller actually asked for.
+    #
     class RetryPolicy
       # @return [Numeric] Default initial delay in seconds.
       DEFAULT_INITIAL_DELAY = 1
@@ -111,6 +117,34 @@ module Gapic
         @retry_predicate
       end
 
+      ##
+      # @private
+      # The settings this policy actually carries, as keyword arguments for {RetryPolicy.initialize}.
+      #
+      # A key is present only if that setting was explicitly supplied; a key that was never set is
+      # absent rather than `nil`. This is what the readers cannot tell you — {#max_delay} returns
+      # {DEFAULT_MAX_DELAY} whether the caller chose that number or said nothing — so it is the only
+      # safe way to carry one policy's settings onto another without dragging defaults along, and
+      # without mistaking a deliberate choice that happens to equal a default for silence.
+      #
+      # An empty `retry_codes` list counts as unset. It retries nothing, which is exactly what an
+      # unset list does, so there is nothing for it to carry.
+      #
+      # @return [Hash{Symbol=>Object}] Explicitly set settings only
+      def overrides
+        # Assigns nil, and so omits the key, when the list is absent or empty.
+        retry_codes = @retry_codes unless @retry_codes.nil? || @retry_codes.empty?
+        {
+          initial_delay:   @initial_delay,
+          max_delay:       @max_delay,
+          multiplier:      @multiplier,
+          retry_codes:     retry_codes,
+          timeout:         @timeout,
+          jitter:          @jitter,
+          retry_predicate: @retry_predicate
+        }.compact
+      end
+
       ##
       # Returns a duplicate in a non-executing state, i.e. with the deadline
       # and current delay reset.

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "1.4.1".freeze
+    VERSION = "1.5.1".freeze
   end
 end

data/lib/gapic/logging_concerns.rb

@@ -67,6 +67,10 @@ module Gapic
         log(Logger::DEBUG, &)
       end
 
+      def warn(&)
+        log(Logger::WARN, &)
+      end
+
       ##
       # @private
       # Builder for a log entry, passed to {StubLogger#log}.

data/lib/gapic/rest/client_stub.rb

@@ -287,17 +287,27 @@ module Gapic
           entry.set "requestId", request_id
           entry.message = "Sending request to #{entry.service}.#{method_name} (try #{try_number})"
         end
-        body = body.to_s
+        body_str = body.to_s
         metadata = metadata.to_h rescue {}
-        return if body.empty? && metadata.empty?
+        return if body_str.empty? && metadata.empty?
         stub_logger.debug do |entry|
           entry.set "requestId", request_id
-          entry.set "request", body
+          entry.set "request", abridge_request_body(body_str)
           entry.set "headers", metadata
           entry.message = "(request payload as JSON)"
         end
       end
 
+      def abridge_request_body body_str
+        utf8_body = body_str.dup.force_encoding Encoding::UTF_8
+        if body_str.bytesize > 1024 || !utf8_body.valid_encoding?
+          prefix_hex = body_str.byteslice(0, 32).unpack1 "H*"
+          "<#{body_str.bytesize} bytes, first 32: #{prefix_hex}>"
+        else
+          utf8_body
+        end
+      end
+
       def log_response method_name, request_id, try_number, response, is_server_streaming
         return unless stub_logger&.enabled?
         stub_logger.info do |entry|

data/lib/gapic/rest/error.rb

@@ -22,6 +22,9 @@ module Gapic
   module Rest
     # Gapic REST exception class
     class Error < ::Gapic::Common::Error
+      # @private
+      REST_ERROR_PREFIX = "An error has occurred when making a REST request".freeze
+
       # @return [Integer, nil] the http status code for the error
       attr_reader :status_code
       # @return [Object, nil] the text representation of status as parsed from the response body
@@ -79,7 +82,7 @@ module Gapic
 
           if err.response_body
             msg, code, status, details = try_parse_from_body err.response_body
-            message = "An error has occurred when making a REST request: #{msg}" unless msg.nil?
+            message = "#{REST_ERROR_PREFIX}: #{msg}" unless msg.nil?
             status_code = code unless code.nil?
           end
 

data/lib/gapic/rest/grpc_transcoder.rb

@@ -111,7 +111,7 @@ module Gapic
       # @return [Hash{String, String}]
       #   Name to value hash of the variables for the uri template expansion.
       #   The values are percent-escaped with slashes potentially preserved.
-      # @raise [Gapic::Common::Error] If any parameter value fails path traversal or injection validation.
+      # @raise [Gapic::Common::Error] If any parameter value fails path traversal validation.
       def bind_uri_values! http_binding, request_hash
         http_binding.field_bindings.to_h do |field_binding|
           field_path_camel = field_binding.field_path.split(".").map { |part| camel_name_for part }.join(".")
@@ -252,7 +252,7 @@ module Gapic
       # Returns nil if:
       # - the field is not found
       # - the field is a Message or an array,
-      # - the regex does not match
+      # - the regex does not match the entire string representation
       # @param request_hash [Hash]
       #   A hash of the GRPC request or the sub-request with the unset
       #   proto3_optional fields removed.
@@ -266,7 +266,9 @@ module Gapic
 
         # Covers the case where in `foo.bar.baz`, `baz` is still a submessage or an array.
         return nil if value.is_a?(::Hash) || value.is_a?(::Array)
-        value.to_s if value.to_s =~ regex
+        str = value.to_s
+        match = regex.match str
+        str if match && match.pre_match.empty? && match.post_match.empty?
       end
 
       # Finds a value in the hash by path.

data/lib/gapic/rest/resumable_upload/core.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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/rest/resumable_upload/data_types"
+require "gapic/rest/resumable_upload/rules"
+
+module Gapic
+  module Rest
+    module ResumableUpload
+      ##
+      # @private
+      # State machine container holding the immutable State snapshot.
+      # Contains zero protocol branching logic and zero side-effects.
+      #
+      # The middle tier of the three-tier design: `Driver` executes side effects, {Rules} decides transitions,
+      # and Core holds the {State} between the two. See {Rules} for the protocol narrative and state graph, and
+      # `design/resumable_upload/implementation-guide.md` section 1 for the tier boundaries.
+      #
+      class Core
+        # @private
+        # @return [State] Current immutable state snapshot
+        attr_reader :state
+
+        # @private
+        # @return [Decision, nil] Decision emitted during the last dispatch
+        attr_reader :last_decision
+
+        ##
+        # @private
+        # Initializes a Core state machine container.
+        #
+        # @param config [StartUploadConfig, ResumeUploadConfig] Upload session configuration
+        #
+        def initialize config
+          @config = config
+          @last_decision = nil
+          @state = State.new(
+            status:            :initializing,
+            upload_url:        nil,
+            offset:            0,
+            chunk_size:        config.chunk_size || Rules::DEFAULT_CHUNK_SIZE,
+            chunk_granularity: nil,
+            in_flight_length:  0,
+            last_error:        nil
+          )
+        end
+
+        ##
+        # @private
+        # Dispatches event to Rules and updates internal state snapshot.
+        #
+        # @param event [Object] Input event
+        # @return [Array<Object>] Driver instructions
+        #
+        def dispatch event
+          decision = Rules.decide @state, event, @config
+          @state = decision.next_state
+          @last_decision = decision
+          decision.instructions
+        end
+      end
+    end
+  end
+end