special_sauce 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c861dcfea52c8836c7d645bd64f009a768a0e2b5
-  data.tar.gz: e2c388db2f03e0e73a3cceb7d39828b9de71e03c
+  metadata.gz: 03137b3e4dcc6c8bc674f5ff2df06d2a44d3d51e
+  data.tar.gz: 70072679b00e5d88504415378bde5ab9c409944e
 SHA512:
-  metadata.gz: 0889cc057466f6ebf0d2da9d269164dc6b7be2353389b632eead937a448bb90e06a0f51daa84336fd4e98f90c3995719935be7ed6457ced98ff31854cfafffe4
-  data.tar.gz: cff53e4e149cef8a6e7511de099d54d3ed18bdf3e7a59009bab60125a2f76939e499b8563a474ce6337afb2efab0499d4998c5beb8a5dd5dae15ebc8d8f16cb6
+  metadata.gz: 2f3de8a1fb1cf790a2975b01365d52baf0797f9493622a07c7cdd6b715a49e43e6850af9627d8672375abe3db07daa0e1aea561bcc302a4c6c4dbb5067f775f5
+  data.tar.gz: d359dea36ac55c5d09d92a24df1c55935bca71f0e8199f651be9d90770f5c116c31a600b28beb53081feeef450ae5b7e289493107988f259d6d841cbab1c9d2b

data/README.md

@@ -3,17 +3,17 @@
 [![Build Status](https://travis-ci.org/nativestranger/special_sauce.svg?branch=master)](https://travis-ci.org/nativestranger/special_sauce)
 
 
-special_sauce makes it easy to run existing [capybara](https://github.com/teamcapybara/capybara) or [watir](https://github.com/watir/watir) based tests against [SauceLabs](https://saucelabs.com/) browsers.
+special_sauce makes it easy to run existing [capybara](https://github.com/teamcapybara/capybara) or [watir](https://github.com/watir/watir) based (selenium) tests against [Sauce Labs](https://saucelabs.com/) browsers.
 
 ## Installation
 
 ```ruby
-gem 'special_sauce', git: 'https://github.com/nativestranger/special_sauce.git'
+gem 'special_sauce', '0.2.0'
 ```
 
 ## Watir Example
 
-If the authentication ENV variables are set, `special_sauce` will try to setup a remote browser, otherwise default to chrome.
+If the authentication ENV variables are set, `special_sauce` will try to set up a remote browser, otherwise default to chrome.
 
 ``` ruby
 @browser = SpecialSauce::Watir.browser || Watir::Browser.new(:chrome)
@@ -21,15 +21,21 @@ If the authentication ENV variables are set, `special_sauce` will try to setup a
 
 ## Capybara Example
 
-If the authentication ENV variables are set, `special_sauce` will try to setup a remote browser, otherwise use your capybara default.
+If the authentication ENV variables are set, `special_sauce` will try to set up a remote browser and set the current drivers, otherwise use Chrome locally.
 
 ``` ruby
-@browser = SpecialSauce::Capybara.browser || Capybara.current_session
+Capybara.register_driver :selenium_chrome do |app|
+  Capybara::Selenium::Driver.new(app, :browser => :chrome)
+end
+
+SpecialSauce::Capybara.setup_session || Capybara.current_driver = :selenium_chrome
 ```
 
 ## Environment Variables
 
-In order to create remote sessions with Sauce Labs, some environment variables must be set.
+`special_sauce` relies on the following env vars to set up remote sessions with sauce labs.
+
+You can set these explicitly or rely on the [Sauce OnDemand Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Sauce+OnDemand+Plugin) to set them in Jenkins builds.
 
 **Authentication Variables - Required**
 
@@ -38,40 +44,13 @@ In order to create remote sessions with Sauce Labs, some environment variables m
 | SAUCE_USER_NAME        | your saucelabs username                  |
 | SAUCE_API_KEY          | saucelabs api key for your username      |
 
-**Optional**
-
-*The following 3 are set automatically when Jenkin's [Sauce OnDemand Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Sauce+OnDemand+Plugin) is configured to run against **one browser**.*
-
-| Environment Variable   |      Value                               |
-|----------              |:----------------------------------------:|
-| SELENIUM_BROWSER       | browser name                             |
-| SELENIUM_VERSION       | browser version                          |
-| SELENIUM_PLATFORM      | operating system & version               |
-
-OR
-
-*`SAUCE_ONDEMAND_BROWSERS` is set automatically when Jenkin's [Sauce OnDemand Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Sauce+OnDemand+Plugin) is configured to run against **multiple browsers**.*
-
-| Environment Variable    |      Value                                     |
-|----------               |:----------------------------------------------:|
-| SAUCE_ONDEMAND_BROWSERS | JSON serialized array of browser capabilities  |
-| CURRENT_BROWSER_ID | **Set this to choose the browser caps from `SAUCE_ONDEMAND_BROWSERS` that should be used. '0' will be the first in the array, '1' will be the second, etc.** |
-
 ## How Browser Capabilities are set.
 
-When calling `SpecialSauce::Watir.browser` or `SpecialSauce::Capybara.browser` without any arguments, `special_sauce` will use the environment variables above to determine browser capabilities.
+When calling `SpecialSauce::Watir.browser` or `SpecialSauce::Capybara.setup_session` without any arguments, `special_sauce` will use env vars to determine browser capabilities.
 
-* When `SAUCE_ONDEMAND_BROWSERS` is absent, `SELENIUM_BROWSER`, `SELENIUM_VERSION`, and `SELENIUM_PLATFORM` is used.
-
-* When `SAUCE_ONDEMAND_BROWSERS` is present, the value is parsed into an array and the caps are set based on `CURRENT_BROWSER_ID`.
-
-## Adding Browser Capabilities
-To add additional browser capabilities, use `plus_caps`:
+You may set these explicitly [or rely on the Sauce OnDemand Plugin](docs/JENKINS_PLUGIN_ENV.md) to set them for you.
 
-``` ruby
-additional_caps = { 'tunnel-identifier' => ENV['TRAVIS_JOB_NUMBER'] }
-@browser = SpecialSauce::Watir.browser(plus_caps: additional_caps)
-```
+**It is recommended you explicitly declare your browser capabilities with `using_caps`.**
 
 ## Overriding Browser Capabilities
 To override default browser capabilities, use `using_caps`:
@@ -83,6 +62,14 @@ custom_caps = { 'browserName' => 'internet explorer',
 @browser = SpecialSauce::Watir.browser(using_caps: custom_caps)
 ```
 
+## Adding Browser Capabilities
+To add additional browser capabilities, use `plus_caps`:
+
+``` ruby
+additional_caps = { 'tunnel-identifier' => ENV['TRAVIS_JOB_NUMBER'] }
+SpecialSauce::Capybara.setup_session(plus_caps: additional_caps)
+```
+
 ## Sauce Labs Options
 
 See [Sauce Lab's Documentation](https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options) for more options such as test name, build number, and screen resolution.
@@ -94,12 +81,13 @@ additional_caps = { 'name' => 'my test name', 'screenResolution' => '1280x1024'
 
 ## [Tips for running against multiple browsers](docs/MULTIPLEBROWSERS.md)
 
+## [CHANGLELOG](docs/CHANGELOG.md)
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 # TODO
 
-* appraise more versions of ruby & versions of capybara & watir.
-* allow customization of ENV variables?
-* update description
-* add contributing version
+* Appraise more versions of ruby & versions of capybara & watir.
+* Allow customization of ENV variables?
+* Add 'contributing' section.

data/lib/special_sauce/capybara.rb

@@ -2,7 +2,19 @@ module SpecialSauce
   class Capybara < SpecialSauce::Driver
 
     def self.current_session(options = {})
-      puts "Sauce Labs auth ENV variables not set." && return unless auth?
+      Kernel.warn(
+        "SpecialSauce::Capybara#current_session is deprecated and will be removed in v1.0.0. Use 'setup_session' instead."
+      )
+      setup_session(options)
+    end
+
+    def self.setup_session(options = {})
+      unless auth?
+        Kernel.warn(
+          'Sauce Labs auth ENV variables not set ... skipping SpecialSauce::Capybara.setup_session'
+        )
+        return
+      end
 
       ::Capybara.register_driver :special_sauce do |app|
         ::Capybara::Selenium::Driver.new(
@@ -14,6 +26,7 @@ module SpecialSauce
       end
 
       ::Capybara.current_driver = :special_sauce
+      ::Capybara.javascript_driver = :special_sauce
 
       ::Capybara.current_session
     end

data/lib/special_sauce/version.rb

@@ -1,3 +1,3 @@
 module SpecialSauce
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/special_sauce/watir.rb

@@ -2,7 +2,12 @@ module SpecialSauce
   class Watir < SpecialSauce::Driver
 
     def self.browser(options = {})
-      puts "Sauce Labs auth ENV variables not set." && return unless auth?
+      unless auth?
+        Kernel.warn(
+          'Sauce Labs auth ENV variables not set ... skipping SpecialSauce::Watir.browser'
+        )
+        return
+      end
 
       ::Watir::Browser.new(
         :remote,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: special_sauce
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Arnold
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails