httping 1.0.0

data/Rakefile

@@ -0,0 +1,26 @@
+require 'spec/rake/spectask'
+
+task :default => [:spec]
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "httping"
+    gem.date = %q{2009-09-15}
+    gem.default_executable = %q{httping}
+    gem.summary = "Measures web site response time"
+    gem.description = "Measures web site response time"
+    gem.email = "john.pignata@gmail.com"
+    gem.authors = ["John Pignata"]
+    gem.add_development_dependency "rspec", "1.2.9"
+    gem.add_development_dependency "fakeweb", "1.2.6"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/httping

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+
+require 'httping'
+
+Runner.new.run

data/lib/extensions/enumerable.rb

@@ -0,0 +1,9 @@
+module Enumerable
+  def sum
+    inject { |result, element| result + element }
+  end
+
+  def mean
+    sum / size
+  end
+end

data/lib/extensions/fixnum.rb

@@ -0,0 +1,9 @@
+class Fixnum
+  def to_human_size
+    case self
+      when 1024..1048576 then "#{self / 1024} kb"
+      when 1048576..1073741824 then "#{self / 1048576} mb"
+      else "#{self} bytes"
+    end
+  end
+end

data/lib/extensions/float.rb

@@ -0,0 +1,9 @@
+class Float
+  def to_human_time
+    case self
+      when 0..1 then "#{(self * 1000).floor} msecs"
+      when 1..2 then "1 sec"
+      else "#{floor} secs"
+    end
+  end
+end

data/lib/httping.rb

@@ -0,0 +1,10 @@
+require 'net/http'
+require 'net/https'
+require 'optparse'
+
+require 'extensions/enumerable'
+require 'extensions/fixnum'
+require 'extensions/float'
+
+require 'httping/runner'
+require 'httping/ping'

data/lib/httping/ping.rb

@@ -0,0 +1,93 @@
+class Ping
+  include Net
+
+  attr_writer :flood, :format, :audible, :user_agent, :referrer, :delay, :count, :uri
+
+  def initialize
+    @ping_results = []
+  end
+  
+  def run
+    trap("INT") { results }
+    loop do 
+      ping
+      results if count_reached?
+      sleep @delay unless @flood
+    end    
+  end
+
+  def ping
+    start_time = Time.now
+    response, data = request.get(uri, http_header)
+    @ping_results << duration = Time.now - start_time
+    ping_summary(response, data, duration) if @format == :interactive
+  end
+  
+  def request
+    request = Net::HTTP.new(@uri.host, @uri.port)
+
+    if @uri.scheme == "https"
+      request.use_ssl = true
+      request.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+    
+    request
+  end
+  
+  def uri
+    if @uri.query
+      "#{@uri.path}?#{@uri.query}"
+    else
+      "#{@uri.path}"
+    end
+  end
+  
+  def http_header
+    header = {}
+    header['User-Agent'] = @user_agent if @user_agent
+    header['Referrer'] = @referrer if @referrer 
+    header   
+  end
+
+  def ping_summary(response, data, duration)
+    print beep if @audible
+    puts "#{data.length.to_human_size} from #{@uri}: code=#{response.code} msg=#{response.message} time=#{duration.to_human_time}"
+  end
+
+  def beep
+    7.chr
+  end
+
+  def results
+    if @format.nil?
+      interactive_results
+    else
+      send("#{@format}_results")
+    end
+    
+    exit
+  end
+
+  def interactive_results
+    puts
+    puts "--- #{@uri} httping.rb statistics ---"
+    puts "#{@ping_results.size} GETs transmitted"
+    puts "round-trip min/avg/max = #{@ping_results.min.to_human_time}/#{@ping_results.mean.to_human_time}/#{@ping_results.max.to_human_time}"
+  end
+  
+  def json_results
+    results = "{\"max\": #{@ping_results.max}, \"avg\": #{@ping_results.mean}, \"min\": #{@ping_results.min}}"
+    sent = @ping_results.size
+    uri = @uri.to_s
+    puts "{\"results\": #{results}, \"sent\": #{sent}, \"uri\": \"#{uri}\"}"
+  end
+
+  def quick_results
+    duration = @ping_results.first.to_human_time
+    puts "OK [#{duration}]"
+  end
+
+  def count_reached?
+    @ping_results.size == @count
+  end
+end

data/lib/httping/runner.rb

@@ -0,0 +1,83 @@
+class Runner
+  BANNER = "Usage: httping [options] uri"
+  
+  def run
+    options = parse_arguments
+    
+    if options[:uri]
+      httping = Ping.new
+      options.each { |property, value| httping.send("#{property}=", value) }
+      httping.run
+    else
+      puts BANNER
+    end
+  end
+
+  def parse_arguments
+    options = {
+      :delay => 1,
+      :format => :interactive,
+      :flood => false,
+      :audible => false
+    }
+
+    begin
+      params = OptionParser.new do |opts|
+        opts.banner = BANNER
+        opts.on('-c', '--count NUM', 'Number of times to ping host') do |count|
+          options[:count] = count.to_i
+        end
+        opts.on('-d', '--delay SECS', 'Delay in seconds between pings (default: 1)') do |delay|
+          options[:delay] = delay.to_i
+        end
+        opts.on('-f', '--flood', 'Flood ping (no delay)') do 
+          options[:flood] = true
+        end
+        opts.on('-j', '--json', 'Return JSON results') do 
+          options[:format] = :json
+        end
+        opts.on('-q', '--quick', 'Ping once and return OK if up') do 
+          options[:format] = :quick
+        end
+        opts.on('-a', '--audible', 'Beep on each ping') do 
+          options[:audible] = true
+        end
+        opts.on('-u', '--user-agent STR', 'User agent string to send in headers') do |user_agent|
+          options[:user_agent] = user_agent
+        end
+        opts.on('-r', '--referrer STR', 'Referrer string to send in headers') do |referrer|
+          options[:referrer] = referrer
+        end
+        opts.on('-h', '--help', 'Display this screen') do
+          puts opts
+          exit
+        end
+        opts.parse!
+        options[:uri] = parse_uri if ARGV.first
+      end
+    rescue OptionParser::InvalidOption => exception
+      puts exception
+    end
+    
+    if options[:format] == :json && !options.include?(:count)
+      options[:count] = 5 # Default to 5 if no count provided for JSON format
+    elsif options[:format] == :quick
+      options[:count] = 1 # Quick format always sends only 1 ping
+    end
+  
+    options
+  end
+  
+  def parse_uri
+    uri = URI.parse(ARGV.first)
+
+    unless ["http", "https"].include?(uri.scheme) 
+      puts "ERROR: Invalid URI #{uri}"
+      exit
+    end
+
+    uri.path = "/" unless uri.path.match /^\//
+    
+    uri
+  end  
+end

data/spec/extensions_spec.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "Enumerable" do
+  before do
+    @array = [1, 58, 49, 330, 2, 15, 3, 80]
+  end
+  
+  context ".sum" do
+    it "returns the sum of all members of a set" do
+      @array.sum.should be(538)
+    end
+  end
+  
+  context ".mean" do
+    it "returns the mean of a set" do
+      @array.mean.should be(67)
+    end
+  end
+end
+
+describe "Float" do
+  before do
+    @milliseconds = 0.2997921
+    @second = 1.1291
+    @seconds = 48.31292
+  end
+  
+  context ".to_human_time" do
+    it "returns a human friendly string of the elapsed time represented by a float" do
+      @milliseconds.to_human_time.should == "299 msecs"
+      @second.to_human_time.should == "1 sec"
+      @seconds.to_human_time.should == "48 secs"
+    end
+  end
+end
+
+describe "Fixnum" do
+  before do
+    @bytes = 12
+    @kilobytes = 8_939
+    @megabytes = 4_911_219
+    @gigabytes = 8_289_119_584
+  end
+  
+  context ".to_human_size" do
+    it "returns a human friendly string of the amount of bytes represented by a number" do
+      @bytes.to_human_size.should == "12 bytes"
+      @kilobytes.to_human_size.should == "8 kb"
+      @megabytes = "5 mb"
+      @gigabytes = "8289119489 bytes"
+    end
+  end
+end

data/spec/ping_spec.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "Ping" do
+  before do
+    @httping = Ping.new
+    @httping.uri = URI.parse("http://www.example.com/")
+    @httping.format = :interactive
+    @httping.count = 10
+  end
+
+  after(:each) do
+    Output.clear
+  end
+
+  context ".ping" do
+    it "pings the configured url and outputs statistics" do
+      @httping.ping 
+      Output.to_s.should match(/10 bytes from http:\/\/www.example.com\/: code=200 msg=OK time=[0-9] msecs/)
+    end
+  end
+
+  context ".count_reached?" do
+    it "returns false if a host has not yet been pinged the number of times requested" do
+      2.times { @httping.ping }
+      @httping.should_not be_count_reached
+    end
+
+    it "returns true if a host has been pinged the number of times requested" do
+      10.times { @httping.ping }
+      @httping.should be_count_reached
+    end
+  end
+  
+  context ".results" do
+    before do
+      5.times { @httping.ping }
+    end
+    
+    it "outputs a summary of the pings" do
+      @httping.results
+      Output.to_s.should match(/-- http:\/\/www.example.com\/ httping.rb statistics ---\n5 GETs transmitted\n/)
+    end
+  end  
+end

data/spec/runner_spec.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "Runner" do  
+  before(:each) do
+    ARGV.clear
+    @runner = Runner.new
+  end
+
+  after(:each) do
+    Output.clear
+  end
+
+  context ".parse_arguments" do
+    it "parses command-line arguments into an options hash" do
+      ARGV << "http://www.example.com"
+      ARGV << "--count"
+      ARGV << "3"
+
+      options = @runner.parse_arguments
+      options[:count].should == 3
+      options[:uri].to_s.should == "http://www.example.com/"
+    end
+  end
+
+  context ".run" do
+    it "returns the params banner if no arguments are passed" do
+      @runner.run
+      Output.to_s.should == "Usage: httping [options] uri"
+    end
+
+    it "returns the params banner if invalid arguments are specified" do
+      ARGV << "-z"
+      @runner.run
+      Output.to_s.should == "invalid option: -z\nUsage: httping [options] uri"
+    end
+  end
+  
+  context "parse_uri" do
+    it "outputs an error and exists if not given an HTTP(S) URI" do
+      ARGV.clear
+      ARGV << "ftp://www.example.com"
+      @runner.parse_uri
+      Output.to_s.should == "ERROR: Invalid URI ftp://www.example.com"
+    end
+    
+    it "accepts HTTP URIs" do
+      ARGV.clear
+      ARGV << "http://www.example.com"
+      @runner.parse_uri
+      Output.to_s.should_not match(/ERROR/)
+    end
+
+    it "accepts HTTPS URIs" do
+      ARGV.clear
+      ARGV << "https://www.example.com"
+      @runner.parse_uri
+      Output.to_s.should_not match(/ERROR/)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'spec'
+require File.join(File.dirname(__FILE__), '../lib/httping')
+
+
+require 'fakeweb'
+FakeWeb.allow_net_connect = false
+FakeWeb.register_uri(:any, "http://www.example.com", :body => "hey there.")
+
+class Object
+  def exit(status_code = nil)
+    @status = status_code
+  end
+
+  def puts(output_string = "\n")
+    Output.puts(output_string)
+  end
+end
+
+class Output 
+  class << self
+    def puts(output_string)
+      @output = [] if @output.nil?
+      @output << output_string
+    end
+  
+    def to_s
+      @output.join("\n") if @output
+    end
+    
+    def clear
+      @output.clear if @output
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: httping
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- John Pignata
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 -04:00
+default_executable: httping
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.2.6
+    version: 
+description: Measures web site response time
+email: john.pignata@gmail.com
+executables: 
+- httping
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- VERSION
+- bin/httping
+- lib/extensions/enumerable.rb
+- lib/extensions/fixnum.rb
+- lib/extensions/float.rb
+- lib/httping.rb
+- lib/httping/ping.rb
+- lib/httping/runner.rb
+- spec/extensions_spec.rb
+- spec/ping_spec.rb
+- spec/runner_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Measures web site response time
+test_files: 
+- spec/extensions_spec.rb
+- spec/ping_spec.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb