sensu-redis 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b8895a42f4cb3e6563be8a39035bb93dc68d049
-  data.tar.gz: 44cb3dbc56d3d2c16a0f6b53b3f7c607a7e4ba2e
+  metadata.gz: d506a4f9c1cb2989055fc0d1f60ad3f8828b5800
+  data.tar.gz: 21f5ddeb2c308b0bd972e5d55b18f76e0aa805e3
 SHA512:
-  metadata.gz: 1e063207d57983942369babd6e2e2eafc350d722a70e270b3d7b132a8cb7ac3d7f6102874fcbac59bd6d0da866f8636eb7c16379e37ccd6acfc1f87422aec0dd
-  data.tar.gz: a84187b8ac1dabb1709c07c64d3622d4d1060620b9631d67281c9d0a95121eca76830618f1dcdd20eec2f6573ddc7704a2b61962de6812b6a1a823ff0fd97420
+  metadata.gz: a315cfdb676056faf7767524e3e74fcbb881120fa8438d41b24a149ac9062599e8f8628771d62569e33f046726bbd76384345fce5ae22891619093ae4a10890e
+  data.tar.gz: ae11c67716d9a903df610b69183aed227fa113310ef5d5f084f23eeab049dc704d59f28c3fc51789496aa26d289ed9fea0094ecdd7cd332fa49bf986649e9fbe

data/lib/sensu/redis/commands.rb

@@ -16,53 +16,67 @@ module Sensu
         string.respond_to?(:bytesize) ? string.bytesize : string.size
       end
 
-      # Send a Redis command using RESP multi bulk. This method is
-      # called by the Redis command methods, which are created by
-      # `create_command_methods()`, it simply implements RESP and
-      # sends commands to Redis via EM connection `send_data()`.
-      def send_command(*arguments)
-        command = "*#{arguments.size}#{DELIM}"
+      # Send a Redis command using RESP multi bulk. This method sends
+      # data to Redis using EM connection `send_data()`.
+      #
+      # @params [Array<Object>] *arguments
+      def send_command_data(*arguments)
+        data = "*#{arguments.size}#{DELIM}"
         arguments.each do |value|
           value = value.to_s
-          command << "$#{get_size(value)}#{DELIM}#{value}#{DELIM}"
+          data << "$#{get_size(value)}#{DELIM}#{value}#{DELIM}"
         end
-        callback { send_data(command) }
+        send_data(data)
       end
 
-      # Create Redis command methods. Command methods just wrap
-      # `send_command()` and enqueue a response callback. This method
-      # MUST be called in the connection object's `initialize()`.
-      def create_command_methods!
+      # Send a Redis command and queue the associated response
+      # callback. This method calls `send_command_data()` for RESP
+      # multi bulk and transmission.
+      #
+      # @params command [String]
+      # @params [Array<Object>] *arguments
+      # @yield command reponse callback
+      def send_command(command, *arguments, &block)
         @response_callbacks ||= []
-        REDIS_COMMANDS.each do |command|
-          self.class.send(:define_method, command.to_sym) do |*arguments, &block|
-            send_command(command, *arguments)
-            @response_callbacks << [RESPONSE_PROCESSORS[command], block]
+        send_command_data(command, *arguments)
+        @response_callbacks << [RESPONSE_PROCESSORS[command], block]
+      end
+
+      # Send a Redis command once the Redis connection has been
+      # established (EM Deferable succeeded).
+      #
+      # @params command [String]
+      # @params [Array<Object>] *arguments
+      # @yield command reponse callback
+      def redis_command(command, *arguments, &block)
+        if @deferred_status == :succeeded
+          send_command(command, *arguments, &block)
+        else
+          callback do
+            send_command(command, *arguments, &block)
           end
         end
       end
 
-      # Authenticate to Redis and select the correct DB, when
-      # applicable. The auth and select Redis commands must be the
-      # first commands (& callbacks) to run.
-      #
-      # @param password [String]
-      # @param db [Integer]
-      def auth_and_select_db(password=nil, db=nil)
-        callbacks = @callbacks || []
-        @callbacks = []
-        send_command(AUTH_COMMAND, password) if password
-        send_command(SELECT_COMMAND, db) if db
-        callbacks.each { |block| callback(&block) }
+      # Create Redis command methods. Command methods wrap
+      # `redis_command()`. This method MUST be called in
+      # `initialize()`.
+      def create_command_methods!
+        REDIS_COMMANDS.each do |command|
+          self.class.send(:define_method, command.to_sym) do |*arguments, &block|
+            redis_command(command, *arguments, &block)
+          end
+        end
       end
 
       # Subscribe to a Redis PubSub channel.
       #
       # @param channel [String]
+      # @yield channel message callback
       def subscribe(channel, &block)
         @pubsub_callbacks ||= Hash.new([])
         @pubsub_callbacks[channel] << block
-        send_command(SUBSCRIBE_COMMAND, channel, &block)
+        redis_command(SUBSCRIBE_COMMAND, channel, &block)
       end
 
       # Unsubscribe to one or more Redis PubSub channels. If a channel
@@ -71,6 +85,7 @@ module Sensu
       # Redis PubSub channels.
       #
       # @param channel [String]
+      # @yield unsubscribe callback
       def unsubscribe(channel=nil, &block)
         @pubsub_callbacks ||= Hash.new([])
         arguments = [UNSUBSCRIBE_COMMAND]
@@ -82,7 +97,7 @@ module Sensu
             @pubsub_callbacks[key] = [block]
           end
         end
-        send_command(arguments)
+        redis_command(arguments)
       end
     end
   end

data/lib/sensu/redis/connection.rb

@@ -5,6 +5,8 @@ module Sensu
   module Redis
     # Sensu Module connecting to Redis.
     module Connection
+      # Initialize the connection, creating the Redis command methods,
+      # and setting the default connection options and callbacks.
       def initialize(options={})
         create_command_methods!
         @host = options[:host]
@@ -22,22 +24,28 @@ module Sensu
         }
       end
 
-      # Set the on error callback.
+      # Set the connection error callback. This callback is called
+      # when the connection encounters either a connection, protocol,
+      # or command error.
       def on_error(&block)
         @error_callback = block
       end
 
-      # Set the before reconnect callback.
+      # Set the connection before reconnect callback. This callback is
+      # called after the connection closes but before a reconnect is
+      # attempted.
       def before_reconnect(&block)
         @reconnect_callbacks[:before] = block
       end
 
-      # Set the after reconnect callback.
+      # Set the connection after reconnect callback. This callback is
+      # called after a successful reconnect, after the connection has
+      # been validated.
       def after_reconnect(&block)
         @reconnect_callbacks[:after] = block
       end
 
-      # Create an error and pass it to the error callback.
+      # Create an error and pass it to the connection error callback.
       #
       # @param klass [Class]
       # @param message [String]
@@ -46,14 +54,14 @@ module Sensu
         @error_callback.call(redis_error)
       end
 
-      # Determine if connected to Redis.
+      # Determine if the connection is connected to Redis.
       def connected?
         @connected || false
       end
 
       # Reconnect to Redis. The before reconnect callback is first
-      # call if not already reconnecting. This method uses a 1 second
-      # delay before attempting a reconnect.
+      # called if not already reconnecting. This method uses a 1
+      # second delay before attempting a reconnect.
       def reconnect!
         @reconnect_callbacks[:before].call unless @reconnecting
         @reconnecting = true
@@ -63,18 +71,17 @@ module Sensu
       end
 
       # Close the Redis connection after writing the current
-      # command/data.
+      # Redis command data.
       def close
         @closing = true
         close_connection_after_writing
       end
 
-      # Called by EM when the connection closes, either intentionally
-      # or unexpectedly.
+      # This method is called by EM when the connection closes, either
+      # intentionally or unexpectedly. This method is reponsible for
+      # starting the reconnect process when appropriate.
       def unbind
         @deferred_status = nil
-        @response_callbacks = []
-        @multibulk_count = false
         if @closing
           @reconnecting = false
         elsif ((@connected || @reconnecting) && @auto_reconnect) || @reconnect_on_error
@@ -87,25 +94,64 @@ module Sensu
         @connected = false
       end
 
-      # Validate the connection, ensuring that the Redis release
-      # supports Sensu's required Redis commands. A connection error
-      # is thrown if Redis's version does not meet the requirement.
-      def validate_connection!
-        info do |redis_info|
+      # Authenticate to Redis if a password has been set in the
+      # connection options. This method uses `send_command()`
+      # directly, as it assumes that the connection has been
+      # established. Redis authentication must be done prior to
+      # issuing other Redis commands.
+      #
+      # @yield the callback called once authenticated.
+      def authenticate
+        if @password
+          send_command(AUTH_COMMAND, @password) do |authenticated|
+            if authenticated
+              yield if block_given?
+            else
+              error(ConnectionError, "redis authenticate failed")
+            end
+          end
+        else
+          yield if block_given?
+        end
+      end
+
+      # Select a Redis DB if a DB has been set in the connection
+      # options. This method (& Redis command) does not require a
+      # response callback.
+      def select_db
+        send_command(SELECT_COMMAND, @db) if @db
+      end
+
+      # Verify the version of Redis. Redis >= 2.0 RC 1 is required for
+      # certain Redis commands that Sensu uses. A connection error is
+      # created if the Redis version does not meet the requirements.
+      #
+      # @yield the callback called once verified.
+      def verify_version
+        send_command(INFO_COMMAND) do |redis_info|
           if redis_info[:redis_version] < "1.3.14"
             error(ConnectionError, "redis version must be >= 2.0 RC 1")
+          else
+            yield if block_given?
           end
         end
       end
 
-      # Called by EM when the connection is established.
+      # This method is called by EM when the connection is
+      # established. This method is reponsible for validating the
+      # connection before Redis commands can be sent.
       def connection_completed
+        @response_callbacks = []
+        @multibulk_count = false
         @connected = true
-        auth_and_select_db(@password, @db)
-        validate_connection!
-        @reconnect_callbacks[:after].call if @reconnecting
-        @reconnecting = false
-        succeed
+        authenticate do
+          select_db
+          verify_version do
+            succeed
+            @reconnect_callbacks[:after].call if @reconnecting
+            @reconnecting = false
+          end
+        end
       end
     end
   end

data/lib/sensu/redis/constants.rb

@@ -51,16 +51,11 @@ module Sensu
       "incr"
     ].freeze
 
-    # Redis DB select command.
-    SELECT_COMMAND = "select".freeze
-
-    # Redis authentication command.
+    # Redis commands.
     AUTH_COMMAND = "auth".freeze
-
-    # Redis PubSub subscribe command.
+    SELECT_COMMAND = "select".freeze
+    INFO_COMMAND = "info".freeze
     SUBSCRIBE_COMMAND = "subscribe".freeze
-
-    # Redis PubSub unsubscribe command.
     UNSUBSCRIBE_COMMAND = "unsubscribe".freeze
 
     # Boolean Redis response value processor.
@@ -68,6 +63,7 @@ module Sensu
 
     # Redis response value processors.
     RESPONSE_PROCESSORS = {
+      "auth" => BOOLEAN_PROCESSOR,
       "exists" => BOOLEAN_PROCESSOR,
       "hexists" => BOOLEAN_PROCESSOR,
       "sismember" => BOOLEAN_PROCESSOR,

data/sensu-redis.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-redis"
-  spec.version       = "0.1.4"
+  spec.version       = "0.1.5"
   spec.authors       = ["Sean Porter"]
   spec.email         = ["portertech@gmail.com"]
   spec.summary       = "The Sensu Redis client library"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Sean Porter