google-cloud-storage 1.53.0 → 1.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe3e1f688d9b54f38ed678c881b0ad6b53f80d9a3f8983b23f2ea42939bb8c1d
-  data.tar.gz: 937a4544aa1f3497c62ec42c6c040cdc54be7eec8f8eb0a6a48825fc5adcd5c9
+  metadata.gz: b88969084fc97975cbd8423d11ea1d02c6a0d4ef77361214cfa86b225d6e2721
+  data.tar.gz: 53efca6d4100e617c4cb435091d4c8a4912b7520eecbe4a643ee50b161c34c85
 SHA512:
-  metadata.gz: 4fe5213423da8b342653278f41c9d00b45cfec9ed1e3d0bc451625390149e1f826ce7dff10e6d45bfddf80558f00a13814a0572193103c964d40b68217e44f2e
-  data.tar.gz: c7dcb018af799f2cbae6a3909377de03dca0127c642da171348c80be1f2870ee758c7d9f49d38035eded59b664713a7675aa775373793ea132bc220bdd47cbee
+  metadata.gz: 3842107e2b0e9eafd47eff5df012f9f133ebb510c3017af5bbc804b40b254d8db8d0b5ce1eb5da7d28ee673192a10dfe6114f1532038b128b84fbc06843d299d
+  data.tar.gz: 17cd1eefbadbdab56c424a013a17d64e1747d0fbc042a73dbfaa6f47bf0b416bdbc40928e8712633c56833275881852cd932c9b1c668fc81cd2950487099c2e6

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History
 
+### 1.55.0 (2025-02-13)
+
+#### Features
+
+* Soft deleted Bucket Restore ([#28138](https://github.com/googleapis/google-cloud-ruby/issues/28138)) 
+#### Documentation
+
+* updating the encryption key GCS sample ([#28815](https://github.com/googleapis/google-cloud-ruby/issues/28815)) 
+
+### 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

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

@@ -72,7 +72,8 @@ module Google
             return nil unless next?
             ensure_service!
             gapi = @service.list_buckets prefix: @prefix, token: @token,
-                                         max: @max, user_project: @user_project
+                                         max: @max, user_project: @user_project,
+                                         soft_deleted: @soft_deleted
             Bucket::List.from_gapi gapi, @service, @prefix, @max,
                                    user_project: @user_project
           end
@@ -146,7 +147,7 @@ module Google
           # @private New Bucket::List from a Google API Client
           # Google::Apis::StorageV1::Buckets object.
           def self.from_gapi gapi_list, service, prefix = nil, max = nil,
-                             user_project: nil
+                             user_project: nil, soft_deleted: nil
             buckets = new(Array(gapi_list.items).map do |gapi_object|
               Bucket.from_gapi gapi_object, service, user_project: user_project
             end)
@@ -155,6 +156,7 @@ module Google
             buckets.instance_variable_set :@prefix, prefix
             buckets.instance_variable_set :@max, max
             buckets.instance_variable_set :@user_project, user_project
+            buckets.instance_variable_set :@soft_deleted, soft_deleted
             buckets
           end
 

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

@@ -982,7 +982,7 @@ module Google
         #
         def uniform_bucket_level_access= new_uniform_bucket_level_access
           @gapi.iam_configuration ||= API::Bucket::IamConfiguration.new
-          @gapi.iam_configuration.uniform_bucket_level_access ||= \
+          @gapi.iam_configuration.uniform_bucket_level_access ||=
             API::Bucket::IamConfiguration::UniformBucketLevelAccess.new
           @gapi.iam_configuration.uniform_bucket_level_access.enabled = new_uniform_bucket_level_access
           patch_gapi! :iam_configuration
@@ -2280,6 +2280,31 @@ module Google
           end
         end
 
+        # Fetches generation of the bucket
+        # @example
+        #   require "google/cloud/storage"
+        #   storage = Google::Cloud::Storage.new
+        #   bucket = storage.bucket "my-bucket"
+        #   generation= bucket.generation
+        def generation
+          @gapi.generation
+        end
+
+        # Fetches soft_delete_time of a soft deleted bucket
+        # @example
+        #   bucket.delete
+        #   bucket.soft_delete_time
+        def soft_delete_time
+          @gapi.soft_delete_time
+        end
+
+        # Fetches hard_delete_time of a soft deleted bucket
+        # @example
+        #   bucket.hard_delete_time
+        def hard_delete_time
+          @gapi.hard_delete_time
+        end
+
         ##
         # Generate a PostObject that includes the fields and URL to
         # upload objects via HTML forms.
@@ -3187,9 +3212,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,
@@ -3207,9 +3232,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/signer_v2.rb

@@ -92,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
@@ -145,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,7 +295,7 @@ 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
 
           ##

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

@@ -2072,9 +2072,9 @@ 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? }
@@ -2240,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

@@ -99,8 +99,7 @@ module Google
         # @return [String] The service account email address.
         #
         def service_account_email
-          @service_account_email ||= \
-            service.project_service_account.email_address
+          @service_account_email ||= service.project_service_account.email_address
         end
 
         ##
@@ -193,11 +192,20 @@ module Google
         #     puts bucket.name
         #   end
         #
-        def buckets prefix: nil, token: nil, max: nil, user_project: nil
+        # @example Retrieve soft deleted buckets
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   soft_deleted_buckets = storage.buckets soft_deleted: true
+        #   soft_deleted_buckets.each do |bucket|
+        #     puts bucket.name
+        #   end
+        def buckets prefix: nil, token: nil, max: nil, user_project: nil, soft_deleted: nil
           gapi = service.list_buckets \
-            prefix: prefix, token: token, max: max, user_project: user_project
+            prefix: prefix, token: token, max: max, user_project: user_project, soft_deleted: soft_deleted
           Bucket::List.from_gapi \
-            gapi, service, prefix, max, user_project: user_project
+            gapi, service, prefix, max, user_project: user_project, soft_deleted: soft_deleted
         end
         alias find_buckets buckets
 
@@ -223,6 +231,10 @@ module Google
         #   account, transit costs will be billed to the given project. This
         #   parameter is required with requester pays-enabled buckets. The
         #   default is `nil`.
+        # @param [Integer] generation generation no of bucket
+        #   on whether the bucket's current metageneration matches the given value.
+        # @param [Boolean] soft_deleted If true, returns the soft-deleted bucket.
+        #   This parameter is required if generation is specified.
         #
         #   The value provided will be applied to all operations on the returned
         #   bucket instance and its files.
@@ -256,9 +268,20 @@ module Google
         #   bucket = storage.bucket "other-project-bucket",
         #                           user_project: "my-other-project"
         #   files = bucket.files # Billed to "my-other-project"
+        # @example With `soft_deleted` set to true and generation specified:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket",
+        #                           soft_deleted: true,
+        #                           generation: 1234567889
+        #   puts bucket.name
         #
         def bucket bucket_name,
                    skip_lookup: false,
+                   generation: nil,
+                   soft_deleted: nil,
                    if_metageneration_match: nil,
                    if_metageneration_not_match: nil,
                    user_project: nil
@@ -269,7 +292,10 @@ module Google
           gapi = service.get_bucket bucket_name,
                                     if_metageneration_match: if_metageneration_match,
                                     if_metageneration_not_match: if_metageneration_not_match,
-                                    user_project: user_project
+                                    user_project: user_project,
+                                    soft_deleted: soft_deleted,
+                                    generation: generation
+
           Bucket.from_gapi gapi, service, user_project: user_project
         rescue Google::Cloud::NotFoundError
           nil
@@ -554,6 +580,32 @@ module Google
             max: max, user_project: user_project
         end
 
+        ##
+        # Restores a soft deleted bucket with bucket name and generation.
+        #
+        # @param [String] bucket_name Name of the bucket.
+        # @param [Fixnum] generation Generation of the bucket.
+        #
+        # @return [Google::Cloud::Storage::Bucket, nil] Returns nil if bucket
+        #   does not exist
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #   generation= 123
+        #
+        #   bucket = storage.restore_bucket "my-bucket", generation
+        #   puts bucket.name
+        #
+        def restore_bucket bucket_name,
+                           generation,
+                           options: {}
+          gapi = service.restore_bucket bucket_name, generation,
+                                        options: options
+          Bucket.from_gapi gapi, service
+        end
+
         ##
         # Generates a signed URL. See [Signed
         # URLs](https://cloud.google.com/storage/docs/access-control/signed-urls)

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

@@ -55,15 +55,14 @@ module Google
           @credentials = credentials
           @service = API::StorageService.new
           @service.client_options.application_name    = "gcloud-ruby"
-          @service.client_options.application_version = \
-            Google::Cloud::Storage::VERSION
+          @service.client_options.application_version = Google::Cloud::Storage::VERSION
           @service.client_options.open_timeout_sec = (open_timeout || timeout)
           @service.client_options.read_timeout_sec = (read_timeout || timeout)
           @service.client_options.send_timeout_sec = (send_timeout || timeout)
           @service.client_options.transparent_gzip_decompression = false
           @service.request_options.retries = retries || 3
           @service.request_options.header ||= {}
-          @service.request_options.header["x-goog-api-client"] = \
+          @service.request_options.header["x-goog-api-client"] =
             "gl-ruby/#{RUBY_VERSION} gccl/#{Google::Cloud::Storage::VERSION}"
           @service.request_options.header["Accept-Encoding"] = "gzip"
           @service.request_options.quota_project = quota_project if quota_project
@@ -97,11 +96,12 @@ module Google
 
         ##
         # Retrieves a list of buckets for the given project.
-        def list_buckets prefix: nil, token: nil, max: nil, user_project: nil, options: {}
+        def list_buckets prefix: nil, token: nil, max: nil, user_project: nil, soft_deleted: nil, options: {}
           execute do
             service.list_buckets \
               @project, prefix: prefix, page_token: token, max_results: max,
-                        user_project: user_project(user_project), options: options
+                        user_project: user_project(user_project),
+                        soft_deleted: soft_deleted, options: options
           end
         end
 
@@ -112,12 +112,16 @@ module Google
                        if_metageneration_match: nil,
                        if_metageneration_not_match: nil,
                        user_project: nil,
+                       soft_deleted: nil,
+                       generation: nil,
                        options: {}
           execute do
             service.get_bucket bucket_name,
                                if_metageneration_match: if_metageneration_match,
                                if_metageneration_not_match: if_metageneration_not_match,
                                user_project: user_project(user_project),
+                               soft_deleted: soft_deleted,
+                               generation: generation,
                                options: options
           end
         end
@@ -543,7 +547,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
@@ -638,7 +641,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 }
@@ -656,6 +658,17 @@ module Google
           end
         end
 
+        ##
+        # Restore soft deleted bucket
+        def restore_bucket bucket_name,
+                           generation,
+                           options: {}
+          execute do
+            service.restore_bucket bucket_name, generation,
+                                   options: options
+          end
+        end
+
         ##
         # Restores a soft-deleted object.
         def restore_file bucket_name,
@@ -670,7 +683,6 @@ module Google
                          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 }
@@ -738,7 +750,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
@@ -899,8 +910,7 @@ module Google
           headers = (options[:header] ||= {})
           headers["x-goog-#{source}encryption-algorithm"] = "AES256"
           headers["x-goog-#{source}encryption-key"] = Base64.strict_encode64 key
-          headers["x-goog-#{source}encryption-key-sha256"] = \
-            Base64.strict_encode64 key_sha256
+          headers["x-goog-#{source}encryption-key-sha256"] = Base64.strict_encode64 key_sha256
           options
         end
 

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

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

data/lib/google/cloud/storage.rb

@@ -98,11 +98,11 @@ module Google
         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

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"]
@@ -195,4 +194,3 @@ Google::Cloud.configure.add_config! :storage do |config|
   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,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.53.0
+  version: 1.55.0
 platform: ruby
 authors:
 - Mike Moore
 - Chris Smith
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -57,16 +56,16 @@ dependencies:
   name: google-apis-storage_v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.38'
+        version: '0.42'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.38'
+        version: '0.42'
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +128,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,7 +324,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-clo
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -333,15 +331,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.22
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: API Client library for Google Cloud Storage
 test_files: []