ruby_xymon 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour --require 'spec_helper'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xymon.gemspec
+
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem "simplecov"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bryan Taylor
+
+MIT License
+
+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,51 @@
+RubyXymon [![Build Status](https://travis-ci.org/rubyisbeautiful/ruby_xymon.png)](https://travis-ci.org/rubyisbeautiful/ruby_xymon)
+========
+
+A simple gem for Xymon
+
+Thanks to Greg Faust
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'xymon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xymon
+
+## Usage
+
+In its current state, the gem is simple to use.  You can set two configuration variables, host and port, like this:
+>> RubyXymon.config[:host] = 'localhost'
+>> RubyXymon.config[:port] = '1984'
+The values in the example are the defaults.
+You can also set the configuration at once, using either a Hash or a String, which points to a file:
+>> RubyXymon.config = { :host => 'localhost' }
+>> RubyXymon.config = "/some/dir/xymon.yml"
+
+You can send a raw Xymon message using the send method:
+>> RubyXymon.send("status www.http green `date` Web OK")
+
+For more information on Xymon, see the [![Xymon man page](http://www.xymon.com/xymon/help/manpages/man1/xymon.1.html#lbAF)]
+
+
+##
+
+Future improvements:
+* methods based on Xymon messages.  Each message has its own syntax, e.g. RubyXymon.status(lifetime, group, hostname, testname, color, txt)
+* methods to read from Xymon, e.g. "query" message
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/ruby_xymon.rb

@@ -0,0 +1,57 @@
+require "ruby_xymon/version"
+require 'socket'
+
+module RubyXymon
+
+
+  def self.send(msg, this_host=nil, this_port=nil)
+    host = this_host.nil? ? self.config[:host] : this_host
+    port = this_port.nil? ? self.config[:port] : this_port
+
+    # create
+    t = self.new_socket(host, port)
+
+    # write
+    t.puts(msg)
+
+    # close
+    t.close
+  end
+
+
+  def self.config=(hash_or_yml_file={})
+
+    case hash_or_yml_file
+      when Hash
+        @_xymon_config = default_config.merge(hash_or_yml_file)
+      when String
+        @_xymon_config = default_config.merge(YAML.load_file(hash_or_yml_file))
+      else
+        raise ArgumentError.new("config takes either a Hash type object or a filename pointing to a YAML")
+    end
+
+  end
+
+
+  def self.config
+    if @_xymon_config.nil?
+      @_xymon_config = default_config
+    end
+    @_xymon_config
+  end
+
+
+  def self.new_socket(host, port)
+    TCPSocket.new(host, port)
+  end
+
+
+  def self.default_config
+    {
+      :host => 'localhost',
+      :port => '1984'
+    }
+  end
+
+
+end

data/lib/ruby_xymon/version.rb

@@ -0,0 +1,3 @@
+module RubyXymon
+  VERSION = "0.0.2"
+end

data/ruby_xymon.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require 'base64'
+require File.expand_path('../lib/ruby_xymon/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bryan Taylor"]
+  gem.email         = ['YmNwdGF5bG9yQGdtYWlsLmNvbQ==\n'].collect{ |foo| Base64.decode64(foo) }
+  gem.description   = %q{ A very simple way to send messages to Xymon }
+  gem.summary       = %q{ An incredibly simple way to send messages to Xymon, with no frills at all }
+  gem.homepage      = "http://github.com/rubyisbeautiful/ruby_xymon"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ruby_xymon"
+  gem.require_paths = ["lib"]
+  gem.version       = RubyXymon::VERSION
+
+
+end

data/spec/ruby_xymon_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe "RubyXymon" do
+
+  before :each do
+    RubyXymon.instance_variable_set('@_xymon_config', nil)
+  end
+
+
+  describe 'default_config' do
+
+    it "should have a port of 1984" do
+      RubyXymon.default_config[:port].should == '1984'
+    end
+
+    it "should have a host of localhost" do
+      RubyXymon.default_config[:host].should == 'localhost'
+    end
+
+  end
+
+
+  describe 'new_socket' do
+
+    it "should return a TCPSocket" do
+      TCPSocket.should_receive(:new).with('localhost', '1984')
+
+      RubyXymon.new_socket('localhost', '1984')
+    end
+
+  end
+
+
+  describe 'config' do
+
+    it "should set @_xymon_config if it was nil" do
+      RubyXymon.instance_variable_get("@_xymon_config").nil?.should be_true
+
+      RubyXymon.config
+
+      RubyXymon.instance_variable_get("@_xymon_config").nil?.should be_false
+    end
+
+    it "should return @_xymon_config if it was not nil" do
+      RubyXymon.instance_variable_set("@_xymon_config", 'foo')
+
+      RubyXymon.config.should == 'foo'
+    end
+
+  end
+
+
+  describe 'config=' do
+
+    it 'should accept a hash and merge it to defaults' do
+      RubyXymon.config = { :host => 'foo' }
+
+      RubyXymon.config.should == { :host => 'foo', :port => '1984' }
+    end
+
+
+    it 'should accept a YAML file and merge it to defaults' do
+      YAML.should_receive(:load_file).with('some_file').and_return({ :host => 'foo' })
+
+      RubyXymon.config = 'some_file'
+
+      RubyXymon.config.should == { :host => 'foo', :port => '1984' }
+    end
+
+  end
+
+
+  describe 'send' do
+
+    it 'should use default host if not passed' do
+      RubyXymon.should_receive(:new_socket).with('localhost', '1984').and_return(double.as_null_object)
+
+      RubyXymon.send('foo')
+    end
+
+
+    it 'should use default port if not passed' do
+      RubyXymon.should_receive(:new_socket).with('baconhost', '1984').and_return(double.as_null_object)
+
+      RubyXymon.send('foo', 'baconhost')
+    end
+
+
+    it "the socket should receive the message" do
+      duck = double.as_null_object
+      duck.should_receive(:puts).with('foo')
+
+      RubyXymon.stub(:new_socket).and_return(duck)
+
+      RubyXymon.send('foo')
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'simplecov'
+require File.join(File.dirname(__FILE__), '..', 'lib/ruby_xymon')
+
+SimpleCov.start
+
+RSpec.configure do |config|
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  # config.use_transactional_fixtures = true
+
+  # config.fixture_path = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
+
+
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: ruby_xymon
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Bryan Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 00:00:00.000000000 Z
+dependencies: []
+description: ! ' A very simple way to send messages to Xymon '
+email:
+- !binary |-
+  YmNwdGF5bG9yQGdtYWlsLmNvbQ==
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ruby_xymon.rb
+- lib/ruby_xymon/version.rb
+- ruby_xymon.gemspec
+- spec/ruby_xymon_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rubyisbeautiful/ruby_xymon
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1473618950636672990
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An incredibly simple way to send messages to Xymon, with no frills at all
+test_files:
+- spec/ruby_xymon_spec.rb
+- spec/spec_helper.rb