samples(storage): Soft deleted Bucket Restore

google-cloud-storage/google-cloud-storage.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "google-cloud-core", "~> 1.6"
   gem.add_dependency "google-apis-core", "~> 0.13"
   gem.add_dependency "google-apis-iamcredentials_v1", "~> 0.18"
-  gem.add_dependency "google-apis-storage_v1", "~> 0.38"
+  gem.add_dependency "google-apis-storage_v1", ">= 0.42"
   gem.add_dependency "googleauth", "~> 1.9"
   gem.add_dependency "digest-crc", "~> 0.4"
   gem.add_dependency "addressable", "~> 2.8"

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

@@ -2280,6 +2280,31 @@ def signed_url path = nil,
           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.

google-cloud-storage/lib/google/cloud/storage/bucket/list.rb

@@ -72,7 +72,8 @@ def next
             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 @@ def all request_limit: nil, &block
           # @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 @@ def self.from_gapi gapi_list, service, prefix = nil, max = nil,
             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
 

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

@@ -192,11 +192,20 @@ def add_custom_header header_name, header_value
         #     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
 
@@ -222,6 +231,10 @@ def buckets prefix: nil, token: nil, max: nil, user_project: nil
         #   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.
@@ -255,9 +268,20 @@ def buckets prefix: nil, token: nil, max: nil, user_project: nil
         #   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
@@ -268,7 +292,10 @@ def bucket bucket_name,
           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
@@ -553,6 +580,32 @@ def hmac_keys service_account_email: nil, project_id: nil,
             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)

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

@@ -96,11 +96,12 @@ def project_service_account
 
         ##
         # 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
 
@@ -111,12 +112,16 @@ def get_bucket bucket_name,
                        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
@@ -653,6 +658,17 @@ def delete_file bucket_name,
           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,