Class: Moneta::Adapters::Fog

Inherits:
Moneta::Adapter show all
Defined in:
lib/moneta/adapters/fog.rb

Overview

Fog backend (Cloud storage services)

Instance Attribute Summary

Attributes inherited from Moneta::Adapter

#backend

Instance Method Summary collapse

Methods inherited from Moneta::Adapter

backend, backend_block, backend_required?

Methods included from Config

#config, included

Methods included from Defaults

#[], #[]=, #close, #create, #decrement, #each_key, #features, #fetch, #fetch_values, included, #increment, #merge!, #slice, #supports?, #update, #values_at

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

  • :backend (::Fog::Storage) —

    Use existing backend instance

  • Other (Object) —

    options passed to ‘Fog::Storage#new`



16
17
18
19
 
# File 'lib/moneta/adapters/fog.rb', line 16

def initialize(options = {})
  super
  @directory = backend.directories.get(config.dir) || backend.directories.create(key: config.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: {}) 


49
50
51
52
53
54
 
# File 'lib/moneta/adapters/fog.rb', line 49

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 Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    current value



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

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 Expires)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/moneta/adapters/fog.rb', line 22

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 Expires)

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • :sync (Boolean) —

    Synchronized load (Cache reloads from adapter, Daybreak syncs with file)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    value



27
28
29
30
 
# File 'lib/moneta/adapters/fog.rb', line 27

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 Expires)

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • value



42
43
44
45
46
 
# File 'lib/moneta/adapters/fog.rb', line 42

def store(key, value, options = {})
  value = value.dup if value.frozen? # HACK: Fog needs unfrozen string
  @directory.files.create(options.merge(key: key, body: value))
  value
end