google-cloud-storage 1.47.0 → 1.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb6046c8eb979e1cbd733518d8fd242e1332813d6241f85e65b07f6d7d9e631f
-  data.tar.gz: 1124d71be6c1954b38f3fb6c8c3814891d9dd108fc0862f2c5436db18c111782
+  metadata.gz: 67fa1effce117003750f759eba79de92380616365652f2a19ba49b1986c75634
+  data.tar.gz: 9729e6dc51f15a9a5e2e0370771f980908f9d6284973503c9c4d4c1e561b8d84
 SHA512:
-  metadata.gz: 2e8598d2cf01a52f20c7bd554b593d7049134a367f17571721e2779a0634013452ad42025c22d59f8542c030a411092c3f2f63edfe8489fee0a9dcb9ccb5c774
-  data.tar.gz: 4918a472cd83aab2c7d1a5ffe6be9957c0113686a00769f082522799fd9cc713c3315de8d8b2d87caa22b37d7d54c2c82702fb2b5b9e1ed30ef011319dc841cf
+  metadata.gz: ec9022c921c0714ebf7f47131c745c113bb0480a34a376ca10055ccdee024821a518d1a87f742486118d7fb3e570beaeef5746f12676d5790e6ae697439dabd9
+  data.tar.gz: d5e57fd75d565a8328cf79ce42374883e4da7f875c7fd9571e928f9648c05578bee5743d68465819f3e5d488469d277749aecebd44810198fd1a1ca0cac6f3c3

data/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Release History
 
+### 1.54.0 (2024-12-11)
+
+#### Features
+
+* Updated required Ruby version to 3.0 or later ([#27599](https://github.com/googleapis/google-cloud-ruby/issues/27599)) 
+
+### 1.53.0 (2024-12-04)
+
+#### Features
+
+* add integration test for universe domain ([#27384](https://github.com/googleapis/google-cloud-ruby/issues/27384)) 
+* fetch file and bucket details from url ([#27322](https://github.com/googleapis/google-cloud-ruby/issues/27322)) 
+
+### 1.52.0 (2024-05-31)
+
+#### Features
+
+* support for hierarchical namespace (folders) ([#25967](https://github.com/googleapis/google-cloud-ruby/issues/25967)) 
+
+### 1.51.0 (2024-04-25)
+
+#### Features
+
+* Respect custom endpoint for signed_url ([#25469](https://github.com/googleapis/google-cloud-ruby/issues/25469)) 
+
+### 1.50.0 (2024-04-19)
+
+#### Features
+
+* Add support for soft deletion ([#25340](https://github.com/googleapis/google-cloud-ruby/issues/25340)) 
+#### Bug Fixes
+
+* Set configured univer_domain and endpoint when initializing through Service ([#25665](https://github.com/googleapis/google-cloud-ruby/issues/25665)) 
+
+### 1.49.0 (2024-02-21)
+
+#### Features
+
+* Support of Managed Folders ([#24809](https://github.com/googleapis/google-cloud-ruby/issues/24809)) 
+
+### 1.48.1 (2024-01-26)
+
+#### Bug Fixes
+
+* Raise an error on mismatching universe domain ([#24486](https://github.com/googleapis/google-cloud-ruby/issues/24486)) 
+
+### 1.48.0 (2024-01-25)
+
+#### Features
+
+* Support for universe_domain ([#24449](https://github.com/googleapis/google-cloud-ruby/issues/24449)) 
+
 ### 1.47.0 (2024-01-09)
 
 #### Features

data/lib/google/cloud/storage/bucket/cors.rb

@@ -182,7 +182,7 @@ module Google
               @origin = Array(origin)
               @methods = Array(methods)
               @headers = Array(headers)
-              @max_age = (max_age || 1800)
+              @max_age = max_age || 1800
             end
 
             # @private
@@ -195,7 +195,7 @@ module Google
 
             # @private
             def self.from_gapi gapi
-              new gapi.origin.dup, gapi.http_method.dup, \
+              new gapi.origin.dup, gapi.http_method.dup,
                   headers: gapi.response_header.dup,
                   max_age: gapi.max_age_seconds
             end

data/lib/google/cloud/storage/bucket.rb

@@ -1194,6 +1194,121 @@ module Google
           patch_gapi! :rpo
         end
 
+        ##
+        # The bucket's soft delete policy. If this policy is set, any deleted
+        # objects will be soft-deleted according to the time specified in the
+        # policy.
+        # This value can be modified by calling {#soft_delete_policy=}.
+        #
+        # @return [Google::Apis::StorageV1::Bucket::SoftDeletePolicy] The default retention policy is for 7
+        # days.
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.soft_delete_policy
+        #
+        def soft_delete_policy
+          @gapi.soft_delete_policy
+        end
+
+        ##
+        # Sets the value for Soft Delete Policy in the bucket. This value can
+        # be queried by calling {#soft_delete_policy}.
+        #
+        # @param [Google::Apis::StorageV1::Bucket::SoftDeletePolicy,
+        #         Hash(String => String)] new_soft_delete_policy The bucket's
+        #         new Soft Delete Policy.
+        #
+        # @example Set Soft Delete Policy to 10 days using SoftDeletePolicy class:
+        #   require "google/cloud/storage"
+        #   require "date"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   soft_delete_policy = Google::Apis::StorageV1::Bucket::SoftDeletePolicy.new
+        #   soft_delete_policy.retention_duration_seconds = 10*24*60*60
+        #
+        #   bucket.soft_delete_policy = soft_delete_policy
+        #
+        # @example Set Soft Delete Policy to 5 days using Hash:
+        #   require "google/cloud/storage"
+        #   require "date"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   soft_delete_policy = { retention_duration_seconds: 432000 }
+        #   bucket.soft_delete_policy = soft_delete_policy
+        #
+        def soft_delete_policy= new_soft_delete_policy
+          @gapi.soft_delete_policy = new_soft_delete_policy || {}
+          patch_gapi! :soft_delete_policy
+        end
+
+        ##
+        # The bucket's hierarchical namespace (Folders) configuration.
+        # This value can be modified by calling {#hierarchical_namespace=}.
+        #
+        # @return [Google::Apis::StorageV1::Bucket::HierarchicalNamespace]
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.hierarchical_namespace
+        #
+        def hierarchical_namespace
+          @gapi.hierarchical_namespace
+        end
+
+        ##
+        # Sets the value of Hierarchical Namespace (Folders) for the bucket.
+        # This can only be enabled at bucket create time. If this is enabled,
+        # Uniform Bucket-Level Access must also be enabled.
+        # This value can be queried by calling {#hierarchical_namespace}.
+        #
+        # @param [Google::Apis::StorageV1::Bucket::HierarchicalNamespace,
+        #         Hash(String => String)] new_hierarchical_namespace The
+        #         bucket's new Hierarchical Namespace Configuration.
+        #
+        # @example Enabled Hierarchical Namespace using HierarchicalNamespace class:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   hierarchical_namespace = Google::Apis::StorageV1::Bucket::HierarchicalNamespace.new
+        #   hierarchical_namespace.enabled = true
+        #
+        #   bucket.hierarchical_namespace = hierarchical_namespace
+        #
+        # @example Disable Hierarchical Namespace using Hash:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   hierarchical_namespace = { enabled: false }
+        #   bucket.hierarchical_namespace = hierarchical_namespace
+        #
+        def hierarchical_namespace= new_hierarchical_namespace
+          @gapi.hierarchical_namespace = new_hierarchical_namespace || {}
+          patch_gapi! :hierarchical_namespace
+        end
+
         ##
         # Updates the bucket with changes made in the given block in a single
         # PATCH request. The following attributes may be set: {#cors},
@@ -1319,6 +1434,11 @@ module Google
         #   as distinct results. The default is `false`. For more information,
         #   see [Object Versioning
         #   ](https://cloud.google.com/storage/docs/object-versioning).
+        # @param [Boolean] include_folders_as_prefixes If `true`, will also include
+        #   folders and managed folders, besides objects, in the returned prefixes.
+        #   Only applicable if delimiter is set to '/'.
+        # @param [Boolean] soft_deleted If true, only soft-deleted object
+        #   versions will be listed. The default is false.
         #
         # @return [Array<Google::Cloud::Storage::File>] (See
         #   {Google::Cloud::Storage::File::List})
@@ -1346,17 +1466,22 @@ module Google
         #   end
         #
         def files prefix: nil, delimiter: nil, token: nil, max: nil,
-                  versions: nil, match_glob: nil
+                  versions: nil, match_glob: nil, include_folders_as_prefixes: nil,
+                  soft_deleted: nil
           ensure_service!
           gapi = service.list_files name, prefix: prefix, delimiter: delimiter,
                                           token: token, max: max,
                                           versions: versions,
                                           user_project: user_project,
-                                          match_glob: match_glob
+                                          match_glob: match_glob,
+                                          include_folders_as_prefixes: include_folders_as_prefixes,
+                                          soft_deleted: soft_deleted
           File::List.from_gapi gapi, service, name, prefix, delimiter, max,
                                versions,
                                user_project: user_project,
-                               match_glob: match_glob
+                               match_glob: match_glob,
+                               include_folders_as_prefixes: include_folders_as_prefixes,
+                               soft_deleted: soft_deleted
         end
         alias find_files files
 
@@ -1392,6 +1517,8 @@ module Google
         # @param [String] encryption_key Optional. The customer-supplied,
         #   AES-256 encryption key used to encrypt the file, if one was provided
         #   to {#create_file}. (Not used if `skip_lookup` is also set.)
+        # @param [Boolean] soft_deleted Optional. If true, only soft-deleted
+        #   object versions will be listed. The default is false.
         #
         # @return [Google::Cloud::Storage::File, nil] Returns nil if file does
         #   not exist
@@ -1413,7 +1540,8 @@ module Google
                  if_metageneration_match: nil,
                  if_metageneration_not_match: nil,
                  skip_lookup: nil,
-                 encryption_key: nil
+                 encryption_key: nil,
+                 soft_deleted: nil
           ensure_service!
           if skip_lookup
             return File.new_lazy name, path, service,
@@ -1426,7 +1554,8 @@ module Google
                                               if_metageneration_match: if_metageneration_match,
                                               if_metageneration_not_match: if_metageneration_not_match,
                                               key: encryption_key,
-                                              user_project: user_project
+                                              user_project: user_project,
+                                              soft_deleted: soft_deleted
           File.from_gapi gapi, service, user_project: user_project
         rescue Google::Cloud::NotFoundError
           nil
@@ -1707,6 +1836,77 @@ module Google
         alias upload_file create_file
         alias new_file create_file
 
+        ##
+        # Restores a soft-deleted object.
+        #
+        # @param [String] file_path
+        #   Name of the file.
+        # @param [Fixnum] generation
+        #   Selects a specific revision of this object.
+        # @param [Boolean] copy_source_acl
+        #   If true, copies the source file's ACL; otherwise, uses the
+        #   bucket's default file ACL. The default is false.
+        # @param [Fixnum] if_generation_match
+        #   Makes the operation conditional on whether the file's one live
+        #   generation matches the given value. Setting to 0 makes the
+        #   operation succeed only if there are no live versions of the file.
+        # @param [Fixnum] if_generation_not_match
+        #   Makes the operation conditional on whether none of the file's live
+        #   generations match the given value. If no live file exists, the
+        #   precondition fails. Setting to 0 makes the operation succeed only
+        #   if there is a live version of the file.
+        # @param [Fixnum] if_metageneration_match
+        #   Makes the operation conditional on whether the file's one live
+        #   metageneration matches the given value.
+        # @param [Fixnum] if_metageneration_not_match
+        #   Makes the operation conditional on whether none of the object's
+        #   live metagenerations match the given value.
+        # @param [String] projection
+        #   Set of properties to return. Defaults to full.
+        # @param [String] user_project
+        #   The project to be billed for this request. Required for Requester
+        #   Pays buckets.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        #
+        # @return [Google::Cloud::Storage::File]
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.restore_file "path/of/file", <generation-of-the-file>
+        #
+        def restore_file file_path,
+                         generation,
+                         copy_source_acl: nil,
+                         if_generation_match: nil,
+                         if_generation_not_match: nil,
+                         if_metageneration_match: nil,
+                         if_metageneration_not_match: nil,
+                         projection: nil,
+                         user_project: nil,
+                         fields: nil,
+                         options: {}
+          ensure_service!
+          gapi = service.restore_file name,
+                                      file_path,
+                                      generation,
+                                      copy_source_acl: File::Acl.predefined_rule_for(copy_source_acl),
+                                      if_generation_match: if_generation_match,
+                                      if_generation_not_match: if_generation_not_match,
+                                      if_metageneration_match: if_metageneration_match,
+                                      if_metageneration_not_match: if_metageneration_not_match,
+                                      projection: projection,
+                                      user_project: user_project,
+                                      fields: fields,
+                                      options: options
+          File.from_gapi gapi, service, user_project: user_project
+        end
+
         ##
         # Concatenates a list of existing files in the bucket into a new file in
         # the bucket. There is a limit (currently 32) to the number of files
@@ -2987,9 +3187,9 @@ module Google
           attributes.flatten!
           return if attributes.empty?
           ensure_service!
-          patch_args = Hash[attributes.map do |attr|
+          patch_args = attributes.to_h do |attr|
             [attr, @gapi.send(attr)]
-          end]
+          end
           patch_gapi = API::Bucket.new(**patch_args)
           @gapi = service.patch_bucket name,
                                        patch_gapi,
@@ -3007,9 +3207,9 @@ module Google
           attributes.flatten!
           return if attributes.empty?
           ensure_service!
-          update_args = Hash[attributes.map do |attr|
+          update_args = attributes.to_h do |attr|
             [attr, @gapi.send(attr)]
-          end]
+          end
           update_gapi = API::Bucket.new(**update_args)
           @gapi = service.update_bucket name,
                                         update_gapi,

data/lib/google/cloud/storage/file/list.rb

@@ -165,8 +165,9 @@ module Google
           # Google::Apis::StorageV1::Objects object.
           def self.from_gapi gapi_list, service, bucket = nil, prefix = nil,
                              delimiter = nil, max = nil, versions = nil,
-                             user_project: nil,
-                             match_glob: nil
+                             user_project: nil, match_glob: nil,
+                             include_folders_as_prefixes: nil,
+                             soft_deleted: nil
             files = new(Array(gapi_list.items).map do |gapi_object|
               File.from_gapi gapi_object, service, user_project: user_project
             end)
@@ -180,6 +181,8 @@ module Google
             files.instance_variable_set :@versions, versions
             files.instance_variable_set :@user_project, user_project
             files.instance_variable_set :@match_glob, match_glob
+            files.instance_variable_set :@include_folders_as_prefixes, include_folders_as_prefixes
+            files.instance_variable_set :@soft_deleted, soft_deleted
             files
           end
 

data/lib/google/cloud/storage/file/signer_v2.rb

@@ -60,7 +60,8 @@ module Google
           ##
           # The external url to the file.
           def ext_url
-            "#{GOOGLEAPIS_URL}#{ext_path}"
+            root_url = @service.service.root_url.chomp "/"
+            "#{root_url}#{ext_path}"
           end
 
           def apply_option_defaults options
@@ -91,7 +92,7 @@ module Google
 
           def error_msg attr_name
             "Service account credentials '#{attr_name}' is missing. To generate service account credentials " \
-            "see https://cloud.google.com/iam/docs/service-accounts"
+              "see https://cloud.google.com/iam/docs/service-accounts"
           end
 
           def post_object options
@@ -144,8 +145,8 @@ module Google
 
           def generate_signed_url issuer, signed_string, expires, query
             url = "#{ext_url}?GoogleAccessId=#{url_escape issuer}" \
-              "&Expires=#{expires}" \
-              "&Signature=#{url_escape signed_string}"
+                  "&Expires=#{expires}" \
+                  "&Signature=#{url_escape signed_string}"
 
             query&.each do |name, value|
               url << "&#{url_escape name}=#{url_escape value}"

data/lib/google/cloud/storage/file/signer_v4.rb

@@ -131,7 +131,7 @@ module Google
           # methods below are public visibility only for unit testing
           # rubocop:disable Style/StringLiterals
           def escape_characters str
-            str.split("").map do |s|
+            str.chars.map do |s|
               if s.ascii_only?
                 case s
                 when "\\"
@@ -207,7 +207,7 @@ module Google
 
           def error_msg attr_name
             "Service account credentials '#{attr_name}' is missing. To generate service account credentials " \
-            "see https://cloud.google.com/iam/docs/service-accounts"
+              "see https://cloud.google.com/iam/docs/service-accounts"
           end
 
           def service_account_signer signer
@@ -243,7 +243,7 @@ module Google
             headers_arr = canonical_headers.map do |k, v|
               [k.downcase, v.strip.gsub(/[^\S\t]+/, " ").gsub(/\t+/, " ")]
             end
-            canonical_headers = Hash[headers_arr]
+            canonical_headers = headers_arr.to_h
             canonical_headers["host"] = host_name virtual_hosted_style, bucket_bound_hostname
 
             canonical_headers = canonical_headers.sort_by(&:first).to_h
@@ -295,13 +295,13 @@ module Google
           ##
           # The external path to the bucket, with trailing slash.
           def bucket_path path_style
-            return "/#{@bucket_name}/" if path_style
+            "/#{@bucket_name}/" if path_style
           end
 
           ##
           # The external url to the file.
           def ext_url scheme, virtual_hosted_style, bucket_bound_hostname
-            url = GOOGLEAPIS_URL.dup
+            url = @service.service.root_url.chomp "/"
             if virtual_hosted_style
               parts = url.split "//"
               parts[1] = "#{@bucket_name}.#{parts[1]}"

data/lib/google/cloud/storage/file.rb

@@ -763,6 +763,30 @@ module Google
           @gapi.retention_expiration_time
         end
 
+        ##
+        # This soft delete time is the time when the object became
+        # soft-deleted.
+        #
+        # @return [DateTime, nil] A DateTime representing the time at
+        #   which the object became soft-deleted, or `nil` if the file was
+        #   not deleted.
+        #
+        def soft_delete_time
+          @gapi.soft_delete_time
+        end
+
+        ##
+        # This hard delete time is The time when the file will be permanently
+        # deleted.
+        #
+        # @return [DateTime, nil] A DateTime representing the time at
+        #   which the file will be permanently deleted, or `nil` if the file is
+        #   not soft deleted.
+        #
+        def hard_delete_time
+          @gapi.hard_delete_time
+        end
+
         ##
         # Retrieves a list of versioned files for the current object.
         #
@@ -2048,15 +2072,59 @@ module Google
         def self.gapi_from_attrs gapi, attributes
           attributes.flatten!
           return nil if attributes.empty?
-          attr_params = Hash[attributes.map do |attr|
-                               [attr, gapi.send(attr)]
-                             end]
+          attr_params = attributes.to_h do |attr|
+            [attr, gapi.send(attr)]
+          end
           # Sending nil metadata results in an Apiary runtime error:
           # NoMethodError: undefined method `each' for nil:NilClass
           attr_params.reject! { |k, v| k == :metadata && v.nil? }
           Google::Apis::StorageV1::Object.new(**attr_params)
         end
 
+        ##
+        # from_gs_url is a method to fetch bucket details and file details from a gs url
+        #
+        # @return [Hash(String => String)]
+        #
+        # @example Fetch bucket_name and file_Path from gs url:
+        #   require "google/cloud/storage"
+        #   gs_url= "gs://my-todo-app/avatars/heidi.jpeg"
+        #   file=Google::Cloud::Storage::File
+        #   file.from_gs_url(gs_url)
+        #   =>
+        #   {"bucket_name"=>"my-todo-app", "file_path"=>"avatars/heidi.jpeg"}
+        #
+        # @example Fetch bucket_name , file_Path and other query params from gs url:
+        #   require "google/cloud/storage"
+        #   gs_url= "gs://my-todo-app/test_sub_folder/heidi.jpeg?params1=test1&params2=test2"
+        #   file=Google::Cloud::Storage::File
+        #   file.from_gs_url(gs_url)
+        #   =>{
+        #     "bucket_name"=>"my-todo-app",
+        #     "file_path"=>"test_sub_folder/heidi.jpeg",
+        #     "options" => {
+        #       "params1"=>"test1",
+        #       "params2"=>"test2"
+        #       }
+        #      }
+
+        def self.from_gs_url gs_url
+          prefix = "gs://".freeze
+          raise ArgumentError, "Invalid GCS URL" unless gs_url.start_with? prefix
+          # seprating params from input url
+          path, query = gs_url.sub(prefix, "").split("?", 2)
+          # parsing the url
+          bucket_name, file_path = path.split "/", 2
+          query_params = URI.decode_www_form(query).to_h if query
+          url_items = {
+            "bucket_name" => bucket_name,
+            "file_path" => file_path
+          }
+          # adding url params to output hash
+          url_items.merge! "options" => query_params if query
+          url_items
+        end
+
         protected
 
         ##
@@ -2172,10 +2240,8 @@ module Google
           [dest_bucket, dest_path]
         end
 
-        # rubocop:disable Style/MultipleComparison
-
         def verify_file! file, verify = :md5
-          verify_md5    = verify == :md5    || verify == :all
+          verify_md5    = verify == :md5 || verify == :all
           verify_crc32c = verify == :crc32c || verify == :all
           Verifier.verify_md5! self, file    if verify_md5    && md5
           Verifier.verify_crc32c! self, file if verify_crc32c && crc32c

data/lib/google/cloud/storage/project.rb

@@ -62,6 +62,15 @@ module Google
           @service = service
         end
 
+        ##
+        # The universe domain the client is connected to
+        #
+        # @return [String]
+        #
+        def universe_domain
+          service.universe_domain
+        end
+
         ##
         # The Storage project connected to.
         #
@@ -412,6 +421,7 @@ module Google
         #     b.lifecycle.add_set_storage_class_rule "COLDLINE", age: 10
         #   end
         #
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def create_bucket bucket_name,
                           acl: nil,
                           default_acl: nil,
@@ -426,11 +436,13 @@ module Google
                           requester_pays: nil,
                           user_project: nil,
                           autoclass_enabled: false,
-                          enable_object_retention: nil
+                          enable_object_retention: nil,
+                          hierarchical_namespace: nil
           params = {
             name: bucket_name,
             location: location,
-            custom_placement_config: custom_placement_config
+            custom_placement_config: custom_placement_config,
+            hierarchical_namespace: hierarchical_namespace
           }.delete_if { |_, v| v.nil? }
           new_bucket = Google::Apis::StorageV1::Bucket.new(**params)
           storage_class = storage_class_for storage_class
@@ -443,6 +455,7 @@ module Google
             b.website_404 = website_404 unless website_404.nil?
             b.versioning = versioning unless versioning.nil?
             b.requester_pays = requester_pays unless requester_pays.nil?
+            b.hierarchical_namespace = hierarchical_namespace unless hierarchical_namespace.nil?
           end
           yield updater if block_given?
           updater.check_for_changed_labels!
@@ -454,6 +467,7 @@ module Google
                         enable_object_retention: enable_object_retention
           Bucket.from_gapi gapi, service, user_project: user_project
         end
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         ##
         # Creates a new HMAC key.

data/lib/google/cloud/storage/service.rb

@@ -15,6 +15,7 @@
 
 require "google/cloud/storage/version"
 require "google/apis/storage_v1"
+require "google/cloud/config"
 require "digest"
 require "mini_mime"
 require "pathname"
@@ -36,6 +37,11 @@ module Google
         # @private
         attr_accessor :credentials
 
+        # @private
+        def universe_domain
+          service.universe_domain
+        end
+
         ##
         # Creates a new Service instance.
         # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -43,7 +49,8 @@ module Google
                        timeout: nil, open_timeout: nil, read_timeout: nil,
                        send_timeout: nil, host: nil, quota_project: nil,
                        max_elapsed_time: nil, base_interval: nil, max_interval: nil,
-                       multiplier: nil, upload_chunk_size: nil
+                       multiplier: nil, upload_chunk_size: nil, universe_domain: nil
+          host ||= Google::Cloud::Storage.configure.endpoint
           @project = project
           @credentials = credentials
           @service = API::StorageService.new
@@ -68,6 +75,13 @@ module Google
           @service.request_options.upload_chunk_size = upload_chunk_size if upload_chunk_size
           @service.authorization = @credentials.client if @credentials
           @service.root_url = host if host
+          @service.universe_domain = universe_domain || Google::Cloud::Storage.configure.universe_domain
+          begin
+            @service.verify_universe_domain!
+          rescue Google::Apis::UniverseDomainError => e
+            # TODO: Create a Google::Cloud::Error subclass for this.
+            raise Google::Cloud::Error, e.message
+          end
         end
         # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
@@ -351,8 +365,8 @@ module Google
         # Retrieves a list of files matching the criteria.
         def list_files bucket_name, delimiter: nil, max: nil, token: nil,
                        prefix: nil, versions: nil, user_project: nil,
-                       match_glob: nil,
-                       options: {}
+                       match_glob: nil, include_folders_as_prefixes: nil,
+                       soft_deleted: nil, options: {}
           execute do
             service.list_objects \
               bucket_name, delimiter: delimiter, max_results: max,
@@ -360,6 +374,8 @@ module Google
                            versions: versions,
                            user_project: user_project(user_project),
                            match_glob: match_glob,
+                           include_folders_as_prefixes: include_folders_as_prefixes,
+                           soft_deleted: soft_deleted,
                            options: options
           end
         end
@@ -443,6 +459,7 @@ module Google
                      if_metageneration_not_match: nil,
                      key: nil,
                      user_project: nil,
+                     soft_deleted: nil,
                      options: {}
           execute do
             service.get_object \
@@ -453,6 +470,7 @@ module Google
               if_metageneration_match: if_metageneration_match,
               if_metageneration_not_match: if_metageneration_not_match,
               user_project: user_project(user_project),
+              soft_deleted: soft_deleted,
               options: key_options(key).merge(options)
           end
         end
@@ -525,7 +543,6 @@ module Google
                          if_metageneration_match: nil,
                          user_project: nil,
                          options: {}
-
           source_objects = compose_file_source_objects source_files, if_source_generation_match
           compose_req = Google::Apis::StorageV1::ComposeRequest.new source_objects: source_objects,
                                                                     destination: destination_gapi
@@ -620,7 +637,6 @@ module Google
                         if_metageneration_not_match: nil,
                         user_project: nil,
                         options: {}
-
           if options[:retries].nil?
             is_idempotent = retry? generation: generation, if_generation_match: if_generation_match
             options = is_idempotent ? {} : { retries: 0 }
@@ -638,6 +654,39 @@ module Google
           end
         end
 
+        ##
+        # Restores a soft-deleted object.
+        def restore_file bucket_name,
+                         file_path,
+                         generation,
+                         copy_source_acl: nil,
+                         if_generation_match: nil,
+                         if_generation_not_match: nil,
+                         if_metageneration_match: nil,
+                         if_metageneration_not_match: nil,
+                         projection: nil,
+                         user_project: nil,
+                         fields: nil,
+                         options: {}
+          if options[:retries].nil?
+            is_idempotent = retry? generation: generation, if_generation_match: if_generation_match
+            options = is_idempotent ? {} : { retries: 0 }
+          end
+
+          execute do
+            service.restore_object bucket_name, file_path, generation,
+                                   copy_source_acl: copy_source_acl,
+                                   if_generation_match: if_generation_match,
+                                   if_generation_not_match: if_generation_not_match,
+                                   if_metageneration_match: if_metageneration_match,
+                                   if_metageneration_not_match: if_metageneration_not_match,
+                                   projection: projection,
+                                   user_project: user_project(user_project),
+                                   fields: fields,
+                                   options: options
+          end
+        end
+
         ##
         # Retrieves a list of ACLs for the given file.
         def list_file_acls bucket_name, file_name, user_project: nil, options: {}
@@ -686,7 +735,6 @@ module Google
         # Returns Google::Apis::StorageV1::HmacKey.
         def create_hmac_key service_account_email, project_id: nil,
                             user_project: nil, options: {}
-
           if options[:retries].nil?
             options = options.merge({ retries: 0 })
           end

data/lib/google/cloud/storage/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.47.0".freeze
+      VERSION = "1.54.0".freeze
     end
   end
 end

data/lib/google/cloud/storage.rb

@@ -67,6 +67,8 @@ module Google
       # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
+      # @param universe_domain [String] Override of the universe domain. Optional.
+      #   If unset or nil, uses the default unvierse domain
       # @param [Integer] upload_chunk_size The chunk size of storage upload, in bytes.
       #                  The default value is 100 MB, i.e. 104_857_600 bytes. To disable chunking and upload
       #                  the complete file regardless of size, pass 0 as the chunk size.
@@ -92,20 +94,21 @@ module Google
                    timeout: nil, open_timeout: nil, read_timeout: nil,
                    send_timeout: nil, endpoint: nil, project: nil, keyfile: nil,
                    max_elapsed_time: nil, base_interval: nil, max_interval: nil,
-                   multiplier: nil, upload_chunk_size: nil
+                   multiplier: nil, upload_chunk_size: nil, universe_domain: nil
         scope             ||= configure.scope
         retries           ||= configure.retries
         timeout           ||= configure.timeout
-        open_timeout      ||= (configure.open_timeout || timeout)
-        read_timeout      ||= (configure.read_timeout || timeout)
-        send_timeout      ||= (configure.send_timeout || timeout)
+        open_timeout      ||= configure.open_timeout || timeout
+        read_timeout      ||= configure.read_timeout || timeout
+        send_timeout      ||= configure.send_timeout || timeout
         endpoint          ||= configure.endpoint
-        credentials       ||= (keyfile || default_credentials(scope: scope))
+        credentials       ||= keyfile || default_credentials(scope: scope)
         max_elapsed_time  ||= configure.max_elapsed_time
         base_interval     ||= configure.base_interval
         max_interval      ||= configure.max_interval
         multiplier        ||= configure.multiplier
         upload_chunk_size ||= configure.upload_chunk_size
+        universe_domain   ||= configure.universe_domain
 
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Storage::Credentials.new credentials, scope: scope
@@ -121,7 +124,8 @@ module Google
             read_timeout: read_timeout, send_timeout: send_timeout,
             host: endpoint, quota_project: configure.quota_project,
             max_elapsed_time: max_elapsed_time, base_interval: base_interval,
-            max_interval: max_interval, multiplier: multiplier, upload_chunk_size: upload_chunk_size
+            max_interval: max_interval, multiplier: multiplier, upload_chunk_size: upload_chunk_size,
+            universe_domain: universe_domain
           )
         )
       end
@@ -145,6 +149,8 @@ module Google
       # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
+      # @param universe_domain [String] Override of the universe domain. Optional.
+      #   If unset or nil, uses the default unvierse domain
       # @param [Integer] upload_chunk_size The chunk size of storage upload, in bytes.
       #                  The default value is 100 MB, i.e. 104_857_600 bytes. To disable chunking and upload
       #                  the complete file regardless of size, pass 0 as the chunk size.
@@ -166,7 +172,7 @@ module Google
       def self.anonymous retries: nil, timeout: nil, open_timeout: nil,
                          read_timeout: nil, send_timeout: nil, endpoint: nil,
                          max_elapsed_time: nil, base_interval: nil, max_interval: nil,
-                         multiplier: nil, upload_chunk_size: nil
+                         multiplier: nil, upload_chunk_size: nil, universe_domain: nil
         open_timeout ||= timeout
         read_timeout ||= timeout
         send_timeout ||= timeout
@@ -175,7 +181,8 @@ module Google
             nil, nil, retries: retries, timeout: timeout, open_timeout: open_timeout,
             read_timeout: read_timeout, send_timeout: send_timeout, host: endpoint,
             max_elapsed_time: max_elapsed_time, base_interval: base_interval,
-            max_interval: max_interval, multiplier: multiplier, upload_chunk_size: upload_chunk_size
+            max_interval: max_interval, multiplier: multiplier, upload_chunk_size: upload_chunk_size,
+            universe_domain: universe_domain
           )
         )
       end

data/lib/google-cloud-storage.rb

@@ -79,11 +79,11 @@ module Google
     def storage scope: nil, retries: nil, timeout: nil, open_timeout: nil, read_timeout: nil, send_timeout: nil,
                 max_elapsed_time: nil, base_interval: nil, max_interval: nil, multiplier: nil, upload_chunk_size: nil
       Google::Cloud.storage @project, @keyfile, scope: scope,
-                                                retries: (retries || @retries),
-                                                timeout: (timeout || @timeout),
-                                                open_timeout: (open_timeout || timeout),
-                                                read_timeout: (read_timeout || timeout),
-                                                send_timeout: (send_timeout || timeout),
+                                                retries: retries || @retries,
+                                                timeout: timeout || @timeout,
+                                                open_timeout: open_timeout || timeout,
+                                                read_timeout: read_timeout || timeout,
+                                                send_timeout: send_timeout || timeout,
                                                 max_elapsed_time: max_elapsed_time,
                                                 base_interval: base_interval,
                                                 max_interval: max_interval,
@@ -149,9 +149,9 @@ module Google
                                  scope: scope,
                                  retries: retries,
                                  timeout: timeout,
-                                 open_timeout: (open_timeout || timeout),
-                                 read_timeout: (read_timeout || timeout),
-                                 send_timeout: (send_timeout || timeout),
+                                 open_timeout: open_timeout || timeout,
+                                 read_timeout: read_timeout || timeout,
+                                 send_timeout: send_timeout || timeout,
                                  max_elapsed_time: max_elapsed_time,
                                  base_interval: base_interval,
                                  max_interval: max_interval,
@@ -162,7 +162,6 @@ module Google
 end
 
 # Set the default storage configuration
-# rubocop:disable Metrics/BlockLength
 Google::Cloud.configure.add_config! :storage do |config|
   default_project = Google::Cloud::Config.deferred do
     ENV["STORAGE_PROJECT"]
@@ -192,7 +191,6 @@ Google::Cloud.configure.add_config! :storage do |config|
   config.add_field! :read_timeout, nil, match: Integer
   config.add_field! :send_timeout, nil, match: Integer
   config.add_field! :upload_chunk_size, nil, match: Integer
-  # TODO: Remove once discovery document is updated.
-  config.add_field! :endpoint, "https://storage.googleapis.com/", match: String
+  config.add_field! :endpoint, nil, match: String, allow_nil: true
+  config.add_field! :universe_domain, nil, match: String, allow_nil: true
 end
-# rubocop:enable Metrics/BlockLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.47.0
+  version: 1.54.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -25,54 +25,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: google-apis-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: google-apis-iamcredentials_v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: google-apis-storage_v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: '0.38'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: '0.38'
 - !ruby/object:Gem::Dependency
   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: digest-crc
   requirement: !ruby/object:Gem::Requirement
@@ -121,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.30.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -325,14 +333,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage