amphibian 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-06-26
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/amphibian.rb
+lib/amphibian/balancerManagerDocument.rb
+lib/amphibian/runner.rb
+script/console
+script/destroy
+script/generate
+test/test_amphibian.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,6 @@
+
+For more information on amphibian, see http://amphibian.rubyforge.org
+
+woot!
+
+

data/README.rdoc

@@ -0,0 +1,46 @@
+= amphibian
+
+== DESCRIPTION:
+
+Amphibian is a ruby library for accessing and interacting with an Apache mod_proxy_balancer via the web GUI created by the balancer_manager directive.
+
+== FEATURES/PROBLEMS:
+
+* TODO
+
+== SYNOPSIS:
+
+*  TODO
+
+== REQUIREMENTS:
+
+* TODO
+
+== INSTALL:
+
+* gem install amphibian
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Nick Stielau
+
+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/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/amphibian'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('amphibian', Amphibian::VERSION) do |p|
+  p.developer('Nick Stielau', 'nick.stielau@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt'
+  p.rubyforge_name       = p.name
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+desc "Upload current documentation to Rubyforge"
+task :upload_docs => [:redocs] do
+  sh "scp -r doc/* nstielau@rubyforge.org:/var/www/gforge-projects/amphibian/doc/"
+end
+
+desc "Upload current documentation to Rubyforge"
+task :upload_site do
+  #webgen && scp -r output/* nstielau@rubyforge.org:/var/www/gforge-projects/amphibian/
+  sh "scp -r webgen_site/* nstielau@rubyforge.org:/var/www/gforge-projects/amphibian/"
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/amphibian/balancerManagerDocument.rb

@@ -0,0 +1,115 @@
+module Amphibian
+  class BalancerManager
+    
+    def initialize(balancer_manager_url, dry_run = false)
+      @balancer_manager_url = balancer_manager_url
+      @dry_run = dry_run
+      
+      if !balancer_manager_url.match("127.0.0.1") && !dry_run
+        @dry_run = true
+        log_error
+        log_error "Not running on localhost: Performing dry-run"
+        log_error
+      end
+    end    
+    
+    # Disables a host from the balancer.
+    def disable_host(host)
+      # TODO: Check Status
+      toggle_host(host, 'Disable')
+    end
+    
+    # Enables a host in the balancer
+    def enable_host(host)
+      # TODO: Check Status
+      toggle_host(host, 'Enable')
+    end
+    
+    # Returns an array of strings indicated the balancer members parsed out of the BalancerManager page.
+    def hosts
+      @hosts ||= (get_doc/'a').select{|a_tag| a_tag.inner_text =~ /^http:/}.map{|a_tag| a_tag.inner_text}
+    end
+    
+    # TODO: Optionally force refresh
+    def enabled_hosts
+      hosts_array = []
+      hosts_with_status.select{|host,state| state == 'Ok'}.each{|host| hosts_array << host}
+      hosts_array
+    end
+    
+    # TODO: Optionally force refresh
+    def disabled_hosts
+      hosts_array = []
+      hosts_with_status.select{|host,state| state != 'Ok'}.each{|host| hosts_array << host}
+      hosts_array
+    end
+    
+    # Returns the name of the balancer on the BalancerManager page.
+    def balancer_name
+      @balancer_name ||= (get_doc/'a').select{|a_tag| a_tag.inner_text =~ /^balancer:/}.map{|a_tag| a_tag.inner_text}[0].sub('balancer://', '')
+    end
+    
+    # Returns the url of the BalancerManager page.
+    def balancer_manager_url
+      @balancer_manager_url
+    end
+    
+    # TODO: Optionally force refresh
+    def host_enabled?(host)
+      enabled_hosts.include?(host)
+    end
+
+    # TODO: Optionally force refresh    
+    def host_disabled?(host)
+      !enabled_hosts.include?(host)
+    end
+    
+    def dry_run?
+      @dry_run
+    end
+
+    def hosts_with_status
+      host_to_status = {}
+      (get_doc/'a').select{|a_tag| a_tag.inner_text =~ /^http:/}.each do |a_tag|
+        host_to_status[a_tag.inner_text] = (a_tag.parent.parent.children[6].inner_text.strip)
+      end
+      host_to_status
+    end
+        
+private
+
+    # Sets the state of the host to the specified state
+    def toggle_host(host, state)
+      log_error("#{state} is an invalid state") if state != "Enable" && state != "Disable"
+      run "curl -s -o /dev/null #{@balancer_manager_url}\?b=#{balancer_name}\\&w=#{host}\\&dw=#{state}"
+      # TODO: Check status
+    end
+
+    # runs a command if not in a dry_run? mode.
+    def run(cmd)
+      #puts "#{dry_run? ? 'Dry ' : ''}Running: #{cmd}"
+      if !dry_run?
+        `#{cmd}`
+      end
+    end
+
+    def log_error(error)
+      puts "ERROR: #{error}"
+    end
+
+    # Returns the Hpricot document of the BalancerManager page.
+    def get_doc
+      @doc ||= begin
+        Hpricot(open(@balancer_manager_url))
+      rescue Exception => e
+        if e =~ /403/
+          log_error "Balancer Manager is getting a 403: Forbidden response.  Make sure it is accessable from this location."
+        else
+          log_error "Error opening the balancer manager: #{e}"
+        end
+        nil
+      end
+    end
+  end
+end
+

data/lib/amphibian/runner.rb

@@ -0,0 +1,132 @@
+require 'net/smtp'
+
+module Amphibian
+  class Runner
+    # TODO: log everything, and set log level, so we don't have to print anything
+    # TODO: Email at the end
+    
+    def initialize(balancer_manager_url, test_page='/', test_regex=nil, dry_run=false)
+      @balancer_manager_url = balancer_manager_url
+      @test_page = test_page
+      @test_regex = test_regex
+      @dry_run = dry_run
+      @errors = []
+      
+      if !balancer_manager_url.match("127.0.0.1") && !dry_run
+        @dry_run = true
+        log_error "Not running on localhost: Performing dry-run"
+      end
+      
+      @balancer_manager = BalancerManager.new(@balancer_manager_url, @dry_run)
+
+      @min_hosts = -1
+    end
+    
+    def do_check
+      check
+    end
+
+private
+    
+    # Checks the balancer members, enabling/disabling each depending on the status.
+    def check
+      puts
+      puts "Load Apache Balancer-Manager at '#{@balancer_manager_url}'"
+      puts
+      puts "Loading Details"
+      puts
+      puts "  Balancer: #{get_balancer_manager.balancer_name}"
+      puts
+      get_balancer_manager.hosts_with_status.each{|h,s| puts "  #{h} => #{s}"}
+
+      @live_hosts = get_balancer_manager.enabled_hosts
+      puts
+      puts "Checking #{@live_hosts.size} live hosts"
+      puts
+
+      @live_hosts.each do |host, state|
+        status = check_host(host, @test_page) 
+        puts "  #{host} is #{status ? 'OK' : 'not responsive. Disabling via BalancerManager.'}"
+        disable_host(host) if !status
+      end
+      puts
+      puts "#{@live_hosts.size}/#{get_balancer_manager.hosts.size} hosts are enabled"
+      puts
+    end
+
+    def log_error(error)
+      @errors << error
+      puts "ERROR: #{error}"
+    end
+    
+    # Returns the BalancerManager object.
+    def get_balancer_manager
+      @balancer_manager
+    end
+
+    # Checks a host with an optional path.
+    # Checks for a 200 response, and that the body of the response matches the test regex, if defined.
+    def check_host(host, path = '/', timeout = 5)
+      begin
+        status = Timeout::timeout(timeout) do
+          Net::HTTP.start(URI.parse(host).host) do |http|
+            response = http.get(path)
+          
+            if not response.code.match(/200/)
+              log_error("Web Server down or not responding: #{response.code} #{response.message}")
+              return false;
+            end
+          
+            if @test_regex && ! response.body.match(@test_regex)
+              log_error("The response did not contain the regex '#{@test_regex}'")
+              return false
+            end
+          end
+        end
+      rescue SocketError => socket_error
+        log_error("Error Connecting To Web: #{socket_error}")
+        return false;
+      rescue TimeoutError => timeout_error
+        log_error("Timeout occured checking #{host}#{path} after #{timeout} seconds.")
+        return false;
+      rescue Exception => e
+        log_error("An unknown error occured checking #{host}#{path}: #{e}")
+        return false;
+      end
+      
+      return true
+    end
+    
+    # Disables a host from the balancer.
+    def disable_host(host)
+      if @live_hosts.size <= @min_hosts
+        puts "Will not take #{host} down, alreay at lower limit #{@min_hosts}"
+        return
+      end
+      
+      #puts "Disabling host '#{host}'"
+      get_balancer_manager.disable_host(host)
+      send_email("Disabled #{host} from the balancer #{get_balancer_manager.balancer_name} at #{get_balancer_manager.balancer_manager_url}")
+    end
+
+    def send_email(message)
+      begin
+        Net::SMTP.start('127.0.0.1', 25) do |smtp|
+          smtp.open_message_stream('dev@delvenetworks.com', ['nick@delvenetworks.com']) do |f|
+            f.puts 'From: dev@delvenetworks.com'
+            f.puts 'To: nick@delvenetworks.com'
+            f.puts 'Subject: Apache mod_balancer host disabled'
+            f.puts
+            f.puts message
+            f.puts
+            f.puts "Errors:"
+            f.puts @errors.join(",")
+          end
+        end
+      rescue Exception => e
+        log_error("Error sending email: #{e}")
+      end
+    end
+  end
+end
+

data/lib/amphibian.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# Core Libraries
+require 'time'
+require 'timeout'
+require 'open-uri'
+
+# Gems
+require 'rubygems'
+require 'hpricot'
+
+# Files
+require 'amphibian/runner'
+require 'amphibian/balancerManagerDocument'
+
+
+module Amphibian
+  VERSION = '0.0.1'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/amphibian.rb'}"
+puts "Loading amphibian gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_amphibian.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestAmphibian < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/amphibian'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: amphibian
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nick Stielau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Amphibian is a ruby library for accessing and interacting with an Apache mod_proxy_balancer via the web GUI created by the balancer_manager directive.
+email: 
+- nick.stielau@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/amphibian.rb
+- lib/amphibian/balancerManagerDocument.rb
+- lib/amphibian/runner.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_amphibian.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: 
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: amphibian
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Amphibian is a ruby library for accessing and interacting with an Apache mod_proxy_balancer via the web GUI created by the balancer_manager directive.
+test_files: 
+- test/test_amphibian.rb
+- test/test_helper.rb