Class: Refile::Backend::S3

Inherits:
Object
  • Object
show all
Defined in:
lib/refile/backend/s3.rb

Overview

A refile backend which stores files in Amazon S3

Defined Under Namespace

Classes: Reader

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_key_id:, secret_access_key:, bucket:, max_size: nil, prefix: nil, hasher: Refile::RandomHasher.new, **s3_options) ⇒ S3

Returns a new instance of S3.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/refile/backend/s3.rb', line 56

def initialize(access_key_id:, secret_access_key:, bucket:, max_size: nil, prefix: nil, hasher: Refile::RandomHasher.new, **s3_options)
  @access_key_id = access_key_id
  @secret_access_key = secret_access_key
  @s3_options = { access_key_id: access_key_id, secret_access_key: secret_access_key }.merge s3_options
  @s3 = AWS::S3.new @s3_options
  @bucket_name = bucket
  @bucket = @s3.buckets[@bucket_name]
  @hasher = hasher
  @prefix = prefix
  @max_size = max_size
end

Instance Attribute Details

#access_key_id ⇒ Object (readonly)

Returns the value of attribute access_key_id.



54
55
56
 
# File 'lib/refile/backend/s3.rb', line 54

def access_key_id
  @access_key_id
end

#max_size ⇒ Object (readonly)

Returns the value of attribute max_size.



54
55
56
 
# File 'lib/refile/backend/s3.rb', line 54

def max_size
  @max_size
end

Instance Method Details

#clear!(confirm = nil) ⇒ Object

Raises:



110
111
112
113
 
# File 'lib/refile/backend/s3.rb', line 110

def clear!(confirm = nil)
  raise Refile::Confirm unless confirm == :confirm
  @bucket.objects.with_prefix(@prefix).delete_all
end

#delete(id) ⇒ Object 



86
87
88
 
# File 'lib/refile/backend/s3.rb', line 86

def delete(id)
  object(id).delete
end

#exists?(id) ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/refile/backend/s3.rb', line 106

def exists?(id)
  object(id).exists?
end

#get(id) ⇒ Object 



82
83
84
 
# File 'lib/refile/backend/s3.rb', line 82

def get(id)
  Refile::File.new(self, id)
end

#object(id) ⇒ Object 



122
123
124
 
# File 'lib/refile/backend/s3.rb', line 122

def object(id)
  @bucket.objects[[*@prefix, id].join("/")]
end

#open(id) ⇒ Object 



90
91
92
 
# File 'lib/refile/backend/s3.rb', line 90

def open(id)
  Reader.new(object(id))
end

#presign ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/refile/backend/s3.rb', line 115

def presign
  id = RandomHasher.new.hash
  signature = @bucket.presigned_post(key: [*@prefix, id].join("/"))
  signature.where(content_length: @max_size) if @max_size
  Signature.new(as: "file", id: id, url: signature.url.to_s, fields: signature.fields)
end

#read(id) ⇒ Object 



94
95
96
97
98
 
# File 'lib/refile/backend/s3.rb', line 94

def read(id)
  object(id).read
rescue AWS::S3::Errors::NoSuchKey
  nil
end

#size(id) ⇒ Object 



100
101
102
103
104
 
# File 'lib/refile/backend/s3.rb', line 100

def size(id)
  object(id).content_length
rescue AWS::S3::Errors::NoSuchKey
  nil
end

#upload(uploadable) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/refile/backend/s3.rb', line 68

def upload(uploadable)
  Refile.verify_uploadable(uploadable, @max_size)

  id = @hasher.hash(uploadable)

  if uploadable.is_a?(Refile::File) and uploadable.backend.is_a?(S3) and uploadable.backend.access_key_id == access_key_id
    uploadable.backend.object(uploadable.id).copy_to(object(id))
  else
    object(id).write(uploadable, content_length: uploadable.size)
  end

  Refile::File.new(self, id)
end