sensu-redis 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9953079714c141b83f7e59b50a9d75fa0474bab
-  data.tar.gz: 96880d16d145c74b1769a8efb02805f7c04b5fee
+  metadata.gz: c8d58f678c26c38a696d2ce0235d79cd48d24c0b
+  data.tar.gz: 516f96d065dfb3a80ad469c2751b4693bdede13e
 SHA512:
-  metadata.gz: b0c05605ee8d75b1a1922942ef34df14669bac9ddaf319bad36afd29f8002ecd8a1051151139f9a397aa0f245d42739b69578d5d2b6725054958a26f26231515
-  data.tar.gz: f7b6d0486645d5170d41331a04fa198fbacd300c8690d93c1493a7945e7e3d415d363abd879c486416f3da8adf47a83ce4cbbb83e7cbd386b49dc0285fb4b701
+  metadata.gz: d128b9760fe34f3fb03c111d214b918ba243b9674b475b2801e0d631f5781650b81cc27518705974d08d53642a0f84aaa742cbebab6e2c1f19a379ff7384131c
+  data.tar.gz: c5ea8e91f0998b563f77dc353ba82383e8a5b294aa18c62bd878e599859224b2769f77ec369662a2e91b9e18500fd118a66123346348d63ee0c10beba259efe6

data/lib/sensu/redis.rb

@@ -7,6 +7,11 @@ require "uri"
 module Sensu
   module Redis
     class << self
+      # Parse a Redis URL. An argument error exception is thrown if
+      # this method is unable to parse the provided URL string.
+      #
+      # @param url [String]
+      # @return [Hash] Redis connection options.
       def parse_url(url)
         begin
           uri = URI.parse(url)
@@ -20,24 +25,35 @@ module Sensu
         end
       end
 
+      # Connect to the current Redis master via Sentinel. Sentinel
+      # will resolve the current Redis master host and port.
+      #
+      # @param options [Hash]
+      # @yield callback to be called with the redis connection object.
       def connect_via_sentinel(options, &block)
         sentinel = Sentinel.new(options)
         sentinel.callback do
           sentinel.resolve do |host, port|
-            block.call(EM.connect(host, port, Client, options))
-          end
-        end
-        sentinel.errback do
-          EM::Timer.new(3) do
-            connect_via_sentinel(options, &block)
+            redis = EM.connect(host, port, Client, options)
+            redis.sentinel = sentinel
+            block.call(redis)
           end
         end
       end
 
+      # Connect to the current Redis master directly, using the
+      # provided connection options.
+      #
+      # @param options [Hash]
+      # @yield callback to be called with the redis connection object.
       def connect_direct(options, &block)
         block.call(EM.connect(options[:host], options[:port], Client, options))
       end
 
+      # Connect to Redis using the provided connection options.
+      #
+      # @param options [String,Hash]
+      # @yield callback to be called with the redis connection object.
       def connect(options={}, &block)
         case options
         when String
@@ -45,6 +61,8 @@ module Sensu
         when nil
           options = {}
         end
+        options[:host] ||= "127.0.0.1"
+        options[:port] ||= 6379
         if options[:sentinels].is_a?(Array)
           connect_via_sentinel(options, &block)
         else

data/lib/sensu/redis/client.rb

@@ -7,6 +7,8 @@ module Sensu
     class Client < EM::Connection
       include EM::Deferrable
 
+      attr_accessor :sentinel
+
       # Initialize the connection, creating the Redis command methods,
       # and setting the default connection options and callbacks.
       def initialize(options={})
@@ -17,15 +19,28 @@ module Sensu
         @password = options[:password]
         @auto_reconnect = options.fetch(:auto_reconnect, true)
         @reconnect_on_error = options.fetch(:reconnect_on_error, true)
-        @error_callback = lambda do |error|
-          raise(error)
-        end
+        @error_callback = Proc.new {}
         @reconnect_callbacks = {
-          :before => lambda {},
-          :after => lambda {}
+          :before => Proc.new {},
+          :after => Proc.new {}
         }
       end
 
+      # Determine the current Redis master address. If Sentinel was
+      # used to determine the original address, use it again. If
+      # Sentinel is not being used, return the host and port used when
+      # the connection was first established.
+      #
+      # @yield callback called when the current Redis master host and
+      #   port has been determined.
+      def determine_address(&block)
+        if @sentinel
+          @sentinel.resolve(&block)
+        else
+          block.call(@host, @port)
+        end
+      end
+
       # Set the connection error callback. This callback is called
       # when the connection encounters either a connection, protocol,
       # or command error.
@@ -68,7 +83,9 @@ module Sensu
         @reconnect_callbacks[:before].call unless @reconnecting
         @reconnecting = true
         EM.add_timer(1) do
-          reconnect(@host, @port)
+          determine_address do |host, port|
+            reconnect(host, port)
+          end
         end
       end
 
@@ -107,7 +124,7 @@ module Sensu
       # Send a Redis command using RESP multi bulk. This method sends
       # data to Redis using EM connection `send_data()`.
       #
-      # @params [Array<Object>] *arguments
+      # @param [Array<Object>] *arguments
       def send_command_data(*arguments)
         data = "*#{arguments.size}#{DELIM}"
         arguments.each do |value|
@@ -121,8 +138,8 @@ module Sensu
       # callback. This method calls `send_command_data()` for RESP
       # multi bulk and transmission.
       #
-      # @params command [String]
-      # @params [Array<Object>] *arguments
+      # @param command [String]
+      # @param [Array<Object>] *arguments
       # @yield command reponse callback
       def send_command(command, *arguments, &block)
         send_command_data(command, *arguments)
@@ -132,8 +149,8 @@ module Sensu
       # Send a Redis command once the Redis connection has been
       # established (EM Deferable succeeded).
       #
-      # @params command [String]
-      # @params [Array<Object>] *arguments
+      # @param command [String]
+      # @param [Array<Object>] *arguments
       # @yield command reponse callback
       def redis_command(command, *arguments, &block)
         if @deferred_status == :succeeded

data/lib/sensu/redis/sentinel.rb

@@ -6,19 +6,38 @@ module Sensu
     class Sentinel
       include EM::Deferrable
 
+      # Initialize the Sentinel connections. The default Redis master
+      # name is "mymaster", which is the same name that the Sensu HA
+      # Redis documentation uses. The master name must be set
+      # correctly in order for `resolve()`.
+      #
+      # @param options [Hash] containing the standard Redis
+      #   connection settings.
       def initialize(options={})
-        @options = options
-        @master_name = options[:host] || "mymaster"
-        @sentinels = connect_to_sentinels(@options[:sentinels])
+        @master = options[:master] || "mymaster"
+        @sentinels = connect_to_sentinels(options[:sentinels])
       end
 
+      # Connect to a Sentinel instance. A successful connection will
+      # set the deferrable status to `:successful`, triggering any
+      # queued Sentinel callback calls (e.g. `resolve()`).
+      #
+      # @param host [String]
+      # @param port [Integer]
+      # @return [Object] Sentinel connection.
       def connect_to_sentinel(host, port)
         connection = EM.connect(host, port, Client)
         connection.callback do
           succeed
         end
+        connection
       end
 
+      # Connect to all Sentinel instances. This method defaults the
+      # Sentinel host and port if either have not been set.
+      #
+      # @param sentinels [Array]
+      # @return [Array] of Sentinel connection objects.
       def connect_to_sentinels(sentinels)
         sentinels.map do |sentinel|
           host = sentinel[:host] || "127.0.0.1"
@@ -27,18 +46,41 @@ module Sensu
         end
       end
 
+      # Select a Sentinel connection object that is currently
+      # connected.
+      #
+      # @return [Object] Sentinel connection.
       def select_a_sentinel
         @sentinels.select { |sentinel| sentinel.connected? }.shuffle.first
       end
 
-      def resolve
+      # Retry `resolve()` with the provided callback.
+      #
+      # @yield callback called when Sentinel resolves the current
+      #   Redis master address (host & port).
+      def retry_resolve(&block)
+        EM::Timer.new(1) do
+          resolve(&block)
+        end
+      end
+
+      # Resolve the current Redis master via Sentinel. The correct
+      # Redis master name is required for this method to work.
+      #
+      # @yield callback called when Sentinel resolves the current
+      #   Redis master address (host & port).
+      def resolve(&block)
         sentinel = select_a_sentinel
         if sentinel.nil?
-          fail
+          retry_resolve(&block)
         else
           sentinel.callback do
-            sentinel.send_command("sentinel", "get-master-addr-by-name", @master_name) do |host, port|
-              yield(host, port)
+            sentinel.send_command("sentinel", "get-master-addr-by-name", @master) do |host, port|
+              if host && port
+                block.call(host, port)
+              else
+                retry_resolve(&block)
+              end
             end
           end
         end

data/sensu-redis.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-redis"
-  spec.version       = "0.1.9"
+  spec.version       = "0.1.10"
   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.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Sean Porter