Parent

Class/Module Index [+]

Quicksearch

Fog::Storage::AWS::File

Attributes

body[W]
multipart_chunk_size[RW]

@note Chunk size to use for multipart uploads.

Use small chunk sizes to minimize memory. E.g. 5242880 = 5mb

Public Instance Methods

acl=(new_acl) click to toggle source

Set file's access control list (ACL).

valid acls: private, public-read, public-read-write, authenticated-read

@param [String] new_acl one of valid options @return [String] @acl

# File lib/fog/aws/models/storage/file.rb, line 41
def acl=(new_acl)
  valid_acls = ['private', 'public-read', 'public-read-write', 'authenticated-read']
  unless valid_acls.include?(new_acl)
    raise ArgumentError.new("acl must be one of [#{valid_acls.join(', ')}]")
  end
  @acl = new_acl
end
body() click to toggle source

Get file's body if exists, else ' '.

@return [File]

# File lib/fog/aws/models/storage/file.rb, line 54
def body
  attributes[:body] ||= if last_modified && (file = collection.get(identity))
    file.body
  else
    ''
  end
end
copy(target_directory_key, target_file_key, options = {}) click to toggle source

Copy object from one bucket to other bucket.

required attributes: directory, key

@param target_directory_key [String] @param target_file_key [String] @param options [Hash] options for copy_object method @return [String] Fog::AWS::Files#head status of directory contents

# File lib/fog/aws/models/storage/file.rb, line 91
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 = {}) click to toggle source

Destroy file via http DELETE.

required attributes: directory, key

@param options [Hash] @option options versionId [] @return [Boolean] true if successful

# File lib/fog/aws/models/storage/file.rb, line 107
def destroy(options = {})
  requires :directory, :key
  attributes[:body] = nil if options['versionId'] == version
  service.delete_object(directory.key, key, options)
  true
end
directory() click to toggle source

Get the file instance's directory.

@return [Fog::AWS::Storage::Directory]

# File lib/fog/aws/models/storage/file.rb, line 77
def directory
  @directory
end
metadata() click to toggle source
# File lib/fog/aws/models/storage/file.rb, line 116
def metadata
  attributes.reject {|key, value| !(key.to_s =~ /^x-amz-/)}
end
metadata=(new_metadata) click to toggle source
# File lib/fog/aws/models/storage/file.rb, line 122
def metadata=(new_metadata)
  merge_attributes(new_metadata)
end
owner=(new_owner) click to toggle source
# File lib/fog/aws/models/storage/file.rb, line 128
def owner=(new_owner)
  if new_owner
    attributes[:owner] = {
      :display_name => new_owner['DisplayName'],
      :id           => new_owner['ID']
    }
  end
end
public=(new_public) click to toggle source

Set Access-Control-List permissions.

valid new_publics: public_read, private

@param [String] new_public @return [String] new_puplic

# File lib/fog/aws/models/storage/file.rb, line 145
def public=(new_public)
  if new_public
    @acl = 'public-read'
  else
    @acl = 'private'
  end
  new_public
end
public_url() click to toggle source

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

required attributes: directory, key

@return [String] public url

# File lib/fog/aws/models/storage/file.rb, line 163
def public_url
  requires :directory, :key
  if service.get_object_acl(directory.key, key).body['AccessControlList'].detect {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
    service.request_url(
      :bucket_name => directory.key,
      :object_name => key
    )
  else
    nil
  end
end
save(options = {}) click to toggle source

Save file with body as contents to directory.key with name key via http PUT

required attributes: body, directory, key

@param [Hash] options @option options [String] acl sets x-amz-acl HTTP header. Valid values include, private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control @option options [String] cache_controle sets Cache-Control header. For example, 'No-cache' @option options [String] content_disposition sets Content-Disposition HTTP header. For exampple, 'attachment; filename=testing.txt' @option options [String] content_encoding sets Content-Encoding HTTP header. For example, 'x-gzip' @option options [String] content_md5 sets Content-MD5. For example, '79054025255fb1a26e4bc422aef54eb4' @option options [String] content_type Content-Type. For example, 'text/plain' @option options [String] expires sets number of seconds before AWS Object expires. @option options [String] storage_class sets x-amz-storage-class HTTP header. Defaults to 'STANDARD'. Or, 'REDUCED_REDUNDANCY' @option options [String] encryption sets HTTP encryption header. Set to 'AES256' to encrypt files at rest on S3 @return [Boolean] true if no errors

# File lib/fog/aws/models/storage/file.rb, line 191
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 = {}) click to toggle source

Get a url for file.

required attributes: key

@param expires [String] number of seconds (since 1970-01-01 00:00) before url expires @param options [Hash] @return [String] url

# File lib/fog/aws/models/storage/file.rb, line 229
def url(expires, options = {})
  requires :key
  collection.get_url(key, expires, options)
end
versions() click to toggle source

File version if exists or creates new version. @return [Fog::Storage::AWS::Version]

# File lib/fog/aws/models/storage/file.rb, line 238
def versions
  @versions ||= begin
    Fog::Storage::AWS::Versions.new(
      :file         => self,
      :service   => service
    )
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.