monit 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+.yardoc
+doc/*

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in monit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    monit (0.1.0)
+      crack (~> 0.1.8)
+      curb (~> 0.7.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    awesome_print (0.2.1)
+    crack (0.1.8)
+    curb (0.7.8)
+    diff-lcs (1.1.2)
+    rake (0.8.7)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.0.0)
+  crack (~> 0.1.8)
+  curb (~> 0.7.8)
+  monit!
+  rake
+  rspec (~> 2.0.0.beta.20)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matias Korhonen
+
+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,33 @@
+Monit Rubygem
+=============
+
+A Ruby interface for Monit.
+
+## Installation
+
+Just like any other gem:
+
+    gem install monit
+
+## Usage
+
+    status = Monit::Status.new({ :host => "monit.myserver.com", 
+                                 :auth => true, 
+                                 :username => "foo", 
+                                 :password => "bar" })
+    status.get              # => true
+    status.platform         # => <Monit::Platform:0x00000003673dd0 ... >
+    status.platform.cpu     # => 2
+    status.platform.memory  # => 4057712
+
+For more options see the API documentation
+
+## Compatibility
+
+At the moment the gem is only compatible with Ruby 1.9.2.
+
+## License and copyright
+
+Copyright (c) 2010 Matias Korhonen
+
+Licensed under the MIT license, see the LICENSE file for details.

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+gemspec = eval(File.read("monit.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["monit.gemspec"] do
+  system "gem build monit.gemspec"
+  system "gem install monit-#{Monit::VERSION}.gem"
+end

data/lib/monit.rb

@@ -0,0 +1,5 @@
+require "monit/httpd"
+require "monit/platform"
+require "monit/server"
+require "monit/service"
+require "monit/status"

data/lib/monit/httpd.rb

@@ -0,0 +1,12 @@
+module Monit
+  # The HTTPD section from the Monit XML
+  class HTTPD
+    attr_reader :address, :port, :ssl
+        
+    def initialize(options = {})
+      @address = options[address]
+      @port = options["port"].to_i
+      @ssl = options["ssl"] == "1" ? true : false
+    end
+  end
+end

data/lib/monit/platform.rb

@@ -0,0 +1,15 @@
+module Monit
+  # The platform section from the Monit XML
+  class Platform
+    attr_reader :name, :release, :version, :machine, :cpu, :memory
+    
+    def initialize(options = {})
+      @name = options["name"]
+      @release = options["release"]
+      @version = options["version"]
+      @machine = options["machine"]
+      @cpu = options["cpu"].to_i
+      @memory = options["memory"].to_i
+    end
+  end
+end

data/lib/monit/server.rb

@@ -0,0 +1,18 @@
+module Monit
+  # The server section from the Monit XML
+  class Server
+      attr_reader :id, :incarnation, :version, :uptime, :poll, :startdelay, :localhostname, :controlfile, :httpd
+      
+      def initialize(options = {})
+        @id = options["id"]
+        @incarnation = options["incarnation"]
+        @version = options["version"]
+        @uptime = options["uptime"].to_i
+        @poll = options["poll"].to_i
+        @startdelay = options["startdelay"].to_i
+        @localhostname = options["localhostname"]
+        @controlfile = options["controlfile"]
+        @httpd = options["httpd"].is_a?(HTTPD) ? options["httpd"] : HTTPD.new(options["httpd"])
+      end
+  end
+end

data/lib/monit/service.rb

@@ -0,0 +1,7 @@
+require "ostruct"
+module Monit
+  # The service section from the Monit XML. Inherits from OpenStruct.
+  class Service < OpenStruct
+    TYPES = { 0 => "Filesystem", 1 => "Directory", 2 => "File", 3 => "Daemon", 4 => "Connection", 5 => "System" }
+  end
+end

data/lib/monit/status.rb

@@ -0,0 +1,75 @@
+require "curb"
+require "uri"
+require "crack/xml"
+
+# A Ruby interface for Monit
+module Monit
+  # The +Status+ class is used to get data from the Monit instance. You should not
+  # need to manually instantiate any of the other classes.
+  class Status
+    attr_reader :url, :hash, :xml, :server, :platform, :services
+    attr_accessor :username, :auth, :host, :port, :ssl, :auth, :username
+    attr_writer :password
+    
+    # Create a new instance of the status class with the given options
+    # 
+    # <b>Options:</b>
+    # * +host+ - the host for monit, defaults to +localhost+
+    # * +port+ - the Monit port, defaults to +2812+
+    # * +ssl+ - should we use SSL for the connection to Monit (default: false)
+    # * +auth+ - should authentication be used, defaults to false
+    # * +username+ - username for authentication
+    # * +password+ - password for authentication
+    def initialize(options = {})
+      @host ||= options[:host] ||= "localhost"
+      @port ||= options[:port] ||= 2812
+      @ssl  ||= options[:ssl]  ||= false
+      @auth ||= options[:auth] ||= false
+      @username = options[:username]
+      @password = options[:password]
+      @services = []
+    end
+    
+    # Construct the URL
+    def url
+      url_params = { :host => @host, :port => @port, :path => "/_status", :query => "format=xml" }
+      @ssl ? URI::HTTPS.build(url_params) : URI::HTTP.build(url_params)
+    end
+    
+    # Get the status from Monit.
+    def get
+      c = Curl::Easy.new(self.url.to_s) do |curl|
+        if @auth
+          curl.password = @password
+          curl.username = @username
+        end
+        curl.headers["User-Agent"] = "Monit Ruby client #{Monit::VERSION}"
+      end
+      c.perform
+      
+      if c.response_code == 200
+        @xml = c.body_str
+        return self.parse(@xml)
+      else
+        return false
+      end
+    end
+    
+    # Parse the XML from Monit into a hash and into a Ruby representation.
+    def parse(xml)
+      @hash = Crack::XML.parse(xml)
+      @server = Server.new(@hash["monit"]["server"])
+      @platform = Platform.new(@hash["monit"]["platform"])
+      if @hash["monit"]["service"].is_a? Array
+        @services = @hash["monit"]["service"].map do |service|
+          Service.new(service)
+        end
+      else
+        @services = [Service.new(@hash["monit"]["service"])]
+      end
+      true
+    rescue
+      false
+    end
+  end
+end

data/lib/monit/version.rb

@@ -0,0 +1,3 @@
+module Monit
+  VERSION = "0.1.0"
+end

data/monit.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/monit/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "monit"
+  s.version     = Monit::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matias Korhonen"]
+  s.email       = ["matias@kiskolabs.com"]
+  s.homepage    = "http://rubygems.org/gems/monit"
+  s.summary     = "Connect to Monit"
+  s.description = "Retrieve server information from Monit."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "monit"
+
+  s.add_development_dependency "bundler", "~> 1.0.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 2.0.0.beta.20"
+  s.add_development_dependency "awesome_print"
+  
+  s.add_dependency "crack", "~> 0.1.8"
+  s.add_dependency "curb", "~> 0.7.8"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/spec/monit_spec.rb

@@ -0,0 +1,165 @@
+# -*- encoding: utf-8 -*-
+require "spec_helper"
+
+describe Monit do
+  context "Status" do
+    it "should be possible to instatiate it with no options" do
+      @status = Monit::Status.new
+      @status.should be_kind_of Monit::Status
+      @status.host.should == "localhost"
+      @status.port.should == 2812
+      @status.ssl.should be_false
+      @status.auth.should be_false
+      @status.username.should be_nil
+      lambda { @status.password }.should raise_error(NoMethodError)
+      @status.services.should == []
+    end
+    
+    it "should generate the correct URL" do
+      @status = Monit::Status.new
+      @status.url.should be_kind_of URI
+      @status.url.to_s.should == "http://localhost:2812/_status?format=xml"
+      @status.ssl = true
+      @status.url.to_s.should == "https://localhost:2812/_status?format=xml"
+      @status.host = "rails.fi"
+      @status.url.to_s.should == "https://rails.fi:2812/_status?format=xml"
+      @status.port = 8080
+      @status.url.to_s.should == "https://rails.fi:8080/_status?format=xml"
+    end
+    
+    it "should parse XML into a Hash" do
+      status = Monit::Status.new
+      status.stub!(:xml).and_return(File.read("./spec/samples/smallish_status.xml"))
+      status.parse(status.xml)
+      status.hash.should be_kind_of Hash
+      status.hash["monit"].should_not be_nil
+      status.hash["monit"]["server"].should_not be_nil
+      status.hash["monit"]["platform"].should_not be_nil
+      status.hash["monit"]["service"].should_not be_nil
+      
+      status.stub!(:xml).and_return(File.read("./spec/samples/largish_status.xml"))
+      status.parse(status.xml)
+      status.hash.should be_kind_of Hash
+      status.hash["monit"].should_not be_nil
+      status.hash["monit"]["server"].should_not be_nil
+      status.hash["monit"]["platform"].should_not be_nil
+      status.hash["monit"]["service"].should_not be_nil
+    end
+    
+    it "should parse XML into a Ruby representation" do
+      status = Monit::Status.new
+      status.stub!(:xml).and_return(File.read("./spec/samples/smallish_status.xml"))
+      status.parse(status.xml)
+      
+      status.server.should be_kind_of Monit::Server
+      status.server.httpd.should be_kind_of Monit::HTTPD
+      status.platform.should be_kind_of Monit::Platform
+      status.services.should be_kind_of Array
+      status.services.first.should be_kind_of Monit::Service
+      status.services.first.should be_kind_of OpenStruct
+      
+      status.stub!(:xml).and_return(File.read("./spec/samples/largish_status.xml"))
+      status.parse(status.xml)
+      
+      status.server.should be_kind_of Monit::Server
+      status.server.httpd.should be_kind_of Monit::HTTPD
+      status.platform.should be_kind_of Monit::Platform
+      status.services.should be_kind_of Array
+      status.services.first.should be_kind_of Monit::Service
+      status.services.first.should be_kind_of OpenStruct
+    end
+  end
+  
+  context "Server" do
+    it "should create a new instance of Monit::Server from a hash" do
+      hash = {         "id" => "52255a0b8999c46c98de9697a8daef67",
+              "incarnation" => "1283946152",
+                  "version" => "5.1.1",
+                   "uptime" => "4",
+                     "poll" => "30",
+               "startdelay" => "0",
+            "localhostname" => "Example.local",
+              "controlfile" => "/etc/monitrc",
+                    "httpd" => { "address" => nil,
+                                    "port" => "2812",
+                                     "ssl" => "0" } }
+      server = Monit::Server.new(hash)
+      server.id.should == "52255a0b8999c46c98de9697a8daef67"
+      server.incarnation.should == "1283946152"
+      server.version.should == "5.1.1"
+      server.uptime.should == 4
+      server.poll.should == 30
+      server.startdelay.should == 0
+      server.localhostname.should == "Example.local"
+      server.controlfile.should == "/etc/monitrc"
+      server.httpd.should be_kind_of Monit::HTTPD
+    end
+  end
+  
+  context "HTTPD" do
+    it "should create a new instance of Monit::HTTPD from a hash" do
+      hash = { "address" => nil,
+                  "port" => "2812",
+                   "ssl" => "0" }
+      httpd = Monit::HTTPD.new(hash)
+      httpd.address.should be_nil
+      httpd.port.should == 2812
+      httpd.ssl.should be_false
+    end
+  end
+  
+  context "Platform" do
+    it "should create a new instance of Monit::Platform from a hash" do
+      hash = { "name" => "Darwin",
+            "release" => "10.4.0",
+            "version" => "Darwin Kernel Version 10.4.0: Fri Apr 23 18:28:53 PDT 2010; root:xnu-1504.7.4~1/RELEASE_I386",
+            "machine" => "i386",
+                "cpu" => "2",
+             "memory" => "4194304" }
+      platform = Monit::Platform.new(hash)
+      platform.name.should == "Darwin"
+      platform.release.should == "10.4.0"
+      platform.version.should == "Darwin Kernel Version 10.4.0: Fri Apr 23 18:28:53 PDT 2010; root:xnu-1504.7.4~1/RELEASE_I386"
+      platform.machine.should == "i386"
+      platform.cpu.should == 2
+      platform.memory.should == 4194304
+    end
+  end
+  
+  context "Service" do
+    it "should create a new instance of Monit::Platform from a hash" do
+      hash = { "collected_sec" => "1283946152",
+              "collected_usec" => "309973",
+                        "name" => "Example.local",
+                      "status" => "0",
+                 "status_hint" => "0",
+                     "monitor" => "1",
+                 "monitormode" => "0",
+               "pendingaction" => "0",
+                      "groups" => { "name" => "server" },
+                      "system" => { "load" => { "avg01" => "0.28",
+                                                "avg05" => "0.43",
+                                                "avg15" => "0.48" },
+                                     "cpu" => {   "user" => "10.0",
+                                                "system" => "4.1" },
+                                  "memory" => { "percent" => "44.1",
+                                               "kilobyte" => "1850152" }
+                                  },
+                        "type" => "5" }
+      service = Monit::Service.new(hash)
+      service.should be_kind_of OpenStruct
+      service.should be_kind_of Monit::Service
+      service.collected_sec.should == "1283946152"
+      service.collected_usec.should == "309973"
+      service.name.should == "Example.local"
+      service.status.should == "0"
+      service.status_hint.should == "0"
+      service.monitor.should == "1"
+      service.monitormode.should == "0"
+      service.pendingaction.should == "0"
+      service.groups.should be_kind_of Hash
+      service.system.should be_kind_of Hash
+      service.type.should == "5"
+    end
+  end
+end