httping 1.0.0 → 1.0.1

data/README.md

@@ -0,0 +1,72 @@
+# HTTPing.rb
+
+HTTPing.rb is a utility to measure web service response time. This is a Ruby port of HTTPing (http://www.vanheusden.com/httping/).
+
+## Bugs, Features, Feedback
+
+Tickets can be submitted by via GitHub issues.
+
+## Example Usage
+
+    jpignata@populuxe:~$ httping --count 10 --user-agent "HTTPinger" http://www.google.com
+    5 kb from http://www.google.com/: code=200 msg=OK time=51 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=61 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=74 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=48 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=106 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=51 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=52 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=50 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=59 msecs
+    5 kb from http://www.google.com/: code=200 msg=OK time=60 msecs
+    
+    --- http://www.google.com/ httping.rb statistics ---
+    10 GETs transmitted
+    round-trip min/avg/max = 48 msecs/61 msecs/106 msecs
+
+
+## Command-line Options
+
+    Usage: httping [options] uri
+        -c, --count NUM                  Number of times to ping host
+        -d, --delay SECS                 Delay in seconds between pings (default: 1)
+        -f, --flood                      Flood ping (no delay)
+        -j, --json                       Return JSON results
+        -q, --quick                      Ping once and return OK if up
+        -a, --audible                    Beep on each ping
+        -u, --user-agent STR             User agent string to send in headers
+        -r, --referrer STR               Referrer string to send in headers
+        -h, --help                       Display this screen
+
+## Installation
+
+    jp@populuxe:~$ gem install httping
+
+## Requirements
+
+- FakeWeb (in order to run the specs)
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jay Pignata
+
+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/Rakefile

@@ -8,14 +8,20 @@ Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.spec_opts = ['--options', 'spec/spec.opts']
 end
 
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude', 'Library,spec']
+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.summary = "Command-line utility for measuring web site response time"
+    gem.homepage = "http://github.com/jpignata/httping"
     gem.email = "john.pignata@gmail.com"
     gem.authors = ["John Pignata"]
     gem.add_development_dependency "rspec", "1.2.9"

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/httping/ping.rb

@@ -9,11 +9,14 @@ class Ping
   
   def run
     trap("INT") { results }
+    
     loop do 
       ping
-      results if count_reached?
+      break if count_reached?
       sleep @delay unless @flood
     end    
+    
+    results
   end
 
   def ping
@@ -59,12 +62,7 @@ class Ping
   end
 
   def results
-    if @format.nil?
-      interactive_results
-    else
-      send("#{@format}_results")
-    end
-    
+    send("#{@format}_results")
     exit
   end
 

data/spec/ping_spec.rb

@@ -12,10 +12,36 @@ describe "Ping" 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/)
+  describe ".ping" do
+    context "a HTTP URI" 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 "a HTTPS URI" do
+      it "pings the configured url and outputs statistics" do
+        @httping.uri = URI.parse("https://www.example.com/")
+        @httping.ping
+        Output.to_s.should match(/10 bytes from https:\/\/www.example.com\/: code=200 msg=OK time=[0-9] msecs/)
+      end
+    end
+
+    context "a URI with a query string" do
+      it "pings the configured url and outputs statistics" do
+        @httping.uri = URI.parse("http://www.example.com/search?q=test")
+        @httping.ping
+        Output.to_s.should match(/10 bytes from http:\/\/www.example.com\/search\?q=test: code=200 msg=OK time=[0-9] msecs/)
+      end
+    end
+    
+    context "audible ping" do
+      it "outputs a console beep if audible is sold" do
+        @httping.audible = true
+        @httping.ping
+        Output.to_s.should match(/\007/)
+      end
     end
   end
 
@@ -40,5 +66,52 @@ describe "Ping" do
       @httping.results
       Output.to_s.should match(/-- http:\/\/www.example.com\/ httping.rb statistics ---\n5 GETs transmitted\n/)
     end
-  end  
+  end
+  
+  context ".json_results" do
+    before do
+      @httping.format = :json
+      2.times { @httping.ping }
+    end
+    
+    it "outputs a summary of the pings in JSON format" do
+      @httping.results
+      Output.to_s.should match(/\{\"results\": \{\"max\": [0-9\.]*, \"avg\": [0-9\.]*, \"min\": [0-9\.]*\}, \"sent\": 2, \"uri\": \"http:\/\/www.example.com\/\"\}/)
+    end
+  end
+
+  context ".quick_results" do
+    before do
+      @httping.format = :quick
+      @httping.ping
+    end
+    
+    it "outputs OK if host responds to HTTP GET" do
+      @httping.results
+      Output.to_s.should match(/OK/)
+    end
+  end
+  
+  context ".run" do
+    before do
+      @httping = Ping.new
+      @httping.uri = URI.parse("http://www.example.com/")
+      @httping.format = :interactive
+      @httping.count = 5
+    end
+    
+    it "pings until a count is reached" do
+      @httping.flood = true
+      @httping.run
+      Output.to_s.should match(/5 GETs transmitted/)
+    end
+
+    it "adds a delay between each ping if a delay is provided" do
+      @httping.flood = false
+      @httping.delay = 0.25
+      start_time = Time.now
+      @httping.run 
+      (Time.now - start_time).should > 0.5
+    end
+  end
 end

data/spec/runner_spec.rb

@@ -13,13 +13,44 @@ describe "Runner" do
   context ".parse_arguments" do
     it "parses command-line arguments into an options hash" do
       ARGV << "http://www.example.com"
-      ARGV << "--count"
-      ARGV << "3"
+      ARGV << "--count" << "3"
+      ARGV << "--delay" << "2"
+      ARGV << "--audible"
+      ARGV << "--user-agent" << "Mozilla"
+      ARGV << "--referrer" << "http://www.example.com/about-us"
+      ARGV << "--flood"
 
       options = @runner.parse_arguments
       options[:count].should == 3
+      options[:delay].should == 2
+      options[:audible].should be
+      options[:flood].should be
+      options[:user_agent].to_s.should == "Mozilla"
+      options[:referrer].to_s.should == "http://www.example.com/about-us"
       options[:uri].to_s.should == "http://www.example.com/"
     end
+
+    it "defaults count to 5 if JSON format is flag passed" do
+      ARGV << "http://www.example.com"
+      ARGV << "--json"
+      
+      options = @runner.parse_arguments
+      options[:count].should == 5
+    end
+
+    it "sets count to 1 if quick format is flag passed" do
+      ARGV << "http://www.example.com"
+      ARGV << "--quick"
+      
+      options = @runner.parse_arguments
+      options[:count].should == 1
+    end
+
+    it "outputs a help screen if help flag passed" do
+      ARGV << "--help"
+      @runner.parse_arguments
+      Output.to_s.should match(/-j, --json *Return JSON results/)
+    end
   end
 
   context ".run" do
@@ -33,25 +64,30 @@ describe "Runner" do
       @runner.run
       Output.to_s.should == "invalid option: -z\nUsage: httping [options] uri"
     end
+
+    it "creates a ping object based upon passed in parameters" do
+      ARGV << "http://www.example.com"
+      ARGV << "--count" << "5"
+      ARGV << "--flood"
+      @runner.run
+      Output.to_s.should match(/5 GETs transmitted/)
+    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/)

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@ 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.")
+FakeWeb.register_uri(:any, "https://www.example.com", :body => "hey there.")
+FakeWeb.register_uri(:any, "http://www.example.com/search?q=test", :body => "hey there.")
 
 class Object
   def exit(status_code = nil)
@@ -14,6 +16,8 @@ class Object
   def puts(output_string = "\n")
     Output.puts(output_string)
   end
+  
+  alias print puts
 end
 
 class Output 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: httping
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - John Pignata
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 -04:00
+date: 2009-10-31 00:00:00 -04:00
 default_executable: httping
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,15 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.6
     version: 
-description: Measures web site response time
+description: 
 email: john.pignata@gmail.com
 executables: 
 - httping
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.md
 files: 
+- README.md
 - Rakefile
 - VERSION
 - bin/httping
@@ -56,7 +57,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/jpignata/httping
 licenses: []
 
 post_install_message: 
@@ -82,7 +83,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Measures web site response time
+summary: Command-line utility for measuring web site response time
 test_files: 
 - spec/extensions_spec.rb
 - spec/ping_spec.rb