wary 0.0.1 → 0.0.2.pre.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3c9f67b4d79d35d1f832b9b814184e6a456db50
-  data.tar.gz: 4edf54ee952fae330c32788d2c5cce8deb82accd
+  metadata.gz: f2bae8d44ad9538819dcffa48babd59376362ed1
+  data.tar.gz: 1d2e26a3e80ec3d694b0d1d59a469f89fb42d9fe
 SHA512:
-  metadata.gz: d5bf9becd9a2b29b807399433223889cb0a1b963dfeabe635ebe99db625c1a7260299916a1a432db7acb6f7528988f28a1b51d2abf004704b03c0cfa9539bdbb
-  data.tar.gz: aef51203c1e816fe9137d87c84ab5bd5632547bc02c748142a8518bfdf9be21d2212f137a0d89cb83678912e0bc24687f5be3d82ac17e157de588632b55730c1
+  metadata.gz: e1d692dd59085066fb17e8d2ade92e92d0d40ec570497aa3579fdd00531e73da1285f535fe6021c98659d10478f74294637b7f2ca01e5f4113b5d95f8dfb8b18
+  data.tar.gz: a71fc87563c582cfd8ed1de5ec558e0c75058f751fa4df48bf25c234c2b657e83f468f499b3c89f0ad0a05ebd350fe0def7de9e5aac83ad3fdeb2a4cbfee5048

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: "rspec"

data/README.md

@@ -1,5 +1,8 @@
 # Wary
 
+[![Code Climate](https://codeclimate.com/github/shostakovich/wary.png)](https://codeclimate.com/github/shostakovich/wary)
+[![Build Status](https://travis-ci.org/shostakovich/wary.png?branch=master)](https://travis-ci.org/shostakovich/wary)
+
 TODO: Write a gem description
 
 ## Installation

data/example/wary.yml

@@ -0,0 +1,10 @@
+:checks:
+  'Load Average':
+    :class: LoadAverage
+    :alert_threshold: 2.0
+  'Example.com':
+    :class: HttpStatus
+    :url: 'http://example.com'
+  'Robots.txt exists':
+    :class: HttpStatus
+    :url: 'http://www.helpster.de/robots.txt'

data/lib/wary/check/http_status.rb

@@ -0,0 +1,35 @@
+require_relative '../check'
+require_relative '../utils/http_client'
+
+module Wary
+  module Check
+    class HttpStatus
+      include Wary::Check
+
+      def initialize(options)
+        @url = options.fetch(:url)
+        @http_client = options.fetch(:http_client) { HTTPClient.new }
+        configure(options)
+      end
+
+      def status
+        begin
+          response = @http_client.get_response(@url)
+        rescue => e
+          return failure("#{@url} down (#{e.message})")
+        end
+
+        if response.code == "200"
+          ok(message(response))
+        else
+          alert("#{@url} (#{response.code} #{response.message})")
+        end
+      end
+
+      private
+      def message(response)
+        "#{@url} (#{response.code} #{response.message})"
+      end
+    end
+  end
+end

data/lib/wary/check/load_average.rb

@@ -0,0 +1,32 @@
+require_relative '../status'
+require_relative '../check'
+require_relative '../load_meter'
+
+module Wary
+  module Check
+    class LoadAverage
+      include Wary::Check
+
+      def initialize(options)
+        @load_meter = options.fetch(:load_meter) { Wary::LoadMeter.new }
+        @alert_threshold = options.fetch(:alert_threshold)
+        configure(options)
+      end
+
+      def status
+        begin
+          load = @load_meter.load
+        rescue => e
+          return failure(e.message)
+        end
+
+        if load < @alert_threshold
+          ok("Load #{load}")
+        else
+          alert("Load #{load} exceeds threshold (#{@alert_threshold})")
+        end
+      end
+    end
+  end
+end
+

data/lib/wary/check.rb

@@ -0,0 +1,25 @@
+require_relative 'check/load_average'
+require_relative 'check/http_status'
+
+module Wary
+  module Check
+    attr_reader :name
+
+    def configure(options)
+      @name = options.fetch(:name) { self.class.to_s }
+    end
+
+    private
+    def ok(message)
+      Status::OK.new(message)
+    end
+
+    def alert(message)
+      Status::Alert.new(message)
+    end
+
+    def failure(message)
+      Status::Failure.new(message)
+    end
+  end
+end

data/lib/wary/check_suite.rb

@@ -0,0 +1,22 @@
+module Wary
+  class CheckSuite
+    attr_reader :checks
+
+    def initialize(checks)
+      @checks = checks
+    end
+
+    def empty?
+      checks.empty?
+    end
+
+    def status
+      if checks.any? { |c| c.status == :alert }
+        :alert
+      else
+        :ok
+      end
+    end
+  end
+end
+

data/lib/wary/load_meter.rb

@@ -0,0 +1,30 @@
+require_relative 'utils/shell'
+
+module Wary
+  class LoadMeter
+    class MeasurementFailed < StandardError; end
+
+    def initialize(shell = nil)
+      @shell = shell || Utils::Shell.new
+    end
+
+    def load
+      raw_load_avg_last_min.sub(',', '.').to_f
+    end
+
+    private
+    def raw_load_avg_last_min
+      matches = raw_data.match(/load averages\: ([0-9,\.]+)/)
+      if matches
+        matches[1]
+      else
+        raise Wary::LoadMeter::MeasurementFailed, "Could no extract load average from '#{raw_data}'"
+      end
+    end
+
+    def raw_data
+      String(@shell.execute('w h'))
+    end
+  end
+end
+

data/lib/wary/status.rb

@@ -0,0 +1,37 @@
+module Wary
+  module Status
+    class Base
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+      
+      def ==(status_symbol)
+        status_symbol == to_sym
+      end
+
+      def to_sym
+        NotImplementedError
+      end
+    end
+
+    class OK < Base
+      def to_sym
+        :ok
+      end
+    end
+
+    class Alert < Base
+      def to_sym
+        :alert
+      end
+    end
+
+    class Failure < Base
+      def to_sym
+        :failure
+      end
+    end
+  end
+end

data/lib/wary/suite_builder.rb

@@ -0,0 +1,30 @@
+require_relative 'check'
+require_relative 'check_suite'
+
+class Wary::SuiteBuilder
+  def initialize(configuration)
+    @checks = configuration.fetch(:checks) || []
+  end
+
+  def build
+    initialized_checks = @checks.map do |name, config|
+      klass = config.fetch(:class)
+      config[:name] = name
+      constantize("Wary::Check::#{klass}").new(config)
+    end
+
+    Wary::CheckSuite.new(initialized_checks)
+  end
+
+  private
+  def constantize(camel_cased_word)
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+end

data/lib/wary/utils/http_client.rb

@@ -0,0 +1,9 @@
+require 'uri'
+require 'net/http'
+
+class HTTPClient
+  def get_response(url)
+    uri = URI(url)
+    Net::HTTP.get_response(uri)
+  end
+end

data/lib/wary/utils/shell.rb

@@ -0,0 +1,10 @@
+# Pray to god that this works
+module Wary
+  module Utils
+    class Shell
+      def execute(command)
+        `#{command}`
+      end
+    end
+  end
+end

data/lib/wary/version.rb

@@ -1,3 +1,3 @@
 module Wary
-  VERSION = "0.0.1"
+  VERSION = "0.0.2-pre"
 end

data/lib/wary.rb

@@ -1,5 +1,25 @@
-require "wary/version"
+require 'yaml'
+require 'terminal-table'
+
+require_relative'wary/version'
+require_relative 'wary/suite_builder'
 
 module Wary
-  # Your code goes here...
+  def self.run
+    configuration = YAML.load_file(ENV['CONFIG'])
+    check_suite = SuiteBuilder.new(configuration).build
+
+    title = "Overall Check Suite Status (#{check_suite.status})"
+
+    headings = ['Name', 'Status', 'Message']
+    rows = check_suite.checks.map do |check|
+      [check.name, check.status.to_sym, check.status.message]
+    end
+
+    table = Terminal::Table.new(headings: headings, rows: rows, title: title)
+    table.align_column(1, :center)
+    puts table
+  end
 end
+
+Wary.run

data/spec/check_suite_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'wary/check_suite'
+
+describe Wary::CheckSuite do
+  let(:suite) { Wary::CheckSuite.new(checks) }
+
+  context 'for an empty list' do
+    let(:checks) { Array.new }
+    
+    it 'is empty' do
+      expect(suite).to be_empty
+    end
+
+    it 'has the status OK if no checks are set' do
+      expect(suite.status).to eq(:ok)
+    end
+  end
+
+  context 'for a filled list' do
+    let(:checks) { [make_check] }
+
+    it 'is not empty' do
+      checks << double('Check')
+      expect(suite).to_not be_empty
+    end
+
+    it 'has the status ALERT if one ore more checks failed' do
+      checks << make_check(status: :alert)
+      expect(suite.status).to eq(:alert)
+    end
+  end
+
+  def make_check(stubs = {})
+    check = double('Check', stubs).as_null_object
+    check
+  end
+end

data/spec/http_status_check_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'wary/check/http_status'
+describe Wary::Check::HttpStatus do
+  it_behaves_like 'a check'
+
+  let(:url) { 'http://example.com' }
+  let(:http_response) { double('Response') }
+  let(:http_client) { double('Client', get_response: http_response)}
+  let(:options) {{ url: url, http_client: http_client}}
+  let(:check) { Wary::Check::HttpStatus.new(options) }
+
+  context 'for the expected HTTP-Code' do
+    it 'signals OK' do
+      http_response.stub(code: '200', message: 'OK')
+      expect(status).to eq(:ok)
+      expect(status.message).to eq "#{url} (200 OK)"
+    end
+  end
+
+  context 'for an unexpected HTTP-Code' do
+    it 'signals alert' do
+      http_response.stub(code: '302', message: 'Found')
+      expect(status).to eq(:alert)
+      expect(status.message).to eq "#{url} (302 Found)"
+    end
+  end
+
+  context 'when something else is wrong' do
+    it 'signals failure' do
+      http_client.stub(:get_response).and_throw StandardError
+      expect(status).to eq(:failure)
+      expect(status.message).to match /#{url} down/
+    end
+  end
+
+  def status
+    check.status
+  end
+end

data/spec/load_average_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'wary/check/load_average'
+
+describe Wary::Check::LoadAverage do
+  it_behaves_like 'a check'
+
+  let(:load_meter) { double('LoadMeter').as_null_object }
+  let(:threshold) { 2.00 }
+  let(:options) { {load_meter: load_meter, alert_threshold: threshold} }
+  let(:check) { Wary::Check::LoadAverage.new(options) }
+  
+  context 'when the load is below the threshold' do
+    let(:load_meter) { double('LoadMeter', load: threshold - 0.01) }
+    
+    it 'has the status :ok' do
+      expect(check.status).to eq(:ok)
+    end
+  end
+
+  context 'when the load is on or above the threshold' do
+    let(:load_meter) { double('LoadMeter', load: threshold) }
+    
+    it 'has the status :alert' do
+      expect(check.status).to eq(:alert)
+    end
+  end
+
+  context 'when measuring the load failed' do
+    let(:load_meter) do
+      loadmeter = double('LoadMeter')
+      loadmeter.stub(:load).and_throw(StandardError)
+      loadmeter
+    end
+
+    it 'has the status :failure' do
+      expect(check.status).to eq(:failure)
+    end
+  end
+end

data/spec/load_meter.rb

@@ -0,0 +1,6 @@
+describe Wary::LoadMeter do
+  it 'execute the load command' do
+    shell = double('Shell').should_receive(execute: 'w h')
+    Wary::LoadMeter.new(shell).load
+  end
+end

data/spec/load_meter_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'wary/load_meter'
+
+describe Wary::LoadMeter do
+  let(:shell) { double('Shell', execute: 'load averages: 1,25 1,22 1,19') }
+
+  it 'execute the load command' do
+    shell.should_receive(:execute).with('w h')
+
+    measure_load
+  end
+
+  it 'extracts the 1 min load' do
+    shell.stub(execute: 'load averages: 1,25 1,22 1,19')
+    expect(measure_load).to eq(1.25)
+  end
+
+  it 'throws an error if load not measurable' do
+    shell.stub(execute: 'Take this..')
+    expect { measure_load }.to raise_error(Wary::LoadMeter::MeasurementFailed)
+  end
+
+  def measure_load
+    Wary::LoadMeter.new(shell).load
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each {|f| require f}

data/spec/status_alert_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'wary/status'
+
+describe Wary::Status::Alert do
+  it_behaves_like 'a status', :alert
+end

data/spec/status_failure_specc.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'wary/status'
+
+describe Wary::Status::Failure do
+  it_behaves_like 'a status', :failure
+end

data/spec/status_ok_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'wary/status'
+
+describe Wary::Status::OK do
+  it_behaves_like 'a status', :ok
+end

data/spec/suite_builder_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'wary/suite_builder'
+
+describe Wary::SuiteBuilder do
+  context 'for an empty list of checks' do
+    let(:configuration) { {:checks => nil} }
+
+    it 'builds an empty suite' do
+      expect(Wary::SuiteBuilder.new(configuration).build).to be_empty
+    end
+  end
+
+  context 'for one configured check' do
+    let(:configuration) do
+      { checks:
+          {'LoadAverage' =>
+             { class: 'LoadAverage',
+               alert_threshold: 2.0 } } }
+    end
+
+    it 'builds a suite with one check' do
+      expect(Wary::SuiteBuilder.new(configuration).build).to_not be_empty
+    end
+  end
+end

data/spec/support/shared_examples/a_check.rb

@@ -0,0 +1,14 @@
+shared_examples_for "a check" do
+  context 'with a custom name set' do
+    it 'has a custom name' do
+      options.merge!(name: 'foo')
+      expect(check.name).to eq 'foo'
+    end
+  end
+
+  context 'without a custom name' do
+    it 'has a default name' do
+      expect(check.name).to eq check.class.to_s
+    end
+  end
+end

data/spec/support/shared_examples/a_status.rb

@@ -0,0 +1,12 @@
+shared_examples_for "a status" do |status_symbol|
+  let(:message) { "Info" }
+  let(:status) { described_class.new(message) }
+
+  it 'has a message' do
+    expect(status.message).to eq message
+  end
+
+  it "is #{status_symbol}" do
+    expect(status).to eq(status_symbol)
+  end
+end

data/wary.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'terminal-table'
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: wary
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2.pre.pre
 platform: ruby
 authors:
 - Robert Curth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - '>='
       - !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: Helps you keep track of your system's health
 email:
 - robert@rocu.de
@@ -46,12 +74,36 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/wary.yml
 - lib/wary.rb
+- lib/wary/check.rb
+- lib/wary/check/http_status.rb
+- lib/wary/check/load_average.rb
+- lib/wary/check_suite.rb
+- lib/wary/load_meter.rb
+- lib/wary/status.rb
+- lib/wary/suite_builder.rb
+- lib/wary/utils/http_client.rb
+- lib/wary/utils/shell.rb
 - lib/wary/version.rb
+- spec/check_suite_spec.rb
+- spec/http_status_check_spec.rb
+- spec/load_average_spec.rb
+- spec/load_meter.rb
+- spec/load_meter_spec.rb
+- spec/spec_helper.rb
+- spec/status_alert_spec.rb
+- spec/status_failure_specc.rb
+- spec/status_ok_spec.rb
+- spec/suite_builder_spec.rb
+- spec/support/shared_examples/a_check.rb
+- spec/support/shared_examples/a_status.rb
 - wary.gemspec
 homepage: ''
 licenses:
@@ -68,13 +120,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Wary
-test_files: []
+test_files:
+- spec/check_suite_spec.rb
+- spec/http_status_check_spec.rb
+- spec/load_average_spec.rb
+- spec/load_meter.rb
+- spec/load_meter_spec.rb
+- spec/spec_helper.rb
+- spec/status_alert_spec.rb
+- spec/status_failure_specc.rb
+- spec/status_ok_spec.rb
+- spec/suite_builder_spec.rb
+- spec/support/shared_examples/a_check.rb
+- spec/support/shared_examples/a_status.rb