igp 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,3 +1,9 @@
+Version 0.0.2                Release: 7th May 2011
+==================================================
+* properly handle time format in 1.8 and 1.9 ruby
+  the things we forget - 1.8 didn't have strftime milliseconds format option
+* refactor output formatting to make it more testable
+
 Version 0.0.1                Release: 7th May 2011
 ==================================================
 * Initial packaging and release

data/README.rdoc

@@ -64,6 +64,8 @@ Ping results are written as a comma-separated record with 4 components:
 * ping duration in seconds (if the test was a success)
 * error or exception code (if any)
 
+Examples:
+
   # a 'good' ping example:
   2011-05-07T03:34:08.078Z,true,0.006508,
   # a 'bad' ping example:

data/Rakefile

@@ -20,13 +20,9 @@ begin
     gem.homepage = "http://github.com/tardate/igp"
     gem.license = "MIT"
     gem.summary = %Q{It goes PING!}
-    gem.description = %Q{command line interface for running longitudinal monitoring for various protocols: HTTP, HTTPS, ICMP and more}
+    gem.description = %Q{It goes PING! .. simple command-line server monitoring with a range of protocols: ICMP, TCP, UDP, HTTP/S, LDAP/S}
     gem.email = "gallagher.paul@gmail.com"
     gem.authors = ["Paul Gallagher"]
-    # Include your dependencies below. Runtime dependencies are required when using your gem,
-    # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-    #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-    #  gem.add_development_dependency 'rspec', '> 1.2.3'
   end
   Jeweler::RubygemsDotOrgTasks.new
 rescue LoadError

data/igp.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{igp}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Gallagher"]
   s.date = %q{2011-05-07}
-  s.description = %q{command line interface for running longitudinal monitoring for various protocols: HTTP, HTTPS, ICMP and more}
+  s.description = %q{It goes PING! .. simple command-line server monitoring with a range of protocols: ICMP, TCP, UDP, HTTP/S, LDAP/S}
   s.email = %q{gallagher.paul@gmail.com}
   s.executables = ["igp"]
   s.extra_rdoc_files = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "lib/igp/shell.rb",
     "lib/igp/version.rb",
     "spec/base_spec.rb",
+    "spec/format_spec.rb",
     "spec/shell_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
   s.summary = %q{It goes PING!}
   s.test_files = [
     "spec/base_spec.rb",
+    "spec/format_spec.rb",
     "spec/shell_spec.rb",
     "spec/spec_helper.rb"
   ]

data/lib/igp/base.rb

@@ -1,7 +1,10 @@
+# main class that runs the ping task
 class Igp::Base
 
   # holds the parsed options
   attr_reader :options
+  # the output formatter
+  attr_reader :formatter
   # the Net::Ping handler for the specific protocol required
   attr_reader :ping_handler
   # number of pings to perform (nil => infinite)
@@ -18,6 +21,7 @@ class Igp::Base
   #  :port => optionally specify the port for host (else default port is assumed)
   #
   def initialize(options = {})
+    @formatter = Format.new
     @options = options
     @limit = options[:limit]
     @interval = options[:interval] || 5
@@ -37,31 +41,44 @@ class Igp::Base
 
   # main routine to run a complete ping test
   def run
-    return unless ping_handler
-    header
+    return unless ping_handler && formatter
+    formatter.header(
+      '# It goes PING! .. testing',options[:url],
+      (limit ? "#{limit} times - once" : nil),
+      'every',interval,'seconds'
+    )
     ping_count=0
     while (limit.nil? || ping_count < limit) do
       status = ping_handler.ping?
-      log status,ping_handler.duration,ping_handler.exception
+      formatter.log(status,formatter.duration(ping_handler.duration),ping_handler.exception)
       ping_count += 1
       sleep interval if (limit.nil? || ping_count < limit)
     end
   end
 
-  protected
+  # handle output formating tasks
+  class Format
 
-  # prints the header structure to STDERR
-  def header
-    $stderr.puts [
-      '# It goes PING! .. testing',options[:url],
-      (limit ? "#{limit} times - once" : nil),'every',interval,'seconds'
-    ].compact.join(' ')
-  end
+    # the time format - in 1.8 strftime doesn't understand milliseconds
+    TIME_FORMAT = (RUBY_VERSION =~ /^1\.9/) ? "%Y-%m-%dT%H:%M:%S.%LZ" : "%Y-%m-%dT%H:%M:%SZ"
+
+    # prints the header structure to STDERR
+    def header(*args)
+      $stderr.puts(args.compact.join(' '))
+    end
+      
+    # logs ping result to STDOUT
+    # +args+ is an array of values to log
+    def log(*args)
+      $stdout.puts(([Time.now.utc.strftime( TIME_FORMAT )] + args).join(','))
+      $stdout.flush
+    end
+    
+    # formats the duration for output. nil duration remains nil
+    def duration(duration)
+      "%.6f" % duration if duration
+    end
 
-  # logs ping result to STDOUT
-  # +args+ is an array of values to log
-  def log(*args)
-    $stdout.puts(([Time.now.utc.strftime( "%Y-%m-%dT%H:%M:%S.%LZ" )] + args).join(','))
-    $stdout.flush
   end
+
 end

data/lib/igp/shell.rb

@@ -1,4 +1,6 @@
 require 'uri'
+
+# class that groks the igp command line options and invokes the ping task
 class Igp::Shell
 
   # holds the parsed options

data/lib/igp/version.rb

@@ -1,3 +1,3 @@
 class Igp
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/base_spec.rb

@@ -4,17 +4,14 @@ require 'getoptions'
 describe Igp::Base do
 
   describe "base initialization without options" do
-    before do
-      @base = Igp::Base.new
-    end
     it "should not set ping_handler" do
-      @base.ping_handler.should be_nil
+      subject.ping_handler.should be_nil
     end
     it "should not set limit" do
-      @base.limit.should be_nil
+      subject.limit.should be_nil
     end
     it "should default interval to 5 sec" do
-      @base.interval.should eql(5)
+      subject.interval.should eql(5)
     end
   end
   
@@ -22,7 +19,7 @@ describe Igp::Base do
     it "should be Net::Ping::External for :icmp" do
       options = { :type => :icmp, :host => 'localhost', :port => nil}
       base = Igp::Base.new(options)
-      base.ping_handler.class.should eql(Net::Ping::External)
+      base.ping_handler.should be_a(Net::Ping::External)
     end
     it "should be Net::Ping::UDP for :tcp" do
       options = { :type => :udp, :host => 'localhost', :port => 22}
@@ -56,4 +53,14 @@ describe Igp::Base do
     end
   end
 
+  describe "#run" do
+    before do
+      @good = Igp::Base.new({ :type => :icmp, :host => 'localhost', :port => nil, :limit => 1})
+    end
+    it "should print header and log a ping result" do
+      @good.formatter.should_receive(:header)
+      @good.formatter.should_receive(:log)
+      capture(:stdout,:stderr){ @good.run }
+    end
+  end
 end

data/spec/format_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'getoptions'
+
+describe Igp::Base::Format do
+
+  describe '#duration' do
+    it "should return nil for nil duration" do
+      subject.duration(nil).should be_nil
+    end
+    it "should return string to 6 decimal places for non-nil duration" do
+      result = subject.duration(1.0)
+      result.should match(/^\d+\.\d{6}$/)
+      result.to_f.should eql(1.0)
+    end
+    it "should handle integer parameter" do
+      result = subject.duration(1)
+      result.should match(/^\d+\.\d{6}$/)
+      result.to_f.should eql(1.0)
+    end
+  end
+
+  describe '#header' do
+    it "should output a blank line for nil parameters" do
+      result = capture(:stderr){ subject.header(nil) }
+      result.should eql("\n")
+    end
+    it "should convert an arbitrary array of strings and numbers to a space-delimited output to stderr" do
+      result = capture(:stderr){ subject.header("string",1.0,"another string",2.0) }
+      result.should eql("string 1.0 another string 2.0\n")
+    end
+  end
+
+  describe '#log' do
+    it "should output time only for nil parameters" do
+      result = capture(:stdout){ subject.log(nil) }
+      result.should match(/^.+Z,$/)
+    end
+    it "should log successful message (boolean,float,nil) to stdout" do
+      result = capture(:stdout){ subject.log(true,1.0,nil) }
+      result.should match(/^.+Z,true,1.0,$/)
+    end
+    it "should log unsuccessful message (boolean,nil,string) to stdout" do
+      result = capture(:stdout){ subject.log(false,nil,"message") }
+      result.should match(/^.+Z,false,,message$/)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1 +1,14 @@
 require 'igp'
+require 'stringio'
+
+def capture(*streams)
+  streams.map! { |stream| stream.to_s }
+  begin
+    result = StringIO.new
+    streams.each { |stream| eval "$#{stream} = result" }
+    yield
+  ensure
+    streams.each { |stream| eval("$#{stream} = #{stream.upcase}") }
+  end
+  result.string
+end

metadata

@@ -2,7 +2,7 @@
 name: igp
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Paul Gallagher
@@ -78,7 +78,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id006
-description: "command line interface for running longitudinal monitoring for various protocols: HTTP, HTTPS, ICMP and more"
+description: "It goes PING! .. simple command-line server monitoring with a range of protocols: ICMP, TCP, UDP, HTTP/S, LDAP/S"
 email: gallagher.paul@gmail.com
 executables: 
 - igp
@@ -102,6 +102,7 @@ files:
 - lib/igp/shell.rb
 - lib/igp/version.rb
 - spec/base_spec.rb
+- spec/format_spec.rb
 - spec/shell_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tardate/igp
@@ -117,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 497536060373054853
+      hash: -2613847138706563759
       segments: 
       - 0
       version: "0"
@@ -136,5 +137,6 @@ specification_version: 3
 summary: It goes PING!
 test_files: 
 - spec/base_spec.rb
+- spec/format_spec.rb
 - spec/shell_spec.rb
 - spec/spec_helper.rb