browsermob-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69748c44c82cfae1b9a39e379ce89fbbcb7b24cc
+  data.tar.gz: b278c6b25bfbbd2c392dd0750795b4d68f0188f5
+SHA512:
+  metadata.gz: 68623a0bd0d3aa936494651dd7ac9308d35a179f8341633ecc0eac66d46d0aa2ff0b0129511e6373466e73eef54c28580db1184dcdda796a03aad7def014542a
+  data.tar.gz: 3897be0c8867450c79b749d8c2c93d6d07e2df35cb0fbe5b9b2bf817096b9c82c8780d81752b8e41abc29b814285544258089b6960ba83637471c15d7f2bf8e8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in browsermob-cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Shashikant Jagtap
+
+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.

data/README.md

@@ -0,0 +1,89 @@
+# 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 can do following things:
+
+* Download Browsermobproxy programatically and save it in /tmp
+
+* Genarate and Preview Har file from command line by passing URL
+
+* Genarate and Preview Har file from command line by passing URL and adding user actions
+
+* List out request urls
+
+
+## Installation
+
+Before we start, please make sure you got following packages installed
+
+* wget
+* Ruby > 1.9.3
+* Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'browsermob-cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install browsermob-cli
+
+## 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
+
+        $ browsermob-cli setup
+
+Now, you should have browsermob-proxy binary downloaded. We need to keep in the /tmp directory itself.
+
+#### Generate HAR file for any URL
+We can generate HAR data for any url e.g (AOL website) by running
+
+         $ browsermob-cli show_har http://www.aol.co.uk
+
+After running this command, you should see following
+
+* Firefox Opened up with AOL homepage within BrowserMob proxy
+* All request URLS printed on console
+* HAR file saved to /tmp/traffic.har
+* HAR data parsed in YAML format and saved to /tmp/traffic.yml
+* WEBrick server starts and open up HAR data to preview
+
+#### Generate HAR file for any URL when user clicks on the page
+We can generate HAR data for any url e.g (BBC website) and passing CSS Selector
+where you want to click
+
+         $ browsermob-cli show_har_click http://www.bbc.co.uk/blogs --locator ".rsp-img"
+
+After running this command, you should see following
+
+* Firefox Opened up with BBC blog homepage within BrowserMob proxy and clicked on image
+* All request URLS printed on console
+* HAR file saved to /tmp/traffic.har
+* HAR data parsed in YAML format and saved to /tmp/traffic.yml
+* WEBrick server starts and open up HAR data to preview
+
+#### View YAML File Or Preview in Browser
+You can view generated YAML file with HAR data.
+
+        $ browsermob-cli view_har_in_YAML
+        $ browsermob-cli view_har_in_browser
+#### Usage command
+
+        $ browsermob-cli
+        Commands:
+         browsermob-cli help [COMMAND]       # Describe available commands or one specific command
+         browsermob-cli setup                # Get Browsermob Proxy from Internet
+         browsermob-cli show_har URL         # Get list of all requests
+         browsermob-cli show_har_click URL   # Get list of all requests when clicked on Locator
+         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...

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'uri'
+require 'cgi'
+require 'capybara'
+require 'capybara/dsl'
+require 'rspec'
+require 'capybara/rspec'
+require 'rspec/expectations'
+require 'selenium/webdriver'
+require 'browsermob/proxy'
+require 'browsermob/proxy/webdriver_listener'
+include RSpec::Matchers
+require 'json'
+require "har"
+require "webrick"
+require "launchy"
+require 'tempfile'
+require 'fileutils'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/browsermob-cli

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+lib_dir = File.expand_path("../lib", File.dirname(__FILE__))
+$:.unshift lib_dir unless $:.include?(lib_dir)
+
+require 'browsermob/cli/version'
+require 'browsermob/cli/browsermob'
+require 'browsermob/cli/main'
+
+BrowserMob::CLI::Main.start(ARGV)

data/browsermob-cli.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'browsermob/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'browsermob-cli'
+  spec.version       = BrowserMob::CLI::VERSION
+  spec.authors       = ['Shashikant86']
+  spec.email         = ['shashikant.jagtap@aol.co.uk']
+  spec.summary       = 'BrowserMob Proxy CLI to Generate HAR and Capture Traffic'
+  spec.description   = 'This Rubygem is CLI interface to check network traffic using HAR. It will generate HAR file preview in browser and YAML'
+  spec.homepage      = "https://github.com/Shashikant86/browsermob-cli"
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "thor", '~> 0'
+  spec.add_development_dependency 'bundler', '~> 0'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'selenium-webdriver', '~> 0'
+  spec.add_development_dependency 'capybara', '~> 0'
+  spec.add_development_dependency 'poltergeist', '~> 0'
+  spec.add_development_dependency 'browsermob-proxy', '~> 0'
+  spec.add_development_dependency 'webrick', '~> 0'
+  spec.add_development_dependency 'launchy', '~> 0'
+  spec.add_runtime_dependency 'addressable', '~> 0'
+end

data/lib/browsermob/cli/browsermob.rb

@@ -0,0 +1,122 @@
+require 'selenium-webdriver'
+require 'browsermob/proxy'
+require 'json'
+require 'browsermob/cli/har_parser'
+require "har"
+require "webrick"
+require "launchy"
+require 'tempfile'
+require 'fileutils'
+
+module BrowserMob
+  module CLI
+    class BrowserMobSetup
+
+      attr_accessor :url
+
+      def initialize
+        @url = url
+      end
+
+      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("chmod +x /tmp/browsermob-proxy/bin/browsermob-proxy")
+      end
+
+      def browsermob_setting
+        binary = "/tmp/browsermob-proxy/bin/browsermob-proxy"
+        server = BrowserMob::Proxy::Server.new(binary, port: 7676)
+        server.start
+        server.create_proxy
+       end
+
+      def firefox_profile_setup
+        firefox_profile_setup = Selenium::WebDriver::Firefox::Profile.new
+        firefox_profile_setup.proxy = @proxy.selenium_proxy
+        firefox_profile_setup
+      end
+
+      def chrome_profile_setup
+        proxy = Selenium::WebDriver::Proxy.new(:http => @proxy.selenium_proxy.http)
+        @chrome_caps = Selenium::WebDriver::Remote::Capabilities.chrome(:proxy => proxy)
+        @driver = Selenium::WebDriver.for(:chrome, :desired_capabilities => caps)
+      end
+
+      def setup
+        File.delete("/tmp/traffic.har") if File.exist?("/tmp/traffic.har")
+        File.delete("/tmp/traffic.yml") if File.exist?("/tmp/traffic.yml")
+        @proxy = browsermob_setting
+        @driver = Selenium::WebDriver.for :firefox, profile: firefox_profile_setup
+        # @driver = Selenium::WebDriver.for(:chrome, :desired_capabilities => @chrome_caps)
+      end
+
+      def teardown
+        @driver.quit
+        @proxy.close
+      end
+
+      def convert_to_yml
+       yml = HarParser.new
+       yml.parse_har_file
+      end
+
+      def user_actions(url, options = {})
+        if options.empty? == true
+          @driver.get url
+      else
+      @driver.find_element(css: options[:source]).click
+      sleep 2
+      end
+      end
+
+      def show_har_data_browser
+        exec("bundle exec har /tmp/traffic.har")
+      end
+
+      def capture_traffic(url)
+        setup
+        @proxy.new_har "google"
+        @driver.get url
+        har = @proxy.har
+        all_requests = Proc.new do
+          har.entries.each do |entry|
+          puts "=====Request URL======\n"
+          puts entry.request.url
+          end
+        end
+        all_requests.call
+        @har_file = File.new("/tmp/traffic.har",  "w+")
+        @proxy.new_har.save_to @har_file
+        har.save_to @har_file
+        teardown
+        convert_to_yml
+        show_har_data_browser
+      end
+
+      def capture_traffic_with_click(url, selector)
+        setup
+        @proxy.new_har "google"
+        @driver.get url
+        @driver.find_element(css: selector).click
+        sleep 3
+        har = @proxy.har
+        all_requests = Proc.new do
+          har.entries.each do |entry|
+          puts "=====Request URL======\n"
+          puts entry.request.url
+          end
+        end
+        all_requests.call
+        @har_file = File.new("/tmp/traffic.har",  "w+")
+        @proxy.new_har.save_to @har_file
+        har.save_to @har_file
+        teardown
+        convert_to_yml
+        show_har_data_browser
+      end
+    end
+  end
+end

data/lib/browsermob/cli/har_parser.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'addressable/uri'
+require 'json'
+require 'yaml'
+require 'tempfile'
+module BrowserMob
+  module CLI
+    class HarParser
+      def initialize
+        @harfile = File.open("/tmp/traffic.har")
+      end
+
+        def parse_har_file
+        archive = nil
+        begin
+          archive = JSON.parse File.read(@harfile)
+        rescue => err
+          puts "could not pase archive file: #{err}"
+          exit 1
+        end
+        entries = archive['log']['entries']
+        hosts = entries.map do |entry|
+          Addressable::URI.parse(entry['request']['url']).host
+        end
+        output = hosts.uniq.map do |host|
+          urls = entries.map do |entry|
+            next unless entry['request']['url'].match("http://#{host}/")
+            {
+              entry['request']['url'] => entry['timings']
+            }
+          end
+          urls.reject!(&:nil?)
+          { host => urls }
+        end
+
+        data = File.open("/tmp/traffic.yml", 'w')
+        data << output.to_yaml
+        # puts output.to_a
+      end
+    end
+ end
+end

data/lib/browsermob/cli/main.rb

@@ -0,0 +1,50 @@
+require 'thor'
+require 'browsermob/cli/version'
+require 'browsermob/cli/browsermob'
+
+module BrowserMob
+  module CLI
+    class Main < Thor
+      include Thor::Actions
+
+      map %w(-v -V --version) => :version
+
+      desc 'setup', 'Get Browsermob Proxy from Internet'
+      def setup
+       bm = BrowserMobSetup.new
+       bm.download_browsermob_proxy
+      end
+
+      desc 'version', 'Get the current version number'
+      def version
+        say BrowserMob::CLI::VERSION
+      end
+
+      desc 'show_har_click URL', 'Get list of all requests when clicked on Locator'
+      option :locator
+      def show_har_click(url)
+        bm = BrowserMobSetup.new
+        if options[:locator]
+        bm.capture_traffic_with_click(url, "#{options[:locator]}")
+        end
+      end
+
+      desc 'show_har URL', 'Get list of all requests'
+      def show_har(url)
+        bm = BrowserMobSetup.new
+        bm.capture_traffic(url)
+      end
+
+      desc 'view_har_in_browser', 'Open up browser and Preview HAR file. Press Ctl+C Once DONE to stop WEBrick server'
+      def view_har_in_browser
+        bm = BrowserMobSetup.new
+        bm.show_har_data_browser
+      end
+
+      desc 'view_har_in_YAML', 'Display HAR file in YML in your Editor'
+      def view_har_in_YAML
+        system("open /tmp/traffic.yml")
+      end
+    end
+  end
+end

data/lib/browsermob/cli/version.rb

@@ -0,0 +1,5 @@
+module BrowserMob
+  module CLI
+    VERSION = "0.1.0"
+  end
+end

data/lib/browsermob/cli.rb

@@ -0,0 +1,13 @@
+require "browsermob/cli/version"
+require 'browsermob/cli/browsermob'
+require 'browsermob/cli/main'
+require 'browsermob/cli/har_parser'
+
+module BrowserMob
+  module CLI
+    def check_file_locations
+    $har = "/tmp/traffic.har"
+    $binary = "/tmp/browsermob-proxy/bin/browsermob-proxy"
+    end
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: browsermob-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shashikant86
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  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'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  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'
+- !ruby/object:Gem::Dependency
+  name: browsermob-proxy
+  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'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  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'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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'
+description: This Rubygem is CLI interface to check network traffic using HAR. It
+  will generate HAR file preview in browser and YAML
+email:
+- shashikant.jagtap@aol.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/browsermob-cli
+- browsermob-cli.gemspec
+- lib/browsermob/cli.rb
+- lib/browsermob/cli/browsermob.rb
+- lib/browsermob/cli/har_parser.rb
+- lib/browsermob/cli/main.rb
+- lib/browsermob/cli/version.rb
+homepage: https://github.com/Shashikant86/browsermob-cli
+licenses:
+- MIT
+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: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: BrowserMob Proxy CLI to Generate HAR and Capture Traffic
+test_files: []