sensu-transport 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa4dd8fe1cfdf292bd43c1eb1a9e9e48f8364ff3
+  data.tar.gz: 0c6d0e95c66e6178440a01735fd9e010c0e1f078
+SHA512:
+  metadata.gz: 589b4ac0df3a423c9560643c87ebf75b6f85259fc126c482511050f31e0472f3c9e8e8e7b3538ac8a3c9d2c30edee5e2b4980bb766d950c386a1b4242be946f5
+  data.tar.gz: 2c145d6f1cd357ec5dcfb737ddf1bd3cf130067e5491f572da15e58d50302550cc94f5751e8e69cdb5d64f5b10514e82a944d9f1fbc44025f04ab9d0c87ce014

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+before_install:
+  - gem update --system 2.1.11
+  - gem --version
+services:
+  - rabbitmq
+notifications:
+  irc:
+    - "irc.freenode.net#sensu"

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Heavy Water Operations.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Sensu::Transport
+
+[![Build Status](https://travis-ci.org/sensu/sensu-transport.svg?branch=master)](https://travis-ci.org/sensu/sensu-transport)
+
+[![Code Climate](https://codeclimate.com/github/sensu/sensu-transport.png)](https://codeclimate.com/github/sensu/sensu-transport)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sensu-transport'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+This library provides the transport Base class, its documentation can be found
+[here](http://rubydoc.info/github/sensu/sensu-transport/Sensu/Transport/Base).
+The RabbitMQ transport is also included, providing an example while
+continuing to be the primary Sensu transport, supported by the
+community and [Heavy Water Operations](http://hw-ops.com).
+
+## Contributing
+
+Please do not submit a pull request to add an additional transport to
+this library.
+
+1. [Fork it](https://github.com/sensu/sensu-transport/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+Sensu-Transport is released under the [MIT license](https://raw.github.com/sensu/sensu-transport/master/LICENSE.txt).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sensu/transport.rb

@@ -0,0 +1,12 @@
+module Sensu
+  module Transport
+    def self.connect(transport, options={})
+      require("sensu/transport/#{transport}")
+      klass = Base.descendants.detect do |klass|
+        klass.name.downcase.split("::").last == transport
+      end
+      object = klass.connect(options)
+      object
+    end
+  end
+end

data/lib/sensu/transport/base.rb

@@ -0,0 +1,141 @@
+module Sensu
+  module Transport
+    class Error < StandardError; end
+
+    class Base
+      # @!attribute [rw] logger
+      #   @return [Logger] the Sensu logger object.
+      attr_accessor :logger
+
+      def initialize
+        @on_error = Proc.new {}
+        @before_reconnect = Proc.new {}
+        @after_reconnect = Proc.new {}
+      end
+
+      # Sets the error callback.
+      #
+      # @param callback [Proc] called in the event of a transport
+      #   error, the exception object should be passed as a parameter.
+      # @return [Proc] the error callback.
+      def on_error(&callback)
+        @on_error = callback
+      end
+
+      # Sets the before reconnect callback.
+      #
+      # @param callback [Proc] called before attempting to reconnect
+      #   to the transport.
+      # @return [Proc] the before reconnect callback.
+      def before_reconnect(&callback)
+        @before_reconnect = callback
+      end
+
+      # Sets the after reconnect callback.
+      #
+      # @param callback [Proc] called after reconnecting to the
+      #   transport.
+      # @return [Proc] the after reconnect callback.
+      def after_reconnect(&callback)
+        @after_reconnect = callback
+      end
+
+      # Transport connection setup.
+      #
+      # @param options [Hash, String]
+      def connect(options={}); end
+
+      # Indicates if connected to the transport.
+      #
+      # @return [TrueClass, FalseClass]
+      def connected?
+        false
+      end
+
+      # Close the transport connection.
+      def close; end
+
+      # Connects to the transport.
+      #
+      # @param options [Hash, String]
+      # @return [Transport] the transport object.
+      def self.connect(options={})
+        options ||= {}
+        transport = self.new
+        transport.connect(options)
+        transport
+      end
+
+      # Publish a message to the transport.
+      #
+      # @param type [Symbol] the transport pipe type, possible values
+      #   are: :direct and :fanout.
+      # @param pipe [String] the transport pipe name.
+      # @param message [String] the message to be published to the transport.
+      # @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)
+        info = {:error => nil}
+        callback.call(info) if callback
+      end
+
+      # Subscribe to a transport pipe and/or funnel.
+      #
+      # @param type [Symbol] the transport pipe type, possible values
+      #   are: :direct and :fanout.
+      # @param pipe [String] the transport pipe name.
+      # @param funnel [String] the transport funnel, which may be
+      #   connected to multiple pipes.
+      # @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=nil, options={}, &callback)
+        info = {}
+        message = ''
+        callback.call(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)
+        info = {}
+        callback.call(info) if callback
+      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
+      end
+
+      # Alias for acknowledge()
+      def ack(*args, &callback)
+        acknowledge(*args, &callback)
+      end
+
+      # Transport funnel stats, such as message and consumer counts.
+      #
+      # @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)
+        info = {}
+        callback.call(info)
+      end
+
+      # Discover available transports (Subclasses)
+      def self.descendants
+        ObjectSpace.each_object(Class).select do |klass|
+          klass < self
+        end
+      end
+    end
+  end
+end

data/lib/sensu/transport/rabbitmq.rb

@@ -0,0 +1,133 @@
+gem "amqp", "1.3.0"
+
+require "amqp"
+
+require File.join(File.dirname(__FILE__), "base")
+
+module Sensu
+  module Transport
+    class RabbitMQ < Base
+      def initialize
+        super
+        @queues = {}
+      end
+
+      def connect(options={})
+        timeout = create_connection_timeout
+        on_failure = on_connection_failure
+        @connection = AMQP.connect(options, {
+          :on_tcp_connection_failure => on_failure,
+          :on_possible_authentication_failure => on_failure
+        })
+        @connection.logger = @logger
+        @connection.on_open do
+          timeout.cancel
+        end
+        reconnect = Proc.new do
+          unless @connection.reconnecting?
+            @before_reconnect.call
+            @connection.periodically_reconnect(5)
+          end
+        end
+        @connection.on_tcp_connection_loss(&reconnect)
+        @connection.on_skipped_heartbeats(&reconnect)
+        setup_channel(options)
+      end
+
+      def connected?
+        @connection.connected?
+      end
+
+      def close
+        @connection.close
+      end
+
+      def publish(exchange_type, exchange_name, message, options={}, &callback)
+        begin
+          @channel.method(exchange_type.to_sym).call(exchange_name, options).publish(message) do
+            info = {}
+            callback.call(info) if callback
+          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)
+        end
+      end
+
+      def unsubscribe(&callback)
+        @queues.values.each do |queue|
+          if connected?
+            queue.unsubscribe
+          else
+            queue.before_recovery do
+              queue.unsubscribe
+            end
+          end
+        end
+        @queues = {}
+        @channel.recover if connected?
+        super
+      end
+
+      def acknowledge(info, &callback)
+        info.ack
+        callback.call(info) if callback
+      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)
+        end
+      end
+
+      private
+
+      def create_connection_timeout
+        EM::Timer.new(20) do
+          error = Error.new("timed out while attempting to connect to rabbitmq")
+          @on_error.call(error)
+        end
+      end
+
+      def on_connection_failure
+        Proc.new do
+          error = Error.new("failed to connect to rabbitmq")
+          @on_error.call(error)
+        end
+      end
+
+      def setup_channel(options={})
+        @channel = AMQP::Channel.new(@connection)
+        @channel.auto_recovery = true
+        @channel.on_error do |channel, channel_close|
+          error = Error.new("rabbitmq channel closed")
+          @on_error.call(error)
+        end
+        prefetch = 1
+        if options.is_a?(Hash)
+          prefetch = options.fetch(:prefetch, 1)
+        end
+        @channel.on_recovery do
+          @after_reconnect.call
+          @channel.prefetch(prefetch)
+        end
+        @channel.prefetch(prefetch)
+      end
+    end
+  end
+end

data/sensu-transport.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-transport"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sean Porter"]
+  spec.email         = ["portertech@gmail.com"]
+  spec.summary       = "The Sensu transport abstraction library"
+  spec.description   = "The Sensu transport abstraction library"
+  spec.homepage      = "https://github.com/sensu/sensu-transport"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("eventmachine")
+  spec.add_dependency("amqp", "1.3.0")
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/base_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/transport/base"
+
+describe "Sensu::Transport::Base" do
+  include Helpers
+
+  before do
+    @transport = Sensu::Transport::Base.new
+  end
+
+  it "provides a transport API (noop)" do
+    Sensu::Transport::Base.should respond_to(:connect)
+    @transport.should respond_to(:on_error, :before_reconnect, :after_reconnect,
+                                 :connect, :connected?, :close,
+                                 :publish, :subscribe, :unsubscribe, :stats)
+  end
+
+  it "behaves as expected" do
+    callback = Proc.new { true }
+    @transport.on_error(&callback).should be_an_instance_of(Proc)
+    @transport.before_reconnect(&callback).should be_an_instance_of(Proc)
+    @transport.after_reconnect(&callback).should be_an_instance_of(Proc)
+    @transport.connect.should eq(nil)
+    @transport.connect({}).should eq(nil)
+    @transport.connected?.should eq(false)
+    @transport.close.should eq(nil)
+    @transport.publish("foo", "bar", "baz").should eq(nil)
+    @transport.publish("foo", "bar", "baz", {}, &callback).should eq(true)
+    @transport.subscribe("foo", "bar", nil, {}, &callback).should eq(true)
+    @transport.unsubscribe.should eq(nil)
+    @transport.unsubscribe(&callback).should eq(true)
+    @transport.acknowledge({}).should eq(nil)
+    @transport.ack({}).should eq(nil)
+    @transport.acknowledge({}, &callback).should eq(true)
+    @transport.ack({}, &callback).should eq(true)
+    @transport.stats("foo", &callback).should eq(true)
+  end
+end

data/spec/helpers.rb

@@ -0,0 +1,24 @@
+require "rspec"
+require "eventmachine"
+
+module Helpers
+  def timer(delay, &callback)
+    periodic_timer = EM::PeriodicTimer.new(delay) do
+      callback.call
+      periodic_timer.cancel
+    end
+  end
+
+  def async_wrapper(&callback)
+    EM::run do
+      timer(10) do
+        raise "test timed out"
+      end
+      callback.call
+    end
+  end
+
+  def async_done
+    EM::stop_event_loop
+  end
+end

data/spec/rabbitmq_spec.rb

@@ -0,0 +1,83 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/transport/rabbitmq"
+
+describe "Sensu::Transport::RabbitMQ" do
+  include Helpers
+
+  before do
+    @transport = Sensu::Transport::RabbitMQ.new
+  end
+
+  it "provides a transport API" do
+    Sensu::Transport::RabbitMQ.should respond_to(:connect)
+    @transport.should respond_to(:on_error, :before_reconnect, :after_reconnect,
+                                 :connect, :connected?, :close,
+                                 :publish, :subscribe, :unsubscribe)
+  end
+
+  it "can publish and subscribe" do
+    async_wrapper do
+      @transport.connect
+      callback = Proc.new do |message|
+        message.should eq("msg")
+        timer(0.5) do
+          async_done
+        end
+      end
+      @transport.subscribe("direct", "foo", "baz", {}, &callback)
+      @transport.subscribe("direct", "bar", "baz", {}, &callback)
+      timer(1) do
+        @transport.publish("direct", "foo", "msg") do |info|
+          info.should be_kind_of(Hash)
+          info.should be_empty
+        end
+      end
+    end
+  end
+
+  it "can unsubscribe from queues and close the connection" do
+    async_wrapper do
+      @transport.connect
+      @transport.subscribe("direct", "bar") do |info, message|
+        true
+      end
+      timer(1) do
+        @transport.unsubscribe do
+          @transport.close
+          async_done
+        end
+      end
+    end
+  end
+
+  it "can acknowledge the delivery of a message" do
+    async_wrapper do
+      @transport.connect
+      @transport.subscribe("direct", "foo", :ack => true) do |info, message|
+        @transport.acknowledge(info) do
+          timer(0.5) do
+            async_done
+          end
+        end
+      end
+      timer(1) do
+        @transport.publish("direct", "foo", "msg") do |info|
+          info.should be_kind_of(Hash)
+          info.should be_empty
+        end
+      end
+    end
+  end
+
+  it "can get queue stats, message and consumer counts" do
+    async_wrapper do
+      @transport.connect
+      @transport.stats("bar") do |info|
+        info.should be_kind_of(Hash)
+        info[:messages].should eq(0)
+        info[:consumers].should eq(0)
+        async_done
+      end
+    end
+  end
+end

data/spec/transport_spec.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/transport"
+
+describe "Sensu::Transport" do
+  include Helpers
+
+  it "can load and connect to the rabbitmq transport" do
+    async_wrapper do
+      options = {}
+      transport = Sensu::Transport.connect("rabbitmq", options)
+      timer(1) do
+        transport.connected?.should be_true
+        async_done
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: sensu-transport
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: amqp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Sensu transport abstraction library
+email:
+- portertech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sensu/transport.rb
+- lib/sensu/transport/base.rb
+- lib/sensu/transport/rabbitmq.rb
+- sensu-transport.gemspec
+- spec/base_spec.rb
+- spec/helpers.rb
+- spec/rabbitmq_spec.rb
+- spec/transport_spec.rb
+homepage: https://github.com/sensu/sensu-transport
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: The Sensu transport abstraction library
+test_files:
+- spec/base_spec.rb
+- spec/helpers.rb
+- spec/rabbitmq_spec.rb
+- spec/transport_spec.rb