google-cloud-storage 1.48.1 → 1.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ba208497567ec78a35a17309d8f7510a26cbfa304522fef436c32b607c7a295
-  data.tar.gz: 2e9294c55434f76c3723d1408c5b777c7bd195f4405ec08d88b8d33903136b60
+  metadata.gz: 94e0030c8442262a0d7670a5ccc0090efe44f6cdad9170cc7eb800a6acffad9c
+  data.tar.gz: 7e4360bab08faa20b814df568f73f708ec8cdd31bb5d90f5fb56292b34636ae3
 SHA512:
-  metadata.gz: 0f31dd1e06029deba139bd8da0551d44664890b88cb6259428f1d150268693aabc3f9e05892108cf38d2c25d18d8046f200c4fbdc6087594f12e8761dc2e7f90
-  data.tar.gz: f0d6919dbb3d252c069ed2673e3dbef881f94409ee6dd7ee73bd1ec63425f8c1afcd0ef19e87095001a69ebc80c6fe253d2e76712b9f412c2745ccbf3d55bdac
+  metadata.gz: f7180d3b2fa31de1ba73eb811439540c4d12a0cc417500566d1d7316d50c5249e66704fef719bc18417682a757a7a538722628fd4bcf3b31f43aca5d083f23e2
+  data.tar.gz: b2a8b010890f3cffcced823aa66806bed2e2b61f4a547848a8c520d0d6d140280522869af668518ca608fcc6a1904541fc626090b5f110bf89f5109fac8a3ba7

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Release History
 
+### 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

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

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

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

@@ -301,7 +301,7 @@ module Google
           ##
           # 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.
         #

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

@@ -421,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,
@@ -435,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
@@ -452,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!
@@ -463,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"
@@ -49,6 +50,7 @@ module Google
                        send_timeout: nil, host: nil, quota_project: nil,
                        max_elapsed_time: nil, base_interval: nil, max_interval: nil,
                        multiplier: nil, upload_chunk_size: nil, universe_domain: nil
+          host ||= Google::Cloud::Storage.configure.endpoint
           @project = project
           @credentials = credentials
           @service = API::StorageService.new
@@ -73,7 +75,7 @@ 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
+          @service.universe_domain = universe_domain || Google::Cloud::Storage.configure.universe_domain
           begin
             @service.verify_universe_domain!
           rescue Google::Apis::UniverseDomainError => e
@@ -363,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,
@@ -372,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
@@ -455,6 +459,7 @@ module Google
                      if_metageneration_not_match: nil,
                      key: nil,
                      user_project: nil,
+                     soft_deleted: nil,
                      options: {}
           execute do
             service.get_object \
@@ -465,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
@@ -650,6 +656,40 @@ 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: {}

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.48.1
+  version: 1.52.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '0.38'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '0.38'
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -340,7 +340,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage