dressing 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dressing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric J. Holmes
+
+MIT License
+
+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,42 @@
+# Dressing
+
+> A lighter weight alternative to sauce.
+
+Dressing is a Ruby gem for running [Capybara](https://github.com/jnicklas/capybara) scenarios with [Sauce Labs](https://saucelabs.com).
+It's an alternative to the official `sauce` gem, which is clunky, bloated and difficult to use.
+
+## Usage
+
+### RSpec + Capybara
+
+```ruby
+require 'dressing/rspec'
+
+RSpec.configure do |config|
+  config.include Capybara::DSL
+  config.include Dressing::RSpec
+end
+```
+
+That's it, you're done. Each test will be run in it's own session on Sauce Labs and you'll be able to see whether
+the test failed or passed in the Sauce Labs UI.
+
+## Configuration
+
+```ruby
+Dressing.configure do |config|
+  config.browser = 'Chrome'
+  config.os = 'Windows 7'
+  config.version = 27
+
+  config.tunnel_identifier = ENV['TRAVIS_JOB_NUMBER']
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/bin/sauce_connect_block.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+
+# Wait for Connect to be ready before exiting
+while [ ! -f $SAUCE_CONNECT_READY_FILE ]; do
+  sleep .5
+done

data/bin/sauce_connect_setup.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+set -e
+
+# Setup and start Sauce Connect for your TravisCI build
+# This script requires your .travis.yml to include the following two private env variables:
+# SAUCE_USERNAME
+# SAUCE_ACCESS_KEY
+# Follow the steps at https://saucelabs.com/opensource/travis to set that up.
+#
+# Curl and run this script as part of your .travis.yml before_script section:
+# before_script:
+#   - curl https://gist.github.com/santiycr/5139565/raw/sauce_connect_setup.sh | bash
+
+CONNECT_URL="http://saucelabs.com/downloads/Sauce-Connect-latest.zip"
+CONNECT_DIR="/tmp/sauce-connect-$RANDOM"
+CONNECT_DOWNLOAD="Sauce_Connect.zip"
+
+CONNECT_LOG="$LOGS_DIR/sauce-connect"
+CONNECT_STDOUT="$LOGS_DIR/sauce-connect.stdout"
+CONNECT_STDERR="$LOGS_DIR/sauce-connect.stderr"
+
+# Get Connect and start it
+mkdir -p $CONNECT_DIR
+cd $CONNECT_DIR
+curl $CONNECT_URL -o $CONNECT_DOWNLOAD 2> /dev/null 1> /dev/null
+unzip $CONNECT_DOWNLOAD > /dev/null
+rm $CONNECT_DOWNLOAD
+
+ARGS=""
+
+# Set tunnel-id only on Travis, to make local testing easier.
+if [ ! -z "$TRAVIS_JOB_NUMBER" ]; then
+  ARGS="$ARGS --tunnel-identifier $TRAVIS_JOB_NUMBER"
+fi
+if [ ! -z "$SAUCE_CONNECT_READY_FILE" ]; then
+  ARGS="$ARGS --readyfile $SAUCE_CONNECT_READY_FILE"
+fi
+
+
+echo "Starting Sauce Connect in the background, logging into:"
+echo "  $CONNECT_LOG"
+echo "  $CONNECT_STDOUT"
+echo "  $CONNECT_STDERR"
+java -jar Sauce-Connect.jar $ARGS $SAUCE_USERNAME $SAUCE_ACCESS_KEY \
+  --logfile $CONNECT_LOG 2> $CONNECT_STDERR 1> $CONNECT_STDOUT &

data/dressing.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dressing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dressing'
+  spec.version       = Dressing::VERSION
+  spec.authors       = ['Eric J. Holmes']
+  spec.email         = ['eric@ejholmes.net']
+  spec.description   = %q{A Capybara driver for Sauce Labs}
+  spec.summary       = %q{A Capybara driver for Sauce Labs}
+  spec.homepage      = 'https://github.com/ejholmes/dressing'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'selenium-webdriver'
+  spec.add_dependency 'sauce_whisk'
+  spec.add_dependency 'net-http-persistent'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'rake'
+end

data/lib/dressing.rb

@@ -0,0 +1,61 @@
+require 'selenium/webdriver'
+require 'selenium/webdriver/remote/http/persistent'
+
+require 'dressing/version'
+
+module Dressing
+  autoload :Configuration, 'dressing/configuration'
+  autoload :RSpec, 'dressing/rspec'
+
+  module Runner
+    autoload :Base, 'dressing/runner/base'
+    autoload :RSpec, 'dressing/runner/rspec'
+  end
+
+  module Capabilities
+    autoload :Base, 'dressing/capabilities/base'
+    autoload :RSpec, 'dressing/capabilities/rspec'
+  end
+
+  module Capybara
+    autoload :Driver, 'dressing/capybara/driver'
+    autoload :Session, 'dressing/capybara/session'
+  end
+
+  class << self
+    attr_accessor :current_session
+
+    def current_session
+      @current_session ||= ::Capybara.current_session
+    end
+
+    def using_driver(driver)
+      old_session = current_session
+      Dressing.current_session = Capybara::Session.new driver
+      yield
+    ensure
+      driver.quit
+      Dressing.current_session = old_session
+    end
+
+    def app
+      ::Capybara.app
+    end
+
+    def http_client
+      @http_client ||= begin
+        client = Selenium::WebDriver::Remote::Http::Persistent.new
+        client.timeout = configuration.http_timeout
+        client
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/dressing/capabilities/base.rb

@@ -0,0 +1,26 @@
+module Dressing
+  module Capabilities
+    class Base
+      attr_reader :example
+
+      def initialize(example)
+        @example = example
+      end
+
+      def to_h
+        { 'job-name' => job_name }.merge(configuration.to_capabilities)
+      end
+
+      def job_name
+        raise NotImplementedError
+      end
+
+    private
+
+      def configuration
+        Dressing.configuration
+      end
+
+    end
+  end
+end

data/lib/dressing/capabilities/rspec.rb

@@ -0,0 +1,17 @@
+module Dressing
+  module Capabilities
+    class RSpec < Base
+
+      def job_name
+        metadata[:full_description]
+      end
+
+    private
+
+      def metadata
+        example.metadata
+      end
+
+    end
+  end
+end

data/lib/dressing/capybara/driver.rb

@@ -0,0 +1,21 @@
+module Dressing
+  module Capybara
+    class Driver < ::Capybara::Selenium::Driver
+      def initialize(app, options = {})
+        options.merge!(
+          url: Dressing.configuration.remote_url,
+          http_client: Dressing.http_client
+        )
+        super
+      end
+
+      def browser
+        @browser ||= Selenium::WebDriver.for(:remote, options.reject { |key,val| SPECIAL_OPTIONS.include?(key) })
+      end
+
+      def session_id
+        browser.__send__(:bridge).session_id
+      end
+    end
+  end
+end

data/lib/dressing/capybara/session.rb

@@ -0,0 +1,12 @@
+module Dressing
+  module Capybara
+    class Session < ::Capybara::Session
+      attr_reader :driver
+
+      def initialize(driver)
+        @driver = driver
+        super nil, driver.app
+      end
+    end
+  end
+end

data/lib/dressing/configuration.rb

@@ -0,0 +1,67 @@
+module Dressing
+  class Configuration
+    attr_accessor :browser
+    attr_accessor :os
+    attr_accessor :version
+
+    attr_accessor :username
+    attr_accessor :access_key
+
+    POTENTIAL_PORTS = [
+        3000, 3001, 3030, 3210, 3333, 4000, 4001, 4040, 4321, 4502, 4503, 5000,
+        5001, 5050, 5555, 5432, 6000, 6001, 6060, 6666, 6543, 7000, 7070, 7774,
+        7777, 8000, 8001, 8003, 8031, 8080, 8081, 8765, 8888, 9000, 9001, 9080,
+        9090, 9876, 9999, 49221, 55001, 80, 443, 888, 2000, 2001, 2020, 2109,
+        2222, 2310
+    ]
+
+    SAUCE_OPTIONS = %w(record-video record-screenshots capture-html tags
+        sauce-advisor single-window user-extensions-url firefox-profile-url
+        max-duration idle-timeout build custom-data tunnel-identifier
+        selenium-version command-timeout prerun prerun-args screen-resolution
+        disable-popup-handler avoid-proxy public name)
+
+    SAUCE_OPTIONS.each do |option|
+      attr_accessor :"#{option.gsub('-', '_')}"
+    end
+
+    def initialize
+      self.browser           = ENV['SAUCE_BROWSER'] || 'Chrome'
+      self.os                = ENV['SAUCE_OS'] || 'Windows 7'
+      self.version           = ENV['SAUCE_VERSION']
+
+      self.username          = ENV['SAUCE_USERNAME']
+      self.access_key        = ENV['SAUCE_ACCESS_KEY']
+
+      self.tunnel_identifier = ENV['SAUCE_TUNNEL_IDENTIFIER'] || ENV['TRAVIS_JOB_NUMBER']
+
+      self.build             = ENV['SAUCE_BUILD'] || ENV['TRAVIS_BUILD_NUMBER']
+      self.tags              = ENV['SAUCE_TAGS'] || travis_tags
+    end
+
+    def remote_url
+      "http://#{username}:#{access_key}@ondemand.saucelabs.com/wd/hub"
+    end
+
+    def http_timeout
+      300
+    end
+
+    def to_capabilities
+      { 'browserName' => browser,
+        'platform' => os,
+        'version' => version }.merge(
+          Hash[SAUCE_OPTIONS.map { |option| [option, __send__(:"#{option.gsub('-', '_')}")] }]
+        ).keep_if { |key, value| !value.nil? }
+    end
+
+    def travis_tags
+      return nil unless ENV['TRAVIS']
+      tags = ['travis']
+      tags << "branch:#{ENV['TRAVIS_BRANCH']}"
+      tags << "repo:#{ENV['TRAVIS_REPO_SLUG']}"
+      tags << "commit:#{ENV['TRAVIS_COMMIT']}"
+      tags
+    end
+  end
+end

data/lib/dressing/rspec.rb

@@ -0,0 +1,15 @@
+require 'dressing'
+require 'rspec'
+require 'capybara/rspec'
+
+module Dressing
+  module RSpec
+    def page
+      Dressing.current_session
+    end
+
+    def self.included(config)
+      config.around { |test| Runner::RSpec.run test, example }
+    end
+  end
+end

data/lib/dressing/runner/base.rb

@@ -0,0 +1,60 @@
+require 'sauce_whisk'
+
+module Dressing
+  module Runner
+    class Base
+      attr_reader :test
+
+      def self.run(*args)
+        new(*args).run
+      end
+
+      def initialize(test)
+        @test = test
+      end
+
+      def run
+        Dressing.using_driver driver do
+          run_test
+          update_status
+        end
+      end
+
+      def run_test
+        raise NotImplementedError
+      end
+
+      def passed?
+        raise NotImplementedError
+      end
+
+    private
+
+      def app
+        Dressing.app
+      end
+
+      def driver
+        @driver ||= Capybara::Driver.new app, desired_capabilities: capabilities
+      end
+
+      def session_id
+        driver.session_id
+      end
+
+      def update_status
+        SauceWhisk::Jobs.change_status driver.session_id, passed?
+      end
+
+      def capabilities
+        capabilities_class.new(test).to_h
+      end
+
+      def capabilities_class
+        klass = :"#{self.class.to_s.gsub(/.*::/, '')}"
+        Capabilities.const_get klass
+      end
+
+    end
+  end
+end

data/lib/dressing/runner/rspec.rb

@@ -0,0 +1,20 @@
+module Dressing
+  module Runner
+    class RSpec < Base
+      attr_reader :example
+
+      def initialize(test, example)
+        @example = example
+        super test
+      end
+
+      def run_test
+        test.run
+      end
+
+      def passed?
+        example.exception.nil?
+      end
+    end
+  end
+end

data/lib/dressing/version.rb

@@ -0,0 +1,3 @@
+module Dressing
+  VERSION = '0.0.1'
+end

data/spec/capybara_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'capybara/rspec'
+require 'dressing/rspec'
+
+def app
+  lambda { |env| [200, {'Content-Type' => 'text/html'}, ['<body><h1>Hello world</h1><a href="#">Button</a></body>']] }
+end
+
+Capybara.app = app
+Capybara.server_port = 9999
+
+RSpec.configure do |config|
+  config.include Capybara::DSL
+  config.include Dressing::RSpec
+end
+
+describe 'page' do
+  2.times do |i|
+    it "runs the page on sauce labs ##{i}" do
+      visit '/'
+      expect(page).to have_content 'Hello world'
+    end
+  end
+
+  it 'clicks buttons' do
+    visit '/'
+    click_on 'Button'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+Bundler.require :default, :test

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: dressing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sauce_whisk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Capybara driver for Sauce Labs
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sauce_connect_block.sh
+- bin/sauce_connect_setup.sh
+- dressing.gemspec
+- lib/dressing.rb
+- lib/dressing/capabilities/base.rb
+- lib/dressing/capabilities/rspec.rb
+- lib/dressing/capybara/driver.rb
+- lib/dressing/capybara/session.rb
+- lib/dressing/configuration.rb
+- lib/dressing/rspec.rb
+- lib/dressing/runner/base.rb
+- lib/dressing/runner/rspec.rb
+- lib/dressing/version.rb
+- spec/capybara_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ejholmes/dressing
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 134270101903359235
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 134270101903359235
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Capybara driver for Sauce Labs
+test_files:
+- spec/capybara_spec.rb
+- spec/spec_helper.rb