sonic 0.0.1

data/lib/generators/templates/config.rb

@@ -0,0 +1,15 @@
+module Sonic
+  checks = []
+
+  # Configure your Sonic checks here
+
+  # HTTP check example 
+  #
+  # checks << Sonic.service_checker do
+  #   protocol :http
+  #   host 'myhost'
+  #   port 80
+  # end
+
+  SONIC_CHECKS = checks
+end

data/lib/sonic.rb

@@ -0,0 +1,22 @@
+require "docile"
+require "sonic/version"
+require "rails"
+
+module Sonic
+  autoload :ServiceChecker,         'sonic/service_checker'
+  autoload :ServiceCheckerBuilder,  'sonic/service_checker_builder'
+  module Protocol
+    autoload :Base,       'sonic/protocols/base'
+    autoload :HTTP,       'sonic/protocols/http'
+    autoload :AMQP,       'sonic/protocols/amqp'
+    autoload :TCP,        'sonic/protocols/tcp'
+  end
+
+  class Engine < Rails::Engine
+    isolate_namespace Sonic
+  end
+
+  def self.service_checker(&block)
+    Docile.dsl_eval(Sonic::ServiceCheckerBuilder.new, &block).build
+  end
+end

data/lib/sonic/protocols/amqp.rb

@@ -0,0 +1,32 @@
+require 'bunny'
+
+module Sonic
+  module Protocol
+    class AMQP
+      include Protocol::Base
+
+      def initialize(service_checker)
+        @service_checker = service_checker  
+      end
+
+      def check
+        begin
+          conn = ::Bunny.new(:host => @service_checker.host, :port => @service_checker.port)
+          conn.start
+          @service_checker.response = conn.status
+          if @service_checker.response == :open
+            true
+          else
+            @service_checker.error = "service error"
+            false
+          end
+          conn.close
+        rescue Exception => e
+          @service_checker.error = e.to_s
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/sonic/protocols/base.rb

@@ -0,0 +1,6 @@
+module Sonic
+  module Protocol
+    module Base
+    end
+  end
+end

data/lib/sonic/protocols/http.rb

@@ -0,0 +1,32 @@
+require 'net/http'
+
+module Sonic
+  module Protocol
+    class HTTP
+      include Protocol::Base
+
+      def initialize(service_checker)
+        @service_checker = service_checker
+        port_suffix = service_checker.port ? ":#{service_checker.port}" : ""
+        @uri = URI.parse("#{service_checker.protocol}://#{service_checker.host}#{port_suffix}/#{service_checker.path}")
+      end
+
+      def get
+        begin
+          @service_checker.response = Net::HTTP.get_response(@uri)
+          case @service_checker.response.code
+          when '200', '201', '202', '203', '204', '205', '206'
+            true
+          else
+            @service_checker.error = "service error"
+            false
+          end
+        rescue Exception => e
+          @service_checker.error = e.to_s
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/sonic/protocols/tcp.rb

@@ -0,0 +1,58 @@
+require 'socket'
+
+module Sonic
+  module Protocol
+    class TCP
+      include Protocol::Base
+
+      def initialize(service_checker)
+        @service_checker = service_checker
+        @host = service_checker.host
+        @port = service_checker.port
+        @payload = service_checker.payload
+        @ssl_key = service_checker.ssl_key
+        @ssl_cert = service_checker.ssl_cert
+      end
+
+      def send
+        begin
+          connection = TCPSocket.new(@host, @port)
+          if @ssl_cert && @ssl_key
+            ssl_context = OpenSSL::SSL::SSLContext.new()
+            ssl_context.cert = OpenSSL::X509::Certificate.new(File.read("#{Dir.pwd}/ssl/#{@ssl_cert}"))
+            ssl_context.ca_file = "#{Dir.pwd}/ssl/#{@ssl_cert}"
+            ssl_context.key = OpenSSL::PKey::RSA.new(File.read("#{Dir.pwd}/ssl/#{@ssl_key}"))
+            socket = OpenSSL::SSL::SSLSocket.new(connection, ssl_context)
+            socket.sync_close = true
+            socket.connect
+          else
+            socket = connection
+          end
+          socket.syswrite(@payload)
+          read_tcp_response(socket)
+          socket.close
+          socket = nil
+          if @service_checker.response
+            true
+          else
+            false
+          end
+        rescue Exception => e
+          @service_checker.error = e.to_s
+          false
+        end
+
+      end
+
+      private
+        def read_tcp_response(socket)
+          @service_checker.response = ""
+          @service_checker.response << socket.sysread(1)
+          while (@service_checker.response =~ /^.+?\n/) == nil
+            @service_checker.response << socket.sysread(1)
+          end
+        end
+
+    end
+  end
+end

data/lib/sonic/service_checker.rb

@@ -0,0 +1,39 @@
+module Sonic
+  class ServiceChecker
+
+    attr_accessor :protocol
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :path
+    attr_accessor :payload
+    attr_accessor :ssl_key
+    attr_accessor :ssl_cert
+    attr_accessor :response
+    attr_accessor :error
+
+    def initialize(protocol, host, port, path=nil, payload=nil, ssl_cert=nil, ssl_key=nil)
+      @protocol = protocol
+      @host     = host
+      @port     = port
+      @path     = path
+      @payload  = payload
+      @ssl_key  = ssl_key
+      @ssl_cert  = ssl_cert
+    end
+
+    def check_service()
+      case protocol
+      when :http, :https
+        http = Protocol::HTTP.new(self)
+        http.get
+      when :amqp
+        amqp = Protocol::AMQP.new(self)
+        amqp.check
+      when :tcp
+        tcp = Protocol::TCP.new(self)
+        tcp.send
+      end
+    end
+
+  end
+end

data/lib/sonic/service_checker_builder.rb

@@ -0,0 +1,14 @@
+module Sonic
+  class ServiceCheckerBuilder
+    def protocol(v=nil); @protocol = v; self; end
+    def host(v=nil); @host = v; self; end
+    def port(v=nil); @port = v; self; end
+    def path(v=nil); @path = v; self; end
+    def payload(v=nil); @payload = v; self; end
+    def ssl_cert(v=nil); @ssl_cert = v; self; end
+    def ssl_key(v=nil); @ssl_key = v; self; end
+    def build
+      Sonic::ServiceChecker.new(@protocol, @host, @port, @path, @payload, @ssl_cert, @ssl_key)
+    end
+  end
+end

data/lib/sonic/version.rb

@@ -0,0 +1,3 @@
+module Sonic
+  VERSION = "0.0.1"
+end

data/sonic.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sonic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sonic"
+  spec.version       = Sonic::VERSION
+  spec.authors       = ["Michael Bulat"]
+  spec.email         = ["mbulat@crazydogsoftware.com"]
+  spec.description   = %q{Sonic is a Rails engine which provides a status page for your applications
+                          services, along with a number of tools to periodically check those services.}
+  spec.summary       = %q{Sonic is a Rails Engine status page and services checker.}
+  spec.homepage      = "http://github.com/sonic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "rails", "~> 3.1"
+  spec.add_dependency "bunny", "~> 0.10"
+  spec.add_dependency "clockwork"
+  spec.add_dependency "docile"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails", "~> 2.6"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "webmock"
+end

data/spec/sonic/service_checker_spec.rb

@@ -0,0 +1,196 @@
+require 'bunny'
+require 'spec_helper'
+
+module Sonic
+  describe ServiceChecker do
+    context "create" do
+      context "with valid http arguments" do
+        let(:protocol)  { :http }
+        let(:host) { "localhost" }
+        let(:port) { 8081 }
+
+        subject(:service_checker) { ServiceChecker.new(protocol, host, port) }
+        it { should be_kind_of ServiceChecker }
+
+        describe "attributes" do
+          its(:protocol) { should be_kind_of(Symbol) }
+          its(:host)     { should be_kind_of(String) }
+          its(:port)     { should be_kind_of(Integer) }
+        end
+
+        context "with responding service" do
+          let(:uri) { "#{protocol}://#{host}:#{port}" }
+          before { stub_request(:get, uri) }
+
+          describe '#check_service' do
+            subject { service_checker.check_service }
+            it { should be_true }
+          end
+
+          context "with a valid response from service" do
+            before { service_checker.check_service }
+            describe '#response' do
+              subject { service_checker.response }
+              it { should_not be_nil }
+            end
+            describe '#error' do
+              subject { service_checker.error }
+              it { should be_nil }
+            end
+          end
+
+          context "with an invalid response from service" do
+            before { stub_request(:get, uri).to_return(:status => 500) }
+            before { service_checker.check_service }
+            describe '#response' do
+              subject { service_checker.response }
+              it { should_not be_nil }
+            end
+            describe '#error' do
+              subject { service_checker.error }
+              it { should == "service error" }
+            end
+          end
+        end
+
+        context "without a responding service" do
+          let(:uri) { "#{protocol}://#{host}:#{port}" }
+          before { stub_request(:get, uri).to_raise(SocketError) }
+
+          describe '#check_service' do
+            subject { service_checker.check_service }
+            it { should be_false }
+          end
+
+          context "successfuly checked down service" do
+            before { service_checker.check_service }
+            describe '#response' do
+              subject { service_checker.response }
+              it { should be_nil }
+            end
+            describe '#error' do
+              subject { service_checker.error }
+              it { should == "Exception from WebMock" }
+            end
+          end
+        end
+
+      end
+
+      context "with valid tcp arguments" do
+        let(:protocol)  { :tcp }
+        let(:host) { "localhost" }
+        let(:port) { 6667 }
+        let(:payload) { "test" }
+
+        subject(:service_checker) { ServiceChecker.new(protocol, host, port, nil, payload) }
+        it { should be_kind_of ServiceChecker }
+
+        describe "attributes" do
+          its(:protocol) { should be_kind_of(Symbol) }
+          its(:host)     { should be_kind_of(String) }
+          its(:port)     { should be_kind_of(Integer) }
+          its(:payload)  { should be_kind_of(String) }
+        end
+
+        context "with responding service" do
+          describe '#check_service' do
+            before(:each) do
+              double_socket = double(TCPSocket)
+              TCPSocket.stub(:new).with(host, port).and_return(double_socket)
+              double_socket.stub(:syswrite).with(payload).and_return(true)
+              double_socket.stub(:sysread).with(1).exactly(6).times.and_return("hello\n")
+              double_socket.stub(:close)
+            end
+
+            subject { service_checker.check_service }
+            it { should be_true }
+
+            describe '#response' do
+              before { service_checker.check_service }
+              subject { service_checker.response }
+              it { should == "hello\n" }
+            end
+          end
+        end
+
+        context "without responding service" do
+          describe '#check_service' do
+            subject { service_checker.check_service }
+            it { should be_false }
+          end
+
+          context "successfuly checked down service" do
+            before { service_checker.check_service }
+            describe '#response' do
+              subject { service_checker.response }
+              it { should be_nil }
+            end
+            describe '#error' do
+              subject { service_checker.error }
+              it { should == "Connection refused - connect(2)" }
+            end
+          end
+        end
+
+      end
+
+      context "with valid amqp arguments" do
+        let(:protocol)  { :amqp }
+        let(:host) { "localhost" }
+        let(:port) { 567222 }
+
+        subject(:service_checker) { ServiceChecker.new(protocol, host, port) }
+        it { should be_kind_of ServiceChecker }
+
+        describe "attributes" do
+          its(:protocol) { should be_kind_of(Symbol) }
+          its(:host)     { should be_kind_of(String) }
+          its(:port)     { should be_kind_of(Integer) }
+        end
+
+        context "with responding service" do
+          describe '#check_service' do
+            before(:each) do
+              double_bunny = double(::Bunny)
+              double_bunny.stub(:start)
+              double_bunny.stub(:status).and_return(:open)
+              double_bunny.stub(:close).and_return(:closed)
+              ::Bunny.stub(:new).with({:host => host, :port => port}).and_return(double_bunny)
+            end
+
+            subject { service_checker.check_service }
+            it { should be_true }
+
+            describe '#response' do
+              before { service_checker.check_service }
+              subject { service_checker.response }
+              it { should == :open }
+            end
+          end
+        end
+
+        context "without responding service" do
+          describe '#check_service' do
+            subject { service_checker.check_service }
+            it { should be_false }
+          end
+
+          context "successfuly checked down service" do
+            before { service_checker.check_service }
+            describe '#response' do
+              subject { service_checker.response }
+              it { should be_nil }
+            end
+            describe '#error' do
+              subject { service_checker.error }
+              it { should == "Could not establish TCP connection to localhost:567222: " }
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end