Skip to content

Add ability to specify s3 restore object tier in post_object_restore #742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions lib/fog/aws/requests/storage/post_object_restore.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ class Real
#
# @param bucket_name [String] Name of bucket containing object
# @param object_name [String] Name of object to restore
# @option days [Integer] Number of days to restore object for. Defaults to 100000 (a very long time)
# @param options [Hash] Optional parameters
# @option options [Integer] :days Number of days to restore object for. Defaults to 100000 (a very long time)
# @option options [String] :tier Glacier retrieval tier. Can be 'Standard', 'Bulk', or 'Expedited'
#
# @return [Excon::Response] response:
# * status [Integer] 200 (OK) Object is previously restored
Expand All @@ -15,11 +17,24 @@ class Real
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html
#
def post_object_restore(bucket_name, object_name, days = 100000)
def post_object_restore(bucket_name, object_name, options = {})
raise ArgumentError.new('bucket_name is required') unless bucket_name
raise ArgumentError.new('object_name is required') unless object_name

data = '<RestoreRequest xmlns="http://s3.amazonaws.com/doc/2006-3-01"><Days>' + days.to_s + '</Days></RestoreRequest>'
unless options.is_a?(Hash)
Fog::Logger.deprecation("post_object_restore with a bare days parameter is deprecated, use post_object_restore(bucket_name, object_name, :days => days) instead [light_black](#{caller.first})[/]")
options = { :days => options }
end

days = options[:days] || 100000
tier = options[:tier]

data = '<RestoreRequest xmlns="http://s3.amazonaws.com/doc/2006-03-01/">'
data += '<Days>' + days.to_s + '</Days>'
if tier
data += '<GlacierJobParameters><Tier>' + tier + '</Tier></GlacierJobParameters>'
end
data += '</RestoreRequest>'

headers = {}
headers['Content-MD5'] = Base64.encode64(OpenSSL::Digest::MD5.digest(data)).strip
Expand All @@ -39,7 +54,12 @@ def post_object_restore(bucket_name, object_name, days = 100000)
end

class Mock # :nodoc:all
def post_object_restore(bucket_name, object_name, days = 100000)
def post_object_restore(bucket_name, object_name, options = {})
unless options.is_a?(Hash)
Fog::Logger.deprecation("post_object_restore with a bare days parameter is deprecated, use post_object_restore(bucket_name, object_name, :days => days) instead [light_black](#{caller.first})[/]")
options = { :days => options }
end

response = get_object(bucket_name, object_name)
response.body = nil
response
Expand Down
10 changes: 10 additions & 0 deletions tests/requests/storage/object_tests.rb
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,16 @@
Fog::Storage[:aws].post_object_restore(@directory.identity, 'fog_object')
end

tests("#post_object_restore('#{@directory.identity}', 'fog_object', :days => 5, :tier => 'Bulk')").succeeds do
pending unless Fog.mocking?
Fog::Storage[:aws].post_object_restore(@directory.identity, 'fog_object', :days => 5, :tier => 'Bulk')
end

tests("#post_object_restore('#{@directory.identity}', 'fog_object', 5)").succeeds do
pending unless Fog.mocking?
Fog::Storage[:aws].post_object_restore(@directory.identity, 'fog_object', 5)
end

tests("#put_object_acl('#{@directory.identity}', 'fog_object', 'private')").succeeds do
Fog::Storage[:aws].put_object_acl(@directory.identity, 'fog_object', 'private')
end
Expand Down
Loading