google-apis-core 0.11.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82086ecd9dad2239ce9089b943519c39de9b7574a9f1d089bee6cf6531c10eea
-  data.tar.gz: defab5fb9d8dc49ee7e0dc228a9d687d173444ad477f41060c0b418212354058
+  metadata.gz: ea35d9daac9481979c51a054b42778f861d4d3fa7d1a8a384e1d955d9c49e0e9
+  data.tar.gz: 9aae36827cc936b1125aeacd887beee6ca92012e8e2c48b4a429aaac925aa775
 SHA512:
-  metadata.gz: d28bfc73a1293291b6e16ddc520082404030a34d9d78c4eb6e88c81bb038ef13996235ae49f436736e9d2cf82850ed54869141508de0f24f19c96c1a30bd0c4e
-  data.tar.gz: 035f5285444a0af8631f87e6164d5cc52554534e5c4e94cfaef122236937bd73597b58c0c475d89c795d04d76051051b16279d3f8437aa671eef86fb455d3c8c
+  metadata.gz: 4591582657b1d9f1ff151cc74379113bc11a591e943a1257ee1371051db844023e2906234b5af3c8f55b1bb7c0ec6115c83f0a3258a3001f251aeba5419669bd
+  data.tar.gz: 2ca6704eb8a9f1c86def9c644bf5868e1fe3b5442d3e1d6da9b5408e989d908ff4eb2ba07af56268ff2022e531c80bd26db435abd0031877345b9e740f668d42

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 # Release History
 
+### 0.16.0 (2025-01-12)
+
+#### Features
+
+* add ECONNRESET error as retriable error ([#20354](https://github.com/googleapis/google-api-ruby-client/issues/20354)) 
+
+### 0.15.1 (2024-07-29)
+
+#### Bug Fixes
+
+* remove rexml from dependencies ([#19971](https://github.com/googleapis/google-api-ruby-client/issues/19971)) 
+
+### 0.15.0 (2024-05-13)
+
+#### Features
+
+* Introduce api_version to discovery clients ([#18969](https://github.com/googleapis/google-api-ruby-client/issues/18969)) 
+
+### 0.14.1 (2024-03-13)
+
+#### Bug Fixes
+
+* fixes uninitialized Pathname issue ([#18480](https://github.com/googleapis/google-api-ruby-client/issues/18480)) 
+
+### 0.14.0 (2024-02-23)
+
+#### Features
+
+* Update minimum Ruby version to 2.7 ([#17896](https://github.com/googleapis/google-api-ruby-client/issues/17896)) 
+#### Bug Fixes
+
+* allow BaseService#root_url to be an Addressable::URI ([#17895](https://github.com/googleapis/google-api-ruby-client/issues/17895)) 
+
+### 0.13.0 (2024-01-26)
+
+#### Features
+
+* Verify credential universe domain against configured universe domain ([#17569](https://github.com/googleapis/google-api-ruby-client/issues/17569)) 
+
+### 0.12.0 (2024-01-22)
+
+#### Features
+
+* Support for universe_domain ([#17131](https://github.com/googleapis/google-api-ruby-client/issues/17131)) 
+
+### 0.11.3 (2024-01-17)
+
+#### Bug Fixes
+
+* download with destination as pathname ([#17120](https://github.com/googleapis/google-api-ruby-client/issues/17120)) 
+
 ### 0.11.2 (2023-10-27)
 
 #### Bug Fixes

data/lib/google/apis/core/base_service.rb

@@ -93,11 +93,49 @@ module Google
       # Base service for all APIs. Not to be used directly.
       #
       class BaseService
+        ##
+        # A substitution string for the universe domain in an endpoint template
+        # @return [String]
+        #
+        ENDPOINT_SUBSTITUTION = "$UNIVERSE_DOMAIN$".freeze
+
         include Logging
 
+        # Universe domain
+        # @return [String]
+        attr_reader :universe_domain
+
+        # Set the universe domain.
+        # If the root URL was set with a universe domain substitution, it is
+        # updated to reflect the new universe domain.
+        #
+        # @param new_ud [String,nil] The new universe domain, or nil to use the Google Default Universe
+        def universe_domain= new_ud
+          new_ud ||= ENV["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] || "googleapis.com"
+          if @root_url_template
+            @root_url = @root_url_template.gsub ENDPOINT_SUBSTITUTION, new_ud
+          end
+          @universe_domain = new_ud
+        end
+
         # Root URL (host/port) for the API
-        # @return [Addressable::URI]
-        attr_accessor :root_url
+        # @return [Addressable::URI, String]
+        attr_reader :root_url
+
+        # Set the root URL.
+        # If the given url includes a universe domain substitution, it is
+        # resolved in the current universe domain
+        #
+        # @param url_or_template [Addressable::URI, String] The URL, which can include a universe domain substitution
+        def root_url= url_or_template
+          if url_or_template.is_a?(String) && url_or_template.include?(ENDPOINT_SUBSTITUTION)
+            @root_url_template = url_or_template
+            @root_url = url_or_template.gsub ENDPOINT_SUBSTITUTION, universe_domain
+          else
+            @root_url_template = nil
+            @root_url = url_or_template
+          end
+        end
 
         # Additional path prefix for all API methods
         # @return [Addressable::URI]
@@ -136,7 +174,9 @@ module Google
         # @param [String,Addressable::URI] base_path
         #   Additional path prefix for all API methods
         # @api private
-        def initialize(root_url, base_path, client_name: nil, client_version: nil)
+        def initialize(root_url, base_path, client_name: nil, client_version: nil, universe_domain: nil)
+          @root_url_template = nil
+          self.universe_domain = universe_domain
           self.root_url = root_url
           self.base_path = base_path
           self.client_name = client_name || 'google-api-ruby-client'
@@ -279,7 +319,7 @@ module Google
         #   Name of the field in the result containing the items. Defaults to :items
         # @param [Boolean] cache
         #  True (default) if results should be cached so multiple iterations can be used.
-        # @return [Enumerble]
+        # @return [Enumerable]
         # @yield [token, service]
         #   Current page token & service instance
         # @yieldparam [String] token
@@ -296,6 +336,20 @@ module Google
           return PagedResults.new(self, max: max, items: items, cache: cache, response_page_token: response_page_token, &block)
         end
 
+        # Verify that the universe domain setting matches the universe domain
+        # in the credentials, if present.
+        #
+        # @raise [Google::Apis::UniverseDomainError] if there is a mismatch
+        def verify_universe_domain!
+          auth = authorization
+          auth_universe_domain = auth.universe_domain if auth.respond_to? :universe_domain
+          if auth_universe_domain && auth_universe_domain != universe_domain
+            raise UniverseDomainError,
+                  "Universe domain is #{universe_domain} but credentials are in #{auth_universe_domain}"
+          end
+          true
+        end
+
         protected
 
         # Create a new upload command.
@@ -308,6 +362,7 @@ module Google
         #  Request-specific options
         # @return [Google::Apis::Core::UploadCommand]
         def make_upload_command(method, path, options)
+          verify_universe_domain!
           template = Addressable::Template.new(root_url + upload_path + path)
           if batch?
             command = MultipartUploadCommand.new(method, template, client_version: client_version)
@@ -332,6 +387,7 @@ module Google
         #  Request-specific options
         # @return [Google::Apis::Core::StorageUploadCommand]
         def make_storage_upload_command(method, path, options)
+          verify_universe_domain!
           template = Addressable::Template.new(root_url + upload_path + path)
           command = StorageUploadCommand.new(method, template, client_version: client_version)
           command.options = request_options.merge(options)
@@ -349,6 +405,7 @@ module Google
         #  Request-specific options
         # @return [Google::Apis::Core::DownloadCommand]
         def make_download_command(method, path, options)
+          verify_universe_domain!
           template = Addressable::Template.new(root_url + base_path + path)
           command = DownloadCommand.new(method, template, client_version: client_version)
           command.options = request_options.merge(options)
@@ -368,6 +425,7 @@ module Google
         #  Request-specific options
         # @return [Google::Apis::Core::StorageDownloadCommand]
         def make_storage_download_command(method, path, options)
+          verify_universe_domain!
           template = Addressable::Template.new(root_url + base_path + path)
           command = StorageDownloadCommand.new(method, template, client_version: client_version)
           command.options = request_options.merge(options)
@@ -386,6 +444,7 @@ module Google
         #  Request-specific options
         # @return [Google::Apis::Core::DownloadCommand]
         def make_simple_command(method, path, options)
+          verify_universe_domain!
           full_path =
             if path.start_with? "/"
               path[1..-1]

data/lib/google/apis/core/download.rb

@@ -15,6 +15,7 @@
 require 'google/apis/core/api_command'
 require 'google/apis/errors'
 require 'addressable/uri'
+require 'pathname'
 
 module Google
   module Apis
@@ -35,7 +36,10 @@ module Google
           @state = :start
           @download_url = nil
           @offset = 0
-          if download_dest.respond_to?(:write)
+          if @download_dest.is_a?(Pathname)
+            @download_io = File.open(download_dest, 'wb')
+            @close_io_on_finish = true
+          elsif download_dest.respond_to?(:write)
             @download_io = download_dest
             @close_io_on_finish = false
           elsif download_dest.is_a?(String)

data/lib/google/apis/core/http_command.rb

@@ -292,7 +292,12 @@ module Google
             rescue Google::Apis::Error => e
               err = e
             end
-          elsif err.is_a?(HTTPClient::TimeoutError) || err.is_a?(SocketError) || err.is_a?(HTTPClient::KeepAliveDisconnected) || err.is_a?(Errno::ECONNREFUSED) || err.is_a?(Errno::ETIMEDOUT)
+          elsif err.is_a?(HTTPClient::TimeoutError) ||
+                err.is_a?(SocketError) ||
+                err.is_a?(HTTPClient::KeepAliveDisconnected) ||
+                err.is_a?(Errno::ECONNREFUSED) ||
+                err.is_a?(Errno::ETIMEDOUT) ||
+                err.is_a?(Errno::ECONNRESET)
             err = Google::Apis::TransmissionError.new(err)
           end
           block.call(nil, err) if block_given?
@@ -348,6 +353,12 @@ module Google
           [:post, :put].include?(method) && body.nil?
         end
 
+        # Set the API version header for the service if not empty.
+        # @return [void]
+        def set_api_version_header api_version
+          self.header['X-Goog-Api-Version'] = api_version unless api_version.empty?
+        end
+
         private
 
         UNSAFE_CLASS_NAMES = [

data/lib/google/apis/core/storage_download.rb

@@ -25,7 +25,7 @@ module Google
 
         # Execute the upload request once. Overrides the default implementation to handle streaming/chunking
         # of file content.
-        # Note: This method is overriden from DownloadCommand in order to respond back with 
+        # Note: This method is overridden from DownloadCommand in order to respond back with 
         # http header. All changes made to `execute_once` of DownloadCommand, should be made 
         # here too.
         #

data/lib/google/apis/core/version.rb

@@ -16,7 +16,7 @@ module Google
   module Apis
     module Core
       # Core version
-      VERSION = "0.11.2".freeze
+      VERSION = "0.16.0".freeze
     end
   end
 end

data/lib/google/apis/errors.rb

@@ -89,5 +89,9 @@ module Google
     # Error class for problems in batch requests.
     class BatchError < Error
     end
+
+    # Error class for universe domain issues
+    class UniverseDomainError < Error
+    end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-core
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -82,29 +81,23 @@ dependencies:
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.16.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.16.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.8.3
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.a
@@ -114,26 +107,12 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.8.3
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.a
 - !ruby/object:Gem::Dependency
-  name: rexml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webrick
+  name: mutex_m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,7 +125,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -186,9 +164,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/google-apis-core/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-core/v0.11.2
+  documentation_uri: https://googleapis.dev/ruby/google-apis-core/v0.16.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/google-apis-core
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -196,15 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Common utility and base classes for legacy Google REST clients
 test_files: []