sensu-transport 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61314ff2ef5b58121e4e081d4e7541a7371e1712
-  data.tar.gz: 1aa88cc40ee08ad0f8ee5ca63cbed7d7beced2ec
+  metadata.gz: 1ce225a451ad7f61802de97848a4cc88153f3ebb
+  data.tar.gz: 2a206e0652fc6c6735a86aeb7be35b218ee14c0d
 SHA512:
-  metadata.gz: 499ed08070d7d38fcf493c1b14caf5839b5c562600d7f337fc63d5595d715aac69e4ca6514d40ad40f03c9e6b7716c7eff3b7c04ed2e19698c089d3523803ed6
-  data.tar.gz: c808abf6000bcb62b63dfa4a56c84b0fafebb770b7fca5f89f8747f0883b856be597433eb909ae29db8eb0768d7174157eb51e9168ee4f059f9e071535b2675e
+  metadata.gz: 24be969e850d8a38bdf898a01c61a4923e970a77cf38bc31b4ef0e2b771785fdc7fca9bbb6b848383f3dc9d467a568666b0b2a43384ba0979465919a656ce196
+  data.tar.gz: 52c1e08b2a6daf56195866c649e465951a3f925f0267c7e3c42101659ba8d4941c7e34f5c5c8a5312db23419269e8e42a73a46f3187085734698270f943884a9

data/lib/sensu/transport/base.rb

@@ -71,10 +71,10 @@ module Sensu
       # @param options [Hash] the options to publish the message with.
       # @yield [info] passes publish info to an optional callback/block.
       # @yieldparam info [Hash] contains publish information, which
-      #   may contain an error object.
-      def publish(type, pipe, message, options={}, &callback)
+      #   may contain an error object (:error).
+      def publish(type, pipe, message, options={})
         info = {:error => nil}
-        callback.call(info) if callback
+        yield(info) if block_given?
       end
 
       # Subscribe to a transport pipe and/or funnel.
@@ -89,30 +89,31 @@ module Sensu
       #   the consumer callback/block.
       # @yieldparam info [Hash] contains message information.
       # @yieldparam message [String] message.
-      def subscribe(type, pipe, funnel=nil, options={}, &callback)
+      def subscribe(type, pipe, funnel=nil, options={})
         info = {}
         message = ''
-        callback.call(info, message)
+        yield(info, message)
       end
 
       # Unsubscribe from all transport pipes and/or funnels.
       #
       # @yield [info] passes info to an optional callback/block.
       # @yieldparam info [Hash] contains unsubscribe information.
-      def unsubscribe(&callback)
+      def unsubscribe
         info = {}
-        callback.call(info) if callback
+        yield(info) if block_given?
       end
 
       # Acknowledge the delivery of a message from the transport.
       #
       # @param info [Hash] message information, eg. contains its id.
       # @yield [info] passes acknowledgment info to an optional callback/block.
-      def acknowledge(info, &callback)
-        callback.call(info) if callback
+      def acknowledge(info)
+        yield(info) if block_given?
       end
 
-      # Alias for acknowledge()
+      # Alias for acknowledge(). This should be superseded by a proper
+      # alias via alias_method in the transport class.
       def ack(*args, &callback)
         acknowledge(*args, &callback)
       end
@@ -121,9 +122,11 @@ module Sensu
       #
       # @param funnel [String] the transport funnel to get stats for.
       # @param options [Hash] the options to get funnel stats with.
-      def stats(funnel, options={}, &callback)
+      # @yield [info] passes funnel stats a callback/block.
+      # @yieldparam info [Hash] contains funnel stats.
+      def stats(funnel, options={})
         info = {}
-        callback.call(info)
+        yield(info) if block_given?
       end
 
       # Discover available transports (Subclasses)
@@ -132,6 +135,23 @@ module Sensu
           klass < self
         end
       end
+
+      private
+
+      # Catch transport errors and call the on_error callback,
+      # providing it with the error object as an argument. This method
+      # is intended to be applied where necessary, not to be confused
+      # with a catch-all. Not all transports will need this.
+      #
+      # @yield [] callback/block to execute within a rescue block to
+      #   catch transport errors.
+      def catch_errors
+        begin
+          yield
+        rescue => error
+          @on_error.call(error)
+        end
+      end
     end
   end
 end

data/lib/sensu/transport/patches/amqp.rb

@@ -1,7 +1,7 @@
 module AMQP
   class Session
     def send_heartbeat
-      if tcp_connection_established? && !reconnecting?
+      if tcp_connection_established? && !reconnecting? && !closed?
         send_frame(AMQ::Protocol::HeartbeatFrame)
         if !@handling_skipped_heartbeats && @last_server_heartbeat
           if @last_server_heartbeat < (Time.now - (self.heartbeat_interval * 2))

data/lib/sensu/transport/rabbitmq.rb

@@ -8,6 +8,9 @@ require File.join(File.dirname(__FILE__), "patches", "amqp")
 module Sensu
   module Transport
     class RabbitMQ < Base
+      # RabbitMQ connection setup.
+      #
+      # @param options [Hash, String]
       def connect(options={})
         reset
         set_connection_options(options)
@@ -15,6 +18,9 @@ module Sensu
         connect_with_eligible_options
       end
 
+      # Reconnect to RabbitMQ.
+      #
+      # @param force [Boolean] the reconnect.
       def reconnect(force=false)
         unless @reconnecting
           @reconnecting = true
@@ -24,70 +30,134 @@ module Sensu
         end
       end
 
+      # Indicates if connected to RabbitMQ.
+      #
+      # @return [TrueClass, FalseClass]
       def connected?
         @connection.connected?
       end
 
+      # Close the RabbitMQ connection.
       def close
         callback = Proc.new { @connection.close }
         connected? ? callback.call : EM.next_tick(callback)
       end
 
-      def publish(exchange_type, exchange_name, message, options={}, &callback)
-        begin
-          @channel.method(exchange_type.to_sym).call(exchange_name, options).publish(message) do
+      # Publish a message to RabbitMQ.
+      #
+      # @param type [Symbol] the RabbitMQ exchange type, possible
+      #   values are: :direct and :fanout.
+      # @param pipe [String] the RabbitMQ exchange name.
+      # @param message [String] the message to be published to
+      #   RabbitMQ.
+      # @param options [Hash] the options to publish the message with.
+      # @yield [info] passes publish info to an optional
+      #   callback/block.
+      # @yieldparam info [Hash] contains publish information.
+      def publish(type, pipe, message, options={})
+        catch_errors do
+          @channel.method(type.to_sym).call(pipe, options).publish(message) do
             info = {}
-            callback.call(info) if callback
+            yield(info) if block_given?
           end
-        rescue => error
-          info = {:error => error}
-          callback.call(info) if callback
         end
       end
 
-      def subscribe(exchange_type, exchange_name, queue_name="", options={}, &callback)
-        previously_declared = @queues.has_key?(queue_name)
-        @queues[queue_name] ||= @channel.queue!(queue_name, :auto_delete => true)
-        queue = @queues[queue_name]
-        queue.bind(@channel.method(exchange_type.to_sym).call(exchange_name))
-        unless previously_declared
-          queue.subscribe(options, &callback)
+      # Subscribe to a RabbitMQ queue.
+      #
+      # @param type [Symbol] the RabbitMQ exchange type, possible
+      #   values are: :direct and :fanout.
+      # @param pipe [String] the RabbitMQ exhange name.
+      # @param funnel [String] the RabbitMQ queue.
+      # @param options [Hash] the options to consume messages with.
+      # @yield [info, message] passes message info and content to the
+      #   consumer callback/block.
+      # @yieldparam info [Hash] contains message information.
+      # @yieldparam message [String] message.
+      def subscribe(type, pipe, funnel="", options={}, &callback)
+        catch_errors do
+          previously_declared = @queues.has_key?(funnel)
+          @queues[funnel] ||= @channel.queue!(funnel, :auto_delete => true)
+          queue = @queues[funnel]
+          queue.bind(@channel.method(type.to_sym).call(pipe))
+          unless previously_declared
+            queue.subscribe(options, &callback)
+          end
         end
       end
 
-      def unsubscribe(&callback)
-        @queues.values.each do |queue|
-          if connected?
-            queue.unsubscribe
-          else
-            queue.before_recovery do
+      # Unsubscribe from all RabbitMQ queues.
+      #
+      # @yield [info] passes info to an optional callback/block.
+      # @yieldparam info [Hash] contains unsubscribe information.
+      def unsubscribe
+        catch_errors do
+          @queues.values.each do |queue|
+            if connected?
               queue.unsubscribe
+            else
+              queue.before_recovery do
+                queue.unsubscribe
+              end
             end
           end
+          @queues = {}
+          @channel.recover if connected?
         end
-        @queues = {}
-        @channel.recover if connected?
         super
       end
 
-      def acknowledge(info, &callback)
-        info.ack
-        callback.call(info) if callback
+      # Acknowledge the delivery of a message from RabbitMQ.
+      #
+      # @param info [Hash] message info containing its delivery tag.
+      # @yield [info] passes acknowledgment info to an optional
+      #   callback/block.
+      def acknowledge(info)
+        catch_errors do
+          info.ack
+        end
+        super
       end
 
-      def stats(queue_name, options={}, &callback)
-        options = options.merge(:auto_delete => true)
-        @channel.queue(queue_name, options).status do |messages, consumers|
-          info = {
-            :messages => messages,
-            :consumers => consumers
-          }
-          callback.call(info)
+      # A proper alias for acknowledge().
+      alias_method :ack, :acknowledge
+
+      # RabbitMQ queue stats, including message and consumer counts.
+      #
+      # @param funnel [String] the RabbitMQ queue to get stats for.
+      # @param options [Hash] the options to get queue stats with.
+      # @yield [info] passes queue stats to the callback/block.
+      # @yieldparam info [Hash] contains queue stats.
+      def stats(funnel, options={})
+        catch_errors do
+          options = options.merge(:auto_delete => true)
+          @channel.queue(funnel, options).status do |messages, consumers|
+            info = {
+              :messages => messages,
+              :consumers => consumers
+            }
+            yield(info)
+          end
         end
       end
 
       private
 
+      # Catch RabbitMQ errors and call the on_error callback,
+      # providing it with the error object as an argument. This method
+      # is intended to be applied where necessary, not to be confused
+      # with a catch-all.
+      #
+      # @yield [] callback/block to execute within a rescue block to
+      #   catch RabbitMQ errors.
+      def catch_errors
+        begin
+          yield
+        rescue AMQP::Error => error
+          @on_error.call(error)
+        end
+      end
+
       def reset
         @queues = {}
         @connection_timeout.cancel if @connection_timeout
@@ -111,11 +181,8 @@ module Sensu
         @eligible_options.shift
       end
 
-      def reconnect_callback
-        Proc.new { reconnect }
-      end
-
-      def setup_connection(options={}, &callback)
+      def setup_connection(options={})
+        reconnect_callback = Proc.new { reconnect }
         @connection = AMQP.connect(options, {
           :on_tcp_connection_failure => reconnect_callback,
           :on_possible_authentication_failure => reconnect_callback
@@ -123,7 +190,7 @@ module Sensu
         @connection.logger = @logger
         @connection.on_open do
           @connection_timeout.cancel
-          callback.call if callback
+          yield if block_given?
         end
         @connection.on_tcp_connection_loss(&reconnect_callback)
         @connection.on_skipped_heartbeats(&reconnect_callback)

data/lib/sensu/transport/redis.rb

@@ -112,7 +112,7 @@ module Sensu
       #
       # @yield [info] passes info to an optional callback/block.
       # @yieldparam info [Hash] empty hash.
-      def unsubscribe(&callback)
+      def unsubscribe
         @connections.each do |name, connection|
           case name
           when "pubsub"
@@ -131,13 +131,15 @@ module Sensu
       #
       # @param funnel [String] the transport funnel to get stats for.
       # @param options [Hash] IGNORED by this transport.
-      def stats(funnel, options={}, &callback)
+      # @yield [info] passes list stats to the callback/block.
+      # @yieldparam info [Hash] contains list stats.
+      def stats(funnel, options={})
         redis_connection("redis").llen(funnel) do |messages|
           info = {
             :messages => messages,
             :consumers => 0
           }
-          callback.call(info)
+          yield(info)
         end
       end
 
@@ -215,11 +217,11 @@ module Sensu
       # @yield [info] passes publish info to an optional callback/block.
       # @yieldparam info [Hash] contains publish information.
       # @yieldparam subscribers [String] current subscriber count.
-      def pubsub_publish(pipe, message, &callback)
+      def pubsub_publish(pipe, message)
         channel = redis_key("channel", pipe)
         redis_connection("redis").publish(channel, message) do |subscribers|
           info = {:subscribers => subscribers}
-          callback.call(info) if callback
+          yield(info) if block_given?
         end
       end
 
@@ -240,7 +242,7 @@ module Sensu
       #   the consumer/method callback/block.
       # @yieldparam info [Hash] contains the channel name.
       # @yieldparam message [String] message content.
-      def pubsub_subscribe(pipe, &callback)
+      def pubsub_subscribe(pipe)
         channel = redis_key("channel", pipe)
         redis_connection("pubsub").subscribe(channel) do |type, channel, message|
           case type
@@ -250,7 +252,7 @@ module Sensu
             @logger.debug("unsubscribed from redis channel: #{channel}") if @logger
           when "message"
             info = {:channel => channel}
-            callback.call(info, message)
+            yield(info, message)
           end
         end
       end
@@ -265,11 +267,11 @@ module Sensu
       # @yield [info] passes publish info to an optional callback/block.
       # @yieldparam info [Hash] contains publish information.
       # @yieldparam queued [String] current list size.
-      def list_publish(pipe, message, &callback)
+      def list_publish(pipe, message)
         list = redis_key("list", pipe)
         redis_connection("redis").rpush(list, message) do |queued|
           info = {:queued => queued}
-          callback.call(info) if callback
+          yield(info) if block_given?
         end
       end
 
@@ -287,7 +289,7 @@ module Sensu
       # @yieldparam message [String] message content.
       def list_blpop(list, &callback)
         redis_connection(list).blpop(list, 0) do |_, message|
-          EM::next_tick {list_blpop(list, &callback)}
+          EM::next_tick { list_blpop(list, &callback) }
           callback.call({}, message)
         end
       end

data/sensu-transport.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-transport"
-  spec.version       = "3.3.0"
+  spec.version       = "4.0.0"
   spec.authors       = ["Sean Porter"]
   spec.email         = ["portertech@gmail.com"]
   spec.summary       = "The Sensu transport abstraction library"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-transport
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: The Sensu transport abstraction library