quietus 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e51bf8e5b702a8806145d97e38942c57af10f020
-  data.tar.gz: 9e91b5c2c85dc0df3c20ee38991c418deeeda022
+  metadata.gz: f3a5cc3af003537f8103ca7f78e41d5a38fdec69
+  data.tar.gz: 9e34862bc1838775b621a9d909c220a9a7f0379d
 SHA512:
-  metadata.gz: 64c4ee237f9c576bf16105c3cd92cd4d3593922f1b9ef861837308e52f5acb9bb474532f439f9bc8d23d7c8314d22832030fa82c1d054ca25151586c973f0caf
-  data.tar.gz: 924f4d57f7bd05a92f4006ba7149216b64c918e83305c8991c7ad925ecc33ee8a4c933f5e2e32a22b24a712aa01ac4299390ebe7378082e291be04deaaefabf6
+  metadata.gz: 8f91b27aed0aa89614aec2a1c2ebb601695612bb698b541c56a7ae244b3593d7ca485e3b36451affb865fa7dbe71660e25577ff0a58a8ace575ff96e4e3d7793
+  data.tar.gz: 9661023616de348ab98c430dac8e2f1bd0427cf69d0f07c8a866a0ca1846a3ac20e5c0c94c917fea119eb5ae2d576e8079d9b71c9a5fb67e79d53d8dc11c7976

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  
+notifications:
+  email:
+    recipients:
+      - robert.kenny@bbc.co.uk
+    on_failure: change
+    on_success: never

data/README.md

@@ -1,4 +1,36 @@
-quietus
+Quietus
 =======
 
 Simple status check web server.
+
+[![Build Status](https://travis-ci.org/BBC-News/quietus.png?branch=master)](https://travis-ci.org/BBC-News/quietus) [![Gem Version](https://badge.fury.io/rb/quietus.png)](http://badge.fury.io/rb/quietus)
+
+##Why
+
+You might want to use this to provide a status check to an AWS ELB where you don't have a web server in your app. Having a status check lets you quietly kill unhealthy instances and replace them. 
+
+See these [AWS Docs](http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-maintain-instance-levels.html).
+
+##Usage
+
+```rb
+require 'quietus'
+
+optional_hostname = 'localhost'
+optional_port     = '2347'
+
+# quietus runs your check in a loop, so you might want to sleep
+def your_status_check
+  sleep 1
+  is_my_app_healthy?
+end
+
+# quietus is blocking so you might want to run it in a thread or fork depending on your Ruby version
+t = Thread.new do
+  Quietus::Server.new(optional_hostname, optional_port) { your_status_check }
+end
+```
+
+**The Quietus server will return a 200 if your_status_check is truthy, 500 otherwise**
+
+By default quietus runs on port 2347.

data/Rakefile

@@ -1,2 +1,10 @@
-require "bundler/gem_tasks"
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'quietus'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
 

data/lib/quietus/version.rb

@@ -1,3 +1,3 @@
 module Quietus
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/quietus.rb

@@ -6,8 +6,8 @@ module Quietus
     attr_reader :port, :hostname
 
     def initialize(hostname = 'localhost', port = 2347)
-      @hostname = hostname
-      @port     = port
+      @hostname   = hostname
+      @port       = port
 
       server &Proc.new
     end
@@ -15,25 +15,11 @@ module Quietus
     private
 
     def server(&proc)
-      tcp_server = TCPServer.new(hostname, port)
-
-      loop do
-        socket = tcp_server.accept
-
-        socket.gets
-        respond(socket, proc)
-        socket.close
-      end
+      loop { respond if proc.call }
     end
 
-    def respond(socket, proc)
-      response = proc.call ? '200 OK' : '500 Internal Server Error'
-      socket.print "HTTP/1.0 #{response}\r\n" +
-        "Content-Type: text/plain\r\n" +
-        "Content-Length: #{response.bytesize}\r\n" +
-        "Connection: close\r\n"
-      socket.print "\r\n"
-      socket.print "#{response}"
+    def respond
+      TCPServer.open(hostname, port) { |s| s.accept.close }
     end
   end
 end

data/quietus.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
 end

data/spec/quietus_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'socket'
+
+describe Quietus::Server do
+  context "creating" do
+
+    context "passed a falsy block" do
+      it "refuses a TCP connection" do
+        pid = fork do
+          Signal.trap("HUP") { exit }
+          Quietus::Server.new { false }
+        end
+
+        sleep 1
+
+        expect { TCPSocket.new('localhost', 2347) }.to raise_error(Errno::ECONNREFUSED)
+
+        Process.kill("HUP", pid)
+        Process.wait
+      end
+    end
+
+    context "passed a truthy block" do
+      it "allows a TCP connection" do
+        pid = fork do
+          Signal.trap("HUP") { exit }
+          Quietus::Server.new { true }
+        end
+
+        sleep 1
+
+        expect { TCPSocket.new('localhost', 2347) }.not_to raise_error
+
+        Process.kill("HUP", pid)
+        Process.wait
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'pry'
+require 'quietus'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quietus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Kenny
@@ -38,6 +38,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
 email:
 - kenoir@gmail.com
@@ -46,14 +74,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/quietus.rb
 - lib/quietus/version.rb
 - quietus.gemspec
+- spec/quietus_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/kenoir/quietus
 licenses:
 - GPLv3

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Robert Kenny
-
-MIT License
-
-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.