browsermob-proxy 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e808535e52ce4cd5ddce8c18fe12c5a20e894be1
-  data.tar.gz: f855084dea71862621514fc59a3ec563d82082a0
+  metadata.gz: 12560fbaf3be7cee85565cdafc44429b393a3ca6
+  data.tar.gz: 2261e5b2be1871c539351af9b4cbd6a3beaa6591
 SHA512:
-  metadata.gz: baf0f7f29b3d8956778d9fd78f253468ff98ff57388fb63cf56c47bbe820a91a35848af43eef5ccdea65714f706035c2e7c98e37c56092056e1988c495b47f3f
-  data.tar.gz: f6461f9495e7288a82b07d0ab1b781bfb9a6af646c0dde04c78a0241ce1dc59a0b8b218e670d231e4464cb3a5567b91fce3abec8d366ea972baae5ef25726a5a
+  metadata.gz: 45fbe33909820112dc59664407358a01ad7b7600fe25558ff8db3623ca4beb3c3a003c85aacdbb873376c64e05235621c267fd6361fdf3f3c4addd88079a773b
+  data.tar.gz: 3d84b98806736425abefaebaf11e2805a80d4e02dff4aaa4c906b6395c5b6db457fba722e1fe2cba8b945d1f7f80fb7514a551e2f60556d46c7cfe9fa47892b0

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-.ruby-version
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -3,9 +3,9 @@ rvm:
   - 2.0.0
 before_script:
   - sudo apt-get install -y unzip
-  - curl -k -L -O https://s3-us-west-1.amazonaws.com/lightbody-bmp/browsermob-proxy-2.0-beta-8-bin.zip
-  - unzip browsermob-proxy-2.0-beta-8-bin.zip
-  - export BROWSERMOB_PROXY_HOME=`pwd`/browsermob-proxy-2.0-beta-8
+  - curl -k -L -O https://s3-us-west-1.amazonaws.com/lightbody-bmp/browsermob-proxy-2.0-beta-9-bin.zip
+  - unzip browsermob-proxy-2.0-beta-9-bin.zip
+  - export BROWSERMOB_PROXY_HOME=`pwd`/browsermob-proxy-2.0-beta-9
   - sudo chmod +x $BROWSERMOB_PROXY_HOME/bin/browsermob-proxy
   - sh -e /etc/init.d/xvfb start
   - export DISPLAY=:99

data/README.md

@@ -38,7 +38,7 @@ driver.quit
 
 With event listener:
 
-``` ruby
+```ruby
 require 'selenium/webdriver'
 require 'browsermob/proxy'
 require 'browsermob/proxy/webdriver_listener'
@@ -65,7 +65,7 @@ The HAR gem includes a HAR viewer. After running the code above, you can view th
 See also
 --------
 
-* http://proxy.browsermob.com/
+* http://bmp.lightbody.net/
 * https://github.com/lightbody/browsermob-proxy
 
 Note on Patches/Pull Requests

data/lib/browsermob/proxy/client.rb

@@ -93,11 +93,19 @@ module BrowserMob
         @resource['whitelist'].put :regex => regex, :status => status_code
       end
 
+      def clear_whitelist
+        @resource['whitelist'].delete
+      end
+
       def blacklist(regexp, status_code)
         regex = Regexp === regexp ? regexp.source : regexp.to_s
         @resource['blacklist'].put :regex => regex, :status => status_code
       end
 
+      def clear_blacklist
+        @resource['blacklist'].delete
+      end
+
       def header(hash)
         @resource['headers'].post hash.to_json, :content_type => "application/json"
       end
@@ -108,6 +116,38 @@ module BrowserMob
         @resource["auth/basic/#{domain}"].post data.to_json, :content_type => "application/json"
       end
 
+      #
+      # Specify timeouts that will be used by a proxy
+      # (see README of browsermob-proxy itself for more info about what they mean)
+      #
+      # @param timeouts [Hash]   options that specify desired timeouts (in seconds)
+      # @option timeouts [Numeric] :request    request timeout
+      # @option timeouts [Numeric] :read       read timeout
+      # @option timeouts [Numeric] :connection connection timeout
+      # @option timeouts [Numeric] :dns_cache  dns cache timeout
+      #
+
+      TIMEOUTS = {
+        request: :requestTimeout,
+        read: :readTimeout,
+        connection: :connectionTimeout,
+        dns_cache: :dnsCacheTimeout
+      }
+
+      def timeouts(timeouts = {})
+        params = {}
+
+        timeouts.each do |key, value|
+          unless TIMEOUTS.member?(key)
+            raise ArgumentError, "invalid key: #{key.inspect}, should belong to: #{TIMEOUTS.keys.inspect}"
+          end
+
+          params[TIMEOUTS[key]] = (value * 1000).to_i
+        end
+
+        @resource['timeout'].put params
+      end
+
       #
       # Override normal DNS lookups (remap the given hosts with the associated IP address).
       #

data/lib/browsermob/proxy/version.rb

@@ -1,5 +1,5 @@
 module BrowserMob
   module Proxy
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/spec/e2e/selenium_spec.rb

@@ -86,6 +86,15 @@ describe "Proxy + WebDriver" do
       driver.get url_for('2.html')
       proxy.har.entries.first.response.status.should == 404
     end
+
+    it "can be cleared" do
+      proxy.new_har('whitelist')
+      proxy.whitelist('foo\.bar\.com', 404)
+
+      proxy.clear_whitelist
+      driver.get url_for('2.html')
+      proxy.har.entries.first.response.status.should_not == 404
+    end
   end
 
   describe 'blacklist' do
@@ -105,6 +114,24 @@ describe "Proxy + WebDriver" do
 
       wait.until { driver.title == '2' }
     end
+
+    it "can be cleared" do
+      proxy.new_har('blacklist')
+
+      dest = url_for('1.html')
+      proxy.blacklist(Regexp.quote(dest), 404)
+
+      proxy.clear_blacklist
+      driver.get dest
+
+      proxy.har.entries.first.response.status.should_not == 404
+    end
+  end
+
+  it 'should set timeouts' do
+    proxy.timeouts(read: 0.001)
+    driver.get url_for('slow')
+    wait.until { driver.title == 'Problem loading page' } # This title appears in Firefox
   end
 
   it "should set headers" do

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ module BrowserMob
   module Proxy
     module SpecHelper
       def self.httpd
-        @httpd ||= HttpServer.new(Rack::File.new(fixture_dir))
+        @httpd ||= HttpServer.new(SpecApp.new(Rack::File.new(fixture_dir)))
       end
 
       def self.fixture_dir
@@ -68,6 +68,22 @@ module BrowserMob
         end
       end
 
+      class SpecApp
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          case env['REQUEST_PATH']
+          when '/slow'
+            sleep 0.1
+            [200, {}, []]
+          else
+            @app.call(env)
+          end
+        end
+
+      end
     end
   end
 end

data/spec/unit/client_spec.rb

@@ -18,7 +18,8 @@ module BrowserMob
           "limit"                => double("resource[limit]"),
           "headers"              => double("resource[headers]"),
           "auth/basic/#{DOMAIN}" => double("resource[auth/basic/#{DOMAIN}]"),
-          "hosts"                => double("resource[hosts]")
+          "hosts"                => double("resource[hosts]"),
+          "timeout"              => double("resource[timeout]")
         }.each do |path, mock|
           resource.stub(:[]).with(path).and_return(mock)
         end
@@ -120,6 +121,12 @@ module BrowserMob
         client.blacklist(%r[http://example.com], 401)
       end
 
+      it "clears the blacklist" do
+        resource['blacklist'].should_receive(:delete)
+
+        client.clear_blacklist
+      end
+
       describe 'whitelist' do
         it "supports a string" do
           resource['whitelist'].should_receive(:put).
@@ -141,6 +148,12 @@ module BrowserMob
 
           client.whitelist([%r{http://example\.com/1/.+}, 'http://example\.com/2/.+'], 401)
         end
+
+        it "clears the whitelist" do
+          resource['whitelist'].should_receive(:delete)
+
+          client.clear_whitelist
+        end
       end
 
       it "sets the :downstream_kbps limit" do
@@ -189,6 +202,28 @@ module BrowserMob
         client.basic_authentication(DOMAIN, user, password)
       end
 
+      describe 'timeouts' do
+        it 'supports valid options' do
+          resource['timeout'].should_receive(:put).with(
+            :requestTimeout    => 1,
+            :readTimeout       => 2000,
+            :connectionTimeout => 3000,
+            :dnsCacheTimeout   => 6_000_000
+          )
+
+          client.timeouts(
+            :request    => 0.001,
+            :read       => 2,
+            :connection => 3,
+            :dns_cache  => 6000
+          )
+        end
+
+        it 'raises ArgumentError when invalid options are passed' do
+          expect { client.timeouts(:invalid => 2) }.to raise_error(ArgumentError, "invalid key: :invalid, should belong to: [:request, :read, :connection, :dns_cache]")
+        end
+      end
+
       it 'sets mapped dns hosts' do
         resource['hosts'].should_receive(:post).with(%({"#{DOMAIN}":"1.2.3.4"}),
                                                      :content_type => "application/json")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browsermob-proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - jari.bakken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-09 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: browsermob-proxy-rb
-rubygems_version: 2.1.10
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Ruby client for the BrowserMob Proxy REST API
@@ -201,4 +201,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/client_spec.rb
 - spec/unit/webdriver_listener_spec.rb
-has_rdoc: