sauce_bindings 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f5442812caea4803e008a9eefa48c95401eff9f26f1dc4b649b480afc2ed745
+  data.tar.gz: 3772c4032b1f44cec5ddbb26f8e70ce3f75543fcf5668145bbd42cee49bdf76b
+SHA512:
+  metadata.gz: 9e2d316260e0f3dfc0223546b11f87d635594fe6dfa5fe413c2491e0c8f58838d9fe3e7510299b88037a46cd8fac53b0142b5caeeb84fb80819c8bf5b1e884fc
+  data.tar.gz: 3e4dbae2ec880b4401efe7c67e9a9c5545d7a044e8d6f75005c3289c01df2df0404fbf20e11b142ff07c411dc454dd01029e49166d8ee036fa311094ee5fe3cb

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/.idea/
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+#ignore Gemfile.lock
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,49 @@
+AllCops:
+  TargetRubyVersion: 2.5.3
+
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Max: 22
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/sauce_bindings/options.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 16
+
+Metrics/ModuleLength:
+  CountComments: false
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/DescribedClass:
+  EnforcedStyle: explicit

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sauce_bindings.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Titus Fortner
+
+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,116 @@
+# SimpleSauce 
+## Ruby's Sauce Labs Bindings!
+
+This gem is intended as a way to easily interact with Sauce Labs in an obvious and straightforward way. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sauce_bindings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sauce_bindings
+
+## Running Tests
+
+To run tests for the Ruby Sauce Bindings, execute
+
+    $ bundle exec rake
+
+## Usage
+
+`SimpleSauce` is broken into two main components, `Options` and `Session`
+
+### Options class
+`Options` provides an easy interface to the Sauce Labs specific settings you want in your tests.
+
+If you want the default settings (the latest Chrome version on Windows 10) with no other settings,
+this is all the code you need:
+```
+sauce_opts = SimpleSauce::Options.new
+```
+To specify additional 
+[Sauce Labs supported settings](https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options),
+simply pass these in as a `Hash`, or use an accessor:
+```
+sauce_options = {screen_resolution: '1080x720',
+                 browser_name: 'Firefox',
+                 platform_name: 'Mac OS'}
+sauce_opts = SimpleSauce::Options.new(sauce_options)
+sauce_opts.idle_timeout = 100
+```
+if you have additional browser specific settings, or 
+[webdriver w3c spec compliant settings](http://w3c.github.io/webdriver/webdriver-spec.html#capabilities), in 
+Selenium 3.x you need to generate each of these separately; see the `Session` class below for how to use it:
+```
+sauce_options = SimpleSauce::Options.new(screen_resolution: '1080x720',
+                                         browser_name: 'Firefox',
+                                         platform_name: 'Mac OS')
+
+selenium_options = Selenium::WebDriver::Remote::Capabilities.new(accept_insecure_certs: false,
+                                                                 page_load_strategy: 'eager'}
+
+browser_options = Selenium::WebDriver::Firefox::Options.new('args' => ['-foo'])
+```
+
+### Session class
+#### Intializing a Session
+`Session` class gets initialized with an `Options` instance. If you want the
+default settings (latest Chrome version on Windows 10), you don't even need to use an `Options` instance:
+```ruby
+@session = SauceBindings::Session.new
+```
+If you want something other than the default, create a Sauce `Option` instance (as generated in the section above,
+then pass it into the constructor:
+```ruby
+@session = SauceBindings::Session.new(sauce_opts)
+```
+If you also have Selenium or Browser options as described above, then you pass them in with an `Array` like so:
+```ruby
+@session = SauceBindings::Session.new([sauce_opts, se_opts, browser_opts])
+```
+
+#### Creating a driver instance
+The `#start` method is required, and will return a `Selenium::WebDriver::<Browser>::Driver` instance,
+and the `#stop` method will automatically quit the driver as well as ending the Sauce Labs session.
+```ruby
+session = SauceBindings::Session.new
+driver = session.start
+# Use the driver
+session.stop
+```
+Note that the `Driver` instance can also be obtained at any time with the `#driver` method:
+```ruby
+session = SauceBindings::Session.new
+session.start
+driver = session.driver
+# Use the driver
+session.stop
+```
+#### Additional Session methods
+We have a number of features we plan to add; stay tuned to see what additional features are made available. If you
+have any request, please contact the Sauce Labs Solution Architect team.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sauce/sauce_bindings. 
+This project is intended to be a safe, welcoming space for collaboration, 
+and contributors are expected to adhere to the 
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimpleSauce project’s codebases, issue trackers, chat rooms and mailing lists 
+is expected to follow the [code of conduct](https://github.com/saucelabs/sauce_bindings/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sauce_bindings.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'sauce_bindings/version'
+require 'sauce_bindings/options'
+require 'sauce_bindings/session'

data/lib/sauce_bindings/capybara_session.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'sauce_bindings'
+require 'capybara'
+
+module SauceBindings
+  class CapybaraSession < Session
+    def initialize(*)
+      super
+
+      Capybara.register_driver :sauce do |app|
+        Capybara::Selenium::Driver.new(app, **{browser: :remote}.merge(to_selenium))
+      end
+      Capybara.current_driver = :sauce
+    end
+
+    def start
+      raise ArgumentError, "needs username; use `ENV['SAUCE_USERNAME']` or `Session#username=`" unless @username
+      raise ArgumentError, "needs access_key; use `ENV['SAUCE_ACCESS_KEY']` or `Session#access_key=`" unless @access_key
+
+      @capybara_driver = Capybara.current_session.driver
+      @driver = @capybara_driver.browser
+    end
+
+    def stop(result)
+      return if @driver.nil?
+
+      SauceWhisk::Jobs.change_status(@driver.session_id, result)
+
+      Capybara.current_session.quit
+    end
+  end
+end

data/lib/sauce_bindings/options.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'selenium-webdriver'
+
+module SauceBindings
+  class Options
+    class << self
+      def camel_case(str)
+        str.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+      end
+    end
+
+    BROWSER_NAMES = {Selenium::WebDriver::Chrome::Options => 'chrome',
+                     Selenium::WebDriver::Edge::Options => 'MicrosoftEdge',
+                     Selenium::WebDriver::Firefox::Options => 'firefox',
+                     Selenium::WebDriver::IE::Options => 'internet explorer',
+                     Selenium::WebDriver::Safari::Options => 'safari'}.freeze
+
+    W3C = %i[browser_name browser_version platform_name accept_insecure_certs page_load_strategy proxy
+             set_window_rect timeouts unhandled_prompt_behavior strict_file_interactability].freeze
+
+    SAUCE = %i[avoid_proxy build chromedriver_version command_timeout custom_data extended_debugging idle_timeout
+               iedriver_version max_duration name parent_tunnel prerun priority public record_logs record_screenshots
+               record_video screen_resolution selenium_version tags time_zone tunnel_identifier video_upload_on_pass
+               capture_performance].freeze
+
+    attr_accessor :browser_name, :browser_version, :platform_name, :accept_insecure_certs, :page_load_strategy, :proxy,
+                  :set_window_rect, :timeouts, :unhandled_prompt_behavior, :strict_file_interactability, :avoid_proxy,
+                  :build, :chromedriver_version, :command_timeout, :custom_data, :extended_debugging, :idle_timeout,
+                  :iedriver_version, :max_duration, :name, :parent_tunnel, :prerun, :priority, :public, :record_logs,
+                  :record_screenshots, :record_video, :screen_resolution, :selenium_version, :tags, :time_zone,
+                  :tunnel_identifier, :video_upload_on_pass, :capture_performance
+    attr_reader :selenium_options
+
+    def initialize(**opts)
+      parse_selenium_options(opts.delete(:selenium_options))
+      create_variables(SAUCE + W3C, opts)
+      @build ||= build_name
+
+      @browser_name ||= selenium_options['browserName'] || 'chrome'
+      @platform_name ||= 'Windows 10'
+      @browser_version ||= 'latest'
+    end
+
+    def capabilities
+      caps = selenium_options.dup
+      W3C.each do |key|
+        value = send(key)
+        key = self.class.camel_case(key)
+        value = parse_w3c_key(key, value)
+        caps[key] = value unless value.nil?
+      end
+      caps['sauce:options'] = {}
+      SAUCE.each do |key|
+        value = send(key)
+        key = self.class.camel_case(key)
+        value = parse_sauce_key(key, value)
+        caps['sauce:options'][key] = value unless value.nil?
+      end
+      caps
+    end
+    alias as_json capabilities
+
+    def merge_capabilities(opts)
+      opts.each do |key, value|
+        raise ArgumentError, "#{key} is not a valid parameter for Options class" unless respond_to?("#{key}=")
+
+        if value.is_a?(Hash)
+          value = value.each_with_object({}) do |(old_key, val), updated|
+            updated[old_key.to_sym] = val
+          end
+        end
+
+        send("#{key}=", value)
+      end
+    end
+
+    private
+
+    def parse_w3c_key(key, value)
+      if key == 'proxy' && value
+        value.as_json
+      elsif key == 'timeouts' && value
+        value.each_with_object({}) do |(old_key, val), updated|
+          updated[self.class.camel_case(old_key)] = val
+        end
+      else
+        value
+      end
+    end
+
+    def parse_sauce_key(key, value)
+      if key == 'prerun' && value.is_a?(Hash)
+        value.each_with_object({}) do |(old_key, val), updated|
+          updated[self.class.camel_case(old_key)] = val
+        end
+      elsif key == 'customData' && value.is_a?(Hash)
+        value.each_with_object({}) do |(old_key, val), updated|
+          updated[self.class.camel_case(old_key)] = val
+        end
+      else
+        value
+      end
+    end
+
+    def parse_selenium_options(selenium_opts)
+      opts = Array(selenium_opts)
+
+      opts.each do |opt|
+        browser = BROWSER_NAMES[opt.class]
+        if browser
+          @browser_name = browser
+        else
+          W3C.each do |capability|
+            send("#{capability}=", opt[capability]) if opt[capability]
+          end
+        end
+      end
+
+      @selenium_options = opts.map(&:as_json).inject(:merge) || {}
+    end
+
+    def create_variables(key, opts)
+      key.each do |option|
+        self.class.__send__(:attr_accessor, option)
+        next unless opts.key?(option)
+
+        instance_variable_set("@#{option}", opts.delete(option))
+      end
+      return if opts.empty?
+
+      raise ArgumentError, "#{opts.inspect} are not valid parameters for Options class"
+    end
+
+    def build_name
+      # Jenkins
+      if ENV['BUILD_TAG']
+        "#{ENV['BUILD_NAME']}: #{ENV['BUILD_NUMBER']}"
+      # Bamboo
+      elsif ENV['bamboo_agentId']
+        "#{ENV['bamboo_shortJobName']}: #{ENV['bamboo_buildNumber']}"
+      # Travis
+      elsif ENV['TRAVIS_JOB_ID']
+        "#{ENV['TRAVIS_JOB_NAME']}: #{ENV['TRAVIS_JOB_NUMBER']}"
+      # CircleCI
+      elsif ENV['CIRCLE_JOB']
+        "#{ENV['CIRCLE_JOB']}: #{ENV['CIRCLE_BUILD_NUM']}"
+      # Gitlab
+      elsif ENV['CI']
+        "#{ENV['CI_JOB_NAME']}: #{ENV['CI_JOB_ID']}"
+      # Team City
+      elsif ENV['TEAMCITY_PROJECT_NAME']
+        "#{ENV['TEAMCITY_PROJECT_NAME']}: #{ENV['BUILD_NUMBER']}"
+      # Default
+      else
+        "Build Time - #{Time.now.to_i}"
+      end
+    end
+  end
+end