capybara-box 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3c837ec541010303e4e84c3e919583b4a4f72c5
+  data.tar.gz: dffeb421a4aaeaa05878c54074dcc2c362044c8c
+SHA512:
+  metadata.gz: c436a08f788a378584be91ecd5e7103ed978983ab1a284ccf9c583124258509d309f85f943a68849121e37bf07054d0159766c49b42f07bd3d75d5fdec3b77a7
+  data.tar.gz: 804393024ebd9c80e67e54574b049f6dcca5a5368c8688dc1085102200d5869d937565ec13b297fddc0859866d5561989cc8b81b661d373c8cbaa80bd84ced29

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+First release.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Washington Botelho
+
+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,126 @@
+# Capybara Box
+
+[![Build Status](https://travis-ci.org/wbotelhos/capybara-box.svg)](https://travis-ci.org/wbotelhos/capybara-box)
+[![Gem Version](https://badge.fury.io/rb/capybara-box.svg)](https://badge.fury.io/rb/capybara-box)
+
+Configure Capybara with **Chrome**, **Headless Chrome** or **Firefox** with *Screenshot* feature and *Session* without lost your mind with just one line.
+
+## install
+
+Add the following code on your Gemfile and run bundle install:
+
+```
+group :test do
+  gem 'capybara-box', require: false
+end
+```
+
+## Usage
+
+Just require the lib **after** Capybara require and you done:
+
+```
+require 'capybara/rails'
+require 'capybara-box'
+
+CapybaraBox::Base.configure
+```
+
+By default, `chrome` is de driver, but you can use `chrome`, `chrome_headless` or `firefox`.
+
+## Screenshot
+
+You can enable screenshot on failure and send it to S3.
+
+```
+CapybaraBox.configure(
+  screenshot: {
+    s3: {
+      access_key_id:     'KEY',
+      bucket:            'bucket',
+      secret_access_key: 'SECRET'
+    }
+  }
+)
+```
+
+If you want enable it only on CI, use the `enabled` option:
+
+```
+CapybaraBox.configure(
+  enabled: ENV['CI'],
+
+  screenshot: { // ... }
+)
+```
+
+## Session
+
+By default, Rack Session manipulation comes as battery, just use it.
+
+```
+page.set_rack_session key: 'value'
+```
+
+```
+page.get_rack_session :key
+# 'value'
+```
+
+You can disable this feature using the `session` option:
+
+```
+CapybaraBox.configure browser: :chrome, session: false
+```
+
+## Add Argument
+
+By default some Switches are enabled for a better performance, you can add yours too:
+
+```
+capybara_box = CapybaraBox.configure
+capybara_box.add_argument '--incognito'
+```
+
+## Arguments
+
+If you prefere, is possible override all of them:
+
+```
+CapybaraBox.configure arguments: ['--incognito']
+```
+
+Click [here](https://peter.sh/experiments/chromium-command-line-switches) to see the avaiables.
+
+## Add Preference
+
+By default some Preferences are enabled for a better performance, you can add yours too:
+
+```
+capybara_box = CapybaraBox.configure
+capybara_box.add_preference :credentials_enable_service, false
+```
+
+## Preferences
+
+If you prefere, is possible override all of them:
+
+```
+CapybaraBox.configure preferences: { credentials_enable_service: false }
+```
+
+You can check [Chrome](https://sites.google.com/a/chromium.org/chromedriver/home) and [Firefox](http://preferential.mozdev.org/preferences.html).
+
+## HTTP Client Options
+
+By default some timeout configs are enabled only on CI env for a better performance.
+It has this restrition because with timeout enabled, debugger cannot evaluate the variables values.
+You can override all of them too:
+
+```
+CapybaraBox.configure http_client_options: { read_timeout: 60 }
+```
+
+## Love it!
+
+Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=capybara-box) or [Gratipay](https://gratipay.com/~wbotelhos). Thanks! (:

data/lib/capybara-box.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CapybaraBox
+end
+
+require 'capybara-box/base'

data/lib/capybara-box/base.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module CapybaraBox
+  require 'selenium/webdriver'
+
+  class Base
+    def initialize(parameters = {})
+      @browser       = parameters[:browser] || :chrome
+      @max_wait_time = parameters[:max_wait_time]
+      @parameters    = parameters
+
+      requires
+    end
+
+    def add_argument(value)
+      options.add_argument value unless options.nil?
+    end
+
+    def add_preference(key, value)
+      options.add_preference key, value unless options.nil?
+    end
+
+    def apply_arguments
+      arguments.each { |argument| add_argument argument }
+
+      add_argument '--headless' if chrome_headless?
+    end
+
+    def apply_preferences
+      preferences.each { |key, value| add_preference key, value }
+    end
+
+    def apply_version(version)
+      if chrome_family?
+        require 'chromedriver/helper'
+
+        ::Chromedriver.set_version version
+      end
+    end
+
+    def arguments
+      return @parameters[:arguments] if @parameters[:arguments]
+      return [] unless chrome_family?
+
+      %w[
+        --disable-default-apps
+        --disable-extensions
+        --disable-infobars
+        --disable-notifications
+        --disable-password-generation
+        --disable-password-manager-reauthentication
+        --disable-password-separated-signin-flow
+        --disable-popup-blocking
+        --disable-save-password-bubble
+        --disable-translate
+        --incognito
+        --mute-audio
+        --no-default-browser-check
+        --start-fullscreen
+      ]
+    end
+
+    def browser
+      @browser ||= chrome_family? ? :chrome : @browser
+    end
+
+    def chrome?
+      @browser == :chrome
+    end
+
+    def chrome_family?
+      chrome? || chrome_headless?
+    end
+
+    def chrome_headless?
+      @browser == :chrome_headless
+    end
+
+    def configure
+      Capybara.javascript_driver     = browser
+      Capybara.default_max_wait_time = @max_wait_time if @max_wait_time
+    end
+
+    def apply_bin_path(path)
+      if firefox?
+        Selenium::WebDriver::Firefox::Binary.path = path
+
+        Selenium::WebDriver::Firefox::Binary.path
+      end
+    end
+
+    def configure_screenshot
+      return false if @parameters[:screenshot].key?(:enabled) && !true?(@parameters[:screenshot][:enabled])
+
+      require 'capybara-screenshot/rspec'
+
+      Capybara::Screenshot.append_timestamp                                  = false
+      Capybara::Screenshot.prune_strategy                                    = :keep_last_run
+      Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples = false
+
+      Capybara::Screenshot.register_filename_prefix_formatter(:rspec) do |example|
+        example.full_description.downcase.gsub('#', '--').tr ' ', '-'
+      end
+
+      if @parameters[:screenshot][:s3]
+        Capybara::Screenshot.s3_configuration = screenshot_s3_config
+      end
+
+      Capybara::Screenshot.register_driver(browser) do |driver, path|
+        driver.browser.save_screenshot path
+      end
+    end
+
+    def create
+      apply_arguments
+      apply_preferences
+
+      apply_bin_path @parameters[:bin_path] if @parameters[:bin_path]
+      apply_version @parameters[:version]   if version?
+      configure_screenshot                  if @parameters[:screenshot]
+
+      register browser
+
+      configure
+    end
+
+    def driver(app)
+      opts               = {}
+      opts[:options]     = options if chrome_family?
+      opts[:http_client] = http_client if true?(ENV['CI'])
+
+      Capybara::Selenium::Driver.new app, opts.merge(driver_options)
+    end
+
+    def driver_options
+      return @parameters[:driver_options] if @parameters[:driver_options]
+
+      {
+        browser:               browser,
+        clear_local_storage:   true,
+        clear_session_storage: true
+      }
+    end
+
+    def firefox?
+      @browser == :firefox
+    end
+
+    def http_client_options
+      return @parameters[:http_client_options] if @parameters[:http_client_options]
+
+      {
+        open_timeout: nil,
+        read_timeout: 120
+      }
+    end
+
+    def http_client
+      @http_client ||= Selenium::WebDriver::Remote::Http::Default.new(http_client_options)
+    end
+
+    def options
+      @options ||= Selenium::WebDriver::Chrome::Options.new if chrome_family?
+    end
+
+    def preferences
+      return @parameters[:preferences] if @parameters[:preferences]
+      return {} unless chrome_family?
+
+      {
+        credentials_enable_service: false,
+
+        profile: {
+          password_manager_enabled: false
+        }
+      }
+    end
+
+    def register(name)
+      Capybara.register_driver name do |app|
+        driver app
+      end
+    end
+
+    def version
+      if chrome_family?
+        require 'chromedriver/helper'
+
+        ::Chromedriver::Helper.new.current_version
+      end
+    end
+
+    def self.configure(parameters)
+      box = new(parameters)
+
+      box.create
+
+      box
+    end
+
+    private
+
+    def true?(value)
+      ['true', true].include? value
+    end
+
+    def requires
+      require 'rack_session_access/capybara' unless @parameters[:session] == false
+    end
+
+    def screenshot_s3_config
+      {
+        s3_client_credentials: {
+          access_key_id:     @parameters[:screenshot][:s3][:access_key_id],
+          secret_access_key: @parameters[:screenshot][:s3][:secret_access_key]
+        },
+
+        bucket_name: @parameters[:screenshot][:s3][:bucket]
+      }
+    end
+
+    def version?
+      !!@parameters[:version]
+    end
+  end
+end

data/lib/capybara-box/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CapybaraBox
+  VERSION = '0.1.0'.freeze
+end

data/spec/lib/capybara_box/base/add_argument_spec.rb

@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.add_argument' do
+  subject { described_class.new parameters }
+
+  context 'when is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    it 'adds the argument' do
+      subject.add_argument '--argument'
+
+      expect(subject.options.args).to eq ['--argument']
+    end
+  end
+
+  context 'when is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    it 'adds the argument' do
+      subject.add_argument '--argument'
+
+      expect(subject.options.args).to eq ['--argument']
+    end
+  end
+
+  context 'when is firefox' do
+    let!(:parameters) { { browser: :firefox } }
+
+    it 'does not applies options' do
+      subject.add_argument '--argument'
+
+      expect(subject.options).to be_nil
+    end
+  end
+end

data/spec/lib/capybara_box/base/add_preference_spec.rb

@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+RSpec.describe CapybaraBox::Base, '.add_preference' do
+  subject { described_class.new parameters }
+
+  context 'when is chrome' do
+    let!(:parameters) { { browser: :chrome } }
+
+    it 'adds the argument' do
+      subject.add_preference :key, :value
+
+      expect(subject.options.prefs).to eq(key: :value)
+    end
+  end
+
+  context 'when is chrome headless' do
+    let!(:parameters) { { browser: :chrome_headless } }
+
+    it 'adds the argument' do
+      subject.add_preference :key, :value
+
+      expect(subject.options.prefs).to eq(key: :value)
+    end
+  end
+
+  context 'when is firefox' do
+    let!(:parameters) { { browser: :firefox } }
+
+    it 'does not applies options' do
+      subject.add_preference :key, :value
+
+      expect(subject.options).to be_nil
+    end
+  end
+end