browsermob-proxy 0.0.2 → 0.0.3

data/README.md

@@ -6,6 +6,8 @@ Ruby client for the BrowserMob Proxy 2.0 REST API.
 How to use with selenium-webdriver
 ----------------------------------
 
+Manually:
+
 ``` ruby
 require 'selenium/webdriver'
 require 'browsermob/proxy'
@@ -16,21 +18,48 @@ server.start
 proxy = server.create_proxy #=> #<BrowserMob::Proxy::Client:0x0000010224bdc0 ...>
 
 profile = Selenium::WebDriver::Firefox::Profile.new #=> #<Selenium::WebDriver::Firefox::Profile:0x000001022bf748 ...>
-profile.proxy = client.selenium_proxy
+profile.proxy = proxy.selenium_proxy
 
 driver = Selenium::WebDriver.for :firefox, :profile => profile
 
-proxy.new_har("google")
+proxy.new_har "google"
 driver.get "http://google.com"
 
 har = proxy.har #=> #<HAR::Archive:0x-27066c42d7e75fa6>
-har.entries.first.request.url
+har.entries.first.request.url #=> "http://google.com"
 har.save_to "/tmp/google.har"
 
 proxy.close
 driver.quit
 ```
 
+With event listener:
+
+``` ruby
+require 'selenium/webdriver'
+require 'browsermob/proxy'
+require 'browsermob/proxy/webdriver_listener'
+
+# start server, set up proxy like above
+proxy_listener = BrowserMob::Proxy::WebDriverListener.new(proxy)
+
+driver = Selenium::WebDriver.for :firefox, :profile => profile, :listener => proxy_listener
+# use driver
+driver.quit
+
+listener.hars #=> [#<HAR::Archive:0x-27066c42d7e75fa6>, #<HAR::Archive:0x-d7e75fa627066c42>]
+proxy.close
+
+```
+
+
+Viewing HARs
+------------
+
+The HAR gem includes a HAR viewer. After running the code above, you can view the saved HAR by running
+
+    $ har /tmp/google.har
+
 
 See also
 --------

data/browsermob-proxy.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "har"
 
   s.add_development_dependency "rspec", ">= 2.5.0"
-  s.add_development_dependency "selenium-webdriver", ">= 2.0.0"
+  s.add_development_dependency "selenium-webdriver", "~> 2.7"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/browsermob/proxy/client.rb

@@ -2,6 +2,8 @@ module BrowserMob
   module Proxy
 
     class Client
+      attr_reader :host, :port
+
       def self.from(server_url)
         port = JSON.parse(
           RestClient.post(URI.join(server_url, "proxy").to_s, '')
@@ -23,7 +25,7 @@ module BrowserMob
         previous = @resource["har"].put :initialPageRef => ref
         HAR::Archive.from_string(previous) unless previous.empty?
       end
-      
+
       def new_page(ref)
         @resource['har/pageRef'].put :pageRef => ref
       end
@@ -37,6 +39,16 @@ module BrowserMob
         Selenium::WebDriver::Proxy.new(:http => "#{@host}:#{@port}")
       end
 
+      def whitelist(regexp, status_code)
+        regex = Regexp === regexp ? regexp.source : regexp.to_s
+        @resource['har/whitelist'].put :regex => regex, :status => status_code
+      end
+
+      def blacklist(regexp, status_code)
+        regex = Regexp === regexp ? regexp.source : regexp.to_s
+        @resource['har/blacklist'].put :regex => regex, :status => status_code
+      end
+
       def close
         @resource.delete
       end

data/lib/browsermob/proxy/server.rb

@@ -27,6 +27,9 @@ module BrowserMob
         @process.start
         sleep 0.1 until listening?
 
+        pid = Process.pid
+        at_exit { stop if Process.pid == pid }
+
         self
       end
 
@@ -39,17 +42,7 @@ module BrowserMob
       end
 
       def stop
-        return unless @process.alive?
-
-        begin
-          @process.poll_for_exit(5)
-        rescue ChildProcess::TimeoutError
-          @process.stop
-        end
-      rescue Errno::ECHILD
-        # already dead
-      ensure
-        @process = nil
+        @process.stop if @process.alive?
       end
 
       private

data/lib/browsermob/proxy/version.rb

@@ -1,5 +1,5 @@
 module BrowserMob
   module Proxy
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/browsermob/proxy/webdriver_listener.rb

@@ -0,0 +1,67 @@
+require 'selenium/webdriver/support'
+
+module BrowserMob
+  module Proxy
+
+    #
+    # WebDriver event listener that assumes the following:
+    #
+    # driver.get - new HAR
+    # driver.click - new page
+    # driver.navigate.back - new page
+    # driver.navigate.forward - new page
+    #
+
+    class WebDriverListener < Selenium::WebDriver::Support::AbstractEventListener
+      attr_reader :hars
+
+      def initialize(client)
+        @client = client
+        @hars = []
+      end
+
+      def reset
+        @hars.clear
+      end
+
+      def before_navigate_to(url, driver)
+        save_har unless @hars.empty? # first request
+        @client.new_har("navigate-to-#{url}")
+      end
+
+      def before_navigate_back(driver = nil)
+        name = "navigate-back"
+        name << "-from-#{driver.current_url}" if driver
+
+        @client.new_page name
+      end
+
+      def before_navigate_forward(driver = nil)
+        name = "navigate-forward"
+        name << "-from-#{driver.current_url}" if driver
+
+        @client.new_page name
+      end
+
+      def before_click(element, driver)
+        name = "click-element-#{identifier_for element}"
+        @client.new_page name
+      end
+
+      def before_quit(driver)
+        save_har
+      end
+
+      private
+
+      def save_har
+        @hars << @client.har
+      end
+
+      def identifier_for(element)
+        # can be ovverriden to provide more meaningful info
+        element.ref
+      end
+    end
+  end
+end

data/spec/e2e/listener_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "Proxy + WebDriverListener" do
+  let(:wait) { Selenium::WebDriver::Wait.new }
+  let(:listener) { BrowserMob::Proxy::WebDriverListener.new(proxy) }
+  let(:driver)  { Selenium::WebDriver.for :firefox, :profile => profile, :listener => listener }
+  let(:proxy) { new_proxy }
+
+  let(:profile) {
+    pr = Selenium::WebDriver::Firefox::Profile.new
+    pr.proxy = proxy.selenium_proxy
+
+    pr
+  }
+
+  after {
+    proxy.close
+  }
+
+  it "should record events" do
+    driver.get url_for("1.html")
+    driver.find_element(:link_text => "2").click
+    driver.quit
+
+    hars = listener.hars
+    hars.size.should == 1
+
+    hars.first.pages.size.should == 2
+
+    hars.each_with_index { |e,i| e.save_to("/tmp/#{i}.har") }
+  end
+end

data/spec/e2e/selenium_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe "Proxy + WebDriver" do
   let(:driver)  { Selenium::WebDriver.for :firefox, :profile => profile }
   let(:proxy) { new_proxy }
+
   let(:profile) {
     pr = Selenium::WebDriver::Firefox::Profile.new
     pr.proxy = proxy.selenium_proxy
@@ -10,16 +11,21 @@ describe "Proxy + WebDriver" do
     pr
   }
 
-  after { driver.quit }
-  after { proxy.close }
+  after {
+    driver.quit
+    proxy.close
+  }
 
   it "should fetch a HAR" do
-    proxy.new_har
-    driver.get "http://google.com"
+    proxy.new_har("1")
+    driver.get url_for("1.html")
+
+    proxy.new_page "2"
+    driver.get url_for("2.html")
 
     har = proxy.har
 
     har.should be_kind_of(HAR::Archive)
-    har.pages.size.should == 1
+    har.pages.size.should == 2
   end
 end

data/spec/fixtures/1.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>1</title>
+</head>
+<body>
+  <a href="2.html">2</a>
+</body>
+</html>

data/spec/fixtures/2.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>2</title>
+</head>
+<body>
+
+</body>
+</html>

data/spec/fixtures/3.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Page Title</title>
+</head>
+<body>
+
+</body>
+</html>

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'browsermob/proxy'
 require 'selenium-webdriver'
+require 'browsermob/proxy/webdriver_listener'
 
 RestClient.log = STDOUT
 
@@ -19,7 +20,15 @@ module BrowserMob
       end
 
       def fixture(name)
-        File.read(File.join(File.expand_path("../", __FILE__), "fixtures", name))
+        File.read(fixture_path(name))
+      end
+
+      def url_for(page)
+        "file://#{fixture_path page}"
+      end
+
+      def fixture_path(name)
+        File.join(File.expand_path("../", __FILE__), "fixtures", name)
       end
 
     end

data/spec/unit/client_spec.rb

@@ -6,36 +6,60 @@ module BrowserMob
     describe Client do
       let(:resource)      { mock(RestClient::Resource) }
       let(:client)        { Client.new(resource, "localhost", 9091) }
-      let(:har_resource)  { mock("resource[har]") }
-      let(:page_ref_resource)  { mock("resource[har/pageRef]") }
 
       before do
-        resource.stub!(:[]).with("har").and_return(har_resource)
-        resource.stub!(:[]).with("har/pageRef").and_return(page_ref_resource)
+        {
+          "har"           => mock("resource[har]"),
+          "har/pageRef"   => mock("resource[har/pageRef]"),
+          "har/whitelist" => mock("resource[har/whitelist]"),
+          "har/blacklist" => mock("resource[har/blacklist]")
+        }.each do |path, mock|
+          resource.stub!(:[]).with(path).and_return(mock)
+        end
       end
 
       it "creates a new har" do
-        har_resource.should_receive(:put).with(:initialPageRef => "foo").and_return('')
+        resource['har'].should_receive(:put).
+                        with(:initialPageRef => "foo").
+                        and_return('')
 
         client.new_har("foo").should be_nil
       end
 
       it "returns the previous archive if one exists" do
-        har_resource.should_receive(:put).with(:initialPageRef => "foo").and_return(fixture("google.har"))
+        resource['har'].should_receive(:put).
+                        with(:initialPageRef => "foo").
+                        and_return(fixture("google.har"))
 
         client.new_har("foo").should be_kind_of(HAR::Archive)
       end
 
       it "gets the current har" do
-        har_resource.should_receive(:get).and_return(fixture("google.har"))
+        resource['har'].should_receive(:get).
+                        and_return(fixture("google.har"))
 
         client.har.should be_kind_of(HAR::Archive)
       end
-      
+
       it "creates a new page" do
-        page_ref_resource.should_receive(:put).with :pageRef => "foo"
-        
-        client.new_page("foo")
+        resource['har/pageRef'].should_receive(:put).
+                                with :pageRef => "foo"
+
+        client.new_page "foo"
+      end
+
+      it "sets the blacklist" do
+        resource['har/blacklist'].should_receive(:put).
+                                  with(:regex => "http://example.com", :status => 401)
+
+        client.blacklist(%r[http://example.com], 401)
+      end
+
+      it "sets the whitelist" do
+        resource['har/whitelist'].should_receive(:put).
+                                  with(:regex => "http://example.com", :status => 401)
+
+        client.whitelist(%r[http://example.com], 401)
       end
     end
 

data/spec/unit/webdriver_listener_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module BrowserMob
+  module Proxy
+
+    describe WebDriverListener do
+      let(:client)   { mock(Client) }
+      let(:driver)   { mock(Selenium::WebDriver::Driver, :current_url => 'http://foo') }
+      let(:listener) { WebDriverListener.new(client) }
+      let(:element)  { mock(Selenium::WebDriver::Element, :ref => "some-id")}
+      let(:har)      { mock(HAR::Archive) }
+
+      it 'creates a new har on navigate.to' do
+        url = "http://example.com"
+        client.should_receive(:new_har).with("navigate-to-http://example.com")
+        client.should_receive(:har).and_return(:har)
+
+        listener.before_navigate_to(url, driver)
+        listener.before_quit(driver)
+        listener.hars.size.should == 1
+      end
+
+      it 'creates a new page on navigate.back' do
+        client.should_receive(:new_page).with(/^navigate-back/)
+
+        listener.before_navigate_back(driver)
+      end
+
+      it 'creates a new page on navigate.forward' do
+        client.should_receive(:new_page).with(/^navigate-forward/)
+
+        listener.before_navigate_forward(driver)
+      end
+
+      it 'creates a new page on click' do
+        client.should_receive(:new_page).with(/^click-element/)
+
+        listener.before_click(element, driver)
+      end
+
+      it 'saves har before quit' do
+        client.should_receive(:har).and_return(har)
+
+        listener.before_quit(driver)
+        listener.hars.size.should == 1
+      end
+    end
+  end
+end

metadata

@@ -1,93 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: browsermob-proxy
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - jari.bakken
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-15 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2161286300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: childprocess
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2161286300
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: &2161279940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2161279940
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2161263620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: har
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2161263620
+- !ruby/object:Gem::Dependency
+  name: har
+  requirement: &2161262300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2161262300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2161259040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: selenium-webdriver
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2161259040
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: &2161253700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.0.0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *2161253700
 description: Ruby client for the BrowserMob Proxy REST API
-email: 
+email:
 - jari.bakken@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -99,39 +95,47 @@ files:
 - lib/browsermob/proxy/client.rb
 - lib/browsermob/proxy/server.rb
 - lib/browsermob/proxy/version.rb
+- lib/browsermob/proxy/webdriver_listener.rb
+- spec/e2e/listener_spec.rb
 - spec/e2e/selenium_spec.rb
+- spec/fixtures/1.html
+- spec/fixtures/2.html
+- spec/fixtures/3.html
 - spec/fixtures/google.har
 - spec/spec_helper.rb
 - spec/unit/client_spec.rb
+- spec/unit/webdriver_listener_spec.rb
 homepage: http://github.com/jarib/browsermob-proxy-rb
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: browsermob-proxy-rb
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby client for the BrowserMob Proxy REST API
-test_files: 
+test_files:
+- spec/e2e/listener_spec.rb
 - spec/e2e/selenium_spec.rb
+- spec/fixtures/1.html
+- spec/fixtures/2.html
+- spec/fixtures/3.html
 - spec/fixtures/google.har
 - spec/spec_helper.rb
 - spec/unit/client_spec.rb
+- spec/unit/webdriver_listener_spec.rb