rack-haproxy_status 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc6e34ba36be74d7a8753a242ecf9bb6182823c0
+  data.tar.gz: 1b27c19a80e60f237d063cfe43d4482652fed11f
+SHA512:
+  metadata.gz: dacc59650333e452f67a6fe5bc2fa26e71b877bb7ae9881afa6f42dddede15ce27db693ce2dc11e66b6625787d69759e975aa4f4934afe60e379d35ce87c0403
+  data.tar.gz: 5d4ef0dfd7c10328a524945d5a7e0acc31c42c5ab54b0fb01b3de4a049a29d2064c15d70878d984c832920b37cfa42233cf6b9008a700f151266a0839c137ee9

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-haproxy_status.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marten Veldthuis
+
+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.

data/README.md

@@ -0,0 +1,35 @@
+# Rack::HaproxyStatus
+
+HAproxy can automatically drop members out of a balancer pool if they return a 50x status code. This tiny mountable Rack app facilitates this.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-haproxy_status'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+If you're using Rails, you can add this line to your `config/routes.rb`:
+
+    mount Rack::HaproxyStatus::Endpoint.new(path: Rails.root.join('config/balancer_state')) => "/load_balancer_status"
+
+Then make sure that `config/balancer_state` contains either `on` or `off`. Anything else will raise an exception. In your HAproxy config, add this line under the backend:
+
+    option httpchk HEAD /load_balancer_status HTTP/1.1
+
+Or a slightly more advanced example where you set some additional headers:
+
+    option httpchk HEAD /load_balancer_status HTTP/1.1\r\nHost:\ www.myhost.com\r\nX-Forwarded-Proto:\ https
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rack-haproxy_status/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rack/haproxy_status.rb

@@ -0,0 +1,34 @@
+require "rack/haproxy_status/version"
+
+module Rack
+  module HaproxyStatus
+    class Endpoint
+      InvalidStatus = Class.new(StandardError)
+
+      VALID_STATES = %w(on off)
+
+      def initialize(path:, io: File)
+        @path = path
+        @io = io
+      end
+
+      def call(env)
+        if balancer_member?
+          [200, {'Content-Type' => 'application/json'}, ['{"status": "ok", "member": true}']]
+        else
+          [503, {'Content-Type' => 'application/json'}, ['{"status": "ok", "member": false}']]
+        end
+      rescue InvalidStatus
+        [500, {'Content-Type' => 'application/json'}, ['{"status": "unknown status"}']]
+      end
+
+      private
+
+      def balancer_member?
+        state = @io.read(@path).strip
+        raise InvalidStatus, "Invalid state: #{state}" unless VALID_STATES.include?(state)
+        state == "on"
+      end
+    end
+  end
+end

data/lib/rack/haproxy_status/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module HaproxyStatus
+    VERSION = "0.8.0"
+  end
+end

data/rack-haproxy_status.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/haproxy_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-haproxy_status"
+  spec.version       = Rack::HaproxyStatus::VERSION
+  spec.authors       = ["Marten Veldthuis"]
+  spec.email         = ["marten@veldthuis.com"]
+  spec.summary       = %q{Tiny mountable app that returns an HTTP state based on contents of a file.}
+  spec.description   = %q{This app will return 503 if a config file contains "off", which will tell HAproxy to drop this node from the balancer backend.}
+  spec.homepage      = "https://github.com/roqua/rack-haproxy_status"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+end

data/spec/rack-haproxy_status_spec.rb

@@ -0,0 +1,34 @@
+require 'rack/haproxy_status'
+require 'json'
+
+describe Rack::HaproxyStatus::Endpoint do
+  let(:disk)             { double("File", read: "on") }
+  let(:response)         { described_class.new(path: 'config/status', io: disk).call({}) }
+  let(:response_status)  { response[0] }
+  let(:response_headers) { response[1] }
+  let(:response_body)    { response[2] }
+  let(:result)           { JSON.load(response_body[0]) }
+
+  it 'returns an ok status' do
+    expect(result.fetch('status')).to eq("ok")
+  end
+
+  describe 'balancer memberness' do
+    it 'should be in the balancer when balancer_status file is "on"' do
+      allow(disk).to receive(:read).and_return("on")
+      expect(response_status).to eq(200)
+      expect(result.fetch('member')).to be_truthy
+    end
+
+    it 'should not be in the balancer when balancer_status file is "off"' do
+      allow(disk).to receive(:read).and_return("off")
+      expect(response_status).to eq(503)
+      expect(result.fetch('member')).to be_falsey
+    end
+
+    it 'raises an exception when balancer_status file is anything else' do
+      allow(disk).to receive(:read).and_return("something")
+      expect(response_status).to eq(500)
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rack-haproxy_status
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Marten Veldthuis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-07 00:00:00.000000000 Z
+dependencies:
+- !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: This app will return 503 if a config file contains "off", which will
+  tell HAproxy to drop this node from the balancer backend.
+email:
+- marten@veldthuis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/haproxy_status.rb
+- lib/rack/haproxy_status/version.rb
+- rack-haproxy_status.gemspec
+- spec/rack-haproxy_status_spec.rb
+homepage: https://github.com/roqua/rack-haproxy_status
+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.2
+signing_key: 
+specification_version: 4
+summary: Tiny mountable app that returns an HTTP state based on contents of a file.
+test_files:
+- spec/rack-haproxy_status_spec.rb
+has_rdoc: