special_sauce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c861dcfea52c8836c7d645bd64f009a768a0e2b5
+  data.tar.gz: e2c388db2f03e0e73a3cceb7d39828b9de71e03c
+SHA512:
+  metadata.gz: 0889cc057466f6ebf0d2da9d269164dc6b7be2353389b632eead937a448bb90e06a0f51daa84336fd4e98f90c3995719935be7ed6457ced98ff31854cfafffe4
+  data.tar.gz: cff53e4e149cef8a6e7511de099d54d3ed18bdf3e7a59009bab60125a2f76939e499b8563a474ce6337afb2efab0499d4998c5beb8a5dd5dae15ebc8d8f16cb6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Eric Arnold
+
+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,105 @@
+# SpecialSauce
+
+[![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.
+
+## Installation
+
+```ruby
+gem 'special_sauce', git: 'https://github.com/nativestranger/special_sauce.git'
+```
+
+## Watir Example
+
+If the authentication ENV variables are set, `special_sauce` will try to setup a remote browser, otherwise default to chrome.
+
+``` ruby
+@browser = SpecialSauce::Watir.browser || Watir::Browser.new(:chrome)
+```
+
+## Capybara Example
+
+If the authentication ENV variables are set, `special_sauce` will try to setup a remote browser, otherwise use your capybara default.
+
+``` ruby
+@browser = SpecialSauce::Capybara.browser || Capybara.current_session
+```
+
+## Environment Variables
+
+In order to create remote sessions with Sauce Labs, some environment variables must be set.
+
+**Authentication Variables - Required**
+
+| Environment Variable   |      Value                               |
+|----------              |:----------------------------------------:|
+| 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 `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`:
+
+``` ruby
+additional_caps = { 'tunnel-identifier' => ENV['TRAVIS_JOB_NUMBER'] }
+@browser = SpecialSauce::Watir.browser(plus_caps: additional_caps)
+```
+
+## Overriding Browser Capabilities
+To override default browser capabilities, use `using_caps`:
+
+``` ruby
+custom_caps = { 'browserName' => 'internet explorer',
+                'version' => '9',
+                'platform' => 'Windows 7' }
+@browser = SpecialSauce::Watir.browser(using_caps: custom_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.
+
+``` ruby
+additional_caps = { 'name' => 'my test name', 'screenResolution' => '1280x1024' }
+@browser = SpecialSauce::Watir.browser(plus_caps: additional_caps)
+```
+
+## [Tips for running against multiple browsers](docs/MULTIPLEBROWSERS.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

data/Rakefile

@@ -0,0 +1,47 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SpecialSauce'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = false
+end
+
+Rake::TestTask.new(:watir_test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/sauce/watir_test.rb'
+  t.verbose = false
+end
+
+Rake::TestTask.new(:capybara_test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/sauce/capybara_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/special_sauce/capybara.rb

@@ -0,0 +1,22 @@
+module SpecialSauce
+  class Capybara < SpecialSauce::Driver
+
+    def self.current_session(options = {})
+      puts "Sauce Labs auth ENV variables not set." && return unless auth?
+
+      ::Capybara.register_driver :special_sauce do |app|
+        ::Capybara::Selenium::Driver.new(
+          app,
+          browser: :remote,
+          url: sauce_endpoint,
+          desired_capabilities: desired_capabilities(options)
+        )
+      end
+
+      ::Capybara.current_driver = :special_sauce
+
+      ::Capybara.current_session
+    end
+
+  end
+end

data/lib/special_sauce/driver.rb

@@ -0,0 +1,67 @@
+module SpecialSauce
+  class Driver
+
+    class << self
+
+      def auth?
+        authentication != ':'
+      end
+
+      def authentication
+        "#{ ENV['SAUCE_USER_NAME'] }:#{ ENV['SAUCE_API_KEY'] }"
+      end
+
+      def sauce_endpoint
+        "http://#{ authentication }@ondemand.saucelabs.com:80/wd/hub"
+      end
+
+      # ENV vars for when running against a single saucelabs browser. (As set by jenkins plugin.)
+      #
+      # Example running locally against saucelabs:
+      # { 'browserName' => 'internet explorer',
+      #   'version' => '9',
+      #   'platform' => 'Windows 7' }
+      #
+      # https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
+      def single_browser_caps
+        { 'browserName' => ENV['SELENIUM_BROWSER'],
+          'version' => ENV['SELENIUM_VERSION'],
+          'platform' => ENV['SELENIUM_PLATFORM'] }
+      end
+
+      # Set SAUCE_ONDEMAND_BROWSERS when running against multiple saucelabs browers.
+      # The value should be a JSON serialized array of browser capabilities.
+      # (Set by jenkins plugin.)
+      def browsers
+        all_browser_caps = ENV['SAUCE_ONDEMAND_BROWSERS'] && JSON.parse(ENV['SAUCE_ONDEMAND_BROWSERS'])
+        if all_browser_caps && all_browser_caps.size > 0
+          all_browser_caps
+        else
+          [single_browser_caps]
+        end
+      end
+
+      # Jenkins plugin doesn't set browserName sometimes.
+      def sanitized_browser_options(current_browser_id)
+        options = browsers[current_browser_id]
+        options['browserName'] ||= options['browser']
+        options
+      end
+
+      def current_browser_caps
+        if ENV['CURRENT_BROWSER_ID']
+          sanitized_browser_options(ENV['CURRENT_BROWSER_ID'].to_i)
+        else
+          single_browser_caps
+        end
+      end
+
+      def desired_capabilities(options = {})
+        options[:plus_caps] ||= {}
+        options[:using_caps] || current_browser_caps.merge(options[:plus_caps])
+      end
+
+    end
+
+  end
+end

data/lib/special_sauce/version.rb

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

data/lib/special_sauce/watir.rb

@@ -0,0 +1,15 @@
+module SpecialSauce
+  class Watir < SpecialSauce::Driver
+
+    def self.browser(options = {})
+      puts "Sauce Labs auth ENV variables not set." && return unless auth?
+
+      ::Watir::Browser.new(
+        :remote,
+        url: sauce_endpoint,
+        desired_capabilities: desired_capabilities(options)
+      )
+    end
+
+  end
+end

data/lib/special_sauce.rb

@@ -0,0 +1,6 @@
+require 'special_sauce/driver'
+require 'special_sauce/capybara'
+require 'special_sauce/watir'
+
+module SpecialSauce
+end

data/lib/tasks/special_sauce_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :special_sauce do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: special_sauce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Arnold
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SpecialSauce helps you run your Capybara or Watir tests with Sauce Labs.
+email:
+- earnold@covermymeds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/special_sauce.rb
+- lib/special_sauce/capybara.rb
+- lib/special_sauce/driver.rb
+- lib/special_sauce/version.rb
+- lib/special_sauce/watir.rb
+- lib/tasks/special_sauce_tasks.rake
+homepage: https://github.com/nativestranger/special_sauce
+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.6.8
+signing_key: 
+specification_version: 4
+summary: SpecialSauce helps you run your Capybara or Watir tests with Sauce Labs.
+test_files: []