speedos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6091d26639cdfd952252c65bcc869c3d8d0dcdf5
+  data.tar.gz: 844e13df23e11dc9b9ed5c1d7aff2eb6cc5a61d7
+SHA512:
+  metadata.gz: 42b8294b4404ea840e51d4746b3eed66c77d42aa4d4cf9249923d39fcc6b570f20d8323c6060774b85d1b1b643ec8f5959a0feb79efb447b00c43f0222b86315
+  data.tar.gz: 528b4604ca39d911f935ed7e7a89dbf39eb9ac71b33c286def8ca96c0a0b88a93de004272e33e87b0b1cb2ab88d505f9b33fc37fca3bfcace38aae1ac2ee4aa2

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+# NOTE: Don't do this! See update below.
+gem 'rspec'
+gem 'database_cleaner'

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    speedos (0.0.1)
+      browsermob-proxy (= 0.1.1)
+      capybara (= 2.1.0)
+      faker (= 1.1.2)
+      logger (= 1.2.8)
+      mongoid (= 3.1.4)
+      selenium-webdriver (= 2.33)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    browsermob-proxy (0.1.1)
+      childprocess
+      har
+      multi_json (~> 1.0)
+      rest-client
+    builder (3.0.4)
+    capybara (2.1.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    database_cleaner (1.0.1)
+    diff-lcs (1.2.4)
+    faker (1.1.2)
+      i18n (~> 0.5)
+    ffi (1.9.0)
+    har (0.0.9)
+      jschematic (>= 0.1.0)
+      json
+      launchy (>= 0.3.7)
+    i18n (0.6.4)
+    jschematic (0.1.0)
+      addressable
+    json (1.8.0)
+    launchy (2.3.0)
+      addressable (~> 2.3)
+    logger (1.2.8)
+    mime-types (1.23)
+    mini_portile (0.5.1)
+    mongoid (3.1.4)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.5.0)
+    multi_json (1.7.7)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    origin (1.1.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.3)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.33.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    tzinfo (0.3.37)
+    websocket (1.0.7)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  rspec
+  speedos!

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2012-2013 SimplyBusiness
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+NOTE: Third-party libraries and softwares inside /bin/ are subject to their own licences (refer to LICENCE.txt within the third-party folder)

data/README.md

@@ -0,0 +1,104 @@
+# Speedos
+
+## What is Speedos?
+Speedos incorporates [BrowserMob Proxy](http://bmp.lightbody.net) along with [Capybara](https://github.com/jnicklas/capybara), recording the web traffic and time taken to load all elements on each of the pages within a user journey. The aim is to identify any performance related issues, such as specific items that take a long time to load on page.
+
+## Installation
+Put speedos on your Gemfile
+
+	gem 'speedos'
+
+Or, install it via rubygem
+
+	$ gem install speedos
+
+The easiest and quickest way to get you started is to run the init script
+
+	$ speedos init
+
+and it will generate following file structure for you:
+
+	├── .irbrc
+	├── Rakefile
+	├── config
+	│   ├── initializer.rb
+	│   └── mongoid.yml
+	├── helpers
+	├── log
+	└── scripts
+
+## Configuration
+
+### Mongoid
+It is essential to let speedos know the location of your mongoid.yml by...
+
+	Speedos::Configuration.load_mongoid_config('/location/to/my/mongoid.yml')
+
+Refer to mongoid documentation for the correct format of mongoid.yml <http://mongoid.org/en/mongoid/docs/installation.html>
+
+### Logger
+By default, speedos will output all the logging using STDOUT, you can override this method by either
+
+	# pass in a Logger Object
+	Speedos::Log.logger = Logger.new(…)
+
+or
+
+	# the location where you want the log to be saved
+	Speedos::Log.logger = "/location/to/desire/log/location"
+
+## Create your own script
+you should put all your script under `/scripts`
+
+	require 'speedos'
+
+	Speedos::Performance.test do |page|
+	  page.is 'simplybusiness-main-page' do
+	    # page.driver is a capybara session instance
+	    page.driver.visit   'https://www.simplybusiness.co.uk/'
+	    page.driver.fill_in 'ctaText', with: "IT contractor"
+	  end
+
+	  page.is 'business-insurance-page' do
+	    page.driver.find_button('ctaBtn').click
+	  end
+	end
+
+## To execute the scripts
+If you use `init` to generate your structure, you should get `Rakefile` created. And it will create rake task for all the scripts you have created in `/scripts`
+
+	└── scripts
+	    ├── earth
+	    │   └── grass.rb
+	    ├── human.rb
+	    └── sky
+	        ├── cloud.rb
+	        └── rain.rb
+
+For example, if you have above scripts structure, then you should get the following rake tasks created
+
+	$ rake -T
+
+	rake earth:grass  # run the script located in /Users/pwu/test/scripts/earth/grass.rb
+	rake human        # run the script located in /Users/pwu/test/scripts/human.rb
+	rake sky:cloud    # run the script located in /Users/pwu/test/scripts/sky/cloud.rb
+	rake sky:rain     # run the script located in /Users/pwu/test/scripts/sky/rain.rb
+
+
+## Report
+You can access the performance data via `Speedos::Record` object
+
+	$ irb
+
+	> Speedos::Record.first.pages
+	#=> [Entries: ["simplybusiness-main-page"], Entries: ["google-result-page"]]
+
+	> Speedos::Record.first.pages.first
+	#=> Entries: ["simplybusiness-main-page"]
+
+	> Speedos::Record.first.pages.first.total_load_time
+	#=> 3828.0
+	# which is the total loading time for the page in milliseconds
+
+
+

data/bin/browsermob-proxy-2.0-beta-8/LICENSE.txt

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/bin/browsermob-proxy-2.0-beta-8/README.md

@@ -0,0 +1,197 @@
+BrowserMob Proxy
+================
+
+BrowserMob Proxy is a simple utility that makes it easy to capture performance data from browsers, typically written using automation toolkits such as Selenium and Watir.
+
+Features
+--------
+
+The proxy is programmatically controlled via a REST interface or by being embedded directly inside Java-based programs and unit tests. It captures performance data the [HAR format](http://groups.google.com/group/http-archive-specification). It addition it also can actually control HTTP traffic, such as:
+
+ - blacklisting and whitelisting certain URL patterns
+ - simulating various bandwidth and latency
+ - remapping DNS lookups
+ - flushing DNS caching
+ - controlling DNS and request timeouts
+ - automatic BASIC authorization
+
+REST API
+--------
+
+To get started, first start the proxy by running `browsermob-proxy` or `browsermob-proxy.bat` in the bin directory:
+
+    $ sh browsermob-proxy -port 9090
+    INFO 05/31 03:12:48 o.b.p.Main           - Starting up...
+    2011-05-30 20:12:49.517:INFO::jetty-7.3.0.v20110203
+    2011-05-30 20:12:49.689:INFO::started o.e.j.s.ServletContextHandler{/,null}
+    2011-05-30 20:12:49.820:INFO::Started SelectChannelConnector@0.0.0.0:9090
+
+Once started, there won't be an actual proxy running until you create a new proxy. You can do this by POSTing to /proxy:
+
+    [~]$ curl -X POST http://localhost:9090/proxy
+    {"port":9091}
+
+or optionally specify your own port:
+
+    [~]$ curl -X POST -d 'port=9099' http://localhost:9090/proxy
+    {"port":9099}
+
+Once that is done, a new proxy will be available on the port returned. All you have to do is point a browser to that proxy on that port and you should be able to browser the internet. The following additional APIs will then be available:
+
+ - PUT /proxy/[port]/har - creates a new HAR attached to the proxy and returns the HAR content if there was a previous HAR. Supports the following parameters:
+  - initialPageRef - the string name of the first page ref that should be used in the HAR. Defaults to "Page 1".
+  - captureHeaders - Boolean, capture headers
+  - captureContent - Boolean, capture content bodies
+  - captureBinaryContent - Boolean, capture binary content
+ - PUT /proxy/[port]/har/pageRef - starts a new page on the existing HAR. Supports the following parameters:
+  - pageRef - the string name of the first page ref that should be used in the HAR. Defaults to "Page N" where N is the next page number.
+ - PUT /proxy/[port]/har/pageRef - creates a new HAR attached to the proxy and returns the HAR content if there was a previous HAR
+ - DELETE /proxy/[port] - shuts down the proxy and closes the port
+ - GET /proxy/[port]/har - returns the JSON/HAR content representing all the HTTP traffic passed through the proxy
+ - PUT /proxy/[port]/whitelist - Sets a list of URL patterns to whitelist. Takes the following parameters:
+  - regex - a comma separated list of regular expressions
+  - status - the HTTP status code to return for URLs that do not match the whitelist
+ - PUT /proxy/[port]/blacklist - Set a URL to blacklist. Takes the following parameters:
+  - regex - the blacklist regular expression
+  - status - the HTTP status code to return for URLs that are blacklisted
+ - PUT /proxy/[port]/limit - Limit the bandwidth through the proxy. Takes the following parameters:
+  - downstreamKbps - Sets the downstream kbps
+  - upstreamKbps - Sets the upstream kbps
+  - latency - Add the given latency to each HTTP request
+  - enable - (true/false) a boolean that enable bandwidth limiter. By default the limit is disabled, although setting any of the properties above will implicitly enable throttling
+  - payloadPercentage - a number ]0, 100] specifying what percentage of data sent is payload. e.g. use this to take into account overhead due to tcp/ip.
+  - maxBitsPerSecond - The max bits per seconds you want this instance of StreamManager to respect.
+ - POST /proxy/[port]/headers - Set and override HTTP Request headers. For example setting a custom User-Agent.
+  - Payload data should be json encoded set of headers (not url-encoded)
+ - POST /proxy/[port]/hosts - Overrides normal DNS lookups and remaps the given hosts with the associated IP address
+  - Payload data should be json encoded set of name/value pairs (ex: {"example.com": "1.2.3.4"})
+ - POST /proxy/[port]/auth/basic/[domain] - Sets automatic basic authentication for the specified domain
+  - Payload data should be json encoded username and password name/value pairs (ex: {"username": "myUsername", "password": "myPassword"}
+ - PUT /proxy/[port]/wait - wait till all request are being made
+  - quietPeriodInMs - Sets quiet period in milliseconds
+  - timeoutInMs - Sets timeout in milliseconds 
+ - PUT /proxy/[port]/timeout - Handles different proxy timeouts. Takes the following parameters:
+  - requestTimeout - request timeout in milliseconds
+  - readTimeout - read timeout in milliseconds. Which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout.
+  - connectionTimeout - Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. 
+  - dnsCacheTimeout - Sets the maximum length of time that records will be stored in this Cache. A negative value disables this feature (that is, sets no limit).
+ - PUT /proxy/[port]/rewrite - Redirecting URL's
+  - matchRegex - a matching URL regular expression
+  - replace - replacement URL
+ - PUT /proxy/[port]/retry - Setting the retry count
+  - retrycount - the number of times a method will be retried
+ - DELETE /proxy/[port]/dns/cache - Empties the Cache.
+
+For example, once you've started the proxy you can create a new HAR to start recording data like so:
+
+    [~]$ curl -X PUT -d 'initialPageRef=Foo' http://localhost:8080/proxy/9091/har
+
+Now when traffic goes through port 9091 it will be attached to a page reference named "Foo". Consult the HAR specification for more info on what a "pageRef" is. You can also start a new pageRef like so:
+
+    [~]$ curl -X PUT -d 'pageRef=Bar' http://localhost:8080/proxy/9091/har/pageRef
+
+That will ensure no more HTTP requests get attached to the old pageRef (Foo) and start getting attached to the new pageRef (Bar). You can also get the HAR content at any time like so:
+
+    [~]$ curl http://localhost:8080/proxy/9091/har
+
+Sometimes you will want to route requests through an upstream proxy server. In this case specify your proxy server by adding the httpProxy parameter to your create proxy request:
+
+    [~]$ curl -X POST http://localhost:9090/proxy?httpProxy=yourproxyserver.com:8080
+    {"port":9091}
+
+Alternatively, you can specify the upstream proxy config for all proxies created using the standard JVM [system properties for HTTP proxies](http://docs.oracle.com/javase/6/docs/technotes/guides/net/proxies.html).
+Note that you can still override the default upstream proxy via the POST payload, but if you omit the payload the JVM
+system properties will be used to specify the upstream proxy.
+
+*TODO*: Other REST APIs supporting all the BrowserMob Proxy features will be added soon.
+
+Embedded Mode
+-------------
+
+If you're using Java and Selenium, the easiest way to get started is to embed the project directly in your test. First, you'll need to make sure that all the dependencies are imported in to the project. You can find them in the *lib* directory. Or, if you're using Maven, you can add this to your pom:
+
+    <dependency>
+        <groupId>net.lightbody.bmp</groupId>
+        <artifactId>browsermob-proxy</artifactId>
+        <version>LATEST_VERSION (ex: 2.0-beta-8)</version>
+        <scope>test</scope>
+    </dependency>
+
+Once done, you can start a proxy using `net.lightbody.bmp.proxy.ProxyServer`:
+
+    ProxyServer server = new ProxyServer(9090);
+    server.start();
+
+This class supports every feature that the proxy supports. In fact, the REST API is a subset of the methods exposed here, so new features will show up here before they show up in the REST API. Consult the Javadocs for the full API.
+
+If your project already defines a Selenium dependency then you may want to exclude the version that browsermob-proxy pulls in, like so:
+
+    <dependency>
+        <groupId>net.lightbody.bmp</groupId>
+        <artifactId>browsermob-proxy</artifactId>
+        <version>LATEST_VERSION (ex: 2.0-beta-8)</version>
+        <scope>test</scope>
+        <exclusions>
+            <exclusion>
+                <groupId>org.seleniumhq.selenium</groupId>
+                <artifactId>selenium-api</artifactId>
+            </exclusion>
+        </exclusions>
+    </dependency>
+
+
+Using With Selenium
+-------------------
+
+You can use the REST API with Selenium however you want. But if you're writing your tests in Java and using Selenium 2, this is the easiest way to use it:
+
+    // start the proxy
+    ProxyServer server = new ProxyServer(4444);
+    server.start();
+
+    // get the Selenium proxy object
+    Proxy proxy = server.seleniumProxy();
+
+    // configure it as a desired capability
+    DesiredCapabilities capabilities = new DesiredCapabilities();
+    capabilities.setCapability(CapabilityType.PROXY, proxy);
+
+    // start the browser up
+    WebDriver driver = new FirefoxDriver(capabilities);
+
+    // create a new HAR with the label "yahoo.com"
+    server.newHar("yahoo.com");
+
+    // open yahoo.com
+    driver.get("http://yahoo.com");
+
+    // get the HAR data
+    Har har = server.getHar();
+
+
+HTTP Request Manipulation
+-------------------
+
+While not yet available via the REST interface, you can manipulate the requests like so:
+
+    server.addRequestInterceptor(new RequestInterceptor() {
+        @Override
+        public void process(BrowserMobHttpRequest request) {
+            request.getMethod().removeHeaders("User-Agent");
+            request.getMethod().addHeader("User-Agent", "Bananabot/1.0");
+        }
+    });
+
+We will soon be adding support for this advanced capability in the REST interface as well, using JavaScript snippets that can be posted as the interceptor code.
+
+SSL Support
+-----------
+
+While the proxy supports SSL, it requires that a Certificate Authority be installed in to the browser. This allows the browser to trust all the SSL traffic coming from the proxy, which will be proxied using a classic man-in-the-middle technique. IT IS CRITICAL THAT YOU NOT INSTALL THIS CERTIFICATE AUTHORITY ON A BROWSER THAT IS USED FOR ANYTHING OTHER THAN TESTING.
+
+If you're doing testing with Selenium, you'll want to make sure that the browser profile that gets set up by Selenium not only has the proxy configured, but also has the CA installed. Unfortuantely, there is no API for doing this in Selenium, so you'll have to solve it uniquely for each browser type. We hope to make this easier in upcoming releases.
+
+NodeJS Support
+--------------
+
+NodeJS bindings for browswermob-proxy are available [here](https://github.com/zzo/browsermob-node).  Built-in support for [Selenium][http://seleniumhq.com] or use [CapserJS-on-PhantomJS](http://casperjs.org) or anything else to drive traffic for HAR generation.

data/bin/browsermob-proxy-2.0-beta-8/README.txt

@@ -0,0 +1,3 @@
+Please see README.md (in Markdown format) or view it at:
+
+https://github.com/lightbody/browsermob-proxy