Class: RightAws::S3Generator::Key

Inherits:
Object
  • Object
show all
Defined in:
lib/s3/right_s3.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket, name, meta_headers = {}) ⇒ Key

Returns a new instance of Key.



1085
1086
1087
1088
1089
1090
 
# File 'lib/s3/right_s3.rb', line 1085

def initialize(bucket, name, meta_headers={})
  @bucket       = bucket
  @name         = name.to_s
  @meta_headers = meta_headers
  raise 'Key name can not be empty.' if @name.blank?
end

Instance Attribute Details

#bucket ⇒ Object (readonly)

Returns the value of attribute bucket.



1062
1063
1064
 
# File 'lib/s3/right_s3.rb', line 1062

def bucket
  @bucket
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



1062
1063
1064
 
# File 'lib/s3/right_s3.rb', line 1062

def name
  @name
end

Instance Method Details

#delete(expires = nil, headers = {}) ⇒ Object

Generate link to delete key. 

bucket.delete(2.hour) #=> https://s3.amazonaws.com:443/my_awesome_bucket/logs%2Ftoday%2F1.log?Signature=4...D&Expires=1180820032&AWSAccessKeyId=1...2



1112
1113
1114
 
# File 'lib/s3/right_s3.rb', line 1112

def delete(expires=nil,  headers={})
  @bucket.s3.interface.delete_link(@bucket.to_s, @name, expires,  headers)
end

#full_name(separator = '/') ⇒ Object

Return a full S# name (bucket/key).

key.full_name #=> 'my_awesome_bucket/cool_key'



1072
1073
1074
 
# File 'lib/s3/right_s3.rb', line 1072

def full_name(separator='/')
  "#{@bucket.to_s}#{separator}#{@name}"
end

#get(expires = nil, headers = {}) ⇒ Object

Generate link to GET key data. 

bucket.get('logs/today/1.log', 1.hour) #=> https://s3.amazonaws.com:443/my_awesome_bucket/logs%2Ftoday%2F1.log?Signature=h...M%3D&Expires=1180820032&AWSAccessKeyId=1...2



1104
1105
1106
 
# File 'lib/s3/right_s3.rb', line 1104

def get(expires=nil, headers={})
  @bucket.s3.interface.get_link(@bucket.to_s, @name, expires, headers)
end

#head(expires = nil, headers = {}) ⇒ Object

Generate link to head key. 

bucket.head(2.hour) #=> https://s3.amazonaws.com:443/my_awesome_bucket/logs%2Ftoday%2F1.log?Signature=4...D&Expires=1180820032&AWSAccessKeyId=1...2



1120
1121
1122
 
# File 'lib/s3/right_s3.rb', line 1120

def head(expires=nil,  headers={})
  @bucket.s3.interface.head_link(@bucket.to_s, @name, expires,  headers)
end

#public_link ⇒ Object

Return a public link to key.

key.public_link #=> 'https://s3.amazonaws.com:443/my_awesome_bucket/cool_key'



1080
1081
1082
1083
 
# File 'lib/s3/right_s3.rb', line 1080

def public_link
  params = @bucket.s3.interface.params
  "#{params[:protocol]}://#{params[:server]}:#{params[:port]}/#{full_name('/')}"
end

#put(expires = nil, headers = {}) ⇒ Object

Generate link to PUT key data. 

puts bucket.put('logs/today/1.log', '123', 2.hour) #=> https://s3.amazonaws.com:443/my_awesome_bucket/logs%2Ftoday%2F1.log?Signature=B...D&Expires=1180820032&AWSAccessKeyId=1...2



1096
1097
1098
 
# File 'lib/s3/right_s3.rb', line 1096

def put(expires=nil, headers={})
  @bucket.put(@name.to_s, @meta_headers, expires, headers)
end

#to_s ⇒ Object 



1064
1065
1066
 
# File 'lib/s3/right_s3.rb', line 1064

def to_s
  @name
end