nagiosharder 0.3.0 → 0.4.0.rc1

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+nagiosharder*.gem
+.bundle
+vendor/gems
+config
+*.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    nagiosharder (0.4.0)
+      activesupport
+      hashie (~> 1.2.0)
+      httparty (~> 0.8.3)
+      i18n
+      nokogiri
+      rest-client (~> 1.6.1)
+      terminal-table
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    hashie (1.2.0)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    i18n (0.6.1)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    nokogiri (1.5.5)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    terminal-table (1.4.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nagiosharder!
+  rspec (>= 1.2.9)

data/README.rdoc

@@ -1,11 +1,18 @@
 = nagiosharder
 
-Query and command a Nagios install using the power of ruby.
+Query and command a Nagios install using the power of ruby (and lots of screen-scaping)! Do the usual gem install jig:
+
+  gem install nagiosharder
+
+
+Now you have access to both a Ruby interface and a command line interface.
+
+Here's some examples to get you started with the Ruby API:
 
   require 'nagiosharder'
   site = NagiosHarder::Site.new('http://path/to/nagios/cgi/directory', 'user', 'password', 'version')
   # version defaults to 3
-  
+
   # get details back about a host's services
   puts site.host_status('myhost')
 
@@ -13,16 +20,28 @@ Query and command a Nagios install using the power of ruby.
   site.schedule_host_check('myhost')
 
   # get details on all services
-  site.service_status(:all)
-  # or just services that have problems 
-  site.service_status(:all_problems)
-  # (other valid symbols: :ok, :warning, :unknown, :critical, :pending, :all_problems)
-  # or make it sorted by  duration, descending
-  site.service_status(:all_problem, :sort_option => :duration, :sort_type => :desc
-  # (other sort_options: :host, :service, :status, :last_check, :duration, :attempts)
-  # (other sort_types: :asc, :desc)
+  site.service_status
+
+  # or just things with problems
+  site.service_status(
+    :service_status_types => [
+      :critical,
+      :warning,
+      :unknown
+    ]
+  )
+
+  # or just muted services, sorted desc by duration
+  site.service_status(
+    :service_props => [
+      :notifications_disabled,
+    ],
+    :sort_type    => :descending,
+    :sort_option  => :state_duration,
+  )
+
   # or get the details for a single service group
-  site.service_status(:all_problem, :group => "AWESOME")
+  site.service_status(:group => "AWESOME")
 
   # schedule a host to have services checks run again right now
   site.schedule_service_check('myhost', 'myservice')
@@ -39,6 +58,9 @@ Query and command a Nagios install using the power of ruby.
   # or unacknowledge
   site.unacknowledge_service('myhost', 'myservice')
 
+  # acknowledge a down service
+  site.acknowledge_host('myhost', 'something bad happened')
+
   # disable notifications for a service:
   site.disable_service_notifications('myhost', 'myservice')
 
@@ -54,10 +76,19 @@ Query and command a Nagios install using the power of ruby.
     sleep 3
   end
 
-To be continue?
+Then there's the command line. Start with --help
+
+  nagiosharder --help
+
+This will show you how you configure nagiosharder enough to talk to your nagios. You need at least a username, password, and nagios url. These can alternatively be in a config file. For example:
+
+  nagiosharder --config /path/to/yaml
+
+This will display all available commands.
+
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a future version unintentionally.

data/Rakefile

@@ -1,51 +1,2 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "nagiosharder"
-    gem.version = "0.3.0"
-    gem.summary = %Q{Nagios access at your ruby fingertips}
-    gem.description = %Q{Nagios access at your ruby fingertips}
-    gem.email = "josh@technicalpickles.com"
-    gem.homepage = "http://github.com/railsmachine/nagiosharder"
-    gem.authors = ["Joshua Nichols"]
-    gem.add_dependency 'rest-client', '~> 1.6.1'
-    gem.add_dependency 'nokogiri', '~> 1.4.3'
-    gem.add_dependency 'activesupport'
-    gem.add_dependency 'httparty', '~> 0.6.1'
-    gem.add_dependency 'hashie', '~> 1.0.0'
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "nagiosharder #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/nagiosharder

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'nagiosharder/cli'
+begin
+  exit NagiosHarder::Cli.new(ARGV).run
+rescue ArgumentError => e
+  puts e.message
+  puts e.backtrace.join("\n") if ENV['DEBUG']
+  exit 1
+end

data/lib/nagiosharder.rb

@@ -3,6 +3,7 @@ require 'nokogiri'
 require 'active_support' # fine, we'll just do all of activesupport instead of the parts I want. thank Rails 3 for shuffling requires around.
 require 'cgi'
 require 'hashie'
+require 'nagiosharder/filters'
 
 # :(
 require 'active_support/version' # double and triplely ensure ActiveSupport::VERSION is around
@@ -24,32 +25,54 @@ class NagiosHarder
     attr_accessor :nagios_url, :user, :password, :default_options, :default_cookies, :version, :nagios_time_format
     include HTTParty::ClassMethods
 
-    def initialize(nagios_url, user, password, version = 3)
+    def initialize(nagios_url, user, password, version = 3, nagios_time_format = nil)
       @nagios_url = nagios_url.gsub(/\/$/, '')
       @user = user
       @password = password
       @default_options = {}
       @default_cookies = {}
       @version = version
+      debug_output if ENV['DEBUG']
       basic_auth(@user, @password) if @user && @password
-
-      @nagios_time_format = if @version.to_i < 3
-                              "%m-%d-%Y %H:%M:%S"
-                            else
-                              "%Y-%m-%d %H:%M:%S"
-                            end
+      @nagios_time_format = if nagios_time_format == 'us'
+         "%m-%d-%Y %H:%M:%S"
+      else
+        if @version.to_i < 3
+          "%m-%d-%Y %H:%M:%S"
+        else
+          "%Y-%m-%d %H:%M:%S"
+        end
+      end
+      self
     end
 
     def acknowledge_service(host, service, comment)
-      # extra options: sticky_arg, send_notification, persistent
-      
       request = {
         :cmd_typ => 34,
         :cmd_mod => 2,
         :com_author => @user,
         :com_data => comment,
         :host => host,
-        :service => service
+        :service => service,
+        :send_notification => true,
+        :persistent => false,
+        :sticky_ack => true
+      }
+
+      response = post(cmd_url, :body => request)
+      response.code == 200 && response.body =~ /successful/
+    end
+
+    def acknowledge_host(host, comment)
+      request = {
+        :cmd_typ => 33,
+        :cmd_mod => 2,
+        :com_author => @user,
+        :com_data => comment,
+        :host => host,
+        :send_notification => true,
+        :persistent => false,
+        :sticky_ack => true
       }
 
       response = post(cmd_url, :body => request)
@@ -63,7 +86,7 @@ class NagiosHarder
         :host => host,
         :service => service
       }
-      
+
       response = post(cmd_url, :body => request)
       response.code == 200 && response.body =~ /successful/
     end
@@ -130,7 +153,7 @@ class NagiosHarder
 
       response.code == 200 && response.body =~ /successful/
     end
-    
+
     def cancel_downtime(downtime_id, downtime_type = :host_downtime)
       downtime_types = {
         :host_downtime => 78,
@@ -143,7 +166,7 @@ class NagiosHarder
                                         })
       response.code == 200 && response.body =~ /successful/
     end
-    
+
     def schedule_host_check(host)
       response = post(cmd_url, :body => {
                                           :start_time => formatted_time_for(Time.now),
@@ -167,65 +190,49 @@ class NagiosHarder
       response.code == 200 && response.body =~ /successful/
     end
 
-    def service_status(type, options = {})
-      service_status_type = case type
-                            when :ok then 2
-                            when :warning then 4
-                            when :unknown then 8
-                            when :critical then 16
-                            when :pending then 1
-                            when :all_problems then 28
-                            when :all then nil
-                            else
-                              raise "Unknown type"
-                            end
-
-      sort_type = case options[:sort_type]
-                  when :asc then 1
-                  when :desc then 2
-                  when nil then nil
-                  else
-                    raise "Invalid options[:sort_type]"
-                  end
-
-      sort_option = case options[:sort_option]
-                    when :host then 1
-                    when :service then 2
-                    when :status then 3
-                    when :last_check then 4
-                    when :duration then 6
-                    when :attempts then 5
-                    when nil then nil
-                    else
-                      raise "Invalid options[:sort_option]"
-                    end
-
-      service_group = options[:group]
-
-
-      params = {
-        'hoststatustype' => 15,
-        'servicestatustype' => service_status_type,
-        'host' => 'all'
-      }
+    def service_status(options = {})
+      params = {}
+
+      {
+        :host_status_types    => :notification_host,
+        :service_status_types => :notification_service,
+        :sort_type            => :sort,
+        :sort_option          => :sort,
+        :host_props           => :host,
+        :service_props        => :service,
+      }.each do |key, val|
+        if options[key] && (options[key].is_a?(Array) || options[key].is_a?(Symbol))
+          params[key.to_s.gsub(/_/, '')] = Nagiosharder::Filters.value(val, *options[key])
+        end
+      end
+
+      # if any of the standard filter params are already integers, those win
+      %w(
+        :hoststatustypes,
+        :servicestatustypes,
+        :sorttype,
+        :sortoption,
+        :hostprops,
+        :serviceprops,
+      ).each do |key|
+        params[key.to_s] = options[:val] if !options[:val].nil? && options[:val].match(/^\d*$/)
+      end
 
+      if @version == 3
+        params['servicegroup'] = options[:group] || 'all'
+        params['style'] = 'detail'
+        params['embedded'] = '1'
+        params['noheader'] = '1'
+      else
+        if options[:group]
+          params['servicegroup'] = options[:group]
+          params['style'] = 'detail'
+        else
+          params['host'] = 'all'
+        end
+      end
 
-      params = if @version == 3
-                 [ "servicegroup=all", "style=detail" ]
-               else
-                 if service_group
-                   ["servicegroup=#{service_group}", "style=detail"]
-                 else
-                   ["host=all"]
-                 end
-               end
-      params += [
-                  service_status_type ? "servicestatustypes=#{service_status_type}" : nil,
-                  sort_type ? "sorttype=#{sort_type}" : nil,
-                  sort_option ? "sortoption=#{sort_option}" : nil,
-                  "hoststatustypes=15"
-                ]
-      query = params.compact.join('&')
+      query = params.select {|k,v| v }.map {|k,v| "#{k}=#{v}" }.join('&')
       url = "#{status_url}?#{query}"
       response = get(url)
 
@@ -240,7 +247,7 @@ class NagiosHarder
     end
 
     def host_status(host)
-      host_status_url = "#{status_url}?host=#{host}"
+      host_status_url = "#{status_url}?host=#{host}&embedded=1&noheader=1"
       response =  get(host_status_url)
 
       raise "wtf #{host_status_url}? #{response.code}" unless response.code == 200
@@ -249,18 +256,24 @@ class NagiosHarder
       parse_status_html(response) do |status|
         services[status[:service]] = status
       end
-    
+
       services
     end
 
     def disable_service_notifications(host, service, options = {})
       request = {
         :cmd_mod => 2,
-        :cmd_typ => 23,
-        :host => host,
-        :service => service,
+        :host => host
       }
 
+      if service
+        request[:cmd_typ] = 23
+        request[:service] = service
+      else
+        request[:cmd_typ] = 29
+        request[:ahas] = true
+      end
+
       response = post(cmd_url, :body => request)
       if response.code == 200 && response.body =~ /successful/
         # TODO enable waiting. seems to hang intermittently
@@ -276,11 +289,17 @@ class NagiosHarder
     def enable_service_notifications(host, service, options = {})
       request = {
         :cmd_mod => 2,
-        :cmd_typ => 22,
-        :host => host,
-        :service => service,
+        :host => host
       }
 
+      if service
+        request[:cmd_typ] = 22
+        request[:service] = service
+      else
+        request[:cmd_typ] = 28
+        request[:ahas] = true
+      end
+
       response = post(cmd_url, :body => request)
       if response.code == 200 && response.body =~ /successful/
         # TODO enable waiting. seems to hang intermittently
@@ -292,12 +311,12 @@ class NagiosHarder
         false
       end
     end
-    
+
     def service_notifications_disabled?(host, service)
       self.host_status(host)[service].notifications_disabled
     end
-    
-    
+
+
     def status_url
       "#{nagios_url}/status.cgi"
     end
@@ -317,14 +336,15 @@ class NagiosHarder
     end
 
     def parse_status_html(response)
-      doc = Nokogiri::HTML(response)
+      doc = Nokogiri::HTML(response.to_s)
       rows = doc.css('table.status > tr')
 
       last_host = nil
       rows.each do |row|
         columns = Nokogiri::HTML(row.inner_html).css('body > td').to_a
         if columns.any?
-          
+
+          # Host column
           host = columns[0].inner_text.gsub(/\n/, '')
 
           # for a given host, the host details are blank after the first row
@@ -335,7 +355,9 @@ class NagiosHarder
             # or save it for later
             host = last_host
           end
+          debug 'parsed host column'
 
+          # Service Column
           if columns[1]
             service_links = columns[1].css('td a')
             service_link, other_links = service_links[0], service_links[1..-1]
@@ -366,13 +388,21 @@ class NagiosHarder
 
             service = service_links[0].inner_html
           end
-          
+          debug 'parsed service column'
+
+          # Status
           status = columns[2].inner_html  if columns[2]
+          debug 'parsed status column'
+
+          # Last Check
           last_check = if columns[3] && columns[3].inner_html != 'N/A'
                          last_check_str = columns[3].inner_html
-
-                         DateTime.strptime(columns[3].inner_html, nagios_time_format).to_time
+                         debug "Need to parse #{columns[3].inner_html} in #{nagios_time_format}"
+                         DateTime.strptime(columns[3].inner_html, nagios_time_format).to_s
                        end
+          debug 'parsed last check column'
+
+          # Duration
           duration = columns[4].inner_html.squeeze(' ').gsub(/^ /, '') if columns[4]
           started_at = if duration && match_data = duration.match(/^\s*(\d+)d\s+(\d+)h\s+(\d+)m\s+(\d+)s\s*$/)
                          (
@@ -382,8 +412,16 @@ class NagiosHarder
                            match_data[4].to_i.seconds
                          ).ago
                        end
+          debug 'parsed duration column'
+
+          # Attempts
           attempts = columns[5].inner_html if columns[5]
-          status_info = columns[6].inner_html.gsub('&nbsp;', '') if columns[6]
+          debug 'parsed attempts column'
+
+          # Status info
+          status_info = columns[6].inner_html.gsub('&nbsp;', '').gsub("\302\240", '') if columns[6]
+          debug 'parsed status info column'
+
 
           if host && service && status && last_check && duration && attempts && started_at && status_info
             service_extinfo_url = "#{extinfo_url}?type=2&host=#{host}&service=#{CGI.escape(service)}"
@@ -412,7 +450,10 @@ class NagiosHarder
 
       nil
     end
-     
-  end
 
+    def debug(*args)
+      $stderr.puts *args if ENV['DEBUG']
+    end
+
+  end
 end