simplevoc-open 1.8.0

data/simplevoc-open.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simplevoc-open}
+  s.version = "1.8.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["triAGENS GmbH", "Oliver Kiessler"]
+  s.date = %q{2011-03-07}
+  s.description = %q{Easy installation, easy administration and simple to use is the focus of the SimpleVOC. It is a pure in-memory key/value store with a REST interface. Unlike other key/value stores the SimpleVOC provides a prefix search!}
+  s.email = %q{kiessler@inceedo.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "config.yml.sample",
+    "lib/simplevoc-open.rb",
+    "lib/simplevoc/open/base.rb",
+    "lib/simplevoc/open/client.rb",
+    "lib/simplevoc/open/configuration.rb",
+    "lib/simplevoc/open/exceptions.rb",
+    "lib/simplevoc/open/hash.rb",
+    "simplevoc-open.gemspec",
+    "test/config.yml",
+    "test/helper.rb",
+    "test/test_client.rb",
+    "test/test_hash.rb",
+    "test/test_non_strict_client.rb",
+    "test/test_simplevoc.rb"
+  ]
+  s.homepage = %q{http://www.worldofvoc.com/products/simplevoc/summary/}
+  s.licenses = ["Apache License Version 2.0, January 2004"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{A pure in-memory key/value store with a REST interface}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_client.rb",
+    "test/test_hash.rb",
+    "test/test_non_strict_client.rb",
+    "test/test_simplevoc.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.7.4"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.7.4"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.7.4"])
+      s.add_dependency(%q<json>, [">= 1.4.6"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.7.4"])
+      s.add_dependency(%q<json>, [">= 1.4.6"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.7.4"])
+    s.add_dependency(%q<json>, [">= 1.4.6"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.7.4"])
+    s.add_dependency(%q<json>, [">= 1.4.6"])
+  end
+end
+

data/test/config.yml

@@ -0,0 +1,5 @@
+protocol: http
+host: localhost
+port: 12345
+strict_mode: true
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simplevoc-open'
+
+class Test::Unit::TestCase
+end

data/test/test_client.rb

@@ -0,0 +1,240 @@
+require 'helper'
+require 'logger'
+
+class TestClient < Test::Unit::TestCase
+  should "fail to connect" do
+    my_client = Simplevoc::Open::Client.new('host' => 'localhost', 'port' => '111111111')
+    assert_raise Simplevoc::Open::ConnectionRefusedException do
+      my_client.insert('a', 'b')
+    end
+  end
+
+  should "insert value for key a" do
+    assert client.flush
+    assert client.insert("a", "b")
+
+    sv_response = client.get("a")
+    assert_equal sv_response.class, Hash
+    assert_not_nil sv_response['value']
+    assert_equal sv_response['value'], 'b'
+
+    sv_response = client.get('a', false)
+    assert_equal sv_response, 'b'
+
+    assert_raise Simplevoc::Open::ValueExistsException do
+      client.insert('a', 'b')
+    end
+  end
+
+  should 'fail inserting value when the value is empty' do
+    assert_raise Simplevoc::Open::EmptyValueException do
+      client.insert('a', nil)
+    end
+  end
+
+  should 'fail inserting value when the key is empty' do
+    assert_raise Simplevoc::Open::EmptyKeyException do
+      client.insert(nil, nil)
+    end
+  end
+
+  should 'insert value for key b with extended value from hash' do
+    assert client.insert_with_extended_values('b', 'c', {'name' => 'testvalue'})
+
+    sv_response = client.get("b")
+    assert_equal sv_response.class, Hash
+    assert_not_nil sv_response['value']
+    assert_equal sv_response['value'], 'c'
+    assert_not_nil sv_response['created']
+    assert_not_nil sv_response['flags']
+    assert_not_nil sv_response['extended-values']
+    assert sv_response['extended-values'].class, Hash
+    assert_not_nil sv_response['extended-values']['name']
+    assert_equal sv_response['extended-values']['name'], 'testvalue'
+  end
+
+  should 'fail inserting unknown extended key value' do
+    assert client.insert_with_extended_values('b2', 'c', '{"name2":"testvalue"}')
+
+    sv_response = client.get("b2")
+    assert_equal sv_response.class, Hash
+    assert_not_nil sv_response['extended-values']
+    assert_nil sv_response['extended-values']['name']
+  end
+
+  should "insert or update value for key c" do
+    assert_raise Simplevoc::Open::KeyNotFoundException do
+      client.get('c')
+    end
+
+    assert client.insert_or_update('c', 'd')
+    sv_response = client.get('c')
+    assert_not_nil sv_response
+    assert_equal sv_response['value'], 'd'
+
+    assert client.insert_or_update('c', 'd2')
+    sv_response = client.get('c')
+    assert_not_nil sv_response
+    assert_equal sv_response['value'], 'd2'
+  end
+
+  should 'fail creating or updating value when the value is empty' do
+    assert_raise Simplevoc::Open::EmptyValueException do
+      client.insert_or_update('a', nil)
+    end
+  end
+
+  should 'fail creating or updating value when the key is empty' do
+    assert_raise Simplevoc::Open::EmptyKeyException do
+      client.insert_or_update(nil, nil)
+    end
+  end
+
+  should "update value for key a" do
+    assert client.update('a', 'c')
+    sv_response = client.get('a')
+    assert_equal sv_response['value'], 'c'
+  end
+
+  should 'fail when trying to update a value for a missing key' do
+    assert_raise Simplevoc::Open::KeyNotFoundException do
+      client.update('a2', 'b2')
+    end
+  end
+
+  should 'fail updating when the value is empty' do
+    assert_raise Simplevoc::Open::EmptyValueException do
+      client.update('a2', nil)
+    end
+  end
+
+  should 'fail updating when the key is empty' do
+    assert_raise Simplevoc::Open::EmptyKeyException do
+      client.update(nil, nil)
+    end
+  end
+
+  should 'delete a value for a key' do
+    assert_raise Simplevoc::Open::KeyNotFoundException do
+      client.get('d')
+    end
+
+    assert client.insert('d', 'e')
+
+    sv_response = client.get('d')
+    assert_equal sv_response['value'], 'e'
+    assert client.delete('d')
+
+    assert_raise Simplevoc::Open::KeyNotFoundException do
+      client.get('d')
+    end
+  end
+
+  should 'fail deleting when the key does not exist' do
+    assert_raise Simplevoc::Open::KeyNotFoundException do
+      client.delete('d2')
+    end
+  end
+
+  should 'fail deleting when the key is empty' do
+    assert_raise Simplevoc::Open::EmptyKeyException do
+      client.delete(nil)
+    end
+  end
+
+  should 'get response hash with value for key e' do
+    assert client.insert('e', 'f')
+
+    sv_response = client.get('e')
+    assert_equal sv_response['value'], 'f'
+    assert_not_nil sv_response['created']
+    assert_not_nil sv_response['flags']
+  end
+
+  should 'get value only for key f' do
+    assert client.insert('f', 'g')
+    assert_equal client.get('f', false), 'g'
+  end
+
+  should 'fail getting when the key does not exist' do
+    assert_raise Simplevoc::Open::KeyNotFoundException do
+      client.get('e2')
+    end
+  end
+
+  should 'fail getting when the key is empty' do
+    assert_raise Simplevoc::Open::EmptyKeyException do
+      client.get(nil)
+    end
+  end
+
+  should 'get keys for a given prefix' do
+    assert client.insert('g', 'h')
+    assert client.insert('gg', 'hh')
+    assert client.insert('ggg', 'ggg')
+
+    keys = client.keys('g')
+    assert_not_nil keys
+    assert_equal keys.size, 3
+    assert keys.include?('g')
+    assert keys.include?('gg')
+    assert keys.include?('ggg')
+
+    keys = client.keys('gg')
+    assert_not_nil keys
+    assert_equal keys.size, 2
+    assert keys.include?('gg')
+    assert keys.include?('ggg')
+
+    keys = client.keys('ggg')
+    assert_not_nil keys
+    assert_equal keys.size, 1
+    assert keys.include?('ggg')
+  end
+
+  should 'fail when a no key for a given prefix can be found' do
+    assert_raise Simplevoc::Open::PrefixNotFoundException do
+      client.keys('test')
+    end
+  end
+
+  should 'flush all keys' do
+    assert client.insert('h', 'i')
+    assert_equal client.get('h', false), 'i'
+    assert client.flush
+    assert_raise Simplevoc::Open::KeyNotFoundException do
+      client.get('h')
+    end
+    # I know this doesn't really prove the flushing...
+  end
+
+  should 'get the server version number' do
+    assert_not_nil client.server_version
+  end
+
+  should 'get the server info including version number' do
+    info = client.server_info
+    assert_not_nil info
+    assert_not_nil info['version']
+    assert_not_nil info['server']
+  end
+
+  should 'create a correct header options hash' do
+    test_date_time_object = Time.now.utc.iso8601
+    extra_options = client.extra_options(test_date_time_object, 1, test_date_time_object, test_date_time_object)
+    assert_not_nil extra_options
+    assert extra_options.include?(:headers)
+    assert_equal extra_options[:headers]['x-voc-expires'], test_date_time_object.to_s
+    assert_equal extra_options[:headers]['x-voc-flags'], "1"
+    assert_equal extra_options[:headers]['x-voc-delete-time'], test_date_time_object.to_s
+    assert_equal extra_options[:headers]['x-voc-flush-delay'], test_date_time_object.to_s
+  end
+
+  private
+  def client
+    port = ENV['SIMPLEVOC_PORT'] || '12345'
+    host = ENV['SIMPLEVOC_HOST'] || 'localhost'
+    @client ||= Simplevoc::Open::Client.new('host' => host, 'port' => port, 'log_level' => Logger::DEBUG, 'strict_mode' => true)
+  end
+end
+

data/test/test_hash.rb

@@ -0,0 +1,37 @@
+require 'helper'
+require 'logger'
+
+class TestHash < Test::Unit::TestCase
+  should 'insert/get a value' do
+    assert hash["a"] = "b"
+    assert_equal hash["a"], "b"
+  end
+
+  should 'update a value' do
+    assert_equal hash["a"], "b"
+    assert hash["a"] = "b2"
+    assert_equal hash["a"], "b2"
+  end
+
+  should 'check for the existence of a key' do
+    hash["x"] = "y"
+    assert hash.has_key?("x")
+  end
+
+  should 'get multiple values at once' do
+    hash["x"] = "y"
+    hash["x2"] = "y2"
+    values_hash = hash.values_at(["x", "x2"])
+    assert_not_nil values_hash
+    assert_equal values_hash["x"], "y"
+    assert_equal values_hash["x2"], "y2"
+  end
+
+  private
+  def hash
+    port = ENV['SIMPLEVOC_PORT'] || '12345'
+    host = ENV['SIMPLEVOC_HOST'] || 'localhost'
+    @hash ||= Simplevoc::Open::Hash.new('host' => host, 'port' => port, :log_level => Logger::DEBUG)
+  end
+end
+

data/test/test_non_strict_client.rb

@@ -0,0 +1,102 @@
+require 'helper'
+require 'logger'
+
+class TestNonStrictClient < Test::Unit::TestCase
+  should "insert value for key a" do
+    assert client.flush
+    assert client.insert("a", "b")
+  end
+
+  should 'fail inserting value when the value is empty' do
+    assert !client.insert('a', nil)
+  end
+
+  should 'fail inserting value when the key is empty' do
+    assert !client.insert(nil, nil)
+  end
+
+  should "fail inserting value for key a when value for key a exists" do
+    assert !client.insert('a', 'b')
+  end
+
+  should "insert or update value for key c" do
+    assert !client.get('c')
+
+    assert client.insert_or_update('c', 'd')
+    sv_response = client.get('c')
+    assert_not_nil sv_response
+    assert_equal sv_response['value'], 'd'
+
+    assert client.insert_or_update('c', 'd2')
+    sv_response = client.get('c')
+    assert_not_nil sv_response
+    assert_equal sv_response['value'], 'd2'
+  end
+
+  should 'fail creating or updating value when the value is empty' do
+    assert !client.insert_or_update('a', nil)
+  end
+
+  should 'fail creating or updating value when the key is empty' do
+    assert !client.insert_or_update(nil, nil)
+  end
+
+  should 'fail when trying to update a value for a missing key' do
+    assert !client.update('a2', 'b2')
+  end
+
+  should 'fail updating when the value is empty' do
+    assert !client.update('a2', nil)
+  end
+
+  should 'fail updating when the key is empty' do
+    assert !client.update(nil, nil)
+  end
+
+  should 'delete a value for a key' do
+    assert_nil client.get('d')
+
+    assert client.insert('d', 'e')
+
+    sv_response = client.get('d')
+    assert_equal sv_response['value'], 'e'
+    assert client.delete('d')
+
+    assert_nil client.get('d')
+  end
+
+  should 'fail deleting when the key does not exist' do
+   assert !client.delete('d2')
+  end
+
+  should 'fail deleting when the key is empty' do
+    assert !client.delete(nil)
+  end
+
+  should 'fail getting when the key does not exist' do
+    assert !client.get('e2')
+  end
+
+  should 'fail getting when the key is empty' do
+    assert !client.get(nil)
+  end
+
+  should 'flush all keys' do
+    assert client.insert('h', 'i')
+    assert_equal client.get('h', false), 'i'
+    assert client.flush
+    assert !client.get('h')
+  end
+
+  should 'fail when a no key for a given prefix can be found' do
+    assert_nil = client.keys('test')
+  end
+
+  private
+  def client
+    port = ENV['SIMPLEVOC_PORT'] || '12345'
+    host = ENV['SIMPLEVOC_HOST'] || 'localhost'
+    @client ||= Simplevoc::Open::Client.new('host' => host, 'port' => port, 'log_level' => Logger::DEBUG, 'strict_mode' => false)
+  end
+end
+