gibson 1.0.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'

data/LICENSE

@@ -0,0 +1,28 @@
+Software License Agreement (BSD License)
+
+Copyright (c) 2013, Simone Margaritelli <evilsocket at gmail dot com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  * Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+  * 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.
+  * Neither the name of Gibson nor the names of its contributors may be used
+    to endorse or promote products derived from this software without
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT OWNER 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,105 @@
+Ruby Gibson client
+========================
+
+A pure Ruby Gibson client library.
+
+<http://gibson-db.in/>
+
+Supported Ruby versions and implementations
+------------------------------------------------
+
+This module should work identically on:
+
+ * JRuby 1.6+
+ * Ruby 1.9.2+
+ * Ruby 1.8.7+
+ * Rubinius 2.0
+
+If you have problems, please enter an issue.
+
+Installation and Usage
+------------------------
+
+You can verify your installation using this piece of code:
+
+    gem install gibson
+
+And
+
+    require 'gibson'
+    g = Gibson::Client.new
+    g.set 0, 'foo', 'bar'
+    p g.get 'foo'
+
+Connection
+----------
+
+Create a Client object to start working.
+
+    require 'gibson'
+
+    gibson = Gibson::Client.new
+
+The following options can be used in the constructor:
+
+* **socket**: String, the path of the unix socket to connect to, default to /var/run/gibson.sock.
+* **address**: String, the tcp address to connect to, setting this option will exclude the :socket option, default to nil.
+* **port**: Integer, the tcp port of Gibson instance, default to 10128.
+* **timeout**: Integer, timeout in milliseconds for socket I/O, default to 100.
+* **keepalive**: Boolean, true to set SO_KEEPALIVE option on the tcp socket, default true.
+
+Tcp connection example:
+
+    gibson = Gibson::Client.new :address => 'localhost'
+
+Custom unix socket connection example with 50ms timeout:
+
+    gibson = Gibson::Client.new :socket => '/tmp/socket', :timeout => 50
+
+Runtime Errors
+--------------
+
+Every Gibson protocol error is mapped to a RuntimeError derived class.
+
+* **GenericError** Generic protocol error.
+* **NotFoundError** Key or prefix not found.
+* **NaNError** The object is not a number.
+* **OutOfMemoryError** Server is out of memory.
+* **LockedError** Object is locked.
+
+Methods
+-------
+
+After connecting, you can start to make requests.
+    
+    # will retrieve the 'key' value
+    gibson.get 'key'
+
+    # create ( or replace ) a value with a TTL of 3600 seconds.
+    # set the TTL to zero and the value will never expire. 
+    gibson.set 3600, 'key', 'value'
+    
+    # delete a key from cache.
+    gibson.del 'key'
+
+    # will print server stats
+	gibson.stats.each do |name,value|
+        puts "#{name}: #{value}"
+    end
+
+Every available command is automatically mapped to a client method, so follow the 
+[official reference](http://gibson-db.in/commands.php) of Gibson commands.
+
+Once you're done, close the connection.
+
+	gibson.close
+
+License
+---
+
+Released under the BSD license.  
+Copyright &copy; 2013, Simone Margaritelli 
+<evilsocket@gmail.com>  
+
+<http://www.evilsocket.net/>
+All rights reserved.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rake/clean'
+CLEAN.include "**/*.rbc"
+CLEAN.include "**/.DS_Store"

data/gibson.gemspec

@@ -0,0 +1,23 @@
+require './lib/gibson/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{gibson}
+  s.version = Gibson::VERSION
+  s.license = "BSD"
+
+  s.authors = ["Simone Margaritelli"]
+  s.description = %q{High performance Gibson client for Ruby}
+  s.email = %q{evilsocket@gmail.com}
+  s.files = Dir.glob("lib/**/*") + [
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "Gemfile",
+     "gibson.gemspec"
+  ]
+  s.homepage = %q{http://gibson-db.in/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.summary = %q{High performance Gibson client for Ruby}
+end
+

data/lib/gibson/connection.rb

@@ -0,0 +1,83 @@
+# Copyright (c) 2013, Simone Margaritelli <evilsocket at gmail dot com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * 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.
+#   * Neither the name of Gibson nor the names of its contributors may be used
+#     to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT OWNER 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.
+module Gibson
+    require 'socket'
+    
+    class Connection
+        DEFAULTS = {
+            :socket    => '/var/run/gibson.sock',
+            :address   => nil,
+            :port      => 10128,
+            :timeout   => 100,
+            :keepalive => false
+        }
+
+        def initialize(opts = {})
+            @sock = nil
+            @connected = false
+            @options = DEFAULTS.merge(opts)
+        end
+
+        def connected?
+            @connected
+        end
+
+        def connect
+            if @options[:address] != nil
+                @sock = TCPSocket.new( @options[:address], @options[:port] ) 
+                @sock.setsockopt( Socket::IPPROTO_TCP, Socket::TCP_NODELAY, true )
+                @sock.setsockopt( Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true ) if @options[:keepalive]
+            else
+                @sock = UNIXSocket.open( @options[:socket] )
+            end
+
+            @connected = true
+        end
+
+        def close
+            @sock.close
+        end
+
+        def wait_writable
+            IO.select(nil, [@sock], nil, @options[:timeout] ) || raise(Timeout::Error, "IO timeout")
+        end
+
+        def wait_readable
+            IO.select( [@sock], nil, nil, @options[:timeout] ) || raise(Timeout::Error, "IO timeout")
+        end
+
+        def write(data)
+            wait_writable
+            @sock.write data
+        end
+
+        def read(n)
+            wait_readable
+            @sock.recv n
+        end
+    end
+end

data/lib/gibson/gibson.rb

@@ -0,0 +1,121 @@
+# Copyright (c) 2013, Simone Margaritelli <evilsocket at gmail dot com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * 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.
+#   * Neither the name of Gibson nor the names of its contributors may be used
+#     to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT OWNER 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.
+require 'gibson/protocol'
+require 'gibson/connection'
+
+module Gibson
+    class Client
+        def initialize(opts = {})
+            @connection = nil
+            @options = opts
+        end
+
+        def connect
+            @connection = Connection.new( @options )
+            @connection.connect
+        end
+
+        def decode_val( encoding, size, data )
+            # plain string
+            if encoding == Protocol::ENCODINGS[:plain]
+                data.unpack( 'Z' + size.to_s )[0]
+            # number
+            elsif encoding == Protocol::ENCODINGS[:number]
+                # 32 bit integer ?
+                if size == 4:
+                    data.unpack( 'l<' )[0]
+                else
+                    data.unpack( 'q<' )[0]
+                end
+            else
+                raise 'Unknown data encoding.'
+            end
+        end
+
+        def decode_kval( data, size )
+            left = size - 4
+            count, data  = data.unpack( 'L<a' + left.to_s )
+            obj = {}
+
+            count.times { |i|
+                left -= 4
+                klen, data = data.unpack( 'L<a' + left.to_s )
+
+                left -= klen
+                key, data = data.unpack( 'a' + klen.to_s + 'a' + left.to_s )
+                
+                left -= 1
+                enc, data = data.unpack( 'ca' + left.to_s )
+
+                left -= 4
+                vsize, data = data.unpack( 'L<a' + left.to_s )
+
+                left -= vsize
+                value, data = data.unpack( 'a' + vsize.to_s + 'a' + left.to_s )
+
+                obj[key] = decode Protocol::REPLIES[:val], enc, vsize, value
+            }
+
+            obj
+        end
+
+        def decode( code, encoding, size, data )
+            if code == Protocol::REPLIES[:val]
+                decode_val encoding, size, data
+            elsif code == Protocol::REPLIES[:kval]
+                decode_kval data, size
+            elsif code == Protocol::REPLIES[:ok]
+                true
+            elsif Protocol.error? code
+                raise Protocol::ERRORS[code]
+
+            else
+                data
+            end
+        end
+
+        def query( opcode, payload = '' )
+            connect if @connection == nil or not @connection.connected?
+
+            psize  = payload.length
+            packet = [ 2 + psize, opcode, payload ].pack( 'L<S<Z' + psize.to_s )
+
+            @connection.write packet
+
+            code, encoding, size = @connection.read(7).unpack('S<cL<' )
+            data = @connection.read size
+
+            decode code, encoding, size, data
+        end
+
+        def method_missing(name, *arguments)
+            if Protocol::COMMANDS.has_key? name 
+                query Protocol::COMMANDS[name], arguments.join(' ')
+            end
+        end
+    end
+end

data/lib/gibson/protocol.rb

@@ -0,0 +1,89 @@
+# Copyright (c) 2013, Simone Margaritelli <evilsocket at gmail dot com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * 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.
+#   * Neither the name of Gibson nor the names of its contributors may be used
+#     to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT OWNER 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.
+module Gibson
+    class GenericError < RuntimeError; end
+    class NotFoundError < RuntimeError; end
+    class NaNError < RuntimeError; end
+    class OutOfMemoryError < RuntimeError; end
+    class LockedError < RuntimeError; end
+
+    class Protocol
+        COMMANDS = {
+            :set     => 1,
+            :ttl     => 2,
+            :get     => 3,
+            :del     => 4,
+            :inc     => 5,
+            :dec     => 6,
+            :lock    => 7,  
+            :unlock  => 8,  
+            :mset    => 9,  
+            :mttl    => 10, 
+            :mget    => 11, 
+            :mdel    => 12, 
+            :minc    => 13, 
+            :mdec    => 14, 
+            :mlock   => 15, 
+            :munlock => 16, 
+            :count   => 17, 
+            :stats   => 18, 
+            :ping    => 19, 
+            :meta    => 20, 
+            :keys    => 21, 
+            :end     => 0xff
+        }
+
+        REPLIES = {
+            :error 	   => 0, # Generic error
+            :not_found => 1, # Key/Prefix not found
+            :nan 	   => 2, # Not a number
+            :mem	   => 3, # Out of memory
+            :locked    => 4, # Object is locked
+            :ok  	   => 5, # Ok, no data follows
+            :val 	   => 6, # Ok, scalar value follows
+            :kval	   => 7  # Ok, [ key => value, ... ] follows
+        }
+
+        ERRORS = {
+            0 => GenericError,
+            1 => NotFoundError,
+            2 => NaNError,
+            3 => OutOfMemoryError,
+            4 => LockedError
+        }
+
+        ENCODINGS = {
+            :plain  => 0x00, # the item is in plain encoding and data points to its buffer
+            :lzf    => 0x01, # PLAIN but compressed data with lzf
+            :number => 0x02  # the item contains a number and data pointer is actually that number
+        }
+
+        def self.error? (code)
+            code >= REPLIES[:error] && code <= REPLIES[:locked]
+        end
+    end
+end

data/lib/gibson/version.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2013, Simone Margaritelli <evilsocket at gmail dot com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * 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.
+#   * Neither the name of Gibson nor the names of its contributors may be used
+#     to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT OWNER 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.
+module Gibson 
+    VERSION = '1.0.1'
+end
+

data/lib/gibson.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2013, Simone Margaritelli <evilsocket at gmail dot com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * 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.
+#   * Neither the name of Gibson nor the names of its contributors may be used
+#     to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT OWNER 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.
+require 'gibson/gibson'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: gibson
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Simone Margaritelli
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-08-07 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: High performance Gibson client for Ruby
+email: evilsocket@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/gibson/connection.rb
+- lib/gibson/gibson.rb
+- lib/gibson/protocol.rb
+- lib/gibson/version.rb
+- lib/gibson.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+- gibson.gemspec
+has_rdoc: true
+homepage: http://gibson-db.in/
+licenses: 
+- BSD
+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: High performance Gibson client for Ruby
+test_files: []
+