susuwatari 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm --create use 1.9.2-p290@susuwatari
+

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in susuwatari.gemspec
+gemspec
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "webmock", "~> 1.7.0"
+end

data/README.md

@@ -0,0 +1,88 @@
+Susuwatari
+===
+
+Susuwatari (ススワタリ lit. meaning "travelling soot") is the name of the dust bunnies featured in [Studio Ghibli](http://en.wikipedia.org/wiki/Studio_Ghibli) Animes _My Neighbour Totoro_ and _Spirited Away_.
+
+
+An Introduction for the Impatient (tl;dr)
+---
+
+This gem allows you to use the API of Patrick Meenan excellent [webpagetest.org](http://www.webpagetest.org) and fetch scores, numbers and waterfall images.
+
+    require 'susuwatari'
+
+    mei = Susuwatari.new( url: 'google.com', k: '5566sdfdsf' )
+    mei.run
+    => "aASFDasfdads2"
+
+    mei.status
+    => :running
+
+    mei.status
+    => :completed
+
+    mei.result.keys
+     => [ "testId", "summary", "testUrl", "location", "connectivity",
+          "bwDown", "bwUp", "latency", "plr", "completed", "runs", "average",
+          "median", "run"]
+
+    mei.result.testId
+    => "aASFDasfdads2"
+
+    mei.result.run.firstView.images.waterfall
+    => "http://www.webpagetest.org/results/12/02/09/KG/35XV333/1_waterfall.png"
+
+    mei.result.run.firstView.results.score_cache
+    => "98"
+
+    mei.result.run.firstView.results.requests
+    => 12
+
+You can check what a result looks like [here](https://sites.google.com/a/webpagetest.org/docs/advanced-features/webpagetest-restful-apis#TOC-Getting-test-results).
+
+So why Susuwatari?
+---
+
+Premature optimization might be the root of all evil, but optimizing actual performance bottlenecks is uniquely satisfying.
+
+Optimizing a web page from the end user perspective is even more satisfying, so we figured we need a way to monitor the web page speed on a regular basis.
+
+This gem allows to you test your url using webpagetest.org and get all the relevant numbers (imho) in a structured form. Looking at the waterfall charts allows you to squash all those little nasty dust bunnies that will slow down your page.
+
+![Squashing Susuwatari](http://dl.dropbox.com/u/3878602/ToShare/lk6r97NoeA1qzgeh8o1_500.gif "Squashing Susuwatari")
+
+So how to use it?
+---
+You need an api key from webpagetest.org to use this gem. You can find more information about that on the [Developer Interfaces Documentation](https://sites.google.com/a/webpagetest.org/docs/advanced-features).
+
+Once you've installed the gem, you can use it like this:
+
+    require 'susuwatari'
+
+    mei = Susuwatari.new( url: 'google.com', k: 'your-key', from: 'detroit', using: 'Chrome')
+
+    mei.run
+    => 'aBd333'
+
+
+    # You can check the status.
+    mei.status
+    => :running
+
+	mei.status
+    => :completed
+
+    mei.result.keys
+     => [ "testId", "summary", "testUrl", "location", "connectivity",
+          "bwDown", "bwUp", "latency", "plr", "completed", "runs", "average",
+          "median", "run"]
+
+    #You can access the results as a hash
+    mei.result["testId"]
+    => 'aBd333'
+
+    #Or in a pseudo-object oriented fashion
+    mei.result.testId
+    => 'aBd333'
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb'].exclude('spec/requests/*_spec.rb')
+end
+
+
+task :default => :spec

data/lib/susuwatari.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'hashie'
+require 'rest_client'
+require 'forwardable'
+
+require 'susuwatari/version'
+require 'susuwatari/error'
+require "susuwatari/result"
+require 'susuwatari/client'
+
+module Susuwatari
+  def self.new(params)
+    Susuwatari::Client.new(params)
+  end
+end

data/lib/susuwatari/client.rb

@@ -0,0 +1,48 @@
+module Susuwatari
+  class Client
+    extend Forwardable
+
+    attr_accessor :params, :response
+
+    def_delegator :@result, :status
+
+    TEST_URL = 'http://www.webpagetest.org/runtest.php'
+
+    def initialize( params = {} )
+      params.fetch(:k)
+      params.fetch(:url)
+      params[:f] = :json
+      params[:runs] ||= 1
+      params.delete(:r)
+      self.params = params
+    end
+
+    def run
+      return status if @result
+      @result = Result.new(make_request)
+      @result.test_id
+    end
+
+    def result
+      @result && @result.test_result || {}
+    end
+
+    def status
+      @result && @result.status || :to_be_run
+    end
+
+    private
+
+    def make_request
+      response = RestClient.get TEST_URL, :params => params, :accept => :json
+      raise_error "The requests was not completed, try again." unless  response.code == 200
+      body     = Hashie::Mash.new(JSON.parse(response.body))
+      raise_error(body.statusText) unless body.statusCode == 200
+      body
+    end
+
+    def raise_error(msg)
+      raise Error.new(msg)
+    end
+  end
+end

data/lib/susuwatari/error.rb

@@ -0,0 +1,4 @@
+module Susuwatari
+  #Custom class for rescuing from webpagetest.org errors.
+  class Error < StandardError; end
+end

data/lib/susuwatari/result.rb

@@ -0,0 +1,46 @@
+require 'active_support/core_ext/hash/conversions'
+
+require 'csv'
+
+module Susuwatari
+  class Result
+    extend Forwardable
+
+    STATUS_URL        = 'http://www.webpagetest.org/testStatus.php'
+    RESULT_URL_PREFIX = 'http://www.webpagetest.org/xmlResult/'
+
+    attr_reader :test_id, :current_status, :test_result, :request_raw
+
+    def_delegators :@test_result, :average, :median
+
+    def initialize( request_response )
+      @request_raw = request_response
+      @test_id  = request_raw.data.testId
+    end
+
+    def status
+      fetch_status unless current_status == :complete
+      current_status
+    end
+
+    private
+
+    def fetch_status
+      status = Hashie::Mash.new(JSON.parse( RestClient.get STATUS_URL, :params => { :f => :json, :test => test_id }))
+      case status.data.statusCode.to_s
+      when /1../
+        @current_status = :running
+      when "200"
+        @current_status = :completed
+        fetch_result
+      when /4../
+        @current_status = :error
+      end
+    end
+
+    def fetch_result
+      response = RestClient.get "#{RESULT_URL_PREFIX}/#{test_id}/"
+      @test_result  = Hashie::Mash.new(Hash.from_xml(response.body)).response.data
+    end
+  end
+end

data/lib/susuwatari/version.rb

@@ -0,0 +1,3 @@
+module Susuwatari
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler.require
+
+require 'susuwatari'
+require 'webmock/rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/susuwatari_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Susuwatari do
+  let(:key){ "4dabc19c6d0a4c30a2a20b4a6448d085" }
+  let(:url){ "google.com"}
+
+  context 'run a simple test' do
+    specify do
+      stub_request(:get, "http://www.webpagetest.org/runtest.php?f=json&k=#{key}&runs=1&url=#{url}").
+        with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :headers => {}, :body =>
+                  { "statusCode" => 200,
+                    "statusText" => "Ok",
+                    "data" => {
+                      "testId"     => "120116_KP_2WMG1",
+                      "ownerKey"   => "4dabc19c6d0a4c30a2a20b4a6448d085",
+                      "jsonUrl"    => "http://www.webpagetest.org/results.php?test=120116_KP_2WMG1&f=json",
+                      "xmlUrl"     => "http://www.webpagetest.org/xmlResult\/120116_KP_2WMG1/",
+                      "userUrl"    => "http://www.webpagetest.org/result\/120116_KP_2WMG1/",
+                      "summaryCSV" => "http://www.webpagetest.org/result\/120116_KP_2WMG1/page_data.csv",
+                      "detailCSV"  => "http://www.webpagetest.org/result\/120116_KP_2WMG1/requests.csv" } }.to_json)
+      mei = Susuwatari.new( url: 'google.com', k: key )
+      mei.run
+    end
+
+    it "raises an error if the request could not be completed" do
+      url = "trollololo"
+      status_text = "Please enter a Valid URL.  <b>trollololo</b> is not a valid Internet host name"
+      stub_request(:get, "http://www.webpagetest.org/runtest.php?f=json&k=#{key}&runs=1&url=#{url}").
+        with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :headers => {}, :body =>
+                  { "statusCode"=>400,
+                    "statusText"=>
+                    status_text }.to_json )
+      mei = Susuwatari.new( url: url, k: key )
+      lambda{ mei.run }.should raise_error(Susuwatari::Error, status_text)
+    end
+  end
+end

data/susuwatari.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "susuwatari/version"
+
+Gem::Specification.new do |s|
+  s.name        = "susuwatari"
+  s.version     = Susuwatari::VERSION
+  s.authors     = ["Benjamin Krause", "Adolfo Builes"]
+  s.email       = ["benjamin@moviepilot.com", "builes.adolfo@gmail.com"]
+  s.homepage    = "https://github.com/moviepilot/susuwatari"
+  s.summary     = %q{Simple Wrapper around the API of webpagetest.org}
+  s.description = %q{Allows to schedule tests on webpagetest.org}
+
+  s.rubyforge_project = "susuwatari"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "activesupport", "~> 3.2.1"
+  s.add_runtime_dependency "json", "~> 1.6.5"
+  s.add_runtime_dependency "hashie", "~> 1.2.0"
+  s.add_runtime_dependency "rest-client", "~> 1.6.7"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: susuwatari
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Krause
+- Adolfo Builes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2153083120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153083120
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2153082620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153082620
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2153082160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153082160
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2153111380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153111380
+description: Allows to schedule tests on webpagetest.org
+email:
+- benjamin@moviepilot.com
+- builes.adolfo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/susuwatari.rb
+- lib/susuwatari/client.rb
+- lib/susuwatari/error.rb
+- lib/susuwatari/result.rb
+- lib/susuwatari/version.rb
+- spec/spec_helper.rb
+- spec/susuwatari_spec.rb
+- susuwatari.gemspec
+homepage: https://github.com/moviepilot/susuwatari
+licenses: []
+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: susuwatari
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Simple Wrapper around the API of webpagetest.org
+test_files:
+- spec/spec_helper.rb
+- spec/susuwatari_spec.rb