sauce_bindings 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e197c96695967d753e6c60e80e64a4845d10d5f06fbaf1dcf38c1a30d4aa9dc3
-  data.tar.gz: 42fe96bb1a78b8f3b2d0560151d5b52a73ca6cf56298bd8a54d63046e3b5450b
+  metadata.gz: 911fcc77b89278c32496a2c1e29a8076494208a2133fa4fa854e949d5db8437d
+  data.tar.gz: c8a91543d40f08b14fd3253e7ca32ecd639c9d2c24833f63c4668da51699ed27
 SHA512:
-  metadata.gz: 4f8a82b1d8029f0820fb79190529012c3a10e1dc9481ad8bc7a9023f5ee5089f90673438d4f7f49493c52f6b1d8acd586e1a536cc183060d4246b22ba8463361
-  data.tar.gz: beccada13701765b1cf497b8575c5cfd1688338bb9d1953ba990d0c107092512553285f525bfbe35364cb1a3fded8a1b945df42438ad1b24fc12f22b9573a748
+  metadata.gz: ce6d3809d1efd72a5b89b0130a659b4d82863b16cf14377480bdfc3989ddf6f4c4e4bf2d9105968a03ee378c295366982a00b008fe2d9a91186ca107c1ea6231
+  data.tar.gz: 6f9a7311e6c206e3ac8689d402bed4dfb7ec8f19e2380b4543e64ddcfc5ed2dbf673da00c9788b6cea8aa3f20a432ff08cf8235d9a22c72f1d585445e3e7c82d

data/.rspec

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

data/.rubocop.yml

@@ -9,17 +9,17 @@ Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
 Metrics/AbcSize:
-  Max: 22
+  Max: 25
 
 Metrics/BlockLength:
   Exclude:
     - "**/*_spec.rb"
 
 Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 8
 
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 9
 
 Metrics/ClassLength:
   Exclude:
@@ -29,7 +29,7 @@ Metrics/LineLength:
   Max: 120
 
 Metrics/MethodLength:
-  Max: 16
+  Max: 17
 
 Metrics/ModuleLength:
   CountComments: false
@@ -39,9 +39,18 @@ Metrics/ModuleLength:
 Style/Documentation:
   Enabled: false
 
+RSpec/AnyInstance:
+  Enabled: false
+
 RSpec/ExampleLength:
   Enabled: false
 
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
 RSpec/MultipleExpectations:
   Enabled: false
 

data/lib/sauce_bindings/options.rb

@@ -8,6 +8,31 @@ module SauceBindings
       def camel_case(str)
         str.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
       end
+
+      def chrome(**opts)
+        opts[:browser_name] = 'chrome'
+        Options.new(**opts)
+      end
+
+      def edge(**opts)
+        opts[:browser_name] = 'MicrosoftEdge'
+        Options.new(**opts)
+      end
+
+      def firefox(**opts)
+        opts[:browser_name] = 'firefox'
+        Options.new(**opts)
+      end
+
+      def ie(**opts)
+        opts[:browser_name] = 'internet explorer'
+        Options.new(**opts)
+      end
+
+      def safari(**opts)
+        opts[:browser_name] = 'safari'
+        Options.new(**opts)
+      end
     end
 
     BROWSER_NAMES = {Selenium::WebDriver::Chrome::Options => 'chrome',
@@ -145,8 +170,11 @@ module SauceBindings
       # CircleCI
       elsif ENV['CIRCLE_JOB']
         "#{ENV['CIRCLE_JOB']}: #{ENV['CIRCLE_BUILD_NUM']}"
+      # GitHub Actions
+      elsif ENV['GITHUB_SHA']
+        "#{ENV['GITHUB_WORKFLOW']}: #{ENV['GITHUB_SHA']}"
       # Gitlab
-      elsif ENV['CI']
+      elsif ENV['CI_JOB_NAME']
         "#{ENV['CI_JOB_NAME']}: #{ENV['CI_JOB_ID']}"
       # Team City
       elsif ENV['TEAMCITY_PROJECT_NAME']

data/lib/sauce_bindings/session.rb

@@ -7,7 +7,8 @@ module SauceBindings
   class Session
     DATA_CENTERS = {US_WEST: 'ondemand.us-west-1.saucelabs.com',
                     US_EAST: 'ondemand.us-east-1.saucelabs.com',
-                    EU_CENTRAL: 'ondemand.eu-central-1.saucelabs.com'}.freeze
+                    EU_CENTRAL: 'ondemand.eu-central-1.saucelabs.com',
+                    APAC_SOUTHEAST: 'ondemand.apac-southeast-1.saucelabs.com'}.freeze
 
     attr_writer :url
     attr_reader :driver, :options, :data_center
@@ -36,7 +37,7 @@ module SauceBindings
       SauceWhisk::Jobs.change_status(@driver.session_id, result)
       # Add output for the Sauce OnDemand Jenkins plugin
       # The first print statement will automatically populate links on Jenkins to Sauce
-      # The second print statement will output the job link to logging/console  
+      # The second print statement will output the job link to logging/console
       puts "SauceOnDemandSessionID=#{@driver.session_id} job-name=#{@options.name}"
       puts "Test Job Link: https://app.saucelabs.com/tests/#{@driver.session_id}"
       @driver.quit
@@ -44,7 +45,7 @@ module SauceBindings
 
     def data_center=(data_center)
       unless DATA_CENTERS.key?(data_center)
-        msg = "#{data_center} is an invalid data center; specify :US_WEST, :US_EAST or :EU_CENTRAL"
+        msg = "#{data_center} is an invalid data center; specify one of: #{DATA_CENTERS.keys}"
         raise ArgumentError, msg
       end
 

data/lib/sauce_bindings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SauceBindings
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/examples/basic_options_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'sauce_bindings'
+require 'rspec'
+
+describe 'Basic Options' do
+  before { WebMock.allow_net_connect! }
+
+  it 'creates session' do
+    # 1. Create a SauceOptions instance with the 3 primary parameters
+    sauce_options = SauceBindings::Options.firefox(browser_version: '73.0',
+                                                   platform_name: 'Windows 8')
+
+    # 2. Create Session object with SauceOptions object instance
+    session = SauceBindings::Session.new(sauce_options)
+
+    # 3. Start Session to get the Driver
+    driver = session.start
+
+    # 4. Use the driver in your tests just like normal
+    driver.get('https://www.saucedemo.com/')
+
+    # 5. Stop the Session with whether the test passed or failed
+    session.stop(true)
+  end
+end

data/spec/examples/browser_options_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'sauce_bindings'
+require 'rspec'
+
+describe 'Browser Options' do
+  before { WebMock.allow_net_connect! }
+
+  it 'creates session' do
+    # 1. Create Selenium Browser Options instance
+    browser_options = Selenium::WebDriver::Firefox::Options.new(args: ['--foo'])
+
+    # 2. Create Sauce Options object with the Browser Options object instance
+    sauce_options = SauceBindings::Options.firefox(selenium_options: browser_options)
+
+    # 3. Create Session object with SauceOptions object instance
+    session = SauceBindings::Session.new(sauce_options)
+
+    # 4. Start Session to get the Driver
+    driver = session.start
+
+    # 5. Use the driver in your tests just like normal
+    driver.get('https://www.saucedemo.com/')
+
+    # 6. Stop the Session with whether the test passed or failed
+    session.stop(true)
+  end
+end

data/spec/examples/create_session_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'sauce_bindings'
+require 'rspec'
+
+describe 'Create Session' do
+  before { WebMock.allow_net_connect! }
+
+  it 'starts session' do
+    # 1. Create Session object with the defaults
+    session = SauceBindings::Session.new
+
+    # 2. Start Session to get the Driver
+    driver = session.start
+
+    # 3. Use the driver in your tests just like normal
+    driver.get('https://www.saucedemo.com/')
+
+    # 4. Stop the Session with whether the test passed or failed
+    session.stop(true)
+  end
+end

data/spec/examples/data_center_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'sauce_bindings'
+require 'rspec'
+
+describe 'Create Session' do
+  before { WebMock.allow_net_connect! }
+
+  it 'starts session' do
+    # 1. Create Session object with the desired Data Center
+    session = SauceBindings::Session.new(data_center: :EU_CENTRAL)
+
+    # 2. Start Session to get the Driver
+    driver = session.start
+
+    # 3. Use the driver in your tests just like normal
+    driver.get('https://www.saucedemo.com/')
+
+    # 4. Stop the Session with whether the test passed or failed
+    session.stop(true)
+  end
+end

data/spec/examples/sauce_options_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'sauce_bindings'
+require 'rspec'
+
+describe 'Sauce Options' do
+  before { WebMock.allow_net_connect! }
+
+  it 'creates session' do
+    # 1. Create a SauceOptions instance with Sauce Labs Specific Options
+    sauce_options = SauceBindings::Options.firefox(extended_debugging: true,
+                                                   idle_timeout: 100,
+                                                   time_zone: 'Alaska')
+
+    # 2. Create Session object with SauceOptions object instance
+    session = SauceBindings::Session.new(sauce_options)
+
+    # 3. Start Session to get the Driver
+    driver = session.start
+
+    # 4. Use the driver in your tests just like normal
+    driver.get('https://www.saucedemo.com/')
+
+    # 5. Stop the Session with whether the test passed or failed
+    session.stop(true)
+  end
+end

data/spec/unit/options_spec.rb

@@ -10,6 +10,56 @@ module SauceBindings
       allow(ENV).to receive(:[]).with('BUILD_NUMBER').and_return('11')
     end
 
+    describe 'self#chrome' do
+      it 'creates Options for Chrome' do
+        options = Options.chrome
+
+        expect(options.browser_name).to eq 'chrome'
+        expect(options.browser_version).to eq 'latest'
+        expect(options.platform_name).to eq 'Windows 10'
+      end
+    end
+
+    describe 'self#edge' do
+      it 'creates Options for Edge' do
+        options = Options.edge
+
+        expect(options.browser_name).to eq 'MicrosoftEdge'
+        expect(options.browser_version).to eq 'latest'
+        expect(options.platform_name).to eq 'Windows 10'
+      end
+    end
+
+    describe 'self#firefox' do
+      it 'creates Options for Firefox' do
+        options = Options.firefox
+
+        expect(options.browser_name).to eq 'firefox'
+        expect(options.browser_version).to eq 'latest'
+        expect(options.platform_name).to eq 'Windows 10'
+      end
+    end
+
+    describe 'self#ie' do
+      it 'creates Options for Chrome' do
+        options = Options.ie
+
+        expect(options.browser_name).to eq 'internet explorer'
+        expect(options.browser_version).to eq 'latest'
+        expect(options.platform_name).to eq 'Windows 10'
+      end
+    end
+
+    describe 'self#safari' do
+      it 'creates Options for Safari' do
+        options = Options.safari
+
+        expect(options.browser_name).to eq 'safari'
+        expect(options.browser_version).to eq 'latest'
+        expect(options.platform_name).to eq 'Windows 10'
+      end
+    end
+
     describe '#new' do
       let(:default_options) do
         {'browserName' => 'chrome',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sauce_bindings
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Titus Fortner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,6 +177,11 @@ files:
 - lib/sauce_bindings/session.rb
 - lib/sauce_bindings/version.rb
 - sauce_bindings.gemspec
+- spec/examples/basic_options_spec.rb
+- spec/examples/browser_options_spec.rb
+- spec/examples/create_session_spec.rb
+- spec/examples/data_center_spec.rb
+- spec/examples/sauce_options_spec.rb
 - spec/integration/desktop_spec.rb
 - spec/options.yml
 - spec/spec_helper.rb
@@ -207,6 +212,11 @@ signing_key:
 specification_version: 4
 summary: Simple interface for interacting with Sauce Labs.
 test_files:
+- spec/examples/basic_options_spec.rb
+- spec/examples/browser_options_spec.rb
+- spec/examples/create_session_spec.rb
+- spec/examples/data_center_spec.rb
+- spec/examples/sauce_options_spec.rb
 - spec/integration/desktop_spec.rb
 - spec/options.yml
 - spec/spec_helper.rb