browsed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 273de99ce82d529db724b003f381012c5b1f92334d51cf313c8f6eb7cdbc924a
+  data.tar.gz: 57b78a4285b0345005e5e1b1fd62c5d971a8a4f4158a54b4e9ff54cfc05c98e7
+SHA512:
+  metadata.gz: 7e410f72cb0b1ddede87f09f2693378cb8e7821a2519e15f724fd4fafe7ac24486e1c7db6a3da1c1f5bd482e6c5423a4b857654e6ce6d6384262e2e571e1f170
+  data.tar.gz: 542852786da4017490e028df8e2ff1eaad8021c92ef17efec8900684b0200343b8315d212db78e46b84561a5f9c37cd07d175c33345a66876193239432d0b218

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/tmp/
+/tmp/
+/files/
+
+# rspec failure tracking
+.rspec_status
+
+# pry history
+.pry_history
+
+# RVM
+.ruby-version
+.ruby-gemset
+
+# DS_Store
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sebastian.johnsson@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in browsed.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    browsed (0.1.0)
+      agents
+      capybara (~> 3.4, >= 3.4.1)
+      poltergeist (~> 1.18, >= 1.18.1)
+      selenium-webdriver (~> 3.13, >= 3.13.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    agents (0.1.2)
+    capybara (3.4.2)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      xpath (~> 3.1)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    cliver (0.3.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    poltergeist (1.18.1)
+      capybara (>= 2.1, < 4)
+      cliver (~> 0.3.1)
+      websocket-driver (>= 0.2.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.13.1)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    xpath (3.1.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  browsed!
+  bundler (~> 1.16)
+  launchy (~> 2.4, >= 2.4.3)
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sebastian
+
+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,59 @@
+# Browsed
+
+Browsed is a lightweight Capybara/PhantomJS/Selenium framework with tools and utilities for randomizing user agents, resolutions etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'browsed'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install browsed
+
+## Usage
+
+```ruby
+# driver can be :poltergeist (PhantomJS) or :selenium/:selenium_chrome (Firefox/Chrome)
+# browser can be: :phantomjs, :firefox, :chrome
+# device can be :desktop, :phone (iphone/android), :tablet (ipad/android), :iphone, :ipad, :android_phone, :android_tablet
+client    =   Browsed::Client.new(driver: :poltergeist, browser: :phantomjs, device: :desktop)
+```
+
+If you want to use proxies (note that proxy authentication is only possible using Poltergeist/PhantomJS):
+
+```ruby
+proxy     =   {host: "127.0.0.1", port: 8080, username: "foo", password: "bar"}
+client    =   Browsed::Client.new(driver: :poltergeist, browser: :phantomjs, device: :desktop, proxy: proxy)
+```
+
+Use the session property to interact with the underlying Capybara::Session object:
+
+```ruby
+client.session.visit("https://www.google.com")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SebastianJ/browsed. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Browsed project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SebastianJ/browsed/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/browse

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "browsed"
+require "launchy"
+
+driver    =   :selenium
+browser   =   :firefox
+
+url       =   "https://whatismyipaddress.com"
+path      =   File.expand_path("../../files/#{Time.now.to_i}.png", __FILE__)
+
+client    =   Browsed::Client.new(driver: driver, browser: browser, device: :desktop, environment: :development)
+
+client.session.visit(url)
+
+if driver.eql?(:poltergeist)
+  client.session.save_screenshot(path)
+  client.display_screenshot!(path)
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "browsed"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.config.history.file = File.join(__FILE__, "../.pry_history")
+Pry.start
+
+#require "irb"
+#IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/browsed.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "browsed/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "browsed"
+  spec.version       = Browsed::VERSION
+  spec.authors       = ["Sebastian"]
+  spec.email         = ["sebastian.johnsson@gmail.com"]
+
+  spec.summary       = %q{Browsed: Lightweight Capybara/PhantomJS/Selenium framework}
+  spec.description   = %q{A lightweight framework for making it easier to work with Capybara/PhantomJS/Selenium}
+  spec.homepage      = "https://github.com/SebastianJ"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "capybara", '~> 3.4', '>= 3.4.1'
+  spec.add_dependency "poltergeist", '~> 1.18', '>= 1.18.1'
+  spec.add_dependency "selenium-webdriver", '~> 3.13', '>= 3.13.1'
+  
+  spec.add_dependency "agents"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "launchy", '~> 2.4', '>= 2.4.3'
+end

data/lib/browsed.rb

@@ -0,0 +1,40 @@
+require "selenium-webdriver"
+
+require "capybara"
+require "capybara/dsl"
+require "capybara/poltergeist"
+
+require "agents"
+
+require "browsed/version"
+
+require "browsed/constants"
+require "browsed/errors"
+require "browsed/configuration"
+
+require "browsed/manager"
+
+require "browsed/poltergeist"
+require "browsed/firefox"
+require "browsed/chrome"
+require "browsed/client"
+
+module Browsed
+  
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= ::Browsed::Configuration.new
+  end
+
+  def self.reset
+    @configuration = ::Browsed::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+  
+end

data/lib/browsed/chrome.rb

@@ -0,0 +1,35 @@
+module Browsed
+  module Chrome
+    
+    private
+      def register_chrome_driver(driver_options: {}, timeout: 60, debug: false)
+        profile                 =   Selenium::WebDriver::Chrome::Profile.new
+        
+        profile["user-agent"]   =   self.user_agent unless self.user_agent.to_s.empty?
+        
+        proxy_options           =   chrome_proxy_options
+        capabilities            =   !proxy_options.nil? ? Selenium::WebDriver::Remote::Capabilities.chrome(proxy: proxy_options) : {}
+        options                 =   Selenium::WebDriver::Chrome::Options.new(profile: profile)
+        
+        Capybara.register_driver self.driver do |app|
+          Capybara::Selenium::Driver.new(app, browser: :chrome, options: options, desired_capabilities: capabilities)
+        end
+      end
+    
+      def chrome_proxy_options
+        proxy_options           =   nil
+        
+        if self.proxy && !self.proxy.empty? && self.proxy.has_key?(:host) && self.proxy.has_key?(:port)
+          proxy_options         =   Selenium::WebDriver::Proxy.new(
+            http: "#{self.proxy.fetch(:host)}:#{self.proxy.fetch(:port)}",
+            ssl:  "#{self.proxy.fetch(:host)}:#{self.proxy.fetch(:port)}"
+          )
+          
+          log("Will use proxy #{self.proxy.fetch(:host)}:#{self.proxy.fetch(:port)} to initiate the request.")
+        end
+      
+        return proxy_options
+      end
+  
+  end
+end

data/lib/browsed/client.rb

@@ -0,0 +1,182 @@
+module Browsed
+  class Client
+    attr_accessor :configuration
+    attr_accessor :manager, :maximum_processes
+    attr_accessor :driver, :browser, :environment
+    attr_accessor :session
+    attr_accessor :device, :proxy
+    attr_accessor :user_agent
+    attr_accessor :resolution
+    
+    include Capybara::DSL
+    
+    def initialize(configuration:     ::Browsed.configuration,
+                   driver:            :poltergeist,
+                   browser:           :phantomjs,
+                   device:            :desktop,
+                   proxy:             nil,
+                   user_agent:        nil,
+                   resolution:        nil,
+                   environment:       :production,
+                   driver_options:    {},
+                   maximum_processes: nil)
+      
+      self.configuration                =   configuration
+      
+      self.driver                       =   driver            || self.configuration.driver
+      self.browser                      =   browser           || self.configuration.browser
+      self.environment                  =   environment       || self.configuration.environment
+      
+      self.device                       =   device
+      self.proxy                        =   proxy
+      
+      self.manager                      =   Browsed::Manager.new(browser: self.browser)
+      self.maximum_processes            =   maximum_processes || self.configuration.maximum_processes
+      
+      set_user_agent(user_agent)
+      set_resolution(resolution)
+      
+      setup_capybara(driver_options: driver_options)
+    end
+    
+    include ::Browsed::Poltergeist
+    include ::Browsed::Firefox
+    include ::Browsed::Chrome
+    
+    def setup_capybara(driver_options: {}, retries: 3)
+      if can_start_new_process?
+        if poltergeist?
+          register_poltergeist_driver(driver_options: driver_options)
+        elsif selenium?
+          if firefox_browser?
+            register_firefox_driver(driver_options: driver_options)
+          elsif chrome_browser?
+            self.driver                 =   :selenium_chrome
+            register_chrome_driver(driver_options: driver_options)
+          end
+        end
+        
+        puts "Self.driver: #{self.driver}"
+        puts "Self.browser: #{self.browser}"
+      
+        Capybara.default_driver         =   self.driver
+        Capybara.javascript_driver      =   self.driver
+      
+        Capybara.default_max_wait_time  =   driver_options.fetch(:wait_time, 30) #seconds
+      
+        self.session                    =   Capybara::Session.new(self.driver)
+      else
+        raise Browsed::TooManyProcessesError, "Too many PhantomJS processes running, reached maximum allowed number of #{self.maximum_processes}"
+      end
+    end
+    
+    def can_start_new_process?
+      self.maximum_processes.nil? || self.manager.can_start_more_processes?(max_count: self.maximum_processes)
+    end
+    
+    def display_screenshot!(path)
+      Launchy.open path if development?
+    end
+    
+    private
+      def poltergeist?
+        self.driver.to_sym.eql?(:poltergeist)
+      end
+      
+      def selenium?
+        self.driver.to_sym.eql?(:selenium)
+      end
+      
+      def firefox_browser?
+        self.browser.to_sym.eql?(:firefox)
+      end
+      
+      def chrome_browser?
+        self.browser.to_sym.eql?(:chrome)
+      end
+      
+      def development?
+        in_environment?(:development)
+      end
+    
+      def in_environment?(env)
+        self.environment.eql?(env)
+      end
+    
+      def terminate_session!(retries: 3)
+        self.session.driver.quit
+        self.session            =   nil
+      end
+    
+      # User Agents
+      def set_user_agent(user_agent)
+        if !user_agent.to_s.empty?
+          self.user_agent       =   user_agent
+        else
+          case self.device
+            when :iphone
+              self.user_agent   =   Agents.random_user_agent(:phones, :iphone)
+            when :android_phone
+              self.user_agent   =   Agents.random_user_agent(:phones, :android)
+            when :ipad
+              self.user_agent   =   Agents.random_user_agent(:tablets, :ipad)
+            when :android_tablet
+              self.user_agent   =   Agents.random_user_agent(:tablets, :android)
+            else
+              self.user_agent   =   Agents.random_user_agent(self.device)
+          end
+        end
+      end
+      
+      def runs_ios?
+        Agents.runs_ios?(self.user_agent)
+      end
+    
+      def is_iphone?
+        Agents.is_iphone?(self.user_agent)
+      end
+    
+      def is_ipad?
+        Agents.is_ipad?(self.user_agent)
+      end
+      
+      # Resolution      
+      def set_resolution(res)
+        self.resolution   =   res&.any? ? res : randomize_resolution
+      end
+      
+      def randomize_resolution
+        runs_ios? ? randomize_ios_resolution : Browsed::Constants::RESOLUTIONS.fetch(self.device, :desktop).sample
+      end
+    
+      def randomize_ios_resolution
+        resolution_device =   case self.device
+          when :iphone, :android_phone
+            :phone
+          when :ipad, :android_tablet
+            :tablet
+          else
+            self.device
+        end
+        
+        random_key        =   Browsed::Constants::RESOLUTIONS.fetch(resolution_device, :desktop).keys.sample
+        resolution        =   Browsed::Constants::RESOLUTIONS.fetch(resolution_device, :desktop)[random_key]
+      end
+      
+      def wait_for_ajax
+        Timeout.timeout(Capybara.default_max_wait_time) do
+          loop until finished_all_ajax_requests?
+        end
+      end
+
+      def finished_all_ajax_requests?
+        evald             =   self.session.evaluate_script('jQuery.active')
+        evald.nil? || evald.zero?
+      end
+      
+      def log(message)
+        puts "[Browsed::Client] - #{Time.now}: #{message}" if self.configuration.verbose?
+      end
+    
+  end
+end

data/lib/browsed/configuration.rb

@@ -0,0 +1,29 @@
+module Browsed
+  class Configuration
+    attr_accessor :driver, :browser, :environment
+    attr_accessor :phantomjs_path, :download_path
+    attr_accessor :maximum_processes, :processes_max_ttl
+    attr_accessor :verbose
+  
+    def initialize
+      self.driver               =   :poltergeist
+      self.browser              =   :phantomjs
+      
+      self.environment          =   :production
+      
+      self.phantomjs_path       =   "/usr/local/bin/phantomjs"
+      
+      self.download_path        =   nil
+      
+      self.maximum_processes    =   nil
+      self.processes_max_ttl    =   60 * 30 # 30 minutes
+      
+      self.verbose              =   false
+    end
+    
+    def verbose?
+      self.verbose
+    end
+  
+  end
+end

data/lib/browsed/constants.rb

@@ -0,0 +1,29 @@
+module Browsed
+  class Constants
+
+    RESOLUTIONS = {
+      desktop: [
+        [1920, 1080], #17%
+        [1366, 768], #35%
+        [1280, 1024], #5%
+        [1280, 800], #4%
+        [1024, 768] #3%
+      ],
+    
+      phone:
+      {
+        '4'   =>  [320, 480],
+        '5'   =>  [320, 568],
+        '6'   =>  [375, 667],
+        '6+'  =>  [414, 736]
+      },
+    
+      tablet:
+      {
+        'standard'  =>  [1024, 768],
+        'retina'    =>  [2048, 1536]
+      }
+    }
+        
+  end
+end

data/lib/browsed/errors.rb

@@ -0,0 +1,4 @@
+module Browsed
+  class TooManyProcessesError < StandardError; end
+  class PotentiallyStaleProxyError < StandardError; end
+end

data/lib/browsed/firefox.rb

@@ -0,0 +1,46 @@
+module Browsed
+  module Firefox
+    
+    private
+      def register_firefox_driver(driver_options: {}, timeout: 60, debug: false)
+        download_path           =   driver_options.fetch(:download_path, self.configuration.download_path)
+        enable_firebug          =   driver_options.fetch(:enable_firebug, false)
+        
+        profile                 =   Selenium::WebDriver::Firefox::Profile.new
+        
+        profile.enable_firebug if enable_firebug
+        
+        unless download_path.to_s.empty?
+          profile["browser.download.useDownloadDir"]          =   true
+          profile["browser.download.dir"]                     =   download_directory
+          profile["browser.download.folderList"]              =   2
+          profile["browser.helperApps.neverAsk.saveToDisk"]   =   "text/plain, application/vnd.ms-excel, text/csv, text/comma-separated-values, application/octet-stream, text/x-comma-separated-values, application/csv, application/x-filler"
+          profile["toolkit.telemetry.prompted"]               =   true
+          profile["pdfjs.disabled"]                           =   true
+        end
+        
+        profile["general.useragent.override"]                 =   self.user_agent unless self.user_agent.to_s.empty?
+        
+        profile                 =   firefox_proxy_options(profile)
+        options                 =   Selenium::WebDriver::Firefox::Options.new(profile: profile)
+        
+        Capybara.register_driver self.driver do |app|
+          Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
+        end
+      end
+    
+      def firefox_proxy_options(profile)
+        if self.proxy && !self.proxy.empty? && self.proxy.has_key?(:host) && self.proxy.has_key?(:port)
+          profile.proxy = Selenium::WebDriver::Proxy.new(
+            http: "#{self.proxy.fetch(:host)}:#{self.proxy.fetch(:port)}",
+            ssl:  "#{self.proxy.fetch(:host)}:#{self.proxy.fetch(:port)}"
+          )
+        
+          log("Will use proxy #{self.proxy.fetch(:host)}:#{self.proxy.fetch(:port)} to initiate the request.")
+        end
+      
+        return profile
+      end
+  
+  end
+end

data/lib/browsed/manager.rb

@@ -0,0 +1,98 @@
+module Browsed
+  class Manager
+    attr_accessor :command, :kill_signal
+    
+    def initialize(browser: :phantomjs, kill_signal: 9)
+      case browser
+        when :phantomjs
+          self.command    =   "ps -ef | grep /[p]hantomjs"
+        when :firefox
+          self.command    =   "ps -ef | grep /[g]eckodriver"
+        when :chrome
+          self.command    =   "ps -ef | grep /[c]hromedriver"
+        else
+          self.command    =   "ps -ef | grep /[p]hantomjs"
+      end
+      
+      self.kill_signal    =   kill_signal
+    end
+    
+    def can_start_more_processes?(max_count: 5)
+      return get_current_processes.size < max_count
+    end
+    
+    def reap_stale_processes(started_after: ::Browsed.configuration.processes_max_ttl.call)
+      processes           =   get_current_processes
+      
+      processes.each do |process|
+        if (process[:date] && process[:date] < (Time.now - started_after))
+          info "[Browsed::Manager] - #{Time.now.to_s(:db)}: Process with PID #{process[:pid]} was started before #{started_after.to_s(:db)}. Process should be terminated."
+          kill_process(process)
+        end
+      end if processes && processes.any?
+    end
+    
+    def kill_process(process)
+      info "[Browsed::Manager] - #{Time.now.to_s(:db)}: Killing process with PID #{process[:pid]} matching command #{self.command}."
+      
+      begin
+        ::Process.kill(self.kill_signal, process[:pid])
+      
+      rescue StandardError => e
+        info "[Browsed::Manager] - #{Time.now.to_s(:db)}:  Failed to kill process with pid '#{process[:pid]}'. Error Class: #{e.class.name}. Error Message: #{e.message}"
+      end
+    end
+    
+    def get_current_processes
+      processes           =   []
+      procs               =   `#{self.command}`.split("\n")
+      
+      procs.each do |process_data|
+        process           =   parse_process(process_data)
+        processes        <<   process
+      end if procs && procs.any?
+      
+      return processes
+    end
+    
+    private
+    
+    def parse_process(process_data)
+      process             =   {}
+      
+      parts               =   process_data.split(' ')
+      pid                 =   parts[1].to_i
+      started             =   parts[4].to_s
+      date                =   parse_date(started)
+      
+      process[:pid]       =   pid
+      process[:started]   =   started
+      process[:date]      =   date
+      
+      info "[Browsed::Manager] - #{Time.now.to_s(:db)}: Pid: #{pid}. Started: #{started}. Date: #{date}.\n"
+      
+      return process
+    end
+    
+    def parse_date(date, retries = 3)
+      begin
+        if (!(date =~ /^[a-z]{3,4}\d*/i).nil?) #Sep16
+          parsed_date = DateTime.strptime(date, "%b%d")
+        
+        elsif (!(date =~ /^\d*:\d*/i).nil?) #11:34
+          parsed_date = Time.strptime(date, "%H:%M").to_datetime
+        end
+      
+      rescue StandardError => e
+        info "[Browsed::Manager] - #{Time.now.to_s(:db)}: Exception occurred while trying to parse date/time string '#{date}'. Error Class: #{e.class.name}. Error: #{e.message}."
+        retries -= 1
+        retry if retries > 0
+      end
+    end
+    
+    def info(message, enabled = true)
+      puts message if enabled
+    end
+    
+  end
+end

data/lib/browsed/poltergeist.rb

@@ -0,0 +1,57 @@
+module Browsed
+  module Poltergeist
+    
+    private
+      def register_poltergeist_driver(driver_options: {}, timeout: 60, debug: false)
+        phantom_opts            =   ['--ignore-ssl-errors=true', '--ssl-protocol=any']
+        disable_images          =   driver_options.fetch(:disable_images, false)
+    
+        if disable_images
+          phantom_opts         <<   "--load-images=false"
+        end
+      
+        phantom_opts            =   phantom_opts | poltergeist_proxy_options
+    
+        options                 =   {
+          timeout:            timeout,
+          js_errors:          false,
+          debug:              debug,
+          phantomjs_options:  phantom_opts
+        }
+    
+        options[:phantomjs]     =   self.configuration.phantomjs_path if in_environment?(:production)
+        options[:window_size]   =   self.resolution if self.resolution&.any?
+      
+        headers                 =   {}
+        headers['User-Agent']   =   self.user_agent unless self.user_agent.to_s.empty?
+      
+        log("Will register a new poltergeist driver:\nOptions: #{options.inspect}\nHeaders: #{headers.inspect}\n")
+    
+        Capybara.register_driver self.driver do |app|
+          poltergeist           =   Capybara::Poltergeist::Driver.new(app, options)
+          poltergeist.headers   =   headers
+          poltergeist
+        end
+      end
+    
+      def poltergeist_proxy_options
+        proxy_options       =   []
+      
+        if self.proxy && !self.proxy.empty? && self.proxy.has_key?(:host) && self.proxy.has_key?(:port)
+          proxy_address     =   "#{self.proxy.fetch(:host)}:#{self.proxy.fetch(:port)}"
+        
+          proxy_options    <<   "--proxy=#{proxy_address}" if !proxy_address.to_s.empty?
+        
+          if !self.proxy.fetch(:username, nil).to_s.empty? && !self.proxy.fetch(:password, nil).to_s.empty?
+            credentials     =   "#{self.proxy.fetch(:username)}:#{self.proxy.fetch(:password)}"
+            proxy_options  <<   "--proxy-auth=#{credentials}"
+          end
+        
+          log("Will use proxy options #{proxy_options} to initiate the request.")
+        end
+      
+        return proxy_options
+      end
+  
+  end
+end

data/lib/browsed/version.rb

@@ -0,0 +1,3 @@
+module Browsed
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: browsed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.1
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.1
+- !ruby/object:Gem::Dependency
+  name: agents
+  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: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+description: A lightweight framework for making it easier to work with Capybara/PhantomJS/Selenium
+email:
+- sebastian.johnsson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/browse
+- bin/console
+- bin/setup
+- browsed.gemspec
+- lib/browsed.rb
+- lib/browsed/chrome.rb
+- lib/browsed/client.rb
+- lib/browsed/configuration.rb
+- lib/browsed/constants.rb
+- lib/browsed/errors.rb
+- lib/browsed/firefox.rb
+- lib/browsed/manager.rb
+- lib/browsed/poltergeist.rb
+- lib/browsed/version.rb
+homepage: https://github.com/SebastianJ
+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.7.7
+signing_key: 
+specification_version: 4
+summary: 'Browsed: Lightweight Capybara/PhantomJS/Selenium framework'
+test_files: []