Class: CarrierWave::Storage::Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/carrierwave/storage/abstract.rb

Overview

This file serves mostly as a specification for Storage engines. There is no requirement that storage engines must be a subclass of this class. However, any storage engine must conform to the following interface:

The storage engine must respond to store!, taking an uploader object and a CarrierWave::SanitizedFile as parameters. This method should do something to store the given file, and then return an object.

The storage engine must respond to retrieve!, taking an uploader object and an identifier as parameters. This method should do retrieve and then return an object.

The objects returned by store! and retrieve! both must respond to identifier, taking no arguments. Identifier is a string that uniquely identifies this file and can be used to retrieve it later.

Direct Known Subclasses

File, S3

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.retrieve!(uploader, identifier) ⇒ #identifier

Do something to retrieve the file

Parameters:

  • uploader (CarrierWave::Uploader) —

    an uploader object

  • identifier (String) —

    uniquely identifies the file

Returns:



45
46
47
 
# File 'lib/carrierwave/storage/abstract.rb', line 45

def self.retrieve!(uploader, identifier)
  self.new
end

.setup! ⇒ Object

Do setup specific for this storage engine



24
 
# File 'lib/carrierwave/storage/abstract.rb', line 24

def self.setup!; end

.store!(uploader, file) ⇒ #identifier

Do something to store the file

Parameters:

Returns:



34
35
36
 
# File 'lib/carrierwave/storage/abstract.rb', line 34

def self.store!(uploader, file)
  self.new
end

Instance Method Details

#identifier ⇒ String

Should return a String that uniquely identifies this file and can be used to retrieve it from the same storage engine later on.

This is OPTIONAL

Returns:

  • (String) —

    path to the file



57
 
# File 'lib/carrierwave/storage/abstract.rb', line 57

def identifier; end

#path ⇒ String

Should return the path where the file is corrently located. This is OPTIONAL.

This is OPTIONAL

Returns:

  • (String) —

    path to the file



76
 
# File 'lib/carrierwave/storage/abstract.rb', line 76

def path; end

#url ⇒ String

Should return the url where the file is publically accessible. If this is not set, then it is assumed that the url is the path relative to the public directory.

This is OPTIONAL

Returns:

  • (String) —

    file’s url



67
 
# File 'lib/carrierwave/storage/abstract.rb', line 67

def url; end