oxblood 0.1.0.dev4 → 0.1.0.dev5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a369a489b3733b77b4742e0d35cbaf30f8a794f
-  data.tar.gz: 081150bc06a0c6c2d3dd280f7ac0405caabd46a2
+  metadata.gz: 2b3e70584c6264f36457da12558ba76dcabc4b19
+  data.tar.gz: 06a8d8e83f0e9d9a68790126fb1324023cd86c08
 SHA512:
-  metadata.gz: 86727e0c5bcfb0960204d6bd5e516d21614a9fb992e9d1cfe7c424872c759dc2673e1faafd2f82ca7035f64524f6f46839498ff0811e018045c854bb6e32467c
-  data.tar.gz: 24d72c0595245b1f19950acd2f65ae1ce19c32a9eed0b37893e9543bda7fb42b48523bd55511e5c87150260f5926e5a7de9f4502bffdc7152ed2df6945e250e1
+  metadata.gz: 36e9a9993f99b8fc11ebb7ee0208964c7eaedf08ce300f3b0061844dfe3d080e25d0d7b66353564b9a73c9c3af624b9e3f18773cbfb2c2ff0fac067b93e7a4fb
+  data.tar.gz: b8612141ca6b893edc340ce5247cf7f2a2b3429baf1b0ccd4688deb1fe2c77fd586910dba1fcb5658a6450c18472b7ba5f4efb2f50e4d8278846c8f22f66e6f7

data/lib/oxblood/pipeline.rb

@@ -1,18 +1,33 @@
+require 'oxblood/session'
+
 module Oxblood
+  # Redis pipeling class. Commands won't be send until {#sync} is called.
+  # @see http://redis.io/topics/pipelining#redis-pipelining
+  #
+  # @example Basic workflow
+  #   pipeline = Pipeline.new(connection)
+  #   pipeline.echo('ping')
+  #   pipeline.ping
+  #   pipeline.echo('!')
+  #   pipeline.sync # => ["ping", "PONG", "!"]
   class Pipeline < Session
     def initialize(connection)
       super
       @commands = Array.new
     end
 
-    def run(command)
-      @commands << command
-    end
-
+    # Sends all commands at once and reads responses
+    # @return [Array] of responses
     def sync
-      serialized_commands = @commands.map { |c| serialize(command) }
+      serialized_commands = @commands.map { |c| serialize(*c) }
       @connection.write(serialized_commands.join)
       @connection.read_responses(@commands.size)
     end
+
+    private
+
+    def run(*command)
+      @commands << command
+    end
   end
 end

data/lib/oxblood/pool.rb

@@ -1,8 +1,10 @@
 require 'connection_pool'
 require 'oxblood/session'
 require 'oxblood/pipeline'
+require 'oxblood/connection'
 
 module Oxblood
+  # Connection pool to Redis server
   class Pool
     # Initialize connection pool
     #
@@ -20,6 +22,17 @@ module Oxblood
       end
     end
 
+    # Run commands on a connection from pool.
+    # Connection is wrapped to the {Session}.
+    # @yield [session] provide {Session} to a block
+    # @yieldreturn response from the last executed operation
+    #
+    # @example
+    #   pool = Oxblood::Pool.new(size: 8)
+    #   pool.with do |session|
+    #     session.set('hello', 'world')
+    #     session.get('hello')
+    #   end # => 'world'
     def with
       conn = @pool.checkout
       yield Session.new(conn)
@@ -27,6 +40,18 @@ module Oxblood
       @pool.checkin if conn
     end
 
+    # Run commands on a connection from pool. Connection is wrapped to
+    # the {Pipeline}. {Pipeline#sync} operation will be executed automatically
+    # at the end of a block.
+    # @yield [pipeline] provide {Pipeline} to a block
+    # @yieldreturn [Array] responses from all executed operations
+    #
+    # @example
+    #  pool = Oxblood::Pool.new(size: 8)
+    #  pool.pipelined do |pipeline|
+    #    pipeline.set('hello', 'world')
+    #    pipeline.get('hello')
+    #  end # => ['OK', 'world']
     def pipelined
       conn = @pool.checkout
       pipeline = Pipeline.new(conn)

data/lib/oxblood/session.rb

@@ -192,6 +192,16 @@ module Oxblood
       run(:AUTH, password)
     end
 
+    # Echo the given string
+    # @see http://redis.io/commands/echo
+    #
+    # @param [String] message
+    #
+    # @return [String] given string
+    def echo(message)
+      run(:ECHO, message)
+    end
+
     # Like {#auth}, except that if error returned, raises it.
     #
     # @param [String] password

data/lib/oxblood/version.rb

@@ -1,3 +1,3 @@
 module Oxblood
-  VERSION = '0.1.0.dev4'
+  VERSION = '0.1.0.dev5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxblood
 version: !ruby/object:Gem::Version
-  version: 0.1.0.dev4
+  version: 0.1.0.dev5
 platform: ruby
 authors:
 - Konstantin Shabanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool