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

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

Instance Attribute Summary collapse

Attributes inherited from Model

#collection, #connection

Instance Method Summary collapse

Methods inherited from Model

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

Methods included from Attributes::ClassMethods

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

Methods included from Attributes::InstanceMethods

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

Constructor Details

This class inherits a constructor from Fog::Model

Instance Attribute Details

#body ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/fog/aws/models/storage/file.rb', line 41

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

#multipart_chunk_size ⇒ Object

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



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

def multipart_chunk_size
  @multipart_chunk_size
end

Instance Method Details

#acl=(new_acl) ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/fog/aws/models/storage/file.rb', line 33

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, options = {}) ⇒ Object 



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

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

#destroy(options = {}) ⇒ Object 



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

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

#directory ⇒ Object 



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

def directory
  @directory
end

#metadata ⇒ Object 



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

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

#metadata=(new_metadata) ⇒ Object 



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

def metadata=(new_metadata)
  merge_attributes(new_metadata)
end

#owner=(new_owner) ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/fog/aws/models/storage/file.rb', line 82

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

#public=(new_public) ⇒ Object 



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

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

#public_url ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/fog/aws/models/storage/file.rb', line 100

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/#{Fog::AWS.escape(key)}"
    else
      "https://s3.amazonaws.com/#{directory.key}/#{Fog::AWS.escape(key)}"
    end
  else
    nil
  end
end

#save(options = {}) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/fog/aws/models/storage/file.rb', line 113

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 = connection.put_object(directory.key, key, body, options)
    merge_attributes(data.headers)
  end
  self.etag.gsub!('"','')
  self.content_length = Fog::Storage.get_body_size(body)
  true
end

#url(expires, options = {}) ⇒ Object 



141
142
143
144
 
# File 'lib/fog/aws/models/storage/file.rb', line 141

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

#versions ⇒ Object 



146
147
148
149
150
151
152
153
 
# File 'lib/fog/aws/models/storage/file.rb', line 146

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