browsermob-cli 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34f2f761077d90c5ab4d73320d6722ce1362073b
-  data.tar.gz: 2c71f18b9826d9ca584433570ded7a18f4b25ace
+  metadata.gz: adfc28fbfcdd6caa72ea973d330426f611ac09bd
+  data.tar.gz: a7591fb8cc870c3b37bd4e381dac73959d0dc90c
 SHA512:
-  metadata.gz: 5f1b2c97e42092be8842a290aa26ec6d7d0264d01e9fbd6532a73c67c0ffcfa7c044198d0c65e6e872b51a3aa1fe0d31d4a7d49b8c9ab18b5332e1a4d0f2a3e6
-  data.tar.gz: 761ee53a73117e6309c111fecca05862b5e964dd39888b959173dde6393d8a237b0f431ce67e2608d4606122bb4eddbc3c372e54ffb788a51e8a8c837f77909a
+  metadata.gz: 301edd6f17ff2f7c35b895d5ffb0c5e70d54eaea40edeceda722b382f495227cb7dd44be6eca576da76987f58f63fdab391072ae79fd61b955adffdae3c897bf
+  data.tar.gz: 46c8ddf64745c210ca973c54d383bf2461018818348ac6b84cace436617941c5715e5b05a4868d15829b641b7463a4d31af24b39246423207dd488935dc14526

data/README.md

@@ -1,8 +1,20 @@
 # BrowserMob CLI
 
-BrowserMob CLI os Rubygem to generate HAR files from command line. This will preview HAR files in the Browser as well as parse it in YAML. It works well for FirefoxDriver and ChromeDriver/GhostDriver are WIP
+BrowserMob CLI os Rubygem to generate HAR files from command line. This will preview HAR files in the Browser as well as parse it in YAML. It works well for FirefoxDriver and ChromeDriver/GhostDriver are WIP.
 
-BrowserMob CLI can do following things:
+If you are new to HAR(HTTP Archive) & BrowserMob Proxy then please read these couple of links
+* What is [HAR](https://www.maxcdn.com/one/visual-glossary/har-file/)
+* HAR [Spec](http://www.softwareishard.com/blog/har-12-spec/)
+* [BrowserMobProxy](http://bmp.lightbody.net/)
+
+HAR file can be used for
+* Calculate Load time.
+* Set/Get HTTP Headers during your tests
+* Capture performance data with HAR files.
+* Simulate network traffic and latency
+* Rewrite HTTP requests and response
+
+##BrowserMob CLI can do following things:
 
 * Download Browsermobproxy programatically and save it in /tmp
 
@@ -18,6 +30,10 @@ BrowserMob CLI can do following things:
 Before we start, please make sure you got following packages installed
 
 * wget
+* Java version > 1.7 and JAVA_HOME set in .bashrc or .zshrc. This is important otherwise browsermob proxy server won't start. OSX Mac user can set it using
+
+                  export JAVA_HOME=$(/usr/libexec/java_home)
+
 * Ruby > 1.9.3
 * Bundler
 * Install Har gem
@@ -41,11 +57,14 @@ Or install it yourself as:
 ## Usage
 
 #### Download BrowserMob Proxy
-Assuming that you don't have BrowserMob Proxy downloaded, then first thing we probaly need to download it and save it to your /tmp directory (Assuming /tmp has write access). It should do be done by
+Assuming that you don't have BrowserMob Proxy downloaded, then first thing we probaly need to download it and save it to your /tmp directory (Assuming /tmp has write access). Just run following command.
 
         $ browsermob-cli setup
 
-Now, you should have browsermob-proxy binary downloaded. We need to keep in the /tmp directory itself.
+Now, you should have browsermob-proxy binary downloaded in the /tmp directory itself.
+
+If that does't work, feel free to manually download BrowserMob proxy from [official website](https://bmp.lightbody.net/) Or from Github.
+Save it to /tmp/browsermob-proxy
 
 #### Generate HAR file for any URL
 We can generate HAR data for any url e.g (AOL website) by running
@@ -90,3 +109,22 @@ You can view generated YAML file with HAR data.
          browsermob-cli version              # Get the current version number
          browsermob-cli view_har_in_YAML     # Display HAR file in YML in your Editor
          browsermob-cli view_har_in_browser  # Open up browser and Preview HAR file. Press Ctl+C Once DONE...
+
+### Common issues
+
+* Server won't start
+Issue: Error message
+
+            unable to launch the server (rerun with :log => true to see process output) (BrowserMob::Proxy::Server::ServerDiedError)
+
+There may be few reason.
+
+1] It uses port 7676. It may be in use. Clear the port by running following command
+
+           $ kill -9 $(lsof -i tcp:3000 -t)
+
+It works for Mac OSX.
+
+2] Java version is below 1.7. Update your JAVA version.
+
+3]  Make sure $JAVA_HOME set correctly, for mac, it’s “export JAVA_HOME=$(/usr/libexec/java_home)”.

data/lib/browsermob/cli/browsermob.rb

@@ -20,9 +20,9 @@ module BrowserMob
 
       def download_browsermob_proxy
         FileUtils.rm_rf('/tmp/browsermob-proxy') if Dir.exists?("/tmp/browsermob-proxy")
-        system('cd /tmp && wget https://github.com/downloads/webmetrics/browsermob-proxy/browsermob-proxy-2.0-beta-6-bin.zip')
-        system("cd /tmp && unzip browsermob-proxy-2.0-beta-6-bin.zip")
-        system("mv /tmp/browsermob-proxy-2.0-beta-6 /tmp/browsermob-proxy/")
+        system('cd /tmp && wget https://github.com/lightbody/browsermob-proxy/releases/download/browsermob-proxy-2.1.0-beta-4/browsermob-proxy-2.1.0-beta-4-bin.zip')
+        system("cd /tmp && unzip browsermob-proxy-2.1.0-beta-4-bin.zip")
+        system("mv /tmp/browsermob-proxy-2.1.0-beta-4 /tmp/browsermob-proxy/")
         system("chmod +x /tmp/browsermob-proxy/bin/browsermob-proxy")
       end
 

data/lib/browsermob/cli/main.rb

@@ -45,6 +45,11 @@ module BrowserMob
       def view_har_in_YAML
         system("open /tmp/traffic.yml")
       end
+
+      desc 'kill_port', 'Clear Port used by BrowserMob proxy'
+      def port_clearance
+        system('kill -9 $(lsof -i tcp:7676 -t)')
+      end
     end
   end
 end

data/lib/browsermob/cli/version.rb

@@ -1,5 +1,5 @@
 module BrowserMob
   module CLI
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browsermob-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Shashikant86
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor