simplevoc-open 1.8.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'httparty', '>= 0.7.4'
+gem 'json', '>= 1.4.6'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    git (1.2.5)
+    httparty (0.7.4)
+      crack (= 0.1.8)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  httparty (>= 0.7.4)
+  jeweler (~> 1.5.2)
+  json (>= 1.4.6)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 triAGENS GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,152 @@
+SimpleVOC Open REST Client
+==========================
+
+This ruby library is a REST client for the SimpleVOC key/value store.
+
+SimpleVOC is a pure in-memory key/value store with a REST Interface. It was developed with easy installation, administration and operation in mind. Checkout [World of Voc](http://www.worldofvoc.com) for more information.
+
+
+Installation
+------------
+
+Tested on Ruby 1.8.7 and RubyGems 1.5.2.
+
+	[sudo] gem install httparty
+    [sudo] gem install simplevoc-open
+
+
+Configuration
+-------------
+
+You can setup the client by passing options into the constructor or by using a configuration file in YAML.
+
+    client = Simplevoc::Open::Client.new('host' => 'localhost', 'port' => 12345)
+
+Possible configuration options:
+
+* host (required)
+* port (required)
+* protocol ("http"/"https"), defaults to "http"
+* strict_mode (true/false), defaults to true
+* log_level, defaults to LOGGER::INFO
+
+You can also provide a configuration file in the current directory of your client to avoid setting up the client within your code. Checkout the config.yml.sample file as an example.
+
+If this configuration file isn't found in the current directory, the client will look for a "global" configuration file in your home directory (~/.simplevoc.yml).
+
+
+Usage
+-----
+
+Add the "simplevoc-open" gem to your bundler Gemfile in Rails 3.x or require the simplevoc gem manually.
+
+    gem 'simplevoc-open'
+    require 'simplevoc-open'
+
+
+Examples
+--------
+
+Creating the client:
+
+    gem 'simplevoc-open'
+    require 'simplevoc-open'
+    client = Simplevoc::Open::Client.new('host' => 'localhost', 'port' => 12345, 'log_level' => LOGGER::DEBUG)
+
+    key = "foo"; value = "bar"
+    key2 = "foo2"; value2 = "bar2"
+
+Inserting a value:
+
+     begin
+       client.insert(key, value) # => true/false
+     rescue => e
+       puts "Inserting fails if the key already exists..."
+     end
+
+Inserting a value with extended values (meta information, must be known to the server):
+
+     client.insert(key, value, "{'name':'test'}") => true/false
+
+Or
+
+     client.insert(key2, value2, {'name' => 'test'}) => true/false
+
+To avoid exceptions, create a client in non-strict mode
+
+    client = Simplevoc::Open::Client.new('host' => 'localhost', 'port' => 12345, 'log_level' => LOGGER::DEBUG, 'strict_mode' => false)
+
+Creating or updating a value:
+
+    client.insert_or_update(key, "bar new")
+	=> true/false
+
+Updating a value
+
+    success = client.update(key, "bar new") # key must exist, use non-strict mode to avoid exceptions
+    => true/false
+
+Getting a value (with additional information)
+
+    client.get(key) # key must exist
+	=> {"flags"=>0, "value"=>"bar", "created"=>#<DateTime: 17680436009/7200,0,2299161>}
+	
+Getting the value only
+
+    client.get(key, false) # key must exist
+    => "bar"
+
+Deleting a value
+
+    success = client.delete(key) # key must exist
+	=> true/false
+
+Getting keys by a prefix
+
+    key2 = "foo2"; value2 = "bar2"
+    client.insert(key2, value2)
+    client.keys("f")
+    => ["foo", "foo2"]
+
+Flush all values:
+
+    client.flush
+	=> true/false
+
+Using the Simplevoc Hash as a simple non-strict mode alternative:
+
+	hash = Simplevoc::Open::Hash.new('host' => 'localhost', 'port' => 12345) # accepts the same options as the regular client
+
+	key = "foo"; key2 = "foo2"
+	hash[key] = "bar" # create or update
+	hash[key2] = "bar2"
+	hash[key] # get
+	hash.delete(key)
+	
+	hash.include?(key) # check for existence of a key (in simplevoc)
+	
+	hash.values_at([key, key2]) # get multiple values at once
+	=> {"key" => "bar", "key2" => "bar2"}
+
+The Simplevoc::Open::Hash class inherits from the Simplevoc::Open::Client, so you can use the regular client methods too. The Simplevoc::Open::Hash doesn't store any values locally, it always connects to Simplevoc.
+
+
+Documentation & Tests
+---------------------
+
+Checkout the rdoc Documentation for more information. Generate the docs with "rake rdoc".
+
+Use "rake test" to run the unit tests. The unit tests expect the SimpleVOC server to be started on port 12345 on your localhost:
+
+  simplevoc --server.http-port=12345 --server.extended-key-values=name:string
+
+To run the tests against an existing SimpleVOC installation on a different host or port, use the SIMPLEVOC_HOST / SIMPLEVOC_PORT environment variables. For example:
+
+  SIMPLEVOC_HOST=localhost SIMPLEVOC_PORT=8008 rake test
+
+Copyright
+---------
+
+Copyright (c) 2011 triAGENS GmbH. See LICENSE.txt for further details.
+
+Author: Oliver Kiessler (kiessler@inceedo.com)

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+require './lib/simplevoc-open.rb'
+
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "simplevoc-open"
+  gem.homepage = "http://www.worldofvoc.com/products/simplevoc/summary/"
+  gem.license = "Apache License Version 2.0, January 2004"
+  gem.summary = "A pure in-memory key/value store with a REST interface"
+  gem.description = "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!"
+  gem.email = "kiessler@inceedo.com"
+  gem.authors = ["triAGENS GmbH", "Oliver Kiessler"]
+  gem.add_dependency "httparty", ">= 0.7.4"
+  gem.add_dependency "json", ">= 1.4.6"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/}
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "SimpleVOC Open Ruby Client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end