eventmachine-redis 0.1.0

data/README.markdown

@@ -0,0 +1,49 @@
+# eventmachine-redis
+
+An [EventMachine](http://github.com/eventmachine/eventmachine/) based Redis client.
+
+## Example
+
+    EM.run do
+      Redis = EM::Protocols::Redis.connect
+
+      puts "Waiting for item on 'queue'..."
+
+      Redis.shift('queue', :timeout => 0) do |key, item|
+        puts "Item: #{item}"
+
+        EM.stop
+      end
+    end
+
+## Warning
+
+This was written as a learning exercise and is currently very incomplete.
+
+## Credits
+
+Based on [em-redis](http://github.com/madsimian/em-redis) by [Jonathan Broad](http://github.com/madsimian).
+
+## License
+
+The MIT License
+
+Copyright (c) 2010 Tristan Dunn
+
+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/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new do |task|
+  task.spec_opts = %w(--color --format specdoc)
+end
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = 'eventmachine-redis'
+    gemspec.summary     = 'An EventMachine based Redis client.'
+    gemspec.description = 'An EventMachine based Redis client.'
+    gemspec.email       = 'hello@tristandunn.com'
+    gemspec.homepage    = 'http://github.com/tristandunn/eventmachine-redis'
+    gemspec.authors     = ['Tristan Dunn']
+  end
+rescue LoadError
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/eventmachine-redis.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{eventmachine-redis}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tristan Dunn"]
+  s.date = %q{2010-03-28}
+  s.description = %q{An EventMachine based Redis client.}
+  s.email = %q{hello@tristandunn.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "eventmachine-redis.gemspec",
+     "examples/push-shift.rb",
+     "lib/eventmachine-redis.rb",
+     "spec/redis_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tristandunn/eventmachine-redis}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{An EventMachine based Redis client.}
+  s.test_files = [
+    "spec/redis_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/push-shift.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/examples/push-shift.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'eventmachine-redis'
+
+EM.run do
+  Redis = EM::Protocols::Redis.connect
+
+  puts "Waiting for item on 'queue'..."
+
+  Redis.shift('queue', :timeout => 0) do |key, item|
+    puts "Item: #{item}"
+
+    EM.stop
+  end
+end

data/lib/eventmachine-redis.rb

@@ -0,0 +1,113 @@
+require 'eventmachine'
+
+module EventMachine::Protocols::Redis
+  include EM::Deferrable
+
+  DELIMETER     = "\r\n".freeze
+  TYPE_BULK     = '$'.freeze
+  TYPE_SINGLE   = '+'.freeze
+  TYPE_INTEGER  = ':'.freeze
+  TYPE_MULTIPLE = '*'.freeze
+
+  MULTILINE_COMMANDS = %w().freeze
+
+  def self.connect(host = 'localhost', port = 6379)
+    EM.connect(host, port, self)
+  end
+
+  def initialize
+    @buffer          = ''
+    @values          = []
+    @handlers        = []
+    @expected_values = 0
+  end
+
+  def connection_completed
+    succeed
+  end
+
+  def receive_data(data)
+    @buffer << data
+
+    while index = @buffer.index(DELIMETER)
+      response = @buffer.slice!(0, index + 2)
+
+      begin
+        process_response(response)
+      rescue IOError
+        @buffer[0...0] = response
+        break
+      end
+    end
+  end
+
+  def shift(key, options = {}, &block)
+    if options[:timeout]
+      command('BLPOP', key, options[:timeout], &block)
+    else
+      command('LPOP', key, &block)
+    end
+  end
+
+  protected
+
+  def command(*arguments, &block)
+    @handlers << block
+
+    callback do
+      command   = arguments.shift
+      multiline = MULTILINE_COMMANDS.include?(command)
+      data      = arguments.pop if multiline
+
+      command << " #{arguments.join(' ')}"          if arguments.length > 0
+      command << " #{data.size}#{DELIMETER}#{data}" if multiline
+      command << DELIMETER
+
+      send_data(command)
+    end
+  end
+
+  def handler(*arguments)
+    handler = @handlers.shift
+    handler.call(*arguments) if handler
+  end
+
+  def process_response(response)
+    type      = response[0]
+    arguments = response.slice(1..-3)
+
+    case type
+    when TYPE_BULK
+      length = arguments.to_i
+
+      if length > -1
+        if @buffer.size >= length + 2
+          value = @buffer.slice!(0, length)
+
+          @buffer.slice!(0, 2)
+        else
+          raise IOError
+        end
+      end
+
+      if @expected_values > 0
+        @values << value
+
+        if @values.size == @expected_values
+          handler(@values)
+
+          @values          = []
+          @expected_values = 0
+        end
+      else
+        handler(value)
+      end
+    when TYPE_SINGLE
+      handler(arguments)
+    when TYPE_INTEGER
+      handler(arguments.to_i)
+    when TYPE_MULTIPLE
+      @expected_values = arguments.to_i
+    end
+  end
+end

data/spec/redis_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe EventMachine::Protocols::Redis do
+  describe 'module' do
+    include EventMachine::Protocols
+
+    it 'should define delimiter constant' do
+      Redis::DELIMETER.should == "\r\n"
+    end
+
+    it 'should define type bulk constant' do
+      Redis::TYPE_BULK.should == '$'
+    end
+
+    it 'should define type single constant' do
+      Redis::TYPE_SINGLE.should == '+'
+    end
+
+    it 'should define type integer constant' do
+      Redis::TYPE_INTEGER.should == ':'
+    end
+
+    it 'should define type multiple constant' do
+      Redis::TYPE_MULTIPLE.should == '*'
+    end
+
+    it 'should define multiline commands constant' do
+      Redis::MULTILINE_COMMANDS.should == %w()
+    end
+
+    it 'should connect via EventMachine when calling Redis.connect' do
+      EM.should_receive(:connect).with('localhost', 6379, Redis)
+      Redis.connect
+    end
+  end
+
+  describe 'instance' do
+    before do
+      @instance  = FakeRedis.new
+      @completed = false
+    end
+
+    it 'should succeed when the connection is completed' do
+      @instance.should_receive(:succeed)
+      @instance.connection_completed
+    end
+
+    it 'should be able to parse inline response' do
+      send_command_and_expect('OK')
+      @instance.receive_data("+OK\r\n")
+      @completed.should be_true
+    end
+
+    it 'should be able to parse integer responses' do
+      send_command_and_expect(0)
+      @instance.receive_data(":0\r\n")
+      @completed.should be_true
+    end
+
+    it 'should be able to parse bulk response' do
+      send_command_and_expect('foo')
+      @instance.receive_data("$3\r\n")
+      @instance.receive_data("foo\r\n")
+      @completed.should be_true
+    end
+
+    it 'should be able to handle nil in bulk response' do
+      send_command_and_expect(nil)
+      @instance.receive_data("$-1\r\n")
+      @completed.should be_true
+    end
+
+    it 'should be able to parse multiple bulk response' do
+      send_command_and_expect(['a', 'yo', 'foo'])
+      @instance.receive_data("*3\r\n")
+      @instance.receive_data("$1\r\na\r\n")
+      @instance.receive_data("$2\r\nyo\r\n")
+      @instance.receive_data("$3\r\nfoo\r\n")
+      @completed.should be_true
+    end
+
+    it 'should be able to handle nil in mulitple bulk response' do
+      send_command_and_expect(['a', nil, 'foo'])
+      @instance.receive_data("*3\r\n")
+      @instance.receive_data("$1\r\na\r\n")
+      @instance.receive_data("$-1\r\n")
+      @instance.receive_data("$3\r\nfoo\r\n")
+      @completed.should be_true
+    end
+
+    describe '#shift' do
+      it 'should generate LPOP command' do
+        @instance.shift('key')
+        @instance.sent_data.should == "LPOP key\r\n"
+      end
+
+      it 'should generate BLPOP command given a timeout' do
+        @instance.shift('key', :timeout => 0)
+        @instance.sent_data.should == "BLPOP key 0\r\n"
+      end
+    end
+
+    protected
+
+    def send_command_and_expect(expected, command = 'FAKE')
+      @instance.__send__(:command, command) do |response|
+        response.should == expected
+        @completed = true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'eventmachine-redis'
+
+class FakeRedis
+  include EventMachine::Protocols::Redis
+
+  def callback(&block)
+    block.call
+  end
+
+  def send_data(data)
+    sent_data << data
+  end
+
+  def sent_data
+    @buffer  ||= ''
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: eventmachine-redis
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tristan Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-28 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: An EventMachine based Redis client.
+email: hello@tristandunn.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- eventmachine-redis.gemspec
+- examples/push-shift.rb
+- lib/eventmachine-redis.rb
+- spec/redis_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tristandunn/eventmachine-redis
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An EventMachine based Redis client.
+test_files: 
+- spec/redis_spec.rb
+- spec/spec_helper.rb
+- examples/push-shift.rb