browsenator 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1df300ccd6a8a359e00fe075bad072d7d090509afcad1121ba9e308dc41ec5b6
-  data.tar.gz: 275b6e48ed9eecc171345cc05d9740760b70eb9979fb9fcf3f9e38038421778a
+SHA1:
+  metadata.gz: c1cd8f665aeaf00307ed5a3a1b301968732bf96a
+  data.tar.gz: '0095335900ac81f7d4490dddf3faa6cc639f6391'
 SHA512:
-  metadata.gz: 64e855a051d847a9d8d2f36cc5ed0dcbabae6466bdca31966dc50bd8c42bbb017a127f736e46dd15fa057b0fbdf2eacd15dee06a97d9607e8b50cc028d6731d3
-  data.tar.gz: d85f9a4a1710d2e1d2efb78de50ce77a31bc6229f3d9759ba4a523d956e821aea9f1ccd0beab500fabd62413d73ab66a03957016049cf49be849a4fb94609a0a
+  metadata.gz: 252fef826e7159eec60a23375860b1af348d4c9b71991cbda67a11cac14bed7041010f243496bd157905425999f220fc7f10cd1ccab61be6ad234fa95cfd447d
+  data.tar.gz: bf78b9a71de6a2811cd8b53173e2a36079adca64b4b4d8d0b6b0cce19d890efacc2b01f7400ac58039155bfb6a20cd1d4f253495473b5a2b79eea0a1cfee6658

data/README.md

@@ -1,5 +1,5 @@
 # Browsenator
-[![Build Status](https://travis-ci.com/Typeform/browsenator.svg?token=4XnFa7v9wzSNqUXXdfpX&branch=master)](https://travis-ci.com/Typeform/browsenator)
+[![Build Status](https://travis-ci.org/aidamanna/browsenator.svg?branch=master)](https://travis-ci.org/aidamanna/browsenator)
 
 Browsenator is a Watir wrapper to make starting local and remote browsers easier.
 
@@ -9,15 +9,19 @@ Big thanks to Browserstack for allowing us to use their tool for developing this
 
 ## Installation
 
-Install Browsenator as a Gem from git:
+Add this line to your application's Gemfile:
 
 ```ruby
-gem 'browsenator', git: git@github.com:Typeform/browsenator.git
+gem 'browsenator'
 ```
 
-And then in your project execute:
+And then execute:
 
-    $ bundle install
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aida
 
 ## Configuration
 
@@ -44,9 +48,26 @@ Chrome and Firefox browsers can be started in headless mode:
 Browsenator.for(:chrome, headless: true)
 ```
 
+If you specify headless property for Safari, Browsenator will just ignore it.
+
+#### Browser versions
+For local browsers Browsenator will always start the browser version that you have installed in your computer.
+
+Additionally, you will need to have installed the corresponding browser driver:
+
+- Google Chrome: chromedriver
+- Mozilla Firefox: geckodriver
+- Apple Safari: safaridriver (no download is needed, it is pre-installed if you have Safari 10 or latter).
+
+In Safari, you will also need to allow remote automation option (under Develop menu). 
+
+#### Defaults
+
+- Browser window is resized to: 1004 x 748
+
 ### Remote browser
 
-To start a remote browser:
+Start a remote browser:
 
 ```ruby
 Browsenator.for(:chrome, remote: :browserstack)
@@ -54,7 +75,58 @@ Browsenator.for(:chrome, remote: :browserstack)
 
 Currently, remote browsers are only available through Browserstack.
 
-You can start the following remote browsers: `:chrome`, `:safari`.
+You can start the following remote browsers: `:chrome`, `:safari`, `:edge`, `:ie`.
+
+#### Browser versions
+
+You can specify the browser version you want to use:
+
+```ruby
+Browsenator.for(:chrome, remote: :browserstack, browser_version: '65.0')
+```
+
+Check [capabilities](https://www.browserstack.com/automate/capabilities) in Browserstack to know which browser versions to use.
+
+#### Defaults
+
+- Resolution: 1024 x 768
+- Chrome browser: v66 - High Sierra
+- Safari browser: v11.1 - High Sierra
+- Edge browser: v17 - Windows 10
+- IE browser: v11 - Windows 10
+
+#### Other configurations
+
+##### Project name
+
+Specify project name in Browserstack execution:
+
+```ruby
+Browsenator.for(:chrome, remote: :browserstack, project: 'Functional Test')
+```
+
+##### Local testing
+
+By default local testing is set to false. You can enable it by setting `local_testing` to `true`:
+
+```ruby
+Browsenator.for(:chrome, remote: :browserstack, local_testing: true)
+```
+
+Note: This property will only set the correct capability so that local testing is enabled. However, to make it work, you still need to setup your [Local Testing connection](https://www.browserstack.com/local-testing) with Browserstack.
+
+See the following example for a Linux machine.
+
+First of all, download the linux binary and start your local testing connection:
+
+    $ wget https://www.browserstack.com/browserstack-local/BrowserStackLocal-linux-x64.zip
+    $ unzip BrowserStackLocal-linux-x64.zip
+    $ ./BrowserStackLocal --key $BROWSERSTACK_ACCESS_KEY & sleep 5
+
+Run your tests. When you are done running your tests, stop your local testing connection (and remove the downloaded binary):
+
+    $ killall BrowserStackLocal
+    $  rm -f BrowserStackLocal*
 
 ## Development
 

data/lib/browsenator/remote/browserstack/chrome.rb

@@ -12,11 +12,12 @@ module Browsenator
         def initialize(opts = {})
           caps = Selenium::WebDriver::Remote::Capabilities.new
           caps['browser'] = 'Chrome'
-          caps['browser_version'] = '66.0'
+          caps['browser_version'] = opts[:browser_version] || '66.0'
           caps['os'] = 'OS X'
           caps['os_version'] = 'High Sierra'
           caps['resolution'] = "#{width}x#{height}"
           caps['project'] = opts[:project]
+          caps['browserstack.local'] = opts[:local_testing].to_s
 
           @options = {
             url: "http://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub",

data/lib/browsenator/remote/browserstack/edge.rb

@@ -0,0 +1,38 @@
+require 'watir'
+require_relative 'browserstack_credentials'
+require_relative 'window_size'
+
+module Browsenator
+  module Remote
+    module Browserstack
+      class Edge
+        include BrowserstackCredentials
+        include WindowSize
+
+        def initialize(opts = {})
+          caps = Selenium::WebDriver::Remote::Capabilities.new
+          caps['browser'] = 'Edge'
+          caps['browser_version'] = opts[:browser_version] || '17.0'
+          caps['os'] = 'Windows'
+          caps['os_version'] = '10'
+          caps['resolution'] = "#{width}x#{height}"
+          caps['project'] = opts[:project]
+          caps['browserstack.local'] = opts[:local_testing].to_s
+
+          @options = {
+            url: "http://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub",
+            desired_capabilities: caps
+          }
+        end
+
+        def open
+          Watir::Browser.new :remote, options
+        end
+
+        private
+
+        attr_reader :options
+      end
+    end
+  end
+end

data/lib/browsenator/remote/browserstack/ie.rb

@@ -0,0 +1,38 @@
+require 'watir'
+require_relative 'browserstack_credentials'
+require_relative 'window_size'
+
+module Browsenator
+  module Remote
+    module Browserstack
+      class IE
+        include BrowserstackCredentials
+        include WindowSize
+
+        def initialize(opts = {})
+          caps = Selenium::WebDriver::Remote::Capabilities.new
+          caps['browser'] = 'IE'
+          caps['browser_version'] = opts[:browser_version] || '11.0'
+          caps['os'] = 'Windows'
+          caps['os_version'] = '10'
+          caps['resolution'] = "#{width}x#{height}"
+          caps['project'] = opts[:project]
+          caps['browserstack.local'] = opts[:local_testing].to_s
+
+          @options = {
+            url: "http://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub",
+            desired_capabilities: caps
+          }
+        end
+
+        def open
+          Watir::Browser.new :remote, options
+        end
+
+        private
+
+        attr_reader :options
+      end
+    end
+  end
+end

data/lib/browsenator/remote/browserstack/safari.rb

@@ -10,13 +10,16 @@ module Browsenator
         include WindowSize
 
         def initialize(opts = {})
+          browser_version = opts[:browser_version] || '11.1'
+
           caps = Selenium::WebDriver::Remote::Capabilities.new
           caps['browser'] = 'Safari'
-          caps['browser_version'] = '11.1'
+          caps['browser_version'] = browser_version
           caps['os'] = 'OS X'
-          caps['os_version'] = 'High Sierra'
+          caps['os_version'] = @@os_version[browser_version]
           caps['resolution'] = "#{width}x#{height}"
           caps['project'] = opts[:project]
+          caps['browserstack.local'] = opts[:local_testing].to_s
 
           @options = {
             url: "http://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub",
@@ -31,6 +34,17 @@ module Browsenator
         private
 
         attr_reader :options
+
+        @@os_version = {
+          '11.1' => 'High Sierra',
+          '10.1' => 'Sierra',
+          '9.1' => 'El Capitan',
+          '8.0' => 'Yosemite',
+          '7.1' => 'Mavericks',
+          '6.2' => 'Mountain Lion',
+          '6.0' => 'Lion',
+          '5.1' => 'Snow Leopard'
+        }
       end
     end
   end

data/lib/browsenator/remote/browserstack.rb

@@ -1,5 +1,7 @@
 require_relative 'browserstack/chrome'
 require_relative 'browserstack/safari'
+require_relative 'browserstack/edge'
+require_relative 'browserstack/ie'
 
 module Browsenator
   module Remote
@@ -10,6 +12,10 @@ module Browsenator
           Chrome.new(opts).open
         when :safari
           Safari.new(opts).open
+        when :edge
+          Edge.new(opts).open
+        when :ie
+          IE.new(opts).open
         else
           raise ArgumentError, "Unknown Browserstack browser: #{browser.inspect}"
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browsenator
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Aida Manna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir
@@ -139,6 +139,8 @@ files:
 - lib/browsenator/remote/browserstack.rb
 - lib/browsenator/remote/browserstack/browserstack_credentials.rb
 - lib/browsenator/remote/browserstack/chrome.rb
+- lib/browsenator/remote/browserstack/edge.rb
+- lib/browsenator/remote/browserstack/ie.rb
 - lib/browsenator/remote/browserstack/safari.rb
 - lib/browsenator/remote/browserstack/window_size.rb
 homepage: https://github.com/Typeform/browsenator
@@ -160,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Easily start different browsers