adapter-redis 0.5

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in adapter-redis.gemspec
+gemspec
+
+group(:development) do
+  gem 'rspec',          '~> 2.3'
+  gem 'log_buddy',      '~> 0.5.0'
+  gem 'timecop',        '~> 0.3.5'
+  gem 'SystemTimer',    '~> 1.2.1'
+  gem 'i18n',           '0.5.0'
+  gem 'activesupport',  '~> 3', :require => 'active_support'
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    adapter-redis (0.5)
+      adapter (~> 0.5)
+      redis
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    SystemTimer (1.2.1)
+    activesupport (3.0.3)
+    adapter (0.5.1)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    log_buddy (0.5.0)
+    redis (2.1.1)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    timecop (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  SystemTimer (~> 1.2.1)
+  activesupport (~> 3)
+  adapter (~> 0.5)
+  adapter-redis!
+  i18n (= 0.5.0)
+  log_buddy (~> 0.5.0)
+  redis
+  rspec (~> 2.3)
+  timecop (~> 0.3.5)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Newtoy, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,13 @@
+= adapter-redis
+
+Redis adapter for adapter gem.
+
+See examples/ or specs/ for usage.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so we don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine, but bump version in a commit by itself so we can ignore when we pull)
+* Send us a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/adapter-redis.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "adapter/redis/version"
+
+Gem::Specification.new do |s|
+  s.name        = "adapter-redis"
+  s.version     = Adapter::Redis::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Nunemaker"]
+  s.email       = ["nunemaker@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Adapter for redis}
+  s.description = %q{Adapter for redis}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'adapter', '~> 0.5.1'
+  s.add_dependency 'redis'
+end

data/examples/redis.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'pathname'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'adapter/redis'
+
+client  = Redis.new
+adapter = Adapter[:redis].new(client)
+adapter.clear
+
+adapter.write('foo', 'bar')
+puts 'Should be bar: ' + adapter.read('foo').inspect
+
+adapter.delete('foo')
+puts 'Should be nil: ' + adapter.read('foo').inspect
+
+adapter.write('foo', 'bar')
+adapter.clear
+puts 'Should be nil: ' + adapter.read('foo').inspect
+
+puts 'Should be bar: ' + adapter.fetch('foo', 'bar')
+puts 'Should be bar: ' + adapter.read('foo')

data/lib/adapter/redis.rb

@@ -0,0 +1,68 @@
+require 'adapter'
+require 'redis'
+
+module Adapter
+  module Redis
+    def read(key)
+      decode(client.get(key_for(key)))
+    end
+
+    def write(key, value)
+      client.set(key_for(key), encode(value))
+    end
+
+    def delete(key)
+      read(key).tap { client.del(key_for(key)) }
+    end
+
+    def clear
+      client.flushdb
+    end
+
+    # Pretty much stolen from redis objects
+    # http://github.com/nateware/redis-objects/blob/master/lib/redis/lock.rb
+    def lock(name, options={}, &block)
+      key           = name.to_s
+      start         = Time.now
+      acquired_lock = false
+      expiration    = nil
+      expires_in    = options.fetch(:expiration, 1)
+      timeout       = options.fetch(:timeout, 5)
+
+      while (Time.now - start) < timeout
+        expiration    = generate_expiration(expires_in)
+        acquired_lock = client.setnx(key, expiration)
+        break if acquired_lock
+
+        old_expiration = client.get(key).to_f
+
+        if old_expiration < Time.now.to_f
+          expiration     = generate_expiration(expires_in)
+          old_expiration = client.getset(key, expiration).to_f
+
+          if old_expiration < Time.now.to_f
+            acquired_lock = true
+            break
+          end
+        end
+
+        sleep 0.1
+      end
+
+      raise(LockTimeout.new(name, timeout)) unless acquired_lock
+
+      begin
+        yield
+      ensure
+        client.del(key) if expiration > Time.now.to_f
+      end
+    end
+
+    # Defaults expiration to 1
+    def generate_expiration(expiration)
+      (Time.now + (expiration || 1).to_f).to_f
+    end
+  end
+end
+
+Adapter.define(:redis, Adapter::Redis)

data/lib/adapter/redis/version.rb

@@ -0,0 +1,5 @@
+module Adapter
+  module Redis
+    VERSION = "0.5"
+  end
+end

data/log/test.log

@@ -0,0 +1 @@
+# Logfile created on Tue Jan 25 22:18:39 -0500 2011 by logger.rb

data/spec/helper.rb

@@ -0,0 +1,26 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :development)
+
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+log_path  = root_path.join('log')
+log_path.mkpath
+
+require 'adapter/spec/an_adapter'
+require 'adapter/spec/marshal_adapter'
+require 'adapter/spec/json_adapter'
+require 'adapter/spec/types'
+
+logger = Logger.new(log_path.join('test.log'))
+LogBuddy.init(:logger => logger)
+
+Rspec.configure do |c|
+
+end

data/spec/redis_spec.rb

@@ -0,0 +1,69 @@
+require 'helper'
+require 'adapter/redis'
+
+describe "Redis adapter" do
+  before do
+    @client = Redis.new
+    @adapter = Adapter[:redis].new(@client)
+    @adapter.clear
+  end
+
+  let(:adapter) { @adapter }
+  let(:client)  { @client }
+
+  it_should_behave_like 'a marshaled adapter'
+
+  describe "#lock" do
+    let(:lock_key) { :add_game }
+
+    it "defaults expiration to 1" do
+      now = Time.mktime(2010, 10, 10, 5, 5, 5)
+      Timecop.freeze(now) do
+        expiration = now.to_i + 1
+        client.should_receive(:setnx).with(lock_key.to_s, expiration).and_return(true)
+        adapter.lock(lock_key) { }
+      end
+    end
+
+    it "allows setting expiration" do
+      now = Time.mktime(2010, 10, 10, 5, 5, 5)
+      Timecop.freeze(now) do
+        expiration = now.to_i + 5
+        client.should_receive(:setnx).with(lock_key.to_s, expiration).and_return(true)
+        adapter.lock(lock_key, :expiration => 5) { }
+      end
+    end
+
+    describe "with no existing lock" do
+      it "acquires lock, performs block, and clears lock" do
+        result = false
+        adapter.lock(lock_key) { result = true }
+
+        result.should be_true
+        adapter.read(lock_key).should be_nil
+      end
+    end
+
+    describe "with lock set" do
+      it "waits for unlock, performs block, and clears lock" do
+        result = false
+        client.set(lock_key.to_s, adapter.generate_expiration(1))
+        adapter.lock(lock_key, :timeout => 2) { result = true }
+
+        result.should be_true
+        adapter.read(lock_key).should be_nil
+      end
+    end
+
+    describe "with lock set that does not expire before timeout" do
+      it "raises lock timeout error" do
+        result = false
+        client.set(lock_key.to_s, adapter.generate_expiration(2))
+
+        lambda do
+          adapter.lock(lock_key, :timeout => 1) { result = true }
+        end.should raise_error(Adapter::LockTimeout, 'Timeout on lock add_game exceeded 1 sec')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: adapter-redis
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  version: "0.5"
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: adapter
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
+        version: 0.5.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Adapter for redis
+email: 
+- nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- adapter-redis.gemspec
+- examples/redis.rb
+- lib/adapter/redis.rb
+- lib/adapter/redis/version.rb
+- log/test.log
+- spec/helper.rb
+- spec/redis_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adapter for redis
+test_files: 
+- spec/helper.rb
+- spec/redis_spec.rb