Class: Moneta::Adapters::RestClient

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

Overview

Moneta rest client backend which works together with Rack::MonetaRest

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Defaults

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

Methods included from OptionSupport

#expires, #prefix, #raw, #with

Constructor Details

#initialize(options = {}) ⇒ RestClient

Returns a new instance of RestClient

Parameters:

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

Options Hash (options):

  • :url (String)

    URL

  • :backend (Faraday connection)

    Use existing backend instance

Raises:

  • (ArgumentError)

15
16
17
18
# File 'lib/moneta/adapters/restclient.rb', line 15

def initialize(options = {})
  raise ArgumentError, 'Option :url is required' unless url = options[:url]
  @backend = options[:backend] || ::Faraday.new(url: url)
end

Instance Attribute Details

#backendObject (readonly)


10
11
12
# File 'lib/moneta/adapters/restclient.rb', line 10

def backend
  @backend
end

Instance Method Details

#clear(options = {}) ⇒ void

This method returns an undefined value.

Clear all keys in this store

Parameters:

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

45
46
47
48
# File 'lib/moneta/adapters/restclient.rb', line 45

def clear(options = {})
  @backend.delete ''
  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


39
40
41
42
# File 'lib/moneta/adapters/restclient.rb', line 39

def delete(key, options = {})
  response = @backend.delete(key)
  response.status == 200 ? response.body : nil
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)

21
22
23
# File 'lib/moneta/adapters/restclient.rb', line 21

def key?(key, options = {})
  @backend.head(key).status == 200
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


26
27
28
29
# File 'lib/moneta/adapters/restclient.rb', line 26

def load(key, options = {})
  response = @backend.get(key)
  response.status == 200 ? response.body : nil
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


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

def store(key, value, options = {})
  response = @backend.post(key, value)
  raise "HTTP error #{response.status}" unless response.status == 200
  value
end