em-handlersocket 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in em-handlersocket.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    em-handlersocket (0.1.0)
+      eventmachine
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    eventmachine (0.12.11)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  em-handlersocket!
+  eventmachine
+  rspec

data/README.md

@@ -0,0 +1,44 @@
+# EM-HandlerSocket
+
+EventMachine client for HandlerSocket MySQL plugin for direct read/write of InnoDB tables. This plugin bypasses any/all SQL parsing, query planner, and other MySQL locks, while giving you the advantage of InnoDB persistence, speed, and the network daemon! Best of all, HandlerSocket plugin runs alongside your regular MySQL engine, which means you still have the full advantage of a SQL console at your disposal.
+
+[HandlerSocket: The NoSQL MySQL & Ruby](http://www.igvita.com/2011/01/14/handlersocket-the-nosql-mysql-ruby/)
+
+## Features
+
+- Plays nicely with the (EventMachine) reactor
+- No native extensions
+- Pipelined processing
+
+## Example: Open & Read from an InnoDB index
+
+Open the PRIMARY key index on the widgets.user InnoDB table, and query for id == 1.
+
+    EM.run {
+      c = EM::HandlerSocket.new
+      idx = {:id => 0, :db => 'widgets', :table => 'user', :index_name => 'PRIMARY', :columns => 'user_name'}
+
+      d = c.open_index(idx)
+      d.callback do
+
+        d = c.query(:id => 0, :op => '=', :key => '1')
+        d.errback { p 'uh oh!' }
+        d.callback do |data|
+          p ["received data", data]
+        end
+      end
+    }
+
+## Todo
+
+- Add support for insert/update/delete
+
+## Resources
+
+- [HandlerSocket Protocol](https://github.com/ahiguti/HandlerSocket-Plugin-for-MySQL/blob/master/docs-en/protocol.en.txt)
+- [HandlerSocket @ DeNA](http://yoshinorimatsunobu.blogspot.com/2010/10/using-mysql-as-nosql-story-for.html)
+
+# License
+
+(The MIT License)
+Copyright © 2011 Ilya Grigorik

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/em-handlersocket.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-handlersocket/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-handlersocket"
+  s.version     = EventMachine::HandlerSocket::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ilya Grigorik"]
+  s.email       = ["ilya@igvita.com"]
+  s.homepage    = "http://github.com/igrigorik/em-handlersocket"
+  s.summary     = "Asynchronous (EventMachine) HandlerSocket client"
+  s.description = s.summary
+
+  s.rubyforge_project = "em-handlersocket"
+
+  s.add_dependency "eventmachine"
+  s.add_development_dependency "rspec"
+
+  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"]
+end

data/lib/em-handlersocket/client.rb

@@ -0,0 +1,80 @@
+module EventMachine
+  module HandlerSocket
+
+    class Deferrable < EM::DefaultDeferrable
+      attr_accessor :lines, :buffer
+
+      def initialize(lines)
+        @lines = lines
+        @buffer = []
+      end
+
+      def recieve(line)
+        status, cols, data = line.chomp.split("\t")
+        @buffer.push data
+
+        # non-zero response code indicates error
+        if status.to_i != 0
+          fail
+          return true
+        end
+
+        done?
+      end
+
+      # non zero response code, or we've processed all lines
+      def done?; (@buffer.size == @lines); end
+
+      def succeed
+        super(@buffer)
+      end
+    end
+
+    class Client < EventMachine::Connection
+      include EventMachine::Deferrable
+      include EventMachine::Protocols::LineProtocol
+
+      def initialize
+        @deferrables = []
+      end
+
+      def connection_completed
+        succeed
+      end
+
+      def open_index(opts)
+        execute([['P', opts[:id], opts[:db], opts[:table], opts[:index_name], opts[:columns]]])
+      end
+
+      def query(*queries)
+        execute(queries.map{|q| [q[:id], q[:op], q[:key].size, q[:key], q[:limit], q[:offset]].compact })
+      end
+
+      def execute(cmd, &blk)
+        callback { send(cmd) }
+        add_deferrable(cmd.size, &blk)
+      end
+
+      private
+
+        def send(data)
+          send_data data.map {|d| d.join("\t")}.join("\n") + "\n"
+        end
+
+        def receive_line(line)
+          if @deferrables.first.recieve(line)
+            @deferrables.shift.succeed
+          end
+        end
+
+        def add_deferrable(lines, &blk)
+          df = Deferrable.new(lines)
+          df.callback &blk
+
+          @deferrables.push(df)
+          df
+        end
+
+    end
+  end
+end

data/lib/em-handlersocket/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  module HandlerSocket
+    VERSION = "0.1.0"
+  end
+end

data/lib/em-handlersocket.rb

@@ -0,0 +1,16 @@
+require 'eventmachine'
+require 'em/protocols/line_protocol'
+require 'em-handlersocket/client'
+
+module EventMachine
+  module HandlerSocket
+    def self.new(options = {})
+      opt = {
+        :host => '127.0.0.1',
+        :port => '9998'
+      }.merge(options)
+
+      EventMachine.connect(opt[:host], opt[:port], EventMachine::HandlerSocket::Client)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,122 @@
+require 'helper'
+
+#
+# create database widgets;
+# CREATE TABLE user (
+#   user_id INT UNSIGNED PRIMARY KEY,
+#   user_name VARCHAR(50),
+#   user_email VARCHAR(255),
+#   created DATETIME
+# ) ENGINE=InnoDB;
+#
+# insert into user (user_id, user_name, user_email, created) values (1, 'Ilya', 'ilya@igvita.com', '2010-01-01');
+# insert into user (user_id, user_name, user_email, created) values (2, 'John', 'john@example.com', '2010-01-02');
+# insert into user (user_id, user_name, user_email, created) values (3, 'Bob', 'bob@example.com', '2010-01-03');
+#
+
+describe EventMachine::HandlerSocket do
+
+  it "should connect to HandlerSocket server" do
+    EM.run {
+      c = EM::HandlerSocket.new(:host => '127.0.0.1', :port => '9998')
+      c.class.should == EventMachine::HandlerSocket::Client
+
+      EM.stop
+    }
+  end
+
+  it "should connect to localhost, read-only port by default" do
+    EM.run {
+      c = EM::HandlerSocket.new
+      c.class.should == EventMachine::HandlerSocket::Client
+
+      EM.stop
+    }
+  end
+
+  it "should open an index via raw interface" do
+    EM.run {
+      c = EM::HandlerSocket.new
+
+      df = c.execute([['P', '0', 'widgets', 'user', 'PRIMARY', 'user_name,user_email,created']])
+      df.callback { EM.stop }
+      df.errback { fail }
+    }
+  end
+
+  it "should invoke errback on bad query" do
+    EM.run {
+      c = EM::HandlerSocket.new
+
+      df = c.execute([['P', '0', 'badDB', 'user', 'PRIMARY', 'user_name,user_email,created']])
+      df.callback { fail }
+      df.errback { EM.stop }
+    }
+  end
+
+  it "should open an index" do
+    EM.run {
+      c = EM::HandlerSocket.new
+      idx = {:id => 0, :db => 'widgets', :table => 'user', :index_name => 'PRIMARY', :columns => 'user_name'}
+
+      d = c.open_index(idx)
+      d.callback do
+        EM.stop
+      end
+    }
+  end
+
+  it "should fetch a single record" do
+    EM.run {
+      c = EM::HandlerSocket.new
+      idx = {:id => 0, :db => 'widgets', :table => 'user', :index_name => 'PRIMARY', :columns => 'user_name'}
+
+      d = c.open_index(idx)
+      d.callback do
+
+        d = c.query(:id => 0, :op => '=', :key => '1')
+        d.callback do |data|
+          data.should == ['Ilya']
+          EM.stop
+        end
+      end
+    }
+  end
+
+  it "should fetch multiple records" do
+    EM.run {
+      c = EM::HandlerSocket.new
+      idx = {:id => 0, :db => 'widgets', :table => 'user', :index_name => 'PRIMARY', :columns => 'user_name'}
+
+      d = c.open_index(idx)
+      d.callback do |s|
+
+        d = c.query({:id => 0, :op => '=', :key => '1'}, {:id => 0, :op => '=', :key => '2'})
+        d.errback { fail }
+        d.callback do |data|
+          data.should == ['Ilya', 'John']
+          EM.stop
+        end
+      end
+    }
+  end
+
+  it "should execute a query against a composite index" do
+    EM.run {
+      c = EM::HandlerSocket.new
+      idx = {:id => 0, :db => 'widgets', :table => 'user', :index_name => 'id_created', :columns => 'user_name'}
+
+      d = c.open_index(idx)
+      d.callback do |s|
+
+        d = c.query(:id => 0, :op => '>=', :key => ['2', '2010-01-03'])
+        d.errback { fail }
+        d.callback do |data|
+          data.should == ['Bob']
+          EM.stop
+        end
+      end
+    }
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler.setup
+
+require 'lib/em-handlersocket'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: em-handlersocket
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ilya Grigorik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-14 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Asynchronous (EventMachine) HandlerSocket client
+email: 
+- ilya@igvita.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- em-handlersocket.gemspec
+- lib/em-handlersocket.rb
+- lib/em-handlersocket/client.rb
+- lib/em-handlersocket/version.rb
+- spec/client_spec.rb
+- spec/helper.rb
+has_rdoc: true
+homepage: http://github.com/igrigorik/em-handlersocket
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: em-handlersocket
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Asynchronous (EventMachine) HandlerSocket client
+test_files: 
+- spec/client_spec.rb
+- spec/helper.rb