Class: Moneta::Adapters::RestClient

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

Overview

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

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 = {}) ⇒ Object

Parameters:

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

Options Hash (options):

  • :url (String) —

    URL

  • :adapter (Symbol) —

    The adapter to tell Faraday to use

  • :backend (Faraday::Connection) —

    Use existing backend instance

  • Other (Object) —

    options passed to Faraday::new (unless :backend option is provided).



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

backend do |url:, adapter: nil, **options|
  ::Faraday.new(url, options) do |faraday|
    faraday.adapter adapter if adapter
  end
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
 
# File 'lib/moneta/adapters/restclient.rb', line 46

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



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

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) 


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

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



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

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



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

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