webdriver-user-agent 7.6 → 7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9589c34ef3fbb25e386f2c5b654f21564afe66a47c89dec46f78dff7cadb70e2
-  data.tar.gz: 44f41c6fabde58f65d1598813fe63ed659b5b430972b23fd9f08349251780f0a
+  metadata.gz: 1f103f486777f7dffc40b6177cbd52c1ed13826daf41c500f8f69f1869e71c6f
+  data.tar.gz: 4844156cef409e1c77d5e4610b3e51e1c995954edc3e0823fd4651255b5372fd
 SHA512:
-  metadata.gz: c07dacc751fdb9793a8d932d3fa11e468d2c10b940f52d0b3c9569fc3dec97b827012ae515ffc7c0c90b3b5d45ec76630cdd7464c14c3e7e8fde3d7fe921c1be
-  data.tar.gz: 8045ac3e0b908bb49609aa31ae7d00c7c98c5d8f8c59edfb8cfa92a1171df4906749255726c36446ab3e2e3f3e01013c10d1e9624968baab503ea917c610ef11
+  metadata.gz: 1f297ddcf8064c4c6a37c550f0bf2ea57e4d3ca6cc60856315f9656b15426ca36357173ac87b246dde72d8f9d9f05d929f35aa82ee6f72461d47409556bdfa23
+  data.tar.gz: 69368f91ffb7b262a7b45161dc4099fa80230d4bca0792b7d1baf80d130e1876850a970dce3b79b2dbae926eddd257dcf7a2ca0584a8cf329f27966941c1b978

data/lib/device-info/devices.yaml

@@ -1,9 +1,20 @@
 # Desktop size sources
-# http://www.hobo-web.co.uk/best-screen-size/
-# https://en.wikipedia.org/wiki/Display_resolution#Common_display_resolutions
-# http://www.w3schools.com/browsers/browsers_display.asp
+# - http://www.hobo-web.co.uk/best-screen-size/
+# - https://en.wikipedia.org/wiki/Display_resolution#Common_display_resolutions
+# - http://www.w3schools.com/browsers/browsers_display.asp
+
+# iPhone and iPad data added by running Simulator on macOS and visiting
+# https://whatismyviewport.com and
+# https://www.whatismybrowser.com/detect/what-is-my-user-agent
+
+# Android user agents and viewports from current android device specs.
+# Tablet: Samsung Galaxy Tab S6; Phone: Google Pixel 4
+# Determined without a simulator to account for software chrome,
+# so these figures are necessarily larger than what will be true
+# on those devices. Please feel free to submit a pull request
+# with corrected and/or expanded device values.
 :desktop:
-   :user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/600.8.9 (KHTML, like Gecko) Version/8.0.8 Safari/600.8.9"
+   :user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1 Safari/605.1.15
    :portrait:
      :width: 768
      :height: 1024
@@ -11,26 +22,28 @@
      :width: 1366
      :height: 768
 :iphone_default: &iphone_default
-   :user_agent: "Mozilla/5.0 (iPhone; CPU iPhone OS 11_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/11.0 Mobile/15E148 Safari/604.1"
+   :user_agent: Mozilla/5.0 (iPhone; CPU iPhone OS 13_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Mobile/15E148 Safari/604.1
    :portrait:
-     :width: 375
-     :height: 635
+     :width: 414
+     :height: 719
    :landscape:
-     :width: 724
-     :height: 375
+     :width: 808
+     :height: 414
 :iphone: &iphone
-   <<: *iphone_default
-:iphonex:
   <<: *iphone_default
-:iphone8plus: &iphone8plus
+:iphone11pro:
   <<: *iphone_default
   :portrait:
-    :width: 414
-    :height: 622
+    :width: 375
+    :height: 635
   :landscape:
-    :width: 736
-    :height: 414
-:iphone8: &iphone8
+    :width: 724
+    :height: 375
+:iphone11promax:
+  <<: *iphone_default
+:iphone11:
+  <<: *iphone_default
+:iphonese: &iphonese
   <<: *iphone_default
   :portrait:
     :width: 375
@@ -38,11 +51,34 @@
   :landscape:
     :width: 667
     :height: 375
+:iphonexr: &iphonexr
+  <<: *iphone_default
+:iphonexsmax:
+  <<: *iphonexr
+:iphonexs: &iphonexs
+  <<: *iphone_default
+  :portrait:
+    :width: 375
+    :height: 635
+  :landscape:
+    :width: 724
+    :height: 375
+:iphonex:
+  <<: *iphonexs
+:iphone8plus: &iphone8plus
+  <<: *iphone_default
+  :portrait:
+    :width: 414
+    :height: 622
+  :landscape:
+    :width: 736
+    :height: 414
+:iphone8: &iphone8
+  <<: *iphonese
 :iphone7plus:
   <<: *iphone8plus
 :iphone7:
   <<: *iphone8
-  :portrait:
 :iphone6splus:
   <<: *iphone8plus
 :iphone6s:
@@ -59,7 +95,7 @@
   :landscape:
     :width: 568
     :height: 320
-:iphonese:
+:iphonese_old:
   <<: *iphone5s
 :iphone5:
   <<: *iphone5s
@@ -74,33 +110,33 @@
 :iphone4:
   <<: *iphone4s
 :ipad: &ipad
-  :user_agent: "Mozilla/5.0 (iPad; CPU OS 11_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/11.0 Mobile/15E148 Safari/604.1"
+  :user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.1 Safari/605.1.15
   :portrait:
-    :width: 768
-    :height: 954
+    :width: 810
+    :height: 1010
   :landscape:
-    :width: 1024
-    :height: 698
+    :width: 1080
+    :height: 740
 :ipad_default:
   <<: *ipad
 :ipad_pro: &ipad_pro
   <<: *ipad
   :portrait:
     :width: 1024
-    :height: 1296
+    :height: 1292
   :landscape:
     :width: 1366
-    :height: 954
+    :height: 950
 :ipad_pro_12:
   <<: *ipad_pro
-:ipad_pro_10:
+:ipad_pro_11:
   <<: *ipad
   :portrait:
     :width: 834
-    :height: 1042
+    :height: 1120
   :landscape:
-    :width: 1112
-    :height: 764
+    :width: 1194
+    :height: 760
 :ipad_pro_9:
   <<: *ipad
   :portrait:
@@ -109,19 +145,29 @@
   :landscape:
     :width: 1024
     :height: 698
+:ipad_air: &ipad_air
+  <<: *ipad
+  :portrait:
+    :width: 834
+    :height: 1038
+  :landscape:
+    :width: 1112
+    :height: 760
+:ipad_pro_10:
+  <<: *ipad_air
 :android_phone:
-  :user_agent: "Mozilla/5.0 (Linux; U; Android 4.0.1; en-us; sdk Build/ICS_MR0) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30"
+  :user_agent: Mozilla/5.0 (Linux; Android 10; Pixel) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.87 Mobile Safari/537.36
   :portrait:
-    :width: 320
-    :height: 356
+    :width: 411
+    :height: 869
   :landscape:
-    :width: 480
-    :height: 196
+    :width: 869
+    :height: 411
 :android_tablet:
-  :user_agent: "Mozilla/5.0 (Linux; U; Android 3.0; en-us; GT-P7100 Build/HRI83) AppleWebkit/534.13 (KHTML, like Gecko) Version/4.0 Safari/534.13"
+  :user_agent: Mozilla/5.0 (Linux; Android 9; SAMSUNG SM-T865) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/10.1 Chrome/71.0.3578.99 Safari/537.36
   :portrait:
-    :width: 768
-    :height: 946
+    :width: 800
+    :height: 1280
   :landscape:
-    :width: 1024
-    :height: 690
+    :width: 1280
+    :height: 800

data/lib/webdriver-user-agent.rb

@@ -3,21 +3,22 @@ require 'webdriver-user-agent/driver'
 
 module Webdriver
   module UserAgent
-    def self.driver options={}
-      Driver.instance.for options
-    end
+    class << self
+      def driver(options = {})
+        Driver.instance.for options
+      end
 
-    def self.devices
-      Driver.instance.devices
-    end
+      def devices
+        Driver.instance.devices
+      end
 
-    def self.resolution_for device_name, orientation
-      Driver.instance.resolution_for device_name, orientation
-    end
-
-    def self.agent_string_for device
-      Driver.instance.agent_string_for device
-    end 
+      def resolution_for(device_name, orientation)
+        Driver.instance.resolution_for device_name, orientation
+      end
 
+      def agent_string_for(device)
+        Driver.instance.agent_string_for device
+      end
+    end
   end
 end

data/lib/webdriver-user-agent/browser_options.rb

@@ -19,7 +19,7 @@ module Webdriver
 
         options[:viewport_width], options[:viewport_height] = parse_viewport_sizes(options[:viewport_width], options[:viewport_height])
 
-        initialize_for_browser(user_agent_string, opts[:accept_language_string])
+        initialize_for_browser(user_agent_string, opts[:accept_language_string], opts[:options])
       end
 
       def method_missing(*args, &block)
@@ -44,23 +44,32 @@ module Webdriver
         @stp = false unless @stp.is_a?(TrueClass)
       end
 
-      def initialize_for_browser(user_agent_string, accept_language_string)
+      def initialize_for_browser(user_agent_string, accept_language_string, driver_options = nil)
+        options[:options] ||= driver_options
+
         case options[:browser]
         when :firefox
-          profile ||= Selenium::WebDriver::Firefox::Profile.new
-          profile['general.useragent.override'] = user_agent_string
-          profile['intl.accept_languages'] = accept_language_string if accept_language_string
-
           options[:options] ||= Selenium::WebDriver::Firefox::Options.new
+
+          profile ||= options[:options].profile || Selenium::WebDriver::Firefox::Profile.new
+          set_keys = profile.instance_variable_get(:@additional_prefs).keys
+
+          profile['general.useragent.override'] = user_agent_string if !set_keys.include?('general.useragent.override')
+          profile['intl.accept_languages'] = accept_language_string if accept_language_string && !set_keys.include?('intl.accept_languages')
+
           options[:options].profile = profile
         when :chrome
           options[:options] ||= Selenium::WebDriver::Chrome::Options.new
-          options[:options].add_argument "--user-agent=#{user_agent_string}"
-          options[:options].add_preference("intl.accept_languages", accept_language_string) if accept_language_string
+
+          set_args = options[:options].args.map{|s| "#{s}"}.join(" ")
+          options[:options].add_argument "--user-agent=#{user_agent_string}" if !set_args.include?("--user-agent=")
+
+          set_prefs = options[:options].prefs.keys
+          options[:options].add_preference("intl.accept_languages", accept_language_string) if accept_language_string && !set_prefs.include?("intl.accept_languages")
         when :safari
+          options[:options] ||= Selenium::WebDriver::Safari::Options.new
           change_safari_user_agent_string(user_agent_string)
           change_safari_language(accept_language_string) if accept_language_string
-          options
         else
           raise "WebDriver UserAgent currently only supports :chrome, :firefox and :safari."
         end
@@ -88,10 +97,17 @@ module Webdriver
         raise "Safari requires a Mac" unless OS.mac?
 
         cmd = "defaults write com.apple.#{safari_version} #{pref} #{setting}"
-
         output = `#{cmd}`
 
-        raise prepare_safari_error_message(cmd, output) unless $?.success?
+        raise prepare_safari_error_message(cmd, output) unless safari_command_success?(setting, safari_version, pref, $?)
+      end
+
+      def safari_command_success?(setting, safari_version, pref, result)
+        setting_chars = "#{setting}".gsub(/\W/, '')
+        read_chars = `defaults read com.apple.#{safari_version} #{pref}`.gsub(/\W/, '')
+
+        setting_match = (setting_chars == read_chars)
+        setting_match && result.success?
       end
 
       def safari_version

data/spec/webdriver-user-agent_spec.rb

@@ -9,14 +9,78 @@ require 'webdrivers'
 
 CHROMEBROWSER_UICHROME_HEIGHT         = 123
 CHROMEBROWSER_UICHROME_HEIGHT_TALL    = 50
-CHROMEBROWSER_UI_MINIMUM_HEIGHT       = 149
+CHROMEBROWSER_UI_MINIMUM_HEIGHT       = 289
 FIREFOXBROWSER_UICHROME_HEIGHT        = 74
+FIREFOXBROWSER_MINIMUM_WIDTH          = 450
 SAFARIBROWSER_UICHROME_HEIGHT         = 38
 
+RSpec.shared_examples "browser driver" do
+  it "creates the browser driver" do
+    expect("#{driver.browser}").to match(/#{Regexp.quote(browser.to_s)}/i)
+  end
+
+  it "matches the agent partial" do
+    expect(driver.execute_script(agent_script)).to include agent_match
+  end
+end
+
+RSpec.shared_examples "random browser driver" do
+  it "creates the browser driver" do
+    expect("#{driver.browser}").to match(/#{Regexp.quote(browser.to_s)}/i)
+  end
+
+  it "matches the agent partial" do
+    expect(driver.execute_script(agent_script)).not_to be_nil
+  end
+end
+
+RSpec.shared_examples "firefox size" do
+  it "matches the expected width" do
+    width_expectation = device.dig(orientation, :width)
+    width_expectation = FIREFOXBROWSER_MINIMUM_WIDTH if width_expectation < FIREFOXBROWSER_MINIMUM_WIDTH
+    expect(driver.execute_script(width_script)).to eq(width_expectation)
+  end
+
+  it "matches the expected height" do
+    height_expectation = device.dig(orientation, :height) - FIREFOXBROWSER_UICHROME_HEIGHT
+    expect(driver.execute_script(height_script)).to eq(height_expectation)
+  end
+end
+
+RSpec.shared_examples "safari size" do
+  it "matches the expected width" do
+    width_expectation = device.dig(orientation, :width)
+    expect(driver.execute_script(width_script)).to eq(width_expectation)
+  end
+
+  it "matches the expected height" do
+    height_expectation = device.dig(orientation, :height) - SAFARIBROWSER_UICHROME_HEIGHT
+    expect(driver.execute_script(height_script)).to eq(height_expectation)
+  end
+end
+
+RSpec.shared_examples "chrome size" do
+  it "matches the expected width" do
+    width_expectation = device.dig(orientation, :width)
+    expect(driver.execute_script(width_script)).to eq(width_expectation)
+  end
+
+  it "matches the expected height" do
+    height_expectation = device.dig(orientation, :height) - CHROMEBROWSER_UICHROME_HEIGHT
+    expect(driver.execute_script(height_script)).to eq(height_expectation)
+  end
+end
+
 describe "webdriver user agent" do
+  let(:devices) { Webdriver::UserAgent.devices }
+  let(:agent_script) { 'return navigator.userAgent' }
+  let(:width_script) { 'return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)' }
+  let(:height_script) { 'return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)' }
+
   after :each do
-    @browser.close if @browser rescue nil
-    @driver.quit if @driver rescue nil
+    driver.quit if defined?(driver)
+    browser.close if defined?(browser) && browser&.is_a?(Watir::Browser)
+    sleep(0.5) # Safari needs time to shutdown
   end
 
   # window.innerWidth and window.innerHeight
@@ -24,37 +88,94 @@ describe "webdriver user agent" do
   # browser widths and heights
   # http://stackoverflow.com/a/8876069/1651458
 
-  it "can create a new webdriver driver using firefox and iphone (portrait) by default" do
-  	@driver = Webdriver::UserAgent.driver
-  	expect(@driver.browser).to eq(:firefox)
-  	expect(@driver.execute_script('return navigator.userAgent')).to include 'iPhone'
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(375)
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(635 - FIREFOXBROWSER_UICHROME_HEIGHT)
+  context "no browser, agent or orientation set" do
+    let(:device) { devices[:iphone] }
+    let(:driver) { Webdriver::UserAgent.driver }
+    let(:browser) { "firefox" }
+    let(:orientation) { :portrait }
+    let(:agent_match) { 'iPhone' }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "firefox size"
   end
 
-  it "can create a new webdriver driver using safari and iphone 6 plus, and landscape" do
-  	@driver = Webdriver::UserAgent.driver(:browser => :safari, :agent => :iphone6plus, :orientation => :landscape)
-  	expect("#{@driver.browser}").to match(/safari/i)
+  context "Safari browser, iPhone 11 Pro Max agent, landscape orientation" do
+    let(:device) { devices[:iphone11promax] }
+    let(:orientation) { :landscape }
+    let(:driver) do
+      # Safari is a mess. safari_technology_preview added because
+      # Safari just isn't working in my environment as of 13.1 - Sam
+
+      Webdriver::UserAgent.driver(
+        browser: :safari,
+        agent: :iphone11promax,
+        orientation: orientation,
+        safari_technology_preview: true
+      )
+    end
+    let(:browser) { "safari" }
+    let(:orientation) { :landscape }
+    let(:agent_match) { 'iPhone' }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "safari size"
+  end
 
-  	expect(@driver.execute_script('return navigator.userAgent')).to include 'iPhone'
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(736)
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(414 - SAFARIBROWSER_UICHROME_HEIGHT)
+  context "Safari browser, iPhone 6 Plus agent, landscape orientation" do
+    let(:device) { devices[:iphone6plus] }
+    let(:orientation) { :landscape }
+    let(:driver) do
+      # Safari is a mess. safari_technology_preview added because
+      # Safari just isn't working in my environment as of 13.1 - Sam
+
+      Webdriver::UserAgent.driver(
+        browser: :safari,
+        agent: :iphone6plus,
+        orientation: orientation,
+        safari_technology_preview: true
+      )
+    end
+    let(:browser) { "safari" }
+    let(:agent_match) { 'iPhone' }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "safari size"
   end
 
-  it "can create a new webdriver driver using chrome and iphone 6 plus (landscape)" do
-  	@driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :iphone6plus, :orientation => :landscape)
-  	expect(@driver.browser).to eq(:chrome)
-  	expect(@driver.execute_script('return navigator.userAgent')).to include 'iPhone'
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(736)
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(414 - CHROMEBROWSER_UICHROME_HEIGHT)
+  context "Chrome browser, iPhone XS agent, landscape orientation" do
+    let(:device_key) { :iphonexs }
+    let(:device) { devices[device_key] }
+    let(:orientation) { :landscape }
+    let(:driver) do
+      Webdriver::UserAgent.driver(
+        browser: :chrome,
+        agent: device_key,
+        orientation: orientation
+      )
+    end
+    let(:browser) { "chrome" }
+    let(:agent_match) { 'iPhone' }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "chrome size"
   end
 
-  it "can create a new webdriver driver using chrome and iPad (landscape)" do
-  	@driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :ipad, :orientation => :landscape)
-  	expect(@driver.browser).to eq(:chrome)
-  	expect(@driver.execute_script('return navigator.userAgent')).to include 'iPad'
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(1024)
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(698 - CHROMEBROWSER_UICHROME_HEIGHT)
+  context "Chrome browser, iPhone XS agent, landscape orientation" do
+    let(:device_key) { :ipad }
+    let(:device) { devices[device_key] }
+    let(:orientation) { :landscape }
+    let(:driver) do
+      Webdriver::UserAgent.driver(
+        browser: :chrome,
+        agent: device_key,
+        orientation: orientation
+      )
+    end
+    let(:browser) { "chrome" }
+    let(:agent_match) { 'Mac OS' }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "chrome size"
   end
 
   it "can create a new webdriver driver using chrome and iPad Pro (portrait)" do
@@ -73,124 +194,195 @@ describe "webdriver user agent" do
 
   	@driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :ipad_pro, :orientation => :portrait)
   	expect(@driver.browser).to eq(:chrome)
-  	expect(@driver.execute_script('return navigator.userAgent')).to include 'iPad'
+  	expect(@driver.execute_script('return navigator.userAgent')).to include 'Mac OS'
   	expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(1024)
 
     # See above
     if @you_have_a_tall_monitor
-  	   expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(1302 - CHROMEBROWSER_UICHROME_HEIGHT)
-     end
-  end
-
-  it "can create a new webdriver driver using firefox and android phone (landscape)" do
-    @driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :android_phone, :orientation => :landscape)
-    expect(@driver.browser).to eq(:chrome)
-    expect(@driver.execute_script('return navigator.userAgent')).to include 'Android'
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(480)
-
-    # Chrome is apparently setting some kind of minimum height
-    # As seen on Chrome v42 on OS X Yosimite
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(CHROMEBROWSER_UI_MINIMUM_HEIGHT)
-
+      expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(1302 - CHROMEBROWSER_UICHROME_HEIGHT)
+    end
   end
 
-  it "can create a new webdriver driver using chrome and android tablet (portrait)" do
-    @driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :android_tablet, :orientation => :portrait)
-    expect(@driver.browser).to eq(:chrome)
-    expect(@driver.execute_script('return navigator.userAgent')).to include 'Android'
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(768)
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(873 - CHROMEBROWSER_UICHROME_HEIGHT_TALL)
+  context "Chrome browser, Android tablet agent, landscape orientation" do
+    let(:device_key) { :android_tablet }
+    let(:device) { devices[device_key] }
+    let(:orientation) { :landscape }
+    let(:driver) do
+      Webdriver::UserAgent.driver(
+        browser: :chrome,
+        agent: device_key,
+        orientation: orientation
+      )
+    end
+    let(:browser) { "chrome" }
+    let(:agent_match) { 'Android' }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "chrome size"
   end
 
-  it "can create a new webdriver driver using firefox and desktop (landscape)" do
-    @driver = Webdriver::UserAgent.driver(:browser => :firefox, :agent => :desktop, :orientation => :landscape)
-    expect(@driver.browser).to eq(:firefox)
-    expect(@driver.execute_script('return navigator.userAgent')).to include 'Mac OS X'
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(1366)
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(768 - FIREFOXBROWSER_UICHROME_HEIGHT)
+  context "Firefox browser, desktop agent, landscape orientation" do
+    let(:device_key) { :desktop }
+    let(:device) { devices[device_key] }
+    let(:orientation) { :landscape }
+    let(:driver) do
+      Webdriver::UserAgent.driver(
+        browser: :firefox,
+        agent: device_key,
+        orientation: orientation
+      )
+    end
+    let(:browser) { "firefox" }
+    let(:agent_match) { 'Mac OS' }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "firefox size"
   end
 
-   it "can create a new webdriver driver using firefox and random user agent" do
-    @driver = Webdriver::UserAgent.driver(:agent => :random)
-    expect(@driver.browser).to eq(:firefox)
-    expect(@driver.execute_script('return navigator.userAgent')).not_to be_nil
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).not_to eq(320)
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).not_to eq(356 - FIREFOXBROWSER_UICHROME_HEIGHT)
-  end
+  context "random agent" do
+    context "no specified browser" do
+      let(:device_key) { :random }
+      let(:driver) { Webdriver::UserAgent.driver(agent: device_key) }
+      let(:browser) { :firefox }
 
-  it "can create a new webdriver driver using chrome and random user agent" do
-    @driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :random)
-    expect(@driver.browser).to eq(:chrome)
-    expect(@driver.execute_script('return navigator.userAgent')).not_to be_nil
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).not_to eq(320)
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).not_to eq(356 - CHROMEBROWSER_UICHROME_HEIGHT)
-  end
+      it_behaves_like "random browser driver"
+    end
 
-  it "can create a new webdriver driver using an existing firefox profile" do
-    profile = Selenium::WebDriver::Firefox::Profile.new
-    profile['browser.startup.homepage'] = "data:text/html,<title>hello</title>"
-    options = Selenium::WebDriver::Firefox::Options.new
-    options.profile = profile
-    @driver = Webdriver::UserAgent.driver(:browser => :firefox, options: options)
+    context "chrome browser" do
+      let(:device_key) { :random }
+      let(:browser) { :chrome }
+      let(:driver) do
+        Webdriver::UserAgent.driver(browser: browser, agent: device_key)
+      end
 
-    expect(@driver.browser).to eq(:firefox)
-    expect(@driver.execute_script('return navigator.userAgent')).to include 'iPhone'
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(375)
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(635 - FIREFOXBROWSER_UICHROME_HEIGHT)
+      it_behaves_like "random browser driver"
+    end
   end
 
-  it "can create a new webdriver driver using firefox and user-specified user agent" do
-    @driver = Webdriver::UserAgent.driver(:user_agent_string => "Mozilla/4.0 (compatible; MSIE 5.5b1; Mac_PowerPC)")
-    expect(@driver.browser).to eq(:firefox)
-    expect(@driver.execute_script('return navigator.userAgent')).to include 'Mac_PowerPC'
-
-    @browser = Watir::Browser.new @driver
+  context "existing firefox profile" do
+    let(:device) { devices[:iphone] }
+    let(:profile) do
+      profile = Selenium::WebDriver::Firefox::Profile.new
+      profile["intl.accept_languages"] = "es-MX"
+      profile
+    end
+    let(:options) { Selenium::WebDriver::Firefox::Options.new(profile: profile) }
+    let(:browser) { :firefox }
+    let(:agent_match) { 'iPhone' }
+    let(:orientation) { :portrait }
+    let(:driver) { Webdriver::UserAgent.driver(browser: browser, options: options) }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "firefox size"
+
+    it "absorbs the options' profile" do
+      expect(driver.execute_script("return (navigator.language || navigator.userLanguage)")).to include("es-MX")
+    end
   end
 
-  it "can create a new webdriver driver using firefox and user-specified language" do
-    @driver = Webdriver::UserAgent.driver(accept_language_string: "es-ES, es-MX;q=0.9, es;q=0.5, *;0.4")
-    expect(@driver.browser).to eq(:firefox)
-    expect(@driver.execute_script('return navigator.language')).to include 'es-ES'
+  context "user-provided user agent string for firefox" do
+    let(:browser) { :firefox }
+    let(:user_agent) { "Mozilla/4.0 (compatible; MSIE 5.5b1; Mac_PowerPC)" }
+    let(:driver) { Webdriver::UserAgent.driver(user_agent_string: user_agent) }
 
-    @browser = Watir::Browser.new @driver
-  end
+    it "can create a new webdriver driver" do
+      expect("#{driver.browser}").to match(/#{Regexp.quote(browser.to_s)}/i)
 
-  it "can create a new webdriver driver using firefox and user-specified language" do
-    @driver = Webdriver::UserAgent.driver(browser: :chrome, accept_language_string: "es-ES, es-MX;q=0.9, es;q=0.5, *;0.4")
-    expect(@driver.browser).to eq(:chrome)
-    expect(@driver.execute_script('return navigator.language')).to include 'es-ES'
-
-    @browser = Watir::Browser.new @driver
+      expect(driver.execute_script("return navigator.userAgent")).to include("Mac_PowerPC")
+    end
   end
 
-  it "can create a new webdriver driver using firefox and user-specified language" do
-    @driver = Webdriver::UserAgent.driver(browser: :safari, accept_language_string: "es-ES, es-MX;q=0.9, es;q=0.5, *;0.4", safari_technology_preview: true)
-    expect(@driver.browser).to match(/safari/i)
-    expect(@driver.execute_script('return navigator.language')).to include 'es-ES'
+  context "user-provided accept language string for firefox" do
+    let(:browser) { :firefox }
+    let(:language) { "es-ES, es-MX;q=0.9, es;q=0.5, *;0.4" }
+    let(:driver) { Webdriver::UserAgent.driver(accept_language_string: language) }
 
-    @browser = Watir::Browser.new @driver
-  end
+    it "can create a new webdriver driver" do
+      expect("#{driver.browser}").to match(/#{Regexp.quote(browser.to_s)}/i)
 
-  it "can create a new webdriver driver using firefox and user-specified viewport sizes (string or int)" do
-    width = 800
-    height = 600
+      expect(driver.execute_script("return (navigator.language || navigator.userLanguage)")).to include("es-ES")
+    end
+  end
 
-    @driver = Webdriver::UserAgent.driver(:viewport_width => "#{width}", :viewport_height => height, :agent => :iphone6)
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(800)
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(600 - FIREFOXBROWSER_UICHROME_HEIGHT)
+  context "user-provided accept language string for safari" do
+    let(:browser) { :safari }
+    let(:language) { "es-ES, es-MX;q=0.9, es;q=0.5, *;0.4" }
+    let(:driver) {
+      Webdriver::UserAgent.driver(
+        browser: browser,
+        accept_language_string: language,
+        safari_technology_preview: true
+      )
+    }
+
+    it "can create a new webdriver driver" do
+      expect("#{driver.browser}").to match(/#{Regexp.quote(browser.to_s)}/i)
+
+      expect(driver.execute_script("return (navigator.language || navigator.userLanguage)")).to include("es-es")
+    end
   end
 
-  it "can create a new webdriver driver, handling for nonsense height and widths" do
-    @driver = Webdriver::UserAgent.driver(:viewport_width => "abc", :agent => :iphone8)
-    expect(@driver.execute_script('return Math.max(document.documentElement.clientWidth, window.innerWidth || 0)')).to eq(375)
-  	expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(553 - FIREFOXBROWSER_UICHROME_HEIGHT)
- end
+  context "user-provided viewport size and agent for firefox" do
+    let(:browser) { :firefox }
+    let(:device_key) { :iphone11 }
+    let(:device) { devices[device_key] }
+    let(:width) { 800 }
+    let(:height) { 600 }
+    let(:agent_match) { 'iPhone' }
+    let(:orientation) { :portrait }
+    let(:driver) {
+      Webdriver::UserAgent.driver(
+        viewport_width: "#{width}",
+        viewport_height: height,
+        agent: device_key
+      )
+    }
+
+    it_behaves_like "browser driver"
+    it "uses user-provided dimensions" do
+    	expect(driver.execute_script(width_script)).to eq(width)
+    	expect(driver.execute_script(height_script)).to eq(height - FIREFOXBROWSER_UICHROME_HEIGHT)
+    end
+  end
 
-  it "can allow using selenium driver for watir browser" do
-    @driver = Webdriver::UserAgent.driver(:browser => :firefox, :agent => :iphone, :orientation => :portrait)
-    @browser = Watir::Browser.new @driver
-    expect(@browser).to be_a(Watir::Browser)
-    expect(@browser.url).to be_a(String)
+  context "user-provided nonsense viewport size for firefox" do
+    let(:browser) { :firefox }
+    let(:device_key) { :iphone8 }
+    let(:device) { devices[device_key] }
+    let(:width) { "xyz" }
+    let(:agent_match) { 'iPhone' }
+    let(:orientation) { :portrait }
+    let(:driver) {
+      Webdriver::UserAgent.driver(
+        viewport_width: "#{width}",
+        agent: device_key
+      )
+    }
+
+    it_behaves_like "browser driver"
+    it_behaves_like "firefox size"
   end
 
+  context "portrait firefox iphone" do
+    let(:browser) { :firefox }
+    let(:device_key) { :iphone }
+    let(:device) { devices[device_key] }
+    let(:width) { "xyz" }
+    let(:agent_match) { 'iPhone' }
+    let(:orientation) { :portrait }
+    let(:driver) {
+      Webdriver::UserAgent.driver(
+        agent: device_key,
+        browser: browser,
+        orientation: orientation
+      )
+    }
+
+    it "can create a browser using the driver" do
+      browser = Watir::Browser.new(driver)
+
+      expect(browser).to be_a(Watir::Browser)
+      expect(browser.url).to be_a(String)
+    end
+  end
 end

data/webdriver-user-agent.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "webdriver-user-agent"
   gem.require_paths = ["lib"]
-  gem.version       = "7.6"
+  gem.version       = "7.8"
   gem.requirements << 'chromedriver, v2.20'
   # chromedriver v2.19 causes
     # Selenium::WebDriver::Error::NoSuchDriverError: no such session errors

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webdriver-user-agent
 version: !ruby/object:Gem::Version
-  version: '7.6'
+  version: '7.8'
 platform: ruby
 authors:
 - Alister Scott
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -174,8 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - chromedriver, v2.20
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A helper gem to emulate populate device user agents and resolutions when