browsermob-proxy2 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+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.above(3000),
+          :log => true
+        ).start
+      end
+
+      def new_proxy
+        server.create_proxy
+      end
+
+      def home
+        ENV['BROWSERMOB_PROXY_HOME'] or raise "BROWSERMOB_PROXY_HOME not set"
+      end
+
+      def fixture(name)
+        File.read(fixture_path(name))
+      end
+
+      def url_for(page)
+        SpecHelper.httpd.url_for(page)
+      end
+
+      def fixture_path(name)
+        File.join(SpecHelper.fixture_dir, name)
+      end
+
+      class HttpServer
+        attr_reader :port
+
+        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
+  end
+end
+
+RSpec.configure do |c|
+  c.include(BrowserMob::Proxy::SpecHelper)
+  c.after(:suite) { $_bm_server.stop if $_bm_server }
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,193 @@
+require 'spec_helper'
+
+module BrowserMob
+  module Proxy
+
+    describe Client do
+      let(:resource)      { mock(RestClient::Resource) }
+      let(:client)        { Client.new(resource, "localhost", 9091) }
+
+      before do
+        {
+          "har"         => mock("resource[har]"),
+          "har/pageRef" => mock("resource[har/pageRef]"),
+          "whitelist"   => mock("resource[whitelist]"),
+          "blacklist"   => mock("resource[blacklist]"),
+          "limit"       => mock("resource[limit]"),
+          "headers"     => mock("resource[headers]"),
+          "hosts"       => mock("rescource[hosts]"),
+          "rewrite"     => mock("resource[rewrite]")
+        }.each do |path, mock|
+          resource.stub!(:[]).with(path).and_return(mock)
+        end
+      end
+
+      it "creates a named har" do
+        resource['har'].should_receive(:put).
+                        with(:initialPageRef => "foo").
+                        and_return('')
+
+        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").
+                        and_return(fixture("google.har"))
+
+        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"))
+
+        client.har.should be_kind_of(HAR::Archive)
+      end
+
+      it "creates a new page" do
+        resource['har/pageRef'].should_receive(:put).
+                                with :pageRef => "foo"
+
+        client.new_page "foo"
+      end
+
+      it "sets the blacklist" do
+        resource['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['whitelist'].should_receive(:put).
+                              with(:regex => "http://example.com", :status => 401)
+
+        client.whitelist(%r[http://example.com], 401)
+      end
+
+      it "sets the hosts list when adding new hosts" do
+        resource['hosts'].should_receive(:post).
+                          with('{"www.example.com":"127.0.0.1"}',
+                              :content_type => "application/json")
+
+        client.add_host('www.example.com', '127.0.0.1')
+      end
+
+      it "sets the hosts list when deleting hosts" do
+        resource['hosts'].should_receive(:post)
+        client.add_host('www.example.com', '127.0.0.1')
+        resource['hosts'].should_receive(:post)
+        client.add_host('subdomain.example.com', '192.168.1.1')
+
+        resource['hosts'].should_receive(:post).
+                          with('{"subdomain.example.com":"192.168.1.1"}',
+                              :content_type => "application/json")
+
+        client.remove_host('www.example.com')
+      end
+
+      it "sets the :downstream_kbps limit" do
+        resource['limit'].should_receive(:put).
+                          with('downstreamKbps' => 100)
+
+        client.limit(:downstream_kbps => 100)
+      end
+
+      it "sets the :upstream_kbps limit" do
+        resource['limit'].should_receive(:put).
+                          with('upstreamKbps' => 100)
+
+        client.limit(:upstream_kbps => 100)
+      end
+
+      it "sets the :latency limit" do
+        resource['limit'].should_receive(:put).
+                          with('latency' => 100)
+
+        client.limit(:latency => 100)
+      end
+
+      it "sets all limits" do
+        resource['limit'].should_receive(:put).
+                          with('latency' => 100, 'downstreamKbps' => 200, 'upstreamKbps' => 300)
+
+        client.limit(:latency => 100, :downstream_kbps => 200, :upstream_kbps => 300)
+      end
+
+      it "raises ArgumentError on invalid options" do
+        lambda { client.limit(:foo => 1) }.should raise_error(ArgumentError)
+        lambda { client.limit({})        }.should raise_error(ArgumentError)
+      end
+
+      it "sets headers" do
+        resource['headers'].should_receive(:post).with('{"foo":"bar"}', :content_type => "application/json")
+
+        client.headers(:foo => "bar")
+      end
+
+      it "rewrites URLs" do
+        resource['rewrite'].should_receive(:put).with(:matchRegex => "foo.*", :replace => "bar")
+
+        client.rewrite(/foo.*/, "bar")
+      end
+
+      context "#selenium_proxy" do
+        it "defaults to HTTP proxy only" do
+          proxy = client.selenium_proxy
+
+          proxy.http.should == "#{client.host}:#{client.port}"
+          proxy.ssl.should be_nil
+          proxy.ftp.should be_nil
+        end
+
+        it "allows multiple protocols" do
+          proxy = client.selenium_proxy(:http, :ssl)
+
+          proxy.http.should == "#{client.host}:#{client.port}"
+          proxy.ssl.should == "#{client.host}:#{client.port}"
+          proxy.ftp.should be_nil
+        end
+
+        it "allows disabling HTTP proxy" do
+          proxy = client.selenium_proxy(:ssl)
+
+          proxy.ssl.should == "#{client.host}:#{client.port}"
+          proxy.http.should be_nil
+          proxy.ftp.should be_nil
+        end
+
+        it "raises an error when a bad protocol is used" do
+          lambda {
+            client.selenium_proxy(:htp)
+          }.should raise_error
+        end
+      end
+    end
+
+  end
+end

data/spec/unit/webdriver_listener_spec.rb

@@ -0,0 +1,56 @@
+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) }
+      let(:url)      { "http://example.com" }
+
+      it 'creates a new har on navigate.to' do
+        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
+
+      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

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: browsermob-proxy2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Pinheiro
+- jari.bakken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: har
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for the BrowserMob Proxy REST API
+email:
+- pdpinheiro@gmail.com
+- jari.bakken@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- browsermob-proxy.gemspec
+- lib/browsermob-proxy.rb
+- lib/browsermob/proxy.rb
+- 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/pdpi/browsermob-proxy-rb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: browsermob-proxy-rb
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+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