outpost 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1 @@
+.yardoc

data/CHANGELOG.rdoc

@@ -0,0 +1,16 @@
+
+== 0.2
+* Features
+ * Adding support for Notifications (Email and Campfire)
+ * RDoc documentation
+ * Refactoring, tests and cleanups
+
+* Deprecations
+ * Renaming Outpost::DSL to Outpost::Application
+
+* Bug Fixes
+ * Fixing Rake task to publish the gem (by github.com/ManuelKiessling)
+ * HTTP Scout now fails when it is not able to connect to the server
+
+== 0.1
+  * Initial release

data/Gemfile

@@ -1,10 +1,16 @@
 source :rubygems
 
-gem 'net-ping', :require => false
-
 group :test do
+  gem 'mail',     :require => false
+  gem 'net-ping', :require => false
+  gem 'tinder',   :require => false
+
   gem 'thin'
   gem 'rack'
   gem 'sinatra'
-  gem 'ruby-debug19'
+
+  gem 'minitest', '~> 2.0.2', :platforms => :ruby_18
+  gem 'ruby-debug',           :platforms => :ruby_18
+
+  gem 'ruby-debug19', :platforms => :ruby_19
 end

data/Gemfile.lock

@@ -1,14 +1,37 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.0.3)
+    addressable (2.2.2)
     archive-tar-minitar (0.5.2)
     columnize (0.3.2)
     daemons (1.1.0)
     eventmachine (0.12.10)
+    faraday (0.5.4)
+      addressable (~> 2.2.2)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    i18n (0.5.0)
+    linecache (0.43)
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    minitest (2.0.2)
+    multipart-post (1.1.0)
     net-ping (1.3.7)
+    polyglot (0.3.1)
     rack (1.2.1)
+    roauth (0.0.3)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
     ruby-debug-base19 (0.11.24)
       columnize (>= 0.3.1)
       linecache19 (>= 0.5.11)
@@ -27,13 +50,29 @@ GEM
       eventmachine (>= 0.12.6)
       rack (>= 1.0.0)
     tilt (1.2.2)
+    tinder (1.4.3)
+      activesupport
+      eventmachine
+      faraday (~> 0.5.1)
+      mime-types
+      multipart-post
+      twitter-stream
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    twitter-stream (0.1.10)
+      eventmachine (>= 0.12.8)
+      roauth (>= 0.0.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  mail
+  minitest (~> 2.0.2)
   net-ping
   rack
+  ruby-debug
   ruby-debug19
   sinatra
   thin
+  tinder

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Vinicius Baggio Fuentes http://www.vinibaggio.net
+
+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.markdown

@@ -1,8 +1,5 @@
 # Outpost
 
-Outpost is under development and is a project for the RMU: Ruby Mendicant
-University.
-
 ## Features
 
 Outpost is a tool to monitor the state of your service (not server). What does it mean?
@@ -21,8 +18,14 @@ It should report a status per declared system.
 The idea is to make a reliable framework for the Ruby developer to create his own monitoring rules.
 So, summing it all up, Nagios in Ruby, much cooler!
 
+## Information
+
+* [Rdoc](http://rdoc.info/github/vinibaggio/outpost/master/frames)
+
 ## Installing
 
+Outpost is tested with Ruby 1.8.7 and Ruby 1.9.2.
+
     gem install outpost
 
 ## Starting
@@ -33,7 +36,7 @@ To create your Outposts, you must require 'outpost'. You also need to include
     require 'outpost'
     require 'outpost/scouts'
 
-    class Bla < Outpost::DSL
+    class Bla < Outpost::Application
       using Outpost::Scouts::Http => "web page" do
         options :host => 'localhost', :port => 3000
         report :up, :response_code => 200
@@ -52,7 +55,7 @@ Consider the following example:
     require 'outpost'
     require 'outpost/scouts'
 
-    class HttpOutpostExample < Outpost::DSL
+    class HttpOutpostExample < Outpost::Application
       using Outpost::Scouts::Http => "web page" do
         options :host => 'localhost', :port => 3000
         report :up, :response_code => 200
@@ -71,7 +74,7 @@ reporting "down" in that case).
 ## Outpost
 
 Outpost is the description of the system and provides a DSL to do it. 
-Check "How it works" section for an example, or check the [integration tests](https://github.com/vinibaggio/outpost/blob/master/test/integration/basic_dsl_test.rb)
+Check "How it works" section for an example, or check the [integration tests](https://github.com/vinibaggio/outpost/blob/master/test/integration/basic_application_test.rb)
 for more.
 
 ## Scout
@@ -150,10 +153,39 @@ So you can easily create your own expectation. Let's recreate the :response\_cod
 You can also check the supplied expectations in the source of the project to have
 an idea on how to implement more complex rules.
 
+## Notifiers
+
+Notifiers query Outposts and act upon its status and reports. In the example
+below, an Email notifier is being used to report failures in the system to the
+system administrator:
+
+    require 'outpost'
+    require 'outpost/scouts'
+    require 'outpost/notifiers'
+
+    class HttpOutpostExample < Outpost::Application
+      notify Outpost::Notifiers::Email, {
+        :from => 'outpost@example.com',
+        :to   => 'sleep_deprived_admin@example.com'
+      }
+
+      using Outpost::Scouts::Http => "web page" do
+        options :host => 'localhost', :port => 3000
+        report :up, :response_code => 200
+        report :down, :response_body => {:match => /Ops/}
+      end
+    end
+    outpost = HttpOutpostExample.new
+    outpost.run # => :down
+
+    # Will send an email to the poor sleep-deprived Sys Admin if the system is
+    # down.
+    outpost.notify if outpost.down?
+
 ## TODO
 
-There's a lot to be done yet. For example, SSH support, :warning status, etc.
+See [TODO](https://github.com/vinibaggio/outpost/blob/master/TODO.md).
 
 ## License
 
-MIT.
+MIT License.

data/Rakefile

@@ -1,5 +1,9 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
 require 'rake/testtask'
 
+require "outpost/version"
+
 desc 'Default: run tests'
 task :default => :test
 
@@ -10,3 +14,13 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
+
+desc 'Build a gem from gemspec'
+task :build do
+  system "gem build outpost.gemspec"
+end
+
+desc 'Release new gem version'
+task :release => :build do
+  system "gem push outpost-#{Outpost::VERSION}.gem"
+end

data/TODO.md

@@ -0,0 +1,7 @@
+# TODO
+
+* SSH Support
+* Daemon and scheduler
+* New status: :warning
+* Web dashboard
+* Better error reporting

data/lib/outpost.rb

@@ -1,6 +1,6 @@
 
 # Outpost definition
-require 'outpost/dsl'
+require 'outpost/application'
 require 'outpost/report'
 
 # Scout definition

data/lib/outpost/application.rb

@@ -0,0 +1,143 @@
+module Outpost
+  # This class is the basic structure of an Outpost application. It provides
+  # the basic DSL for you to configure the monitoring of your services.
+  # Example:
+  #
+  #  class ExampleSuccess < Outpost::Application
+  #    name "Example"
+  #    using Outpost::Scouts::Http => 'master http server' do
+  #      options :host => 'localhost', :port => 9595
+  #      report :up, :response_code => 200
+  #    end
+  #  end
+  #
+  # @abstract
+  class Application
+    class << self
+      # Returns all the registered scouts.
+      attr_reader :scouts
+
+      # Returns all the registered notifiers.
+      attr_reader :notifiers
+
+      # Register a scout in the list of scouts.
+      #
+      # @param [Hash{Scout => String}, #read] scout_description A hash
+      #   containing Scout class as key and its description as a value.
+      #
+      # @yield Block to be evaluated to configure the current {Scout}.
+      def using(scout_description, &block)
+        @scouts ||= Hash.new { |h, k| h[k] = {} }
+
+        config = ScoutConfig.new
+        config.instance_eval(&block)
+
+        scout_description.each do |scout, description|
+          @scouts[scout][:description] = description
+          @scouts[scout][:config]      = config
+        end
+      end
+
+      # Register a notifier class in the list of notifications.
+      #
+      # @param [Class, #read] class A class that will be used to issue
+      #   a notification. The class must accept a configuration hash in the
+      #   constructor and also implement a #notify method that will receive an
+      #   outpost instance. See {Outpost::Notifiers::Email} for an example.
+      #
+      # @param [Hash, #read] options Options that will be used to configure the
+      #   notification class.
+      def notify(notifier, options={})
+        @notifiers           ||= {}
+        @notifiers[notifier]   = options
+      end
+
+      # Set the name of the scout. Can be used by notifiers in order to have
+      # a better description of the service in question.
+      #
+      # @param [String, #read] name The name to be given to a Outpost-based
+      #   class.
+      def name(val=nil)
+        if val
+          @name = val
+        else
+          @name
+        end
+      end
+    end
+
+    # Returns the status of the last service check or nil if it didn't happen.
+    attr_reader :last_status
+
+    # Returns a list of {Report} containing the last results of the last check.
+    attr_reader :reports
+
+    # New instance of a Outpost-based class.
+    def initialize
+      @reports     = []
+      @last_status = nil
+    end
+
+    # Execute all the scouts associated with an Outpost-based class and returns
+    # either :up or :down, depending on the results.
+    def run
+      @reports = self.class.scouts.map do |scout, options|
+        run_scout(scout, options)
+      end
+
+      statuses = @reports.map { |r| r.status }
+
+      @last_status = Report.summarize(statuses)
+    end
+
+    # Runs all notifications associated with an Outpost-based class.
+    def notify
+      if reports.any?
+        self.class.notifiers.each do |notifier, options|
+          # .dup is NOT reliable
+          options_copy = Marshal.load(Marshal.dump(options))
+          notifier.new(options_copy).notify(self)
+        end
+      end
+    end
+
+    # Returns true if the last status is :up
+    def up?
+      @last_status == :up
+    end
+
+    # Returns true if the last status is :down
+    def down?
+      @last_status == :down
+    end
+
+    # Returns the name of an Outpost-based class or the class name itself if
+    # not set.
+    #
+    # @return [String] The name of the Outpost
+    def name
+      self.class.name || self.class.to_s
+    end
+
+    # Returns the messages of the latest service check.
+    #
+    # @return [Array<String>] An array containing all report messages.
+    def messages
+      reports.map { |r| r.to_s }
+    end
+
+    private
+
+    # :nodoc:
+    def run_scout(scout, options)
+      scout_instance = scout.new(options[:description], options[:config])
+
+      params = {
+        :name        => scout.name,
+        :description => options[:description],
+        :status      => scout_instance.run
+      }
+      Report.new(params)
+    end
+  end
+end

data/lib/outpost/expectations/response_body.rb

@@ -1,20 +1,34 @@
 module Outpost
   module Expectations
+    # Module containing response_body matching expectations. Extend your Scout
+    # with ResponseBody and it will gain response_body evaluation powers!
+    #
+    # It respond to the following rules:
+    # * match => If the response body matches the associated regular expression
+    # * not_match => If the response body does not match the associated regular
+    #   expression
+    # * equals => If the response body matches exactly the associated string
+    # * differs => If the response body differs in any way the associated
+    #   string.
     module ResponseBody
-      RESPONSE_BODY_MAPPING = {
-        :match => "=~",
-        :not_match => "!~",
-        :equals => "==",
-        :differs => "!="
-      }.freeze
-
+      # Installs the response body expectation
       def self.extended(base)
         base.expect :response_body, base.method(:evaluate_response_body)
       end
 
+      # Method that will be used as an expectation to evaluate response body
       def evaluate_response_body(scout, rules)
-        rules.all? do |rule,comparison|
-          scout.response_body.send(RESPONSE_BODY_MAPPING[rule], comparison)
+        rules.all? do |rule, comparison|
+          case rule
+          when :match
+            scout.response_body =~ comparison
+          when :not_match
+            scout.response_body !~ comparison
+          when :equals
+            scout.response_body == comparison
+          when :differs
+            scout.response_body != comparison
+          end
         end
       end
     end