google-cloud-storage 1.37.0 → 1.54.0

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.
         #
@@ -825,6 +849,9 @@ module Google
         # @param [Integer] if_metageneration_not_match Makes the operation
         #   conditional on whether the file's current metageneration does not
         #   match the given value.
+        # @param [Boolean] override_unlocked_retention
+        #   Must be true to remove the retention configuration, reduce its unlocked
+        #   retention period, or change its mode from unlocked to locked.
         #
         # @yield [file] a block yielding a delegate object for updating the file
         #
@@ -865,7 +892,8 @@ module Google
                    if_generation_match: nil,
                    if_generation_not_match: nil,
                    if_metageneration_match: nil,
-                   if_metageneration_not_match: nil
+                   if_metageneration_not_match: nil,
+                   override_unlocked_retention: nil
           updater = Updater.new gapi
           yield updater
           updater.check_for_changed_metadata!
@@ -875,7 +903,8 @@ module Google
                        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
+                       if_metageneration_not_match: if_metageneration_not_match,
+                       override_unlocked_retention: override_unlocked_retention
         end
 
         ##
@@ -1560,6 +1589,64 @@ module Google
           true
         end
 
+        # Mode of object level retention configuration.
+        # Valid values are 'Locked' or 'Unlocked'
+        #
+        # @return [String]
+        def retention_mode
+          @gapi.retention&.mode
+        end
+
+        # The earliest time in RFC 3339 UTC "Zulu" format that the object can
+        # be deleted or replaced.
+        #
+        # @return [DateTime]
+        def retention_retain_until_time
+          @gapi.retention&.retain_until_time
+        end
+
+        # A collection of object level retention parameters.
+        # The full list of available options are outlined at the [JSON API docs]
+        # (https://cloud.google.com/storage/docs/json_api/v1/objects/insert#request-body).
+        #
+        # @return [Google::Apis::StorageV1::Object::Retention]
+        def retention
+          @gapi.retention
+        end
+
+        ##
+        # Update method to update retention parameter of an object / file
+        # It accepts params as a Hash of attributes in the following format:
+        #
+        #     { mode: 'Locked|Unlocked', retain_until_time: '2023-12-19T03:22:23+00:00' }
+        #
+        # @param [Hash(String => String)] new_retention_attributes
+        #
+        # @example Update retention parameters for the File / Object
+        #   require "google/cloud/storage"
+        #   storage = Google::Cloud::Storage.new
+        #   bucket = storage.bucket "my-bucket"
+        #   file = bucket.file "avatars/heidi/400x400.png"
+        #   retention_params = { mode: 'Unlocked', retain_until_time: '2023-12-19T03:22:23+00:00'.to_datetime }
+        #   file.retention = retention_params
+        #
+        # @example Update retention parameters for the File / Object with override enabled
+        #   require "google/cloud/storage"
+        #   storage = Google::Cloud::Storage.new
+        #   bucket = storage.bucket "my-bucket"
+        #   file = bucket.file "avatars/heidi/400x400.png"
+        #   retention_params = { mode: 'Unlocked',
+        #                        retain_until_time: '2023-12-19T03:22:23+00:00'.to_datetime,
+        #                        override_unlocked_retention: true }
+        #   file.retention = retention_params
+        #
+        def retention= new_retention_attributes
+          @gapi.retention ||= Google::Apis::StorageV1::Object::Retention.new
+          @gapi.retention.mode = new_retention_attributes[:mode]
+          @gapi.retention.retain_until_time = new_retention_attributes[:retain_until_time]
+          update_gapi! :retention, override_unlocked_retention: new_retention_attributes[:override_unlocked_retention]
+        end
+
         ##
         # Public URL to access the file. If the file is not public, requests to
         # the URL will return an error. (See {File::Acl#public!} and
@@ -1985,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
 
         ##
@@ -2015,7 +2146,8 @@ module Google
                          if_generation_match: nil,
                          if_generation_not_match: nil,
                          if_metageneration_match: nil,
-                         if_metageneration_not_match: nil
+                         if_metageneration_not_match: nil,
+                         override_unlocked_retention: nil
           attributes = Array(attributes)
           attributes.flatten!
           return if attributes.empty?
@@ -2044,7 +2176,8 @@ module Google
                                        if_generation_not_match: if_generation_not_match,
                                        if_metageneration_match: if_metageneration_match,
                                        if_metageneration_not_match: if_metageneration_not_match,
-                                       user_project: user_project
+                                       user_project: user_project,
+                                       override_unlocked_retention: override_unlocked_retention
                   end
         end
 
@@ -2107,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.
         #
@@ -94,6 +103,41 @@ module Google
             service.project_service_account.email_address
         end
 
+        ##
+        # Add custom Google extension headers to the requests that use the signed URLs.
+        #
+        # @param [Hash] headers Google extension headers (custom HTTP headers that
+        #   begin with `x-goog-`) to be included in requests that use the signed URLs.
+        #   Provide headers as a key/value array, where the key is
+        #   the header name, and the value is an array of header values.
+        #   For headers with multiple values, provide values as a simple
+        #   array, or a comma-separated string. For a reference of allowed
+        #   headers, see [Reference Headers](https://cloud.google.com/storage/docs/xml-api/reference-headers).
+        #
+        # @return [Google::Cloud::Storage::Project] Returns the Project for method chaining
+        #
+        def add_custom_headers headers
+          @service.add_custom_headers headers
+          self
+        end
+
+        ##
+        # Add custom Google extension header to the requests that use the signed URLs.
+        #
+        # @param [String] header_name Name of Google extension header (custom HTTP header that
+        #   begin with `x-goog-`) to be included in requests that use the signed URLs.
+        #   For a reference of allowed headers, see
+        #   [Reference Headers](https://cloud.google.com/storage/docs/xml-api/reference-headers).
+        # @param [Object] header_value Valid value of the Google extension header being added.
+        #   For headers with multiple values, provide values as a simple array, or a comma-separated string.
+        #
+        # @return [Google::Cloud::Storage::Project] Returns the Project for method chaining
+        #
+        def add_custom_header header_name, header_value
+          @service.add_custom_header header_name, header_value
+          self
+        end
+
         ##
         # Retrieves a list of buckets for the given project.
         #
@@ -290,9 +334,9 @@ module Google
         #     access, and allUsers get READER access.
         # @param [String] location The location of the bucket. Optional.
         #   If not passed, the default location, 'US', will be used.
-        #   If specifying a dual-region location, the regions can be specified
-        #   by joining them with a plus sign, for example 'US-CENTRAL1+US-WEST1'. See:
-        #   [Storage Locaitons](https://cloud.google.com/storage/docs/locations).
+        #   If specifying a dual-region location, the `customPlacementConfig`
+        #   property should be set in conjunction. See:
+        #   [Storage Locations](https://cloud.google.com/storage/docs/locations).
         # @param [String] logging_bucket The destination bucket for the bucket's
         #   logs. For more information, see [Access
         #   Logs](https://cloud.google.com/storage/docs/access-logs).
@@ -327,11 +371,18 @@ module Google
         #   other than the current project, and that project is authorized for
         #   the currently authenticated service account, transit costs will be
         #   billed to the given project. The default is `nil`.
+        # @param [Boolean] autoclass_enabled The bucket's autoclass configuration.
+        #   Buckets can have either StorageClass OLM rules or Autoclass, but
+        #   not both. When Autoclass is enabled on a bucket, adding StorageClass
+        #   OLM rules will result in failure. For more information, see
+        #   [Autoclass](https://cloud.google.com/storage/docs/autoclass).
         #
         #   The value provided will be applied to all operations on the returned
         #   bucket instance and its files.
         #
         #   See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
+        # @param [Boolean] enable_object_retention
+        #   When set to true, object retention is enabled for this bucket.
         #
         # @yield [bucket] a block for configuring the bucket before it is
         #   created
@@ -346,6 +397,13 @@ module Google
         #
         #   bucket = storage.create_bucket "my-bucket"
         #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.create_bucket "my-bucket", enable_object_retention: true
+        #
         # @example Configure the bucket in a block:
         #   require "google/cloud/storage"
         #
@@ -363,10 +421,12 @@ 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,
                           location: nil,
+                          custom_placement_config: nil,
                           storage_class: nil,
                           logging_bucket: nil,
                           logging_prefix: nil,
@@ -374,21 +434,28 @@ module Google
                           website_404: nil,
                           versioning: nil,
                           requester_pays: nil,
-                          user_project: nil
+                          user_project: nil,
+                          autoclass_enabled: false,
+                          enable_object_retention: nil,
+                          hierarchical_namespace: nil
           params = {
             name: bucket_name,
-            location: location
+            location: location,
+            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
           updater = Bucket::Updater.new(new_bucket).tap do |b|
             b.logging_bucket = logging_bucket unless logging_bucket.nil?
             b.logging_prefix = logging_prefix unless logging_prefix.nil?
+            b.autoclass_enabled = autoclass_enabled
             b.storage_class = storage_class unless storage_class.nil?
             b.website_main = website_main unless website_main.nil?
             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!
@@ -396,9 +463,11 @@ module Google
           updater.check_for_mutable_lifecycle!
           gapi = service.insert_bucket \
             new_bucket, acl: acl_rule(acl), default_acl: acl_rule(default_acl),
-                        user_project: user_project
+                        user_project: user_project,
+                        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.