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

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

Instance Attribute Summary collapse

Attributes inherited from Model

#collection, #connection

Instance Method Summary collapse

Methods included from Deprecation

deprecate, self_deprecate

Methods inherited from Model

#initialize, #inspect, #reload, #to_json, #wait_for

Methods included from Fog::Attributes::ClassMethods

#_load, #aliases, #attribute, #attributes, #identity, #ignore_attributes, #ignored_attributes

Methods included from Fog::Attributes::InstanceMethods

#_dump, #attributes, #identity, #identity=, #merge_attributes, #new_record?, #requires

Constructor Details

This class inherits a constructor from Fog::Model

Instance Attribute Details

#body ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/fog/storage/models/aws/file.rb', line 36

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

Instance Method Details

#acl=(new_acl) ⇒ Object 



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

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

#copy(target_directory_key, target_file_key) ⇒ Object 



52
53
54
55
56
57
 
# File 'lib/fog/storage/models/aws/file.rb', line 52

def copy(target_directory_key, target_file_key)
  requires :directory, :key
  connection.copy_object(directory.key, key, target_directory_key, target_file_key)
  target_directory = connection.directories.new(:key => target_directory_key)
  target_directory.files.get(target_file_key)
end

#destroy ⇒ Object 



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

def destroy
  requires :directory, :key
  connection.delete_object(directory.key, key)
  true
end

#directory ⇒ Object 



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

def directory
  @directory
end

#metadata ⇒ Object 



66
67
68
 
# File 'lib/fog/storage/models/aws/file.rb', line 66

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

#metadata=(new_metadata) ⇒ Object 



71
72
73
 
# File 'lib/fog/storage/models/aws/file.rb', line 71

def metadata=(new_metadata)
  merge_attributes(new_metadata)
end

#owner=(new_owner) ⇒ Object 



76
77
78
79
80
81
82
83
 
# File 'lib/fog/storage/models/aws/file.rb', line 76

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

#public=(new_public) ⇒ Object 



85
86
87
88
89
90
91
92
 
# File 'lib/fog/storage/models/aws/file.rb', line 85

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

#public_url ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/fog/storage/models/aws/file.rb', line 94

def public_url
  requires :directory, :key
  if connection.get_object_acl(directory.key, key).body['AccessControlList'].detect {|grant| grant['Grantee']['URI'] == 'http://acs.amazonaws.com/groups/global/AllUsers' && grant['Permission'] == 'READ'}
    if directory.key.to_s =~ /^(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]$/
      "https://#{directory.key}.s3.amazonaws.com/#{key}"
    else
      "https://s3.amazonaws.com/#{directory.key}/#{key}"
    end
  else
    nil
  end
end

#save(options = {}) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/fog/storage/models/aws/file.rb', line 107

def save(options = {})
  requires :body, :directory, :key
  if options != {}
    Formatador.display_line("[yellow][WARN] 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

  data = connection.put_object(directory.key, key, body, options)
  merge_attributes(data.headers)
  if body.is_a?(String)
    self.content_length = body.size
  else
    self.content_length = ::File.size(body.path)
  end
  true
end

#url(expires) ⇒ Object 



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

def url(expires)
  requires :key
  collection.get_url(key, expires)
end