capybara-box 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0deb88846933c0b4cdd24ec64635b968b84a6704043ecf36aa60d8271f9bca5d
-  data.tar.gz: 3cc96c2a55edffa829341d134e698978cfe1f6b0424b1fbe18a7ecdb077f3fe5
+  metadata.gz: 012a0f0743be254b6cfe3cbb5353ecad6e8abeb00c1498370656c52d26f34d98
+  data.tar.gz: c07e5d764ab4af59c4136ea93c93c10086dee9cf98abc5b202283758b98f89b9
 SHA512:
-  metadata.gz: 6a7cef25e696a2cfd356c73d5864544b0150219569dcb3070511dfa9b1a3db67a410be604acca4408a1884cbd2ad521789491967006287563453d9b54a14a40a
-  data.tar.gz: aadf0bd2d9e84dd0d778e640dd53a8f1593a2ff50f8cf93be24d38fa4e795731fe7ca91632040ba23481fcdca959bf318c68175a72c7de8c1b08da180be5b6de
+  metadata.gz: 208d41d18d4f3d6a8776717c30ca9471ea1281ea59b3f374b9d40ecfde1cbe1e4cfb9300f0db8ec9ea424fd50ee17d1597587e91b26077bb60f5517101a431c4
+  data.tar.gz: 6172f0ded5edbb4f6ec7aa12ff90fd727859d03fb9ab548c71dfb6fe42a5783d922f8948d8779ab3962bf51905b10cba2d724f683e05b4046be58aa8bfc759f1

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v1.0.0
+
+- Updates
+  - Updated default arguments;
+
+- Features
+  - Capybara `load_selenium` is called before startup;
+  - Screenshot S3 feature now is configure only via ENV;
+  - Using new gem `webdrivers`;
+
+- Fixes
+  - Fix screenshot upload;
+
 ## v0.4.0
 
 - Updates Selenium WebDriver deprecated message;
@@ -9,12 +22,12 @@
 
 ## v0.2.1
 
-- fixes
+- Fixes
   - `chrome_headless` was being registered with wrong name.
 
 ## v0.2.0
 
-- features
+- Features
   - Add log feature for Chrome and Chrome Headless.
 
 ## v0.1.0

data/README.md

@@ -1,9 +1,11 @@
 # Capybara Box
 
-[![Build Status](https://travis-ci.org/wbotelhos/capybara-box.svg)](https://travis-ci.org/wbotelhos/capybara-box)
+[![Build Status](https://travis-ci.org/wbotelhos/capybara-box.svg?branch=master)](https://travis-ci.org/wbotelhos/capybara-box)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1b13dc12b03be63baaed/maintainability)](https://codeclimate.com/github/wbotelhos/capybara-box/maintainability)
 [![Gem Version](https://badge.fury.io/rb/capybara-box.svg)](https://badge.fury.io/rb/capybara-box)
+[![Patreon](https://img.shields.io/badge/donate-%3C3-brightgreen.svg)](https://www.patreon.com/wbotelhos)
 
-Configure Capybara with **Chrome**, **Chrome Headless** or **Firefox** with *Screenshot* feature and *Session* without losing your mind with just one line.
+Configure Capybara with **Chrome**, **Chrome Headless**, **Firefox** and **Firefox Headless** with *Screenshot* feature without losing your mind.
 
 ## install
 
@@ -26,44 +28,41 @@ require 'capybara-box'
 CapybaraBox::Base.configure
 ```
 
-By default, `chrome` is the driver, but you can use `chrome_headless` and `firefox` too.
+By default, `selenium_chrome` is the driver, but you can use `selenium_chrome_headless` and `selenium_firefox` or `selenium_firefox_headless` too.
 
 ## Version
 
-You can use a embbeded driver via `webdrivers` if you do not want to install the `chromedriver` by yourself as following:
+The version is setted via `webdrivers`. You can specify the version:
 
 ```ruby
-CapybaraBox::Base.configure version: '2.32'
+CapybaraBox::Base.configure(version: '83.0.4103.39')
 ```
 
-* This works just for `chrome` and `chrome_headless`, for now
-
 ## Screenshot
 
-You can enable screenshot on failure and send it to S3.
+You can enable screenshot on failure:
 
 ```ruby
-CapybaraBox.configure(
-  screenshot: {
-    s3: {
-      access_key_id:     'KEY',
-      bucket:            'bucket',
-      secret_access_key: 'SECRET'
-    }
-  }
-)
+CapybaraBox.configure(screenshot: { enabled: true })
 ```
 
-If you want enable it only on CI, use the `enabled` option:
+If you want to send the screenshot and html page to S3 setup your credentials via ENV:
 
-```ruby
-CapybaraBox.configure(
-  enabled: ENV['CI'],
+```sh
+ENV['CAPYBARA_BOX__S3_BUCKET_NAME']
+ENV['CAPYBARA_BOX__S3_REGION']
+ENV['CAPYBARA_BOX__S3_ACCESS_KEY_ID']
+ENV['CAPYBARA_BOX__S3_SECRET_ACCESS_KEY']
+```
+
+And then enable S3 feature:
 
-  screenshot: { // ... }
-)
+```ruby
+CapybaraBox.configure(screenshot: { enabled: true, s3: true })
 ```
 
+If you want enable it only on CI, use the `enabled` option:
+
 ## Add Argument
 
 By default some Switches are enabled for a better performance, you can add yours too:
@@ -71,7 +70,7 @@ By default some Switches are enabled for a better performance, you can add yours
 ```ruby
 capybara_box = CapybaraBox.configure
 
-capybara_box.add_argument '--incognito'
+capybara_box.add_argument('--incognito')
 ```
 
 ## Arguments
@@ -79,7 +78,7 @@ capybara_box.add_argument '--incognito'
 If you prefere, is possible override all of them:
 
 ```ruby
-CapybaraBox.configure arguments: ['--incognito']
+CapybaraBox.configure(arguments: ['--incognito'])
 ```
 
 Click [here](https://peter.sh/experiments/chromium-command-line-switches) to see the avaiables.
@@ -91,7 +90,7 @@ By default some Preferences are enabled for a better performance, you can add yo
 ```ruby
 capybara_box = CapybaraBox.configure
 
-capybara_box.add_preference :credentials_enable_service, false
+capybara_box.add_preference(:credentials_enable_service, false)
 ```
 
 ## Preferences
@@ -99,7 +98,7 @@ capybara_box.add_preference :credentials_enable_service, false
 If you prefere, is possible override all of them:
 
 ```ruby
-CapybaraBox.configure preferences: { credentials_enable_service: false }
+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).
@@ -111,7 +110,7 @@ It has this restrition because with timeout enabled, debugger cannot evaluate th
 You can override all of them too:
 
 ```ruby
-CapybaraBox.configure http_client_options: { read_timeout: 60 }
+CapybaraBox.configure(http_client_options: { read_timeout: 60 })
 ```
 
 ## Driver Options
@@ -119,15 +118,18 @@ CapybaraBox.configure http_client_options: { read_timeout: 60 }
 You can override all driver options:
 
 ```ruby
-CapybaraBox.configure driver_options: { clear_local_storage: true }
+CapybaraBox.configure(driver_options: { clear_local_storage: true })
 ```
 
 ## Log
 
 Log is writen at `log/capybara-box.log` as default.
-
 You can see each command executed. Time spent between them and debug some hanging command. :tada:
 
+```ruby
+CapybaraBox.configure(log: true)
+```
+
 ```
 [15.479][INFO]: RESPONSE Navigate
 [15.482][INFO]: COMMAND ExecuteScript {
@@ -137,15 +139,3 @@ You can see each command executed. Time spent between them and debug some hangin
 [15.483][INFO]: Waiting for pending navigations...
 [15.545][INFO]: Done waiting for pending navigations. Status: ok
 ```
-
-To disable log on CI, for example, use the `log` options:
-
-```ruby
-CapybaraBox.configure log: ENV['CI'].nil?
-```
-
-* It works only for **chrome** and **chrome_headless**.
-
-## 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

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require 'selenium/webdriver'
+require 'webdrivers'
+
 module CapybaraBox
+  require 'capybara-box/base'
+  require 'capybara-box/helper'
+  require 'capybara-box/screenshot'
 end
-
-require 'capybara-box/base'

data/lib/capybara-box/base.rb

@@ -1,38 +1,36 @@
 # frozen_string_literal: true
 
 module CapybaraBox
-  require 'selenium/webdriver'
-
   class Base
     def initialize(parameters = {})
-      @browser       = parameters[:browser] || :chrome
+      @browser       = parameters.fetch(:browser) { :selenium_chrome }
       @max_wait_time = parameters[:max_wait_time]
       @parameters    = parameters
     end
 
     def add_argument(value)
-      options.add_argument value unless options.nil?
+      options&.add_argument(value)
     end
 
     def add_preference(key, value)
-      options.add_preference key, value unless options.nil?
+      options&.add_preference(key, value)
     end
 
     def apply_arguments
-      arguments.each { |argument| add_argument argument }
+      arguments.each { |argument| add_argument(argument) }
 
-      add_argument '--headless' if chrome_headless?
+      add_argument('--headless') if chrome_headless?
     end
 
     def apply_preferences
-      preferences.each { |key, value| add_preference key, value }
+      preferences.each { |key, value| add_preference(key, value) }
     end
 
     def apply_version(version)
       if chrome_family?
-        require 'chromedriver/helper'
-
-        ::Chromedriver.set_version version
+        Webdrivers::Chromedriver.required_version = version
+      else
+        Webdrivers::Geckodriver.required_version = version
       end
     end
 
@@ -50,6 +48,7 @@ module CapybaraBox
         --disable-password-separated-signin-flow
         --disable-popup-blocking
         --disable-save-password-bubble
+        --disable-site-isolation-trials
         --disable-translate
         --incognito
         --mute-audio
@@ -59,7 +58,7 @@ module CapybaraBox
     end
 
     def chrome?
-      @browser == :chrome
+      @browser == :selenium_chrome
     end
 
     def chrome_family?
@@ -67,41 +66,19 @@ module CapybaraBox
     end
 
     def chrome_headless?
-      @browser == :chrome_headless
+      @browser == :selenium_chrome_headless
     end
 
-    def configure
+    def configure_capybara
       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 = 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
+        ::Selenium::WebDriver::Firefox::Binary.path
       end
     end
 
@@ -109,39 +86,40 @@ module CapybaraBox
       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]
+      apply_bin_path(@parameters[:bin_path]) if @parameters[:bin_path]
+      apply_version(@parameters[:version])   if !!@parameters[:version]
+
+      ::CapybaraBox::Screenshot.configure(@parameters[:screenshot], @browser) if @parameters[:screenshot]
 
-      register @browser
+      register(@browser)
 
-      configure
+      configure_capybara
     end
 
     def driver(app)
-      opts               = {}
-      opts[:options]     = options if chrome_family?
-      opts[:http_client] = http_client if true?(ENV['CI'])
+      opts           = {}
+      opts[:options] = options if chrome_family?
 
-      Capybara::Selenium::Driver.new app, opts.merge(driver_options)
+      Capybara::Selenium::Driver.load_selenium
+
+      opts[:http_client] = http_client if ::CapybaraBox::Helper.true?(ENV['CI'])
+
+      Capybara::Selenium::Driver.new(app, opts.merge(driver_options))
     end
 
     def driver_options
       return @parameters[:driver_options] if @parameters[:driver_options]
 
       opts = {
-        browser:               chrome_family? ? :chrome : @browser,
-        clear_local_storage:   true,
-        clear_session_storage: true
+        browser: chrome_family? ? :chrome : @browser,
+        clear_local_storage: true,
+        clear_session_storage: true,
       }
 
-      if log?
-        if chrome_family?
-          opts[:service] = Selenium::WebDriver::Service.chrome(args: {
-            log_path: 'log/capybara-box.log',
-            verbose: true,
-          })
-        end
+      if log? && chrome_family?
+        opts[:service] = ::Selenium::WebDriver::Service.chrome(
+          args: { log_path: 'log/capybara-box.log', verbose: true }
+        )
       end
 
       opts
@@ -156,16 +134,16 @@ module CapybaraBox
 
       {
         open_timeout: nil,
-        read_timeout: 120
+        read_timeout: 120,
       }
     end
 
     def http_client
-      @http_client ||= Selenium::WebDriver::Remote::Http::Default.new(http_client_options)
+      @http_client ||= ::Selenium::WebDriver::Remote::Http::Default.new(**http_client_options)
     end
 
     def options
-      @options ||= Selenium::WebDriver::Chrome::Options.new if chrome_family?
+      @options ||= ::Selenium::WebDriver::Chrome::Options.new if chrome_family?
     end
 
     def preferences
@@ -176,31 +154,17 @@ module CapybaraBox
         credentials_enable_service: false,
 
         profile: {
-          password_manager_enabled: false
-        }
+          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
+      Capybara.register_driver(name) { |app| driver(app) }
     end
 
     def self.configure(parameters)
-      box = new(parameters)
-
-      box.create
-
-      box
+      new(parameters).tap(&:create)
     end
 
     private
@@ -208,26 +172,7 @@ module CapybaraBox
     def log?
       return true if @parameters[:log].nil?
 
-      true? @parameters[:log]
-    end
-
-    def true?(value)
-      ['true', true].include? value
-    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]
+      ::CapybaraBox::Helper.true?(@parameters[:log])
     end
   end
 end