httpProfiler 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in httpProfiler.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    httpProfiler (0.0.1)
+      bundler (~> 1.3)
+      curb
+      floatstats
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    curb (0.8.4)
+    floatstats (0.2.1)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  httpProfiler!
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 PerceptiSys Ltd (Stephen Gaito)
+
+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,62 @@
+# HttpProfiler
+
+HttpProfiler uses [curb](https://github.com/taf2/curb) and 
+[floatstats](https://github.com/fizquierdo/floatstats) to compute 
+connection time statistics for configurable collections of webserver 
+urls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'httpProfiler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install httpProfiler
+
+## Usage
+
+### Command line
+
+For help type:
+
+> httpProfiler --help
+
+Invoking the example YAML configuration file:
+
+> httpProfiler $HTTP_TIMER_GEM/examples/httpProfiler.yaml
+
+### Library
+
+> require 'httpProfiler'
+
+> results = HttpProfiler.run(configFileName, configHash);
+> results.each_pair do | requestGroupName, requestGroupResults |
+>   puts "#{requestGroupName}, #{requestGroupResults.join(', ')}";
+> end
+
+The results is a Hash whose keys are the requestGroupNames taken from 
+the configHash, and whose results are the curb derived connection time 
+min, average, median, maximum and stardard deviations for all of the 
+urls in each requestGroup.
+
+See the $HTTP_TIMER_GEM/examples/httpProfiler.yaml file for documentation 
+of the configuration options.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the [MIT](http://opensource.org/licenses/MIT) license 
+(see LICENSE.txt).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ToDo.md

@@ -0,0 +1,14 @@
+# ToDo
+
+## High priority
+
+ 1. implement the abilitiy to extract cookies from previous visits to 
+urls in order to implement typcial login behaviour.
+
+## Medium priority
+
+ 1. Allow the delay to be randomized between minDelay and maxDelay
+
+## Low priority
+
+Nothing at the moment.

data/bin/httpProfiler

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+# This ruby script runs the httpProfiler and then prints the results 
+# to stdout.
+
+require 'rubygems' unless defined?(Gem);
+require 'bundler/setup';
+
+require 'optparse';
+require 'yaml';
+require 'httpProfiler';
+
+defaultOptions = Hash.new();
+defaultOptions['verbose']      = false;
+defaultOptions['randomize']    = -1;
+defaultOptions['replications'] = 10;
+defaultOptions['delay']        = 1.0;
+
+cmdOptions = Hash.new();
+
+OptionParser.new do | opts |
+
+  opts.banner = "Usage: httpProfiler [options] CONFIG_FILE";
+
+  opts.on("-r", "--repl REPLICATIONS", "The default number of replications to perform of each url-hash-key x url combination") do | opt |
+    cmdOptions['replications'] = opt.to_i;
+  end
+
+  opts.on("-R", "--rand RANDOM_SEED", "The (integer) random seed, zero for no randomization, negative to use the current time as the random seed") do | opt |
+    cmdOptions['randomize'] = opt.to_i;
+  end
+
+  opts.on("-d", "--delay DELAY_SECONDS", "The (float) number of seconds to delay between each request, if zero or negative then no delay will be used") do | opt |
+    cmdOptions['delay'] = opt.to_f;
+  end
+
+  opts.on("-v", "--[no-]verbose", "Toggle verbose output to stdout (default: false)") do | opt |
+    cmdOptions['verbose'] = opt;
+  end
+
+end.parse!(ARGV)
+
+ARGV.each do | configFile |
+  if File.exists?(configFile) then
+    config = YAML::load_file(configFile);
+    config = defaultOptions.merge(config);
+    config.merge!(cmdOptions);
+    timings = HttpProfiler.run(configFile, config);
+    puts "\n\nrequestGroupName, minConnTime, meanConnTime, medianConnTime, maxConnTime, stdDevConnTime";
+    timings.each_pair do | key, results |
+      puts "#{key}, #{results.join(', ')}";
+    end
+    puts "\n\n";
+  else
+    puts "Warning: the httpProfiler configuration file [#{configFile}] does not exist...";
+  end
+end

data/examples/httpProfiler.yaml

@@ -0,0 +1,65 @@
+# This is a simple (ruby) YAML file which determines what the 
+# httpProfiler should time, and how it should go about conducting the 
+# timings.
+
+# Many websites will require logins and will store session and login 
+# information in one or more cookies. SO we ensure any cookies defined 
+# in this section are obtained before attempting to visit any of the 
+# mail urls below.
+#
+# The cookies themselves are stored in the "cookies" hash with 
+# arbitrary hash keys (used below to reference the cookies).
+#
+# Each cookie is really a simple string of key=value pairs extracted 
+# from the result of visiting the corresponding url.
+#
+cookies: {}
+
+# The collection of urls to be visited are listed in the urls hash.
+#
+requestGroups:
+  fandianPF:
+    urls: 
+      - http://github.com/fandianpf/fandianpf
+      - http://github.com/fandianpf/fandianpf/wiki/Home
+      - http://github.com/fandianpf/fandianpf/issues
+  httpProfiler:
+    urls: 
+      - http://github.com/stephengaito/httpProfiler
+      - http://github.com/stephengaito/httpProfiler/issues
+
+# The randomize int determines whether or not to visit the urls in a 
+# deterministic sequential (lexigraphical) order (by hash key and url) 
+# or to visit them in a random order.
+#
+# If the randomize int is zero then no randomization will take place. 
+# If the randomize int is negative, then the randomization seed will 
+# be taken from the current time. If the randomize int is positive, 
+# than that number will be used as the randomization seed.
+#
+randomize: -1
+
+# The replication int determines the global default number of 
+# replications for each hash key, url provided.
+#
+replications: 10
+
+# The delay float determines how many seconds to wait between requests.
+#
+# A negative or zero value means there will be no delay between requests.
+#
+delay: 0.5
+
+# Headers is a hash of key value pairs to provide as default headers 
+# for each request.
+#
+# This hash will be merged with corresponding headers hashes contained 
+# in the urls structure.
+#
+headers: 
+  User-Agent: httpProfiler
+
+# Verbose is a boolean which specifies if extra verbose output should 
+# be sent to the stdout.
+#
+verbose: true

data/httpProfiler.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'httpProfiler'
+
+Gem::Specification.new do |spec|
+  spec.name          = "httpProfiler"
+  spec.version       = HttpProfiler::VERSION
+  spec.authors       = ["Stephen Gaito"]
+  spec.email         = ["stephen@perceptisys.co.uk"]
+  spec.description = %q{Run simple (sequencial) tests on a collection 
+of urls to determine average, stardard deviation and median connection 
+times}
+  spec.summary = %q{Run simple (sequential) tests on a collection of 
+urls}
+  spec.homepage      = "https://github.com/stephengaito/httpProfiler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "bundler", "~> 1.3"
+  spec.add_dependency "curb"
+  spec.add_dependency "floatstats"
+end

data/lib/httpProfiler.rb

@@ -0,0 +1,89 @@
+#require "httpProfiler/version"
+require 'curb';
+require 'floatstats';
+
+module HttpProfiler
+  VERSION = "0.0.1";
+
+  class Runner
+
+    def initialize(configFileName, config)
+      @configFileName = configFileName;
+      @options = config;
+      @cookies = Hash.new();
+      if @options.has_key?('cookies') then
+        @cookies = @options['cookies'];
+        @options.delete('cookies');
+      end
+      @requestGroups = Hash.new();
+      if @options.has_key?('requestGroups') then
+        @requestGroups = @options['requestGroups'];
+        @options.delete('requestGroups');
+      end
+    end
+
+    def runRequestGroup(requestGroupName, requestGroup)
+      requestList = Array.new();
+      @options['replications'].times do 
+        requestGroup['urls'].each do | url |
+          requestList.push(url);
+        end    
+      end
+
+      randGen = nil;
+      if requestGroup['randomize'] == 0 then
+      elsif requestGroup['randomize'] < 0 then
+        randGen = Random.new();
+      else
+        randGen = Random.new(requestGroup['randomize']);
+      end
+      requestList.shuffle!(random: randGen) unless randGen.nil?;
+
+      connectTimes = Array.new();
+
+      puts requestGroupName if @options['verbose'];
+      requestList.each do | url |
+        puts "\t#{url}" if @options['verbose'];
+        c = Curl::Easy.new(url);
+        c.follow_location = true;
+        c.perform;
+        connectTimes.push(c.connect_time);
+        if 0 < @options['delay'] then
+          puts "\t\tsleeping(#{@options['delay']})" if @options['verbose'];
+          sleep(@options['delay']);
+        end
+      end
+
+      [ connectTimes.min, 
+        connectTimes.average,
+        connectTimes.median,
+        connectTimes.max,
+        connectTimes.standard_deviation ]
+    end
+
+    def run
+      if @options['verbose'] then
+        require 'pp';
+        puts "\n\nConfiguration taken from: [#{@configFileName}]";
+        puts "options:";
+        pp @options;
+        puts "requestGroups:";
+        pp @requestGroups;
+        puts "\n\n";
+      end
+      results = Hash.new();
+      @requestGroups.each_pair do | requestGroupName, requestGroup |
+        results[requestGroupName] = runRequestGroup(requestGroupName, 
+                                                    requestGroup.merge!(@options));
+      end
+      results;
+    end
+
+  end
+
+  def self.run(configFile, config)
+    runner = HttpProfiler::Runner.new(configFile, config);
+    runner.run;
+  end
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: httpProfiler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Gaito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: floatstats
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Run simple (sequencial) tests on a collection \nof urls to determine
+  average, stardard deviation and median connection \ntimes"
+email:
+- stephen@perceptisys.co.uk
+executables:
+- httpProfiler
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ToDo.md
+- bin/httpProfiler
+- examples/httpProfiler.yaml
+- httpProfiler.gemspec
+- lib/httpProfiler.rb
+homepage: https://github.com/stephengaito/httpProfiler
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Run simple (sequential) tests on a collection of  urls
+test_files: []
+has_rdoc: