Class: Moneta::Adapters::Fog

Inherits:
Object
  • Object
show all
Includes:
Defaults
Defined in:
lib/moneta/adapters/fog.rb

Overview

Fog backend (Cloud storage services)

Instance Method Summary collapse

Methods included from Defaults

#[], #[]=, #close, #decrement, #fetch, #increment

Methods included from OptionSupport

#expires, #prefix, #raw, #with

Constructor Details

#initialize(options = {}) ⇒ Fog

Returns a new instance of Fog

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :dir (String)

    Fog directory

  • Other (Object)

    options passed to `Fog::Storage#new`

Raises:

  • (ArgumentError)

13
14
15
16
17
# File 'lib/moneta/adapters/fog.rb', line 13

def initialize(options = {})
  raise ArgumentError, 'Option :dir is required' unless dir = options.delete(:dir)
  storage = ::Fog::Storage.new(options)
  @directory = storage.directories.get(dir) || storage.directories.create(:key => dir)
end

Instance Method Details

#clear(options = {}) ⇒ void

This method returns an undefined value.

Clear all keys in this store

Parameters:

  • options (Hash) (defaults to: {})

46
47
48
49
50
51
# File 'lib/moneta/adapters/fog.rb', line 46

def clear(options = {})
  @directory.files.all.each do |file|
    file.destroy
  end
  self
end

#delete(key, options = {}) ⇒ Object

Delete the key from the store and return the current value

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :raw (Boolean)

    Raw access without value transformation (See `Moneta::Transformer`)

  • :prefix (String)

    Prefix key (See `Moneta::Transformer`)

  • Other (Object)

    options as defined by the adapters or middleware

Returns:

  • (Object)

    current value


31
32
33
34
35
36
37
# File 'lib/moneta/adapters/fog.rb', line 31

def delete(key, options = {})
  if value = @directory.files.get(key)
    body = value.body
    value.destroy
    body
  end
end

#key?(key, options = {}) ⇒ Boolean

Exists the value with key

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer)

    Update expiration time (See `Moneta::Expires`)

  • :prefix (String)

    Prefix key (See `Moneta::Transformer`)

  • Other (Object)

    options as defined by the adapters or middleware

Returns:

  • (Boolean)

20
21
22
# File 'lib/moneta/adapters/fog.rb', line 20

def key?(key, options = {})
  @directory.files.head(key) != nil
end

#load(key, options = {}) ⇒ Object

Fetch value with key. Return nil if the key doesn't exist

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer)

    Update expiration time (See `Moneta::Expires`)

  • :raw (Boolean)

    Raw access without value transformation (See `Moneta::Transformer`)

  • :prefix (String)

    Prefix key (See `Moneta::Transformer`)

  • Other (Object)

    options as defined by the adapters or middleware

Returns:

  • (Object)

    value


25
26
27
28
# File 'lib/moneta/adapters/fog.rb', line 25

def load(key, options = {})
  value = @directory.files.get(key)
  value && value.body
end

#store(key, value, options = {}) ⇒ Object

Store value with key

Parameters:

  • key (Object)
  • value (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer)

    Set expiration time (See `Moneta::Expires`)

  • :raw (Boolean)

    Raw access without value transformation (See `Moneta::Transformer`)

  • :prefix (String)

    Prefix key (See `Moneta::Transformer`)

  • Other (Object)

    options as defined by the adapters or middleware

Returns:

  • value


40
41
42
43
# File 'lib/moneta/adapters/fog.rb', line 40

def store(key, value, options = {})
  @directory.files.create(options.merge(:key => key, :body => value))
  value
end