Class: Fog::AWS::Storage::File
- Inherits:
-
Model
- Object
- Model
- Fog::AWS::Storage::File
- Defined in:
- lib/fog/aws/models/storage/file.rb
Instance Attribute Summary collapse
-
#body ⇒ File
Get file’s body if exists, else ”.
- #multipart_chunk_size ⇒ Object
Instance Method Summary collapse
- #acl ⇒ Object
-
#acl=(new_acl) ⇒ String
Set file’s access control list (ACL).
-
#copy(target_directory_key, target_file_key, options = {}) ⇒ String
Copy object from one bucket to other bucket.
-
#destroy(options = {}) ⇒ Boolean
Destroy file via http DELETE.
-
#directory ⇒ Fog::AWS::Storage::Directory
Get the file instance’s directory.
- #metadata ⇒ Object
- #metadata=(new_metadata) ⇒ Object
- #owner=(new_owner) ⇒ Object
-
#public=(new_public) ⇒ String
Set Access-Control-List permissions.
- #public? ⇒ Boolean
-
#public_url ⇒ String
Get publicly accessible url via http GET.
-
#save(options = {}) ⇒ Boolean
Save file with body as contents to directory.key with name key via http PUT.
-
#url(expires, options = {}) ⇒ String
Get a url for file.
-
#versions ⇒ Fog::AWS::Storage::Version
File version if exists or creates new version.
Instance Attribute Details
#body ⇒ File
Get file’s body if exists, else ”.
62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/fog/aws/models/storage/file.rb', line 62 def body return attributes[:body] if attributes[:body] return '' unless last_modified file = collection.get(identity) if file attributes[:body] = file.body else attributes[:body] = '' end end |
#multipart_chunk_size ⇒ Object
Chunk size to use for multipart uploads. Use small chunk sizes to minimize memory. E.g. 5242880 = 5mb
32 33 34 |
# File 'lib/fog/aws/models/storage/file.rb', line 32 def multipart_chunk_size @multipart_chunk_size end |
Instance Method Details
#acl ⇒ Object
38 39 40 41 |
# File 'lib/fog/aws/models/storage/file.rb', line 38 def acl requires :directory, :key service.get_object_acl(directory.key, key).body['AccessControlList'] end |
#acl=(new_acl) ⇒ String
Set file’s access control list (ACL).
valid acls: private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control
50 51 52 53 54 55 56 |
# File 'lib/fog/aws/models/storage/file.rb', line 50 def acl=(new_acl) valid_acls = ['private', 'public-read', 'public-read-write', 'authenticated-read', 'bucket-owner-read', 'bucket-owner-full-control'] unless valid_acls.include?(new_acl) raise ArgumentError.new("acl must be one of [#{valid_acls.join(', ')}]") end @acl = new_acl end |
#copy(target_directory_key, target_file_key, options = {}) ⇒ String
Copy object from one bucket to other bucket.
required attributes: directory, key
100 101 102 103 104 105 |
# File 'lib/fog/aws/models/storage/file.rb', line 100 def copy(target_directory_key, target_file_key, = {}) requires :directory, :key service.copy_object(directory.key, key, target_directory_key, target_file_key, ) target_directory = service.directories.new(:key => target_directory_key) target_directory.files.head(target_file_key) end |
#destroy(options = {}) ⇒ Boolean
Destroy file via http DELETE.
required attributes: directory, key
115 116 117 118 119 120 |
# File 'lib/fog/aws/models/storage/file.rb', line 115 def destroy( = {}) requires :directory, :key attributes[:body] = nil if ['versionId'] == version service.delete_object(directory.key, key, ) true end |
#directory ⇒ Fog::AWS::Storage::Directory
Get the file instance’s directory.
87 88 89 |
# File 'lib/fog/aws/models/storage/file.rb', line 87 def directory @directory end |
#metadata ⇒ Object
123 124 125 |
# File 'lib/fog/aws/models/storage/file.rb', line 123 def attributes.reject {|key, value| !(key.to_s =~ /^x-amz-/)} end |
#metadata=(new_metadata) ⇒ Object
128 129 130 |
# File 'lib/fog/aws/models/storage/file.rb', line 128 def () merge_attributes() end |
#owner=(new_owner) ⇒ Object
133 134 135 136 137 138 139 140 |
# File 'lib/fog/aws/models/storage/file.rb', line 133 def owner=(new_owner) if new_owner attributes[:owner] = { :display_name => new_owner['DisplayName'] || new_owner[:display_name], :id => new_owner['ID'] || new_owner[:id] } end end |
#public=(new_public) ⇒ String
Set Access-Control-List permissions.
valid new_publics: public_read, private
153 154 155 156 157 158 159 160 |
# File 'lib/fog/aws/models/storage/file.rb', line 153 def public=(new_public) if new_public @acl = 'public-read' else @acl = 'private' end new_public end |
#public? ⇒ Boolean
142 143 144 |
# File 'lib/fog/aws/models/storage/file.rb', line 142 def public? acl.any? {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'} end |
#public_url ⇒ String
Get publicly accessible url via http GET. Checks permissions before creating. Defaults to s3 subdomain or compliant bucket name
required attributes: directory, key
170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/fog/aws/models/storage/file.rb', line 170 def public_url requires :directory, :key if public? service.request_url( :bucket_name => directory.key, :object_name => key ) else nil end end |
#save(options = {}) ⇒ Boolean
Save file with body as contents to directory.key with name key via http PUT
required attributes: body, directory, key
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/fog/aws/models/storage/file.rb', line 199 def save( = {}) requires :body, :directory, :key if != {} Fog::Logger.deprecation("options param is deprecated, use acl= instead [light_black](#{caller.first})[/]") end ['x-amz-acl'] ||= @acl if @acl ['Cache-Control'] = cache_control if cache_control ['Content-Disposition'] = content_disposition if content_disposition ['Content-Encoding'] = content_encoding if content_encoding ['Content-MD5'] = content_md5 if content_md5 ['Content-Type'] = content_type if content_type ['Expires'] = expires if expires .merge!() ['x-amz-storage-class'] = storage_class if storage_class ['x-amz-tagging'] = if .merge!(encryption_headers) # With a single PUT operation you can upload objects up to 5 GB in size. Automatically set MP for larger objects. self.multipart_chunk_size = 5242880 if !multipart_chunk_size && Fog::Storage.get_body_size(body) > 5368709120 if multipart_chunk_size && Fog::Storage.get_body_size(body) >= multipart_chunk_size && body.respond_to?(:read) data = multipart_save() merge_attributes(data.body) else data = service.put_object(directory.key, key, body, ) merge_attributes(data.headers.reject {|key, value| ['Content-Length', 'Content-Type'].include?(key)}) end self.etag = self.etag.gsub('"','') if self.etag self.content_length = Fog::Storage.get_body_size(body) self.content_type ||= Fog::Storage.get_content_type(body) true end |
#url(expires, options = {}) ⇒ String
Get a url for file.
required attributes: key
240 241 242 243 |
# File 'lib/fog/aws/models/storage/file.rb', line 240 def url(expires, = {}) requires :key collection.get_url(key, expires, ) end |