Class: Fog::Storage::AWS::File

Inherits:
Model
  • Object
show all
Defined in:
lib/fog/aws/models/storage/file.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#body ⇒ File

Get file’s body if exists, else ‘ ’.

Returns:



56
57
58
59
60
61
62
 
# File 'lib/fog/aws/models/storage/file.rb', line 56

def body
  attributes[:body] ||= if last_modified && (file = collection.get(identity))
    file.body
  else
    ''
  end
end

#multipart_chunk_size ⇒ Object

Note:

Chunk size to use for multipart uploads. Use small chunk sizes to minimize memory. E.g. 5242880 = 5mb



30
31
32
 
# File 'lib/fog/aws/models/storage/file.rb', line 30

def multipart_chunk_size
  @multipart_chunk_size
end

Instance Method Details

#acl ⇒ Object 



32
33
34
35
 
# File 'lib/fog/aws/models/storage/file.rb', line 32

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

Parameters:

  • new_acl (String) —

    one of valid options

Returns:



44
45
46
47
48
49
50
 
# File 'lib/fog/aws/models/storage/file.rb', line 44

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

Parameters:

  • target_directory_key (String)
  • target_file_key (String)
  • options (Hash) (defaults to: {}) —

    options for copy_object method

Returns:

  • (String) —

    Fog::AWS::Files#head status of directory contents



90
91
92
93
94
95
 
# File 'lib/fog/aws/models/storage/file.rb', line 90

def copy(target_directory_key, target_file_key, options = {})
  requires :directory, :key
  service.copy_object(directory.key, key, target_directory_key, target_file_key, options)
  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

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • versionId (Object) —

Returns:

  • (Boolean) —

    true if successful



105
106
107
108
109
110
 
# File 'lib/fog/aws/models/storage/file.rb', line 105

def destroy(options = {})
  requires :directory, :key
  attributes[:body] = nil if options['versionId'] == version
  service.delete_object(directory.key, key, options)
  true
end

#directory ⇒ Fog::AWS::Storage::Directory

Get the file instance’s directory.

Returns:

  • (Fog::AWS::Storage::Directory) 


77
78
79
 
# File 'lib/fog/aws/models/storage/file.rb', line 77

def directory
  @directory
end

#metadata ⇒ Object 



113
114
115
 
# File 'lib/fog/aws/models/storage/file.rb', line 113

def metadata
  attributes.reject {|key, value| !(key.to_s =~ /^x-amz-/)}
end

#metadata=(new_metadata) ⇒ Object 



118
119
120
 
# File 'lib/fog/aws/models/storage/file.rb', line 118

def metadata=(new_metadata)
  merge_attributes(new_metadata)
end

#owner=(new_owner) ⇒ Object 



123
124
125
126
127
128
129
130
 
# File 'lib/fog/aws/models/storage/file.rb', line 123

def owner=(new_owner)
  if new_owner
    attributes[:owner] = {
      :display_name => new_owner['DisplayName'],
      :id           => new_owner['ID']
    }
  end
end

#public=(new_public) ⇒ String

Set Access-Control-List permissions.

valid new_publics: public_read, private

Parameters:

Returns:



143
144
145
146
147
148
149
150
 
# File 'lib/fog/aws/models/storage/file.rb', line 143

def public=(new_public)
  if new_public
    @acl = 'public-read'
  else
    @acl = 'private'
  end
  new_public
end

#public? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/fog/aws/models/storage/file.rb', line 132

def public?
  acl.any? {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
end

#public_url ⇒ String

Get pubically acessible url via http GET. Checks permissions before creating. Defaults to s3 subdomain or compliant bucket name

required attributes: directory, key

Returns:



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/fog/aws/models/storage/file.rb', line 160

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

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • acl (String) —

    sets x-amz-acl HTTP header. Valid values include, private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control

  • cache_control (String) —

    sets Cache-Control header. For example, ‘No-cache’

  • content_disposition (String) —

    sets Content-Disposition HTTP header. For exampple, ‘attachment; filename=testing.txt’

  • content_encoding (String) —

    sets Content-Encoding HTTP header. For example, ‘x-gzip’

  • content_md5 (String) —

    sets Content-MD5. For example, ‘79054025255fb1a26e4bc422aef54eb4’

  • content_type (String) —

    Content-Type. For example, ‘text/plain’

  • expires (String) —

    sets number of seconds before AWS Object expires.

  • storage_class (String) —

    sets x-amz-storage-class HTTP header. Defaults to ‘STANDARD’. Or, ‘REDUCED_REDUNDANCY’

  • encryption (String) —

    sets HTTP encryption header. Set to ‘AES256’ to encrypt files at rest on S3

Returns:

  • (Boolean) —

    true if no errors



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/fog/aws/models/storage/file.rb', line 188

def save(options = {})
  requires :body, :directory, :key
  if options != {}
    Fog::Logger.deprecation("options param is deprecated, use acl= instead [light_black](#{caller.first})[/]")
  end
  options['x-amz-acl'] ||= @acl if @acl
  options['Cache-Control'] = cache_control if cache_control
  options['Content-Disposition'] = content_disposition if content_disposition
  options['Content-Encoding'] = content_encoding if content_encoding
  options['Content-MD5'] = content_md5 if content_md5
  options['Content-Type'] = content_type if content_type
  options['Expires'] = expires if expires
  options.merge!(metadata)
  options['x-amz-storage-class'] = storage_class if storage_class
  options['x-amz-server-side-encryption'] = encryption if encryption

  if multipart_chunk_size && body.respond_to?(:read)
    data = multipart_save(options)
    merge_attributes(data.body)
  else
    data = service.put_object(directory.key, key, body, options)
    merge_attributes(data.headers.reject {|key, value| ['Content-Length', 'Content-Type'].include?(key)})
  end
  self.etag.gsub!('"','')
  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

Parameters:

  • expires (String) —

    number of seconds (since 1970-01-01 00:00) before url expires

  • options (Hash) (defaults to: {})

Returns:



225
226
227
228
 
# File 'lib/fog/aws/models/storage/file.rb', line 225

def url(expires, options = {})
  requires :key
  collection.get_url(key, expires, options)
end

#versions ⇒ Fog::Storage::AWS::Version

File version if exists or creates new version.

Returns:



233
234
235
236
237
238
239
240
 
# File 'lib/fog/aws/models/storage/file.rb', line 233

def versions
  @versions ||= begin
    Fog::Storage::AWS::Versions.new(
      :file         => self,
      :service   => service
    )
  end
end