class Moneta::Adapters::MongoMoped

MongoDB backend

Supports expiration, documents will be automatically removed starting with mongodb >= 2.2 (see {docs.mongodb.org/manual/tutorial/expire-data/}).

You can store hashes directly using this adapter.

@example Store hashes

db = Moneta::Adapters::MongoMoped.new
db['key'] = {a: 1, b: 2}

@api public

Public Class Methods

new(options = {}) click to toggle source

@param [Hash] options @option options [String] :collection ('moneta') MongoDB collection name @option options [String] :host ('127.0.0.1') MongoDB server host @option options [String] :user Username used to authenticate @option options [String] :password Password used to authenticate @option options [Integer] :port (MongoDB default port) MongoDB server port @option options [String] :db ('moneta') MongoDB database @option options [Integer] :expires Default expiration time @option options [String] :expires_field ('expiresAt') Document field to store expiration time @option options [String] :value_field ('value') Document field to store value @option options [String] :type_field ('type') Document field to store value type @option options [::Moped::Session] :backend Use existing backend instance @option options Other options passed to `Moped::Session#new`

Calls superclass method Moneta::Adapters::MongoBase.new
# File lib/moneta/adapters/mongo/moped.rb, line 32
def initialize(options = {})
  super(options)
  collection = options.delete(:collection) || 'moneta'
  db = options.delete(:db) || 'moneta'
  user = options.delete(:user)
  password = options.delete(:password)
  @backend = options[:backend] ||
    begin
      host = options.delete(:host) || '127.0.0.1'
      port = options.delete(:port) || 27017
      ::Moped::Session.new(["#{host}:#{port}"])
    end
  @backend.use(db)
  @backend.login(user, password) if user && password
  @collection = @backend[collection]
  if @backend.command(buildinfo: 1)['version'] >= '2.2'
    @collection.indexes.create({ @expires_field => 1 }, expireAfterSeconds: 0)
  else
    warn 'Moneta::Adapters::Mongo - You are using MongoDB version < 2.2, expired documents will not be deleted'
  end
end

Public Instance Methods

clear(options = {}) click to toggle source

(see Moneta::Proxy#clear)

# File lib/moneta/adapters/mongo/moped.rb, line 101
def clear(options = {})
  @collection.drop
  self
end
create(key, value, options = {}) click to toggle source

(see Moneta::Proxy#create)

# File lib/moneta/adapters/mongo/moped.rb, line 89
def create(key, value, options = {})
  key = to_binary(key)
  @backend.with(safe: true, consistency: :strong) do |safe|
    safe[@collection.name].insert(value_to_doc(key, value, options))
  end
  true
rescue ::Moped::Errors::MongoError => ex
  raise if ex.details['code'] != 11000 # duplicate key error
  false
end
delete(key, options = {}) click to toggle source

(see Moneta::Proxy#delete)

# File lib/moneta/adapters/mongo/moped.rb, line 74
def delete(key, options = {})
  value = load(key, options)
  @collection.find(_id: to_binary(key)).remove if value
  value
end
increment(key, amount = 1, options = {}) click to toggle source

(see Moneta::Proxy#increment)

# File lib/moneta/adapters/mongo/moped.rb, line 81
def increment(key, amount = 1, options = {})
  @backend.with(safe: true, consistency: :strong) do |safe|
    safe[@collection.name].find(_id: to_binary(key)).modify({:$inc => { @value_field => amount }},
                                                               new: true, upsert: true)[@value_field]
  end
end
load(key, options = {}) click to toggle source

(see Moneta::Proxy#load)

# File lib/moneta/adapters/mongo/moped.rb, line 55
def load(key, options = {})
  key = to_binary(key)
  doc = @collection.find(_id: key).one
  if doc && (!doc[@expires_field] || doc[@expires_field] >= Time.now)
    # @expires_field must be a Time object (BSON date datatype)
    expires = expires_at(options, nil)
    @collection.find(_id: key).update(:$set => { @expires_field => expires || nil }) if expires != nil
    doc_to_value(doc)
  end
end
store(key, value, options = {}) click to toggle source

(see Moneta::Proxy#store)

# File lib/moneta/adapters/mongo/moped.rb, line 67
def store(key, value, options = {})
  key = to_binary(key)
  @collection.find(_id: key).upsert(value_to_doc(key, value, options))
  value
end

Protected Instance Methods

to_binary(s) click to toggle source
# File lib/moneta/adapters/mongo/moped.rb, line 108
def to_binary(s)
  ::Moped::BSON::Binary.new(:generic, s)
end