oxblood 0.1.0.dev2 → 0.1.0.dev3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a00f0943e58421dc3712679260605e17607e709
-  data.tar.gz: 8cf70de44aaa9dc92d6c58c614781548ee3db53b
+  metadata.gz: 2d7a859b01da306481014391452d354b78e733d9
+  data.tar.gz: b5b6a5ccc51f7b07c562c29b434a85f65b9bd4cd
 SHA512:
-  metadata.gz: 90fd668f8be2a153061537d565c0470f9202121b88bf64c8ee82e03b4d057d5a34a1cf6a7a989ffa225afba91406e7342901b9c696f7c2988ac6c0b56c4d3881
-  data.tar.gz: eab75bed05a363806827dffed9bcfe0f32b51d900fc4e31248eb1c42d44ebfc7549e61e3941e027854d345536b7d14fc9cfc84b5ea2ca91c0c7c64897c95684e
+  metadata.gz: c1dffe945b9bb71adec19fc0f33a6847ca90fa325d061f699e7b784ced2aedcc4ec0f7685a17764e94db4f2ca513e830f0233e7a379b89a75584409f08862ce0
+  data.tar.gz: 53ccf202c3821c309a5d7e4c998280f682f7197d54f9c2f2cb6e7295bd07acb7054a5b4df50086e7b604a91f2911301d79677f416dcd8dd046a2202ec561b42e

data/.codeclimate.yml

@@ -9,6 +9,8 @@ engines:
     enabled: true
   rubocop:
     enabled: true
+    exclude_fingerprints:
+      - 5b0714ee48391458a7484df9bc2ac262
 ratings:
   paths:
   - "**.rb"

data/.gitignore

@@ -7,5 +7,6 @@
 /pkg/
 /spec/reports/
 /spec/examples.txt
-/tmp/
+/tmp/*
+!/tmp/.keep
 /benchmarks/Gemfile.lock

data/lib/oxblood/command.rb

@@ -61,7 +61,7 @@ module Oxblood
         serialize([:HVALS, key])
       end
 
-      def hscan(key, cursor)
+      def hscan(_key, _cursor)
         raise 'Not implemented!'
       end
 
@@ -69,6 +69,10 @@ module Oxblood
 
       # ------------------ Connection ---------------------
 
+      def auth(password)
+        serialize([:AUTH, password])
+      end
+
       def ping(message = nil)
         command = [:PING]
         command << message if message
@@ -76,6 +80,10 @@ module Oxblood
         serialize(command)
       end
 
+      def select(index)
+        serialize([:SELECT, index])
+      end
+
       # ------------------ Server ---------------------
 
       def info(section = nil)

data/lib/oxblood/connection.rb

@@ -1,5 +1,6 @@
 require 'oxblood/protocol'
 require 'oxblood/buffered_io'
+require 'oxblood/session'
 
 module Oxblood
   # Class responsible for connection maintenance
@@ -7,54 +8,51 @@ module Oxblood
     TimeoutError = Class.new(RuntimeError)
 
     class << self
-      # Open Redis connection
+      # Open connection to Redis server
       #
-      # @param [Hash] options Connection options
+      # @param [Hash] opts Connection options
       #
-      # @option (see .connect_tcp)
-      # @option (see .connect_unix)
-      def open(options = {})
-        options.key?(:path) ? connect_unix(options) : connect_tcp(options)
-      end
-
-      # Connect to Redis server through TCP
+      # @option opts [Float] :timeout (1.0) socket read timeout
+      # @option opts [Integer] :db database number
+      # @option opts [String] :password
       #
-      # @param [Hash] options Connection options
+      # @option opts [String] :host ('localhost') Hostname or IP address to connect to
+      # @option opts [Integer] :port (6379) Port Redis server listens on
+      # @option opts [Float] :connect_timeout (1.0) socket connect timeout
       #
-      # @option options [String] :host ('localhost') Hostname or IP address to connect to
-      # @option options [Integer] :port (5672) Port Redis server listens on
-      # @option options [Float] :timeout (1.0) socket read timeout
-      # @option options [Float] :connect_timeout (1.0) socket connect timeout
+      # @option opts [String] :path UNIX socket path
       #
       # @return [Oxblood::Connection] connection instance
-      def connect_tcp(options = {})
-        host = options.fetch(:host, 'localhost')
-        port = options.fetch(:port, 6379)
-        timeout = options.fetch(:timeout, 1.0)
-        connect_timeout = options.fetch(:connect_timeout, 1.0)
+      def open(opts = {})
+        socket = if opts.key?(:path)
+          unix_socket(opts.fetch(:path))
+        else
+          host = opts.fetch(:host, 'localhost')
+          port = opts.fetch(:port, 6379)
+          connect_timeout = opts.fetch(:connect_timeout, 1.0)
+
+          tcp_socket(host, port, connect_timeout)
+        end
+
+        timeout = opts.fetch(:timeout, 1.0)
+
+        new(socket, timeout).tap do |conn|
+          session = Session.new(conn)
+          session.auth!(opts[:password]) if opts[:password]
+          session.select(opts[:db]) if opts[:db]
+        end
+      end
 
-        socket = Socket.tcp(host, port, connect_timeout: connect_timeout)
-        socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+      private
 
-        new(socket, timeout)
+      def unix_socket(path)
+        UNIXSocket.new(path)
       end
 
-      # Connect to Redis server through UNIX socket
-      #
-      # @param [Hash] options Connection options
-      #
-      # @option options [String] :path UNIX socket path
-      # @option options [Float] :timeout (1.0) socket read timeout
-      #
-      # @raise [KeyError] if :path was not passed
-      #
-      # @return [Oxblood::Connection] connection instance
-      def connect_unix(options = {})
-        path = options.fetch(:path)
-        timeout = options.fetch(:timeout, 1.0)
-
-        socket = ::Socket.unix(path)
-        new(socket, timeout)
+      def tcp_socket(host, port, connect_timeout)
+        Socket.tcp(host, port, connect_timeout: connect_timeout).tap do |sock|
+          sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+        end
       end
     end
 
@@ -72,15 +70,16 @@ module Oxblood
       write(Protocol.build_command(command))
     end
 
-    # FIXME: docs
-    def write(command)
-      @socket.write(command)
+    # Write data to socket
+    # @param [#to_s] data given
+    # @return [Integer] the number of bytes written
+    def write(data)
+      @socket.write(data)
     end
 
     # Send command to Redis server and read response from it
     # @example run_command(['PING']) => PONG
     # @param [Array] command Array of command name with it's args
-    # @return #FIXME
     def run_command(command)
       send_command(command)
       read_response
@@ -129,7 +128,8 @@ module Oxblood
       Protocol.parse(self)
     end
 
-    # FIXME: docs
+    # Read several responses from server
+    # (see #read_response)
     def read_responses(n)
       Array.new(n) { read_response }
     end

data/lib/oxblood/session.rb

@@ -1,4 +1,3 @@
-require 'oxblood/connection'
 require 'oxblood/command'
 
 module Oxblood
@@ -185,6 +184,28 @@ module Oxblood
 
     # ------------------ Connection ---------------------
 
+    # Authenticate to the server
+    # @see http://redis.io/commands/auth
+    #
+    # @param [String] password
+    #
+    # @return [String] 'OK'
+    def auth(password)
+      run(cmd.auth(password))
+    end
+
+    # Like {#auth}, except that if error returned, raises it.
+    #
+    # @param [String] password
+    #
+    # @raise [Protocol::RError] if error returned
+    #
+    # @return [String] 'OK'
+    def auth!(password)
+      response = auth(password)
+      error?(response) ? (raise response) : response
+    end
+
     # Returns PONG if no argument is provided, otherwise return a copy of
     # the argument as a bulk
     # @see http://redis.io/commands/ping
@@ -196,6 +217,16 @@ module Oxblood
       run(cmd.ping(message))
     end
 
+    # Change the selected database for the current connection
+    # @see http://redis.io/commands/select
+    #
+    # @param [Integer] index database to switch
+    #
+    # @return [String] 'OK'
+    def select(index)
+      run(cmd.select(index))
+    end
+
     # ------------------ Server ---------------------
 
     # Returns information and statistics about the server in a format that is
@@ -204,10 +235,7 @@ module Oxblood
     #
     # @param [String] section used to select a specific section of information
     def info(section = nil)
-      command = [:INFO]
-      command << section if section
-
-      response = run(cmd.info(section))
+      run(cmd.info(section))
       # FIXME: Parse response
     end
 
@@ -304,5 +332,11 @@ module Oxblood
       @connection.write(command)
       @connection.read_response
     end
+
+    private
+
+    def error?(response)
+      Protocol::RError === response
+    end
   end
 end

data/lib/oxblood/version.rb

@@ -1,3 +1,3 @@
 module Oxblood
-  VERSION = '0.1.0.dev2'
+  VERSION = '0.1.0.dev3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxblood
 version: !ruby/object:Gem::Version
-  version: 0.1.0.dev2
+  version: 0.1.0.dev3
 platform: ruby
 authors:
 - Konstantin Shabanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -123,6 +123,7 @@ files:
 - lib/oxblood/version.rb
 - lib/redis/connection/oxblood.rb
 - oxblood.gemspec
+- tmp/.keep
 homepage: https://github.com/etehtsea/oxblood
 licenses:
 - MIT