web_performo 0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-05-11
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/web_performo.rb
+lib/web_performo/result.rb
+script/console
+script/destroy
+script/generate
+spec/web_performo_results_spec.rb
+spec/web_performo_spec.rb
+tasks/test.rake

data/README.rdoc

@@ -0,0 +1,77 @@
+= web_performo
+
+* http://github.com/moowahaha/WebPerformoTheMagnificent
+
+== DESCRIPTION:
+
+Measures the time it takes a given web page to both return the first byte
+and to render in a given browser.
+
+== SYNOPSIS:
+
+Getting the performance statistics of a given URL:
+
+  performo = WebPerformo.new('firefox')
+  performo.run('http://www.google.com')
+
+  # high precision seconds taken to return the first byte from the web server
+  performo.first_byte_speed
+
+  # high precision seconds taken to render the page in a browser
+  performo.render_speed
+
+Compare the performance of two sites:
+
+  performo = WebPerformo.new('firefox')
+
+  google = performo.run('http://www.google.com')
+  bing = performo.run('http://www.bing.com')
+
+  if google > bing
+    puts "google is faster than bing"
+  end
+
+Make an assertion about website performance
+
+  performo = WebPerformo.new('firefox')
+
+  rea = performo.run('http://www.realestate.com.au')
+  nest = performo.run('http://www.nestoria.com.au')
+
+  # ... assuming realestate.com.au is faster than nestoria...
+  nest.assert > rea #=> exception
+  rea.assert < nest #=> exception
+
+
+== REQUIREMENTS:
+
+* selenium-webdriver >= 0.0.18
+
+== INSTALL:
+
+* sudo gem install web_performo
+
+== LICENSE:
+
+Copyright (c) 2010 Stephen Hardisty
+
+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. Except as contained in this notice, neither
+the names of the above copyright holders nor sponsors in relation to the Software
+(REA Group or its subsidiaries) shall be used in advertising or otherwise to promote
+the sale, use or other dealings in the Software without prior written authorization.
+
+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 OR SPONSORS IN RELATION TO THE SOFTWARE (REA GROUP LIMITED OR ITS
+SUBSIDIARIES) OR THEIR RELATED PERSONS 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

@@ -0,0 +1,21 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/web_performo'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'web_performo' do
+  self.developer 'Stephen Hardisty', 'moowahaha@hotmail.com'
+  self.rubyforge_name       = self.name
+  self.extra_deps         = [['selenium-webdriver','>= 0.0.18']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/*.rake'].each { |t| load t }
+

data/lib/web_performo.rb

@@ -0,0 +1,55 @@
+require File.join(File.dirname(__FILE__), 'web_performo', 'result')
+require 'socket'
+include Socket::Constants
+require 'selenium-webdriver'
+
+class WebPerformo
+  VERSION = '0.1'
+
+  def initialize browser = 'firefox'
+    @browser = browser.to_sym
+  end
+
+  def run url
+    WebPerformo::Result.new(
+            :url => url,
+            :first_byte_speed => time_first_byte(url),
+            :render_speed => time_render(url)
+    )
+  end
+
+  private
+
+  def time_first_byte url
+    socket = Socket.new(AF_INET, SOCK_STREAM, 0)
+    sockaddr = Socket.sockaddr_in(80, url.downcase.gsub(/^https?:\/\//, ''))
+
+    begin
+      socket.connect_nonblock(sockaddr)
+    rescue Errno::EINPROGRESS
+      IO.select(nil, [socket])
+    end
+
+    timer(socket) do |socket|
+      socket.write( "GET / HTTP/1.0\r\n\r\n" )
+      socket.readchar
+    end
+  end
+
+  def time_render url
+    selenium_driver = Selenium::WebDriver.for @browser
+
+    time_elapsed = timer(selenium_driver, url.downcase =~ /^http:/ ? url : "http://#{url}") do |driver, url|
+      driver.navigate.to(url)
+    end
+
+    selenium_driver.close
+    time_elapsed
+  end
+
+  def timer *params
+    before = Time.now.to_f
+    yield *params
+    Time.now.to_f - before
+  end
+end

data/lib/web_performo/result.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), 'assertion')
+
+class WebPerformo
+  class Result
+    attr_reader :first_byte_speed, :render_speed, :url
+    
+    def initialize result
+      @url, @first_byte_speed, @render_speed = result[:url], result[:first_byte_speed], result[:render_speed]
+    end
+
+    def > candidate
+      self.first_byte_speed > candidate.first_byte_speed && self.render_speed > candidate.render_speed
+    end
+
+    def < candidate
+      self.first_byte_speed < candidate.first_byte_speed && self.render_speed < candidate.render_speed
+    end
+
+    def assert
+      WebPerformo::Assertion.new(self)
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/web_performo.rb'}"
+puts "Loading web_performo gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/web_performo_results_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'web_performo', 'result')
+
+describe WebPerformo::Result do
+  it "should allow us to fetch data we sat" do
+    result = WebPerformo::Result.new(:render_speed => 10, :first_byte_speed => 20, :url => 'bob')
+
+    result.render_speed.should == 10
+    result.first_byte_speed.should == 20
+    result.url.should == 'bob'
+  end
+
+  describe 'comparing' do
+    before do
+      @slow_result = WebPerformo::Result.new(:render_speed => 2, :first_byte_speed => 2, :url => 'slow')
+      @fast_result = WebPerformo::Result.new(:render_speed => 1, :first_byte_speed => 1, :url => 'fast')
+    end
+
+    it "should recognise results that are fast" do
+      @fast_result.should < @slow_result
+    end
+
+    it "should recognise results that are slow" do
+      @slow_result.should > @fast_result
+    end
+  end
+end

data/spec/web_performo_spec.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'web_performo')
+
+describe WebPerformo do
+  it "should tell me what url a result is based on" do
+    result = WebPerformo.new.run('http://www.dcyder.com')
+    result.url.should == 'http://www.dcyder.com'
+  end
+
+  describe 'first byte' do
+    it "should give me the first-byte speed of dcyder.com (what a site!)" do
+      fake_socket = stub('fake socket')
+      Socket.should_receive(:new).and_return(fake_socket)
+
+      fake_sockaddr = stub('fake socket address')
+      Socket.should_receive(:sockaddr_in).with(80, 'www.dcyder.com').and_return(fake_sockaddr)
+      fake_socket.should_receive(:connect_nonblock).with(fake_sockaddr)
+      
+      fake_socket.should_receive(:write).with(/GET/)
+      fake_socket.should_receive(:readchar).and_return {sleep 0.5}
+
+      performo = WebPerformo.new
+      result = performo.run('http://www.dcyder.com')
+
+      result.first_byte_speed.should > 0.5
+      result.first_byte_speed.should < 0.7
+    end
+  end
+
+  describe 'rendering' do
+    it "should give me the render speed of dcyder.com (worth rendering, btw)" do
+      fake_driver = stub('fake browser')
+      Selenium::WebDriver.should_receive(:for).with(:fakeyfox).and_return(fake_driver)
+
+      fake_navigator = stub('fake selenium navigator')
+      fake_driver.should_receive(:navigate).and_return(fake_navigator)
+      fake_navigator.should_receive(:to).with('http://www.dcyder.com').and_return {sleep 0.5}
+      
+      fake_driver.should_receive(:close)
+
+      performo = WebPerformo.new('fakeyfox')
+      result = performo.run('www.dcyder.com')
+
+      result.render_speed.should > 0.5
+      result.render_speed.should < 0.7
+    end
+  end
+end

data/tasks/test.rake

@@ -0,0 +1,30 @@
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+task :test => ['test:covered']
+
+namespace :test do
+  report_dir = "reports"
+  directory report_dir
+
+  spec_opts = ["--colour", "--format", "progress"]
+
+  rcov_opts = ["--include", "spec", "--exclude", "spec/*,gems/*,db/*,features/*,gremlin/lib/*,nagios_reporter/lib", "--rails"]
+  rcov_report_dir = report_dir + "/rcov"
+
+  desc "Run all specs in spec directory with RCov (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:all_with_reports => [report_dir]) do |t|
+    t.spec_opts = spec_opts + ["--format", "html:#{report_dir}/rspec/specs.html"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_dir = rcov_report_dir
+    t.rcov_opts = rcov_opts
+  end
+
+
+  RCov::VerifyTask.new(:covered => :all_with_reports) do |t|
+        t.threshold = 100.0
+        t.require_exact_threshold = false
+        t.index_html = "#{rcov_report_dir}/index.html"
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: web_performo
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Stephen Hardisty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-11 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: selenium-webdriver
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.18
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+    version: 
+description: |-
+  Measures the time it takes a given web page to both return the first byte
+  and to render in a given browser.
+email: 
+- moowahaha@hotmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/web_performo.rb
+- lib/web_performo/result.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/web_performo_results_spec.rb
+- spec/web_performo_spec.rb
+- tasks/test.rake
+has_rdoc: true
+homepage: http://github.com/moowahaha/WebPerformoTheMagnificent
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: web_performo
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Measures the time it takes a given web page to both return the first byte and to render in a given browser.
+test_files: []
+