browsermob-proxy 0.0.7 → 0.0.8

data/browsermob-proxy.gemspec

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

data/lib/browsermob/proxy/client.rb

@@ -22,8 +22,27 @@ module BrowserMob
         @port = port
       end
 
-      def new_har(ref = nil)
-        previous = @resource["har"].put :initialPageRef => ref
+      #
+      # Examples:
+      #
+      #   client.new_har("page-name")
+      #   client.new_har("page-name", :capture_headers => true)
+      #   client.new_har(:capture_headers => true)
+      #
+
+      def new_har(ref = nil, opts = {})
+        if opts.empty? && ref.kind_of?(Hash)
+          opts = ref
+          ref = nil
+        end
+
+        params = {}
+
+        params[:initialPageRef] = ref if ref
+        params[:captureHeaders] = true if opts[:capture_headers]
+
+
+        previous = @resource["har"].put params
         HAR::Archive.from_string(previous) unless previous.empty?
       end
 
@@ -93,4 +112,4 @@ module BrowserMob
     end # Client
 
   end # Proxy
-end # BrowserMob
+end # BrowserMob

data/lib/browsermob/proxy/version.rb

@@ -1,5 +1,5 @@
 module BrowserMob
   module Proxy
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/lib/browsermob/proxy/webdriver_listener.rb

@@ -15,9 +15,12 @@ module BrowserMob
     class WebDriverListener < Selenium::WebDriver::Support::AbstractEventListener
       attr_reader :hars
 
-      def initialize(client)
+      def initialize(client, opts = {})
         @client = client
         @hars = []
+
+        @new_har_opts = {}
+        @new_har_opts[:capture_headers] = true if opts[:capture_headers]
       end
 
       def reset
@@ -26,7 +29,7 @@ module BrowserMob
 
       def before_navigate_to(url, driver)
         save_har unless @hars.empty? # first request
-        @client.new_har("navigate-to-#{url}")
+        @client.new_har("navigate-to-#{url}", @new_har_opts)
       end
 
       def before_navigate_back(driver = nil)
@@ -64,4 +67,4 @@ module BrowserMob
       end
     end
   end
-end
+end

data/spec/e2e/selenium_spec.rb

@@ -29,6 +29,17 @@ describe "Proxy + WebDriver" do
     har.pages.size.should == 2
   end
 
+  it "should fetch a HAR and capture headers" do
+    proxy.new_har("2", :capture_headers => true)
+
+    driver.get url_for("2.html")
+
+    entry = proxy.har.entries.first
+    entry.should_not be_nil
+
+    entry.request.headers.should_not be_empty
+  end
+
   it "should set whitelist and blacklist" do
     proxy.whitelist(/example\.com/, 201)
     proxy.blacklist(/bad\.com/, 404)
@@ -42,4 +53,4 @@ describe "Proxy + WebDriver" do
     proxy.limit(:downstream_kbps => 100, :upstream_kbps => 100, :latency => 2)
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -1,16 +1,25 @@
 require 'browsermob/proxy'
 require 'selenium-webdriver'
 require 'browsermob/proxy/webdriver_listener'
+require 'rack'
 
 RestClient.log = STDOUT
 
 module BrowserMob
   module Proxy
     module SpecHelper
+      def self.httpd
+        @httpd ||= HttpServer.new(Rack::File.new(fixture_dir))
+      end
+
+      def self.fixture_dir
+        @fixture_dir ||= File.join(File.expand_path("../", __FILE__), "fixtures")
+      end
+
       def server
         $_bm_server ||= Server.new(
           File.join(home, "bin", "browsermob-proxy"),
-          :port => Selenium::WebDriver::PortProber.random,
+          :port => Selenium::WebDriver::PortProber.above(3000),
           :log => true
         ).start
       end
@@ -28,11 +37,34 @@ module BrowserMob
       end
 
       def url_for(page)
-        "file://#{fixture_path page}"
+        SpecHelper.httpd.url_for(page)
       end
 
       def fixture_path(name)
-        File.join(File.expand_path("../", __FILE__), "fixtures", name)
+        File.join(SpecHelper.fixture_dir, name)
+      end
+
+      class HttpServer
+        def initialize(app)
+          @port = Selenium::WebDriver::PortProber.above(3000)
+
+          pid = fork do
+            Rack::Server.new(:app => app, :Port => @port).start
+          end
+
+          at_exit { Process.kill 'TERM', pid }
+
+          poller = Selenium::WebDriver::SocketPoller.new("localhost", @port, 10)
+
+          unless poller.connected?
+            raise "unable to start web server in 5 seconds"
+          end
+        end
+
+        def url_for(page)
+          # use 0.0.0.0 to avoid default no-proxy rules on localhost
+          "http://0.0.0.0:#{@port}/#{page}"
+        end
       end
 
     end

data/spec/unit/client_spec.rb

@@ -20,7 +20,7 @@ module BrowserMob
         end
       end
 
-      it "creates a new har" do
+      it "creates a named har" do
         resource['har'].should_receive(:put).
                         with(:initialPageRef => "foo").
                         and_return('')
@@ -28,6 +28,14 @@ module BrowserMob
         client.new_har("foo").should be_nil
       end
 
+      it "creates a new har with no name" do
+        resource['har'].should_receive(:put).
+                        with({}).
+                        and_return('')
+
+        client.new_har.should be_nil
+      end
+
       it "returns the previous archive if one exists" do
         resource['har'].should_receive(:put).
                         with(:initialPageRef => "foo").
@@ -36,6 +44,22 @@ module BrowserMob
         client.new_har("foo").should be_kind_of(HAR::Archive)
       end
 
+      it "turns on header capture when given a name" do
+        resource['har'].should_receive(:put).
+                        with(:initialPageRef => "foo", :captureHeaders => true).
+                        and_return('')
+
+        client.new_har("foo", :capture_headers => true).should be_nil
+      end
+
+      it "turns on header capture when not given a name" do
+        resource['har'].should_receive(:put).
+                        with(:captureHeaders => true).
+                        and_return('')
+
+        client.new_har(:capture_headers => true).should be_nil
+      end
+
       it "gets the current har" do
         resource['har'].should_receive(:get).
                         and_return(fixture("google.har"))
@@ -137,4 +161,4 @@ module BrowserMob
     end
 
   end
-end
+end

data/spec/unit/webdriver_listener_spec.rb

@@ -9,10 +9,10 @@ module BrowserMob
       let(:listener) { WebDriverListener.new(client) }
       let(:element)  { mock(Selenium::WebDriver::Element, :ref => "some-id")}
       let(:har)      { mock(HAR::Archive) }
+      let(:url)      { "http://example.com" }
 
       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(:new_har).with("navigate-to-http://example.com", {})
         client.should_receive(:har).and_return(:har)
 
         listener.before_navigate_to(url, driver)
@@ -44,6 +44,13 @@ module BrowserMob
         listener.before_quit(driver)
         listener.hars.size.should == 1
       end
+
+      it 'passes the :capture_headers option' do
+        listener = WebDriverListener.new(client, :capture_headers => true)
+        client.should_receive(:new_har).with("navigate-to-http://example.com", :capture_headers => true)
+
+        listener.before_navigate_to(url, driver)
+      end
     end
   end
-end
+end

metadata

@@ -1,135 +1,150 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: browsermob-proxy
-version: !ruby/object:Gem::Version
-  version: 0.0.7
+version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 8
+  version: 0.0.8
 platform: ruby
-authors:
+authors: 
 - jari.bakken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-06-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: childprocess
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: childprocess
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multi_json
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: har
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: har
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
         version: 2.5.0
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.7'
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: selenium-webdriver
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
         version: 0.9.2
   type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rack
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.2
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
 description: Ruby client for the BrowserMob Proxy REST API
-email:
+email: 
 - jari.bakken@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -154,36 +169,37 @@ files:
 - 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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: browsermob-proxy-rb
-rubygems_version: 1.8.21
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby client for the BrowserMob Proxy REST API
-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
+test_files: []
+
 has_rdoc: