Wraps a local disk path as an Active Storage service. See ActiveStorage::Service
for the generic API documentation that applies to all services.
Methods
- delete
- delete_prefixed
- download
- download_chunk
- exist?
- headers_for_direct_upload
- new
- upload
- url
- url_for_direct_upload
Attributes
[R] | root |
Class Public methods
new(root:)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 14
def initialize(root:)
@root = root
end
🔎 See on GitHub
Instance Public methods
delete(key)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 50
def delete(key)
instrument :delete, key: key do
begin
File.delete path_for(key)
rescue Errno::ENOENT
# Ignore files already deleted
end
end
end
🔎 See on GitHub
delete_prefixed(prefix)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 60
def delete_prefixed(prefix)
instrument :delete_prefixed, prefix: prefix do
Dir.glob(path_for("#{prefix}*")).each do |path|
FileUtils.rm_rf(path)
end
end
end
🔎 See on GitHub
download(key)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 25
def download(key)
if block_given?
instrument :streaming_download, key: key do
File.open(path_for(key), "rb") do |file|
while data = file.read(5.megabytes)
yield data
end
end
end
else
instrument :download, key: key do
File.binread path_for(key)
end
end
end
🔎 See on GitHub
download_chunk(key, range)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 41
def download_chunk(key, range)
instrument :download_chunk, key: key, range: range do
File.open(path_for(key), "rb") do |file|
file.seek range.begin
file.read range.size
end
end
end
🔎 See on GitHub
exist?(key)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 68
def exist?(key)
instrument :exist, key: key do |payload|
answer = File.exist? path_for(key)
payload[:exist] = answer
answer
end
end
🔎 See on GitHub
headers_for_direct_upload(key, content_type:, **)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 126
def headers_for_direct_upload(key, content_type:, **)
{ "Content-Type" => content_type }
end
🔎 See on GitHub
upload(key, io, checksum: nil, **)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 18
def upload(key, io, checksum: nil, **)
instrument :upload, key: key, checksum: checksum do
IO.copy_stream(io, make_path_for(key))
ensure_integrity_of(key, checksum) if checksum
end
end
🔎 See on GitHub
url(key, expires_in:, filename:, disposition:, content_type:)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 76
def url(key, expires_in:, filename:, disposition:, content_type:)
instrument :url, key: key do |payload|
content_disposition = content_disposition_with(type: disposition, filename: filename)
verified_key_with_expiration = ActiveStorage.verifier.generate(
{
key: key,
disposition: content_disposition,
content_type: content_type
},
{ expires_in: expires_in,
purpose: :blob_key }
)
current_uri = URI.parse(current_host)
generated_url = url_helpers.rails_disk_service_url(verified_key_with_expiration,
protocol: current_uri.scheme,
host: current_uri.host,
port: current_uri.port,
disposition: content_disposition,
content_type: content_type,
filename: filename
)
payload[:url] = generated_url
generated_url
end
end
🔎 See on GitHub
url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
📝 Source code
# File activestorage/lib/active_storage/service/disk_service.rb, line 105
def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
instrument :url, key: key do |payload|
verified_token_with_expiration = ActiveStorage.verifier.generate(
{
key: key,
content_type: content_type,
content_length: content_length,
checksum: checksum
},
{ expires_in: expires_in,
purpose: :blob_token }
)
generated_url = url_helpers.update_rails_disk_service_url(verified_token_with_expiration, host: current_host)
payload[:url] = generated_url
generated_url
end
end
🔎 See on GitHub