tarantool 0.1

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "eventmachine"
+gem "em-synchrony"
+gem "activemodel"
+
+gem "rr"
+gem "yajl-ruby"
+gem "bson"
+gem "bson_ext"
+
+gem "ruby-debug19"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    tarantool (0.1)
+      activemodel (>= 3.1, < 4.0)
+      em-synchrony (>= 1.0.0, < 2.0)
+      eventmachine (>= 1.0.0.beta.4, < 2.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    archive-tar-minitar (0.5.2)
+    bson (1.4.0)
+    bson_ext (1.4.0)
+    builder (3.0.0)
+    columnize (0.3.5)
+    em-synchrony (1.0.0)
+      eventmachine (>= 1.0.0.beta.1)
+    eventmachine (1.0.0.beta.4)
+    i18n (0.6.0)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    multi_json (1.0.3)
+    rr (1.0.4)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  bson
+  bson_ext
+  em-synchrony
+  eventmachine
+  rr
+  ruby-debug19
+  tarantool!
+  yajl-ruby

data/LICENSE

@@ -0,0 +1,24 @@
+/* 
+ * Copyright (C) 2011 Mail.RU
+  *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */

data/README.md

@@ -0,0 +1,116 @@
+# About
+
+Its asynchronyous EventMachine ruby client for [Tarantool Key-Value Storage](github.com/mailru/tarantool).
+
+# Install
+
+```bash
+gem install tarantool
+```
+
+```ruby
+require 'tarantool'
+# or
+require 'tarantool/synchrony'
+# or
+require 'tarantool/record'
+```
+
+# Usage
+
+Before all requests you must configure client:
+
+```ruby
+Tarantool.configure host: 'locahost', port: 33013, space_no: 0
+```
+
+Low level part of client can work in two mode: EM deferrables and EM-Synchrony.
+
+EM deferrables:
+
+```ruby
+req = Tarantool.insert 'prepor', 'Andrew', 'ceo@prepor.ru'
+req.callback do
+    req = Tarantool.select 'prepor'
+    req.callback do |res|
+        puts "Name: #{res.tuple[1].to_s}; Email: #{res.tuple[2].to_s}"
+    end
+end
+req.errback do |err|
+    puts "Error while insert: #{err}"
+end
+```
+
+Synchrony mode:
+
+```ruby
+require 'tarantool/synchrony'
+
+Tarantool.insert 'prepor', 'Andrew', 'ceo@prepor.ru'
+res = Tarantool.select 'prepor'
+puts "Name: #{res.tuple[1].to_s}; Email: #{res.tuple[2].to_s}"
+```
+
+High level part of client implements ActiveModel API: Callbacks, Validations, Serialization, Dirty. Its autocast types, choose right index for query and something more. So code looks like this:
+
+```ruby
+require 'tarantool/record'
+require 'tarantool/serializers/bson'
+class User < Tarantool::Record
+  field :login, :string
+  field :name, :string
+  field :email, :string      
+  field :apples_count, :integer, default: 0
+  field :info, :bson
+  index :name, :email
+
+  validates_length_of(:login, minimum: 3)
+
+  after_create do
+    # after work!
+  end
+end
+
+# Now attribute positions are not important.
+User.create login: 'prepor', email: 'ceo@prepor.ru', name: 'Andrew'
+User.create login: 'ruden', name: 'Andrew', email: 'rudenkoco@gmail.com'
+
+# find by primary key login
+User.find 'prepor' 
+# first 2 users with name Andrew
+User.where(name: 'Andrew').limit(2).all 
+# second user with name Andrew
+User.where(name: 'Andrew').offset(1).limit(1).all 
+# user with name Andrew and email ceo@prepor.ru
+User.where(name: 'Andrew', email: 'ceo@prepor.ru').first
+# raise exception, becouse we can't select query started from not first part of index
+begin
+    User.where(email: 'ceo@prepor.ru') 
+rescue Tarantool::ArgumentError => e
+end
+# increment field apples_count by one. Its atomic operation via native Tarantool interface
+User.find('prepor').increment :apples_count
+
+# update only dirty attributes
+user = User.find('prepor')
+user.name = "Petr"
+user.save
+
+# field serialization to bson
+user.info = { 'bio' => "hi!", 'age' => 23, 'hobbies' => ['mufa', 'tuka'] }
+user.save
+User.find('prepor').info['bio'] # => 'hi!'
+# delete record
+user.destroy
+```
+
+On record definition step, fields order are important, in that order they will be store in Tarantool. By default primary key is first field. `index` method just mapping to your Tarantool schema, client doesn't modify schema for you.
+
+# TODO
+
+* `#first`, `#all` without keys, batches requests via box.select_range
+* `#where` chains
+* admin-socket protocol
+* safe to add fields to exist model
+* Hash, Array and lambdas as default values
+* timers to response, reconnect strategies

data/Rakefile

@@ -0,0 +1,131 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+
+task :default => :spec
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/examples/em_simple.rb

@@ -0,0 +1,21 @@
+require 'bundler'
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+Bundler.setup
+
+require 'tarantool'
+
+EM.run do
+  Tarantool.configure host: 'localhost', port: 33013, space_no: 0
+  req = Tarantool.insert 'prepor', 'Andrew', 'ceo@prepor.ru'
+  req.callback do
+    req = Tarantool.select 'prepor'
+    req.callback do |res|
+      puts "Name: #{res.tuple[1].to_s}; Email: #{res.tuple[2].to_s}"
+      EM.stop
+    end
+  end
+  req.errback do |err|
+    puts "Error while insert: #{err}"
+    EM.stop
+  end
+end

data/examples/record.rb

@@ -0,0 +1,56 @@
+require 'bundler'
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+Bundler.setup
+
+require 'tarantool/record'
+require 'tarantool/serializers/bson'
+class User < Tarantool::Record
+  field :login, :string
+  field :name, :string
+  field :email, :string      
+  field :apples_count, :integer, default: 0
+  field :info, :bson
+  index :name, :email
+
+  validates_length_of(:login, minimum: 3)
+
+  after_create do
+    # after work!
+  end
+end
+
+EM.synchrony do
+  Tarantool.configure host: 'localhost', port: 33013, space_no: 0
+  # Now attribute positions are not important.
+  User.create login: 'prepor', email: 'ceo@prepor.ru', name: 'Andrew'
+  User.create login: 'ruden', name: 'Andrew', email: 'rudenkoco@gmail.com'
+
+  # find by primary key login
+  User.find 'prepor' 
+  # first 2 users with name Andrew
+  User.where(name: 'Andrew').limit(2).all 
+  # second user with name Andrew
+  User.where(name: 'Andrew').offset(1).limit(1).all 
+  # user with name Andrew and email ceo@prepor.ru
+  User.where(name: 'Andrew', email: 'ceo@prepor.ru').first
+  # raise exception, becouse we can't select from not first part of index
+  begin
+    User.where(email: 'ceo@prepor.ru') 
+  rescue Tarantool::ArgumentError => e
+  end
+  # increment field apples_count by one. Its atomic operation vie native Tarantool interface
+  User.find('prepor').increment :apples_count
+
+  # update only dirty attributes
+  user = User.find('prepor')
+  user.name = "Petr"
+  user.save
+
+  # field serialization to bson
+  user.info = { 'bio' => "hi!", 'age' => 23, 'hobbies' => ['mufa', 'tuka'] }
+  user.save
+  User.find('prepor').info['bio'] # => 'hi!'
+  user.destroy
+  puts "Ok!"
+  EM.stop
+end

data/examples/synchrony_simple.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+Bundler.setup
+
+require 'tarantool/synchrony'
+
+EM.synchrony do
+  Tarantool.configure host: 'localhost', port: 33013, space_no: 0
+  Tarantool.insert 'prepor', 'Andrew', 'ceo@prepor.ru'
+  res = Tarantool.select 'prepor'
+  puts "Name: #{res.tuple[1].to_s}; Email: #{res.tuple[2].to_s}"
+  EM.stop
+end

data/lib/em/protocols/fixed_header_and_body.rb

@@ -0,0 +1,67 @@
+module EventMachine
+  module Protocols
+    module FixedHeaderAndBody
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def header_size(size = nil)
+          if size
+            @_header_size = size
+          else
+            @_header_size
+          end
+        end
+      end
+
+      attr_accessor :header, :body
+
+      def receive_data(data)
+        @buffer ||= ''
+        offset = 0
+        while (chunk = data[offset, _needed_size - @buffer.size]).size > 0 || _needed_size == 0
+          @buffer += chunk
+          offset += chunk.size
+          if @buffer.size == _needed_size
+            case _state
+            when :receive_header
+              @_state = :receive_body
+              receive_header @buffer
+            when :receive_body
+              @_state = :receive_header
+              receive_body @buffer
+            end
+            @buffer = ''
+          end
+        end 
+      end
+
+      def receive_header(header)
+        # for override
+      end
+
+      def body_size
+        # for override
+      end
+
+      def receive_body(body)
+        # for override
+      end
+
+      def _needed_size
+        case _state
+        when :receive_header
+          self.class.header_size
+        when :receive_body
+          body_size
+        end
+      end
+
+      def _state
+        @_state ||= :receive_header
+      end
+    end
+  end
+end