webdriver-user-agent 7.2 → 7.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f103f486777f7dffc40b6177cbd52c1ed13826daf41c500f8f69f1869e71c6f
+  data.tar.gz: 4844156cef409e1c77d5e4610b3e51e1c995954edc3e0823fd4651255b5372fd
+SHA512:
+  metadata.gz: 1f297ddcf8064c4c6a37c550f0bf2ea57e4d3ca6cc60856315f9656b15426ca36357173ac87b246dde72d8f9d9f05d929f35aa82ee6f72461d47409556bdfa23
+  data.tar.gz: 69368f91ffb7b262a7b45161dc4099fa80230d4bca0792b7d1baf80d130e1876850a970dce3b79b2dbae926eddd257dcf7a2ca0584a8cf329f27966941c1b978

data/.ruby-version

@@ -1 +1 @@
-ruby-1.9.3-p429
+ruby-2.4.1

data/ChangeLog

@@ -1,3 +1,22 @@
+=== Version 7.5 / 2017-8-22
+* Enhancements
+  * Added support for modern iPhone and iPad sizes
+  * Added support for driving Safari and Safari Technology Preview
+  * Updated to use new Watir namespace
+  * Updated to Ruby 2.4.1
+  * Updated Chrome and Firefox options configuration to use new Selenium syntax
+
+=== Version 7.4 / 2016-1-6
+* Enhancements
+  * Added support for iPad Pro and iPhone 6/6s (Thanks samnissen)
+
+=== Version 7.3 / 2015-7-14    (Thanks samnissen)
+* Enhancements
+  * Allow users to override the browser screensize
+* Fixes
+  * Removed development puts commands
+  * Chrome no longer rejects using Javascript to rewize the window
+
 === Version 7.2 / 2014-12-12
 * Enhancements
   * Added iphone 5 and 6 variants (Thanks samnissen)
@@ -6,4 +25,3 @@
 === Version 7.1 / 2014-3-2
 * Enhancements
   * Added ipad 7 device support (Thanks Matthwe Fleeger)
-

data/README.md

@@ -25,6 +25,7 @@ provides a UserAgent.driver method to return a new web-driver with user agent an
 * :browser
 	* :firefox (default)
 	* :chrome
+  * :safari
 * :agent
 	* :iphone (default)
 	* :ipad
@@ -51,9 +52,9 @@ provides a UserAgent.driver method to return a new web-driver with user agent an
 	driver.execute_script('return navigator.userAgent')
 	# random agent like "Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:0.9.2) Gecko/20010726 Netscape6/6.1"
 
-### Example using watir-webdriver
+### Example using watir
 
-	require 'watir-webdriver'
+	require 'watir'
 	require 'webdriver-user-agent'
 	driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :iphone, :orientation => :landscape)
 	browser = Watir::Browser.new(driver)

data/lib/device-info/devices.yaml

@@ -1,64 +1,173 @@
-:iphone:
-   :user_agent: "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B435 Safari/600.1.4"
+# 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
+
+# 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_15_4) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1 Safari/605.1.15
    :portrait:
-     :width: 375
-     :height: 559
+     :width: 768
+     :height: 1024
    :landscape:
-     :width: 667
-     :height: 375
-:iphone6plus:
-  :user_agent: "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B435 Safari/600.1.4"
+     :width: 1366
+     :height: 768
+:iphone_default: &iphone_default
+   :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: 414
+     :height: 719
+   :landscape:
+     :width: 808
+     :height: 414
+:iphone: &iphone
+  <<: *iphone_default
+:iphone11pro:
+  <<: *iphone_default
   :portrait:
-    :width: 414
-    :height: 628
+    :width: 375
+    :height: 635
   :landscape:
-    :width: 736
-    :height: 414
-:iphone6:
-  :user_agent: "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B435 Safari/600.1.4"
+    :width: 724
+    :height: 375
+:iphone11promax:
+  <<: *iphone_default
+:iphone11:
+  <<: *iphone_default
+:iphonese: &iphonese
+  <<: *iphone_default
   :portrait:
     :width: 375
-    :height: 559
+    :height: 553
   :landscape:
     :width: 667
     :height: 375
-:iphone5s:
-  :user_agent: "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B435 Safari/600.1.4"
+: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
+:iphone6splus:
+  <<: *iphone8plus
+:iphone6s:
+  <<: *iphone8
+:iphone6plus:
+  <<: *iphone8plus
+:iphone6:
+  <<: *iphone8
+:iphone5s: &iphone5s
+  <<: *iphone_default
   :portrait:
     :width: 320
-    :height: 460
+    :height: 454
   :landscape:
     :width: 568
-    :height: 212
-:iphone4s:
-  :user_agent: "Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B435 Safari/600.1.4"
+    :height: 320
+:iphonese_old:
+  <<: *iphone5s
+:iphone5:
+  <<: *iphone5s
+:iphone4s: &iphone4s
+  <<: *iphone_default
   :portrait:
     :width: 320
     :height: 356
   :landscape:
     :width: 480
     :height: 196
-:ipad:
-  :user_agent: "Mozilla/5.0(iPad; U; CPU OS 8_1_1 like Mac OS X) AppleWebKit/600.14 (KHTML, like Gecko) Version/8.0 Mobile/12B435 Safari/9537.53"
+:iphone4:
+  <<: *iphone4s
+:ipad: &ipad
+  :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: 810
+    :height: 1010
+  :landscape:
+    :width: 1080
+    :height: 740
+:ipad_default:
+  <<: *ipad
+:ipad_pro: &ipad_pro
+  <<: *ipad
+  :portrait:
+    :width: 1024
+    :height: 1292
+  :landscape:
+    :width: 1366
+    :height: 950
+:ipad_pro_12:
+  <<: *ipad_pro
+:ipad_pro_11:
+  <<: *ipad
+  :portrait:
+    :width: 834
+    :height: 1120
+  :landscape:
+    :width: 1194
+    :height: 760
+:ipad_pro_9:
+  <<: *ipad
   :portrait:
     :width: 768
-    :height: 960
+    :height: 954
   :landscape:
     :width: 1024
-    :height: 704
+    :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

@@ -2,6 +2,12 @@ require 'facets/hash/except'
 
 module Webdriver
   module UserAgent
+
+    MINIMUM_MACOS_VERSION_NUMBER = 12
+    DEFAULT_BROWSER = :firefox
+    DEFAULT_AGENT = :iphone
+    DEFAULT_ORIENTATION = :portrait
+
     class BrowserOptions
 
       def initialize(opts, user_agent_string)
@@ -9,7 +15,11 @@ module Webdriver
         options[:browser] ||= :firefox
         options[:agent] ||= :iphone
         options[:orientation] ||= :portrait
-        initialize_for_browser(user_agent_string)
+        set_preview_option(options[:safari_technology_preview]) if (@options[:browser] == :safari)
+
+        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], opts[:options])
       end
 
       def method_missing(*args, &block)
@@ -20,7 +30,7 @@ module Webdriver
       end
 
       def browser_options
-        options.except(:browser, :agent, :orientation, :user_agent_string)
+        options.except(:browser, :agent, :orientation, :user_agent_string, :accept_language_string, :viewport_width, :viewport_height, :safari_technology_preview)
       end
 
       private
@@ -29,19 +39,112 @@ module Webdriver
         @options ||= {}
       end
 
-      def initialize_for_browser(user_agent_string)
+      def set_preview_option(opt)
+        @stp = opt
+        @stp = false unless @stp.is_a?(TrueClass)
+      end
+
+      def initialize_for_browser(user_agent_string, accept_language_string, driver_options = nil)
+        options[:options] ||= driver_options
+
         case options[:browser]
         when :firefox
-          options[:profile] ||= Selenium::WebDriver::Firefox::Profile.new
-          options[:profile]['general.useragent.override'] = user_agent_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[:switches] ||= []
-          options[:switches] << "--user-agent=#{user_agent_string}"
+          options[:options] ||= Selenium::WebDriver::Chrome::Options.new
+
+          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
         else
-          raise "WebDriver UserAgent currently only supports :firefox and :chrome."
+          raise "WebDriver UserAgent currently only supports :chrome, :firefox and :safari."
+        end
+      end
+
+      def parse_viewport_sizes(width, height)
+        return ["0","0"] unless "#{width}".to_i > 0 && "#{height}".to_i > 0
+
+        ["#{width}", "#{height}"]
+      end
+
+      def change_safari_user_agent_string(user_agent_string)
+        ua  = "\"\\\"#{user_agent_string}\\\"\"" # escape for shell quoting
+
+        safari_command_runner(ua, "CustomUserAgent")
+      end
+
+      def change_safari_language(accept_language_string)
+        parsed_safari_string = prepare_safari_string(accept_language_string)
+
+        safari_command_runner(parsed_safari_string, "AppleLanguages")
+      end
+
+      def safari_command_runner(setting, pref)
+        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 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
+        if @stp
+          Selenium::WebDriver::Safari.technology_preview!
+          return "SafariTechnologyPreview"
         end
-        
+
+        "Safari"
       end
+
+      def prepare_safari_error_message(cmd, output)
+        error_message  = "Unable to execute '#{cmd}'. "
+        error_message += "Error message reported: '#{output}'"
+        error_message += "Please execute the command manually and correct any errors."
+
+        error_message
+      end
+
+      def prepare_safari_string(accept_language_string)
+        ["'(", accept_language_string.split(",").map{|l|
+          "\"#{l.gsub(/\s+/,'')}\""
+        }.join(", "), ")'"].join('')
+      end
+
+      # Require a Mac at version 12 (Sierra) or greater
+      def require_mac_version
+        raise "Safari requires a Mac" unless OS.mac?
+        raise "Selenium only works with Safari on Sierra or newer" unless valid_mac_version?
+      end
+
+      def valid_mac_version?
+        version = "#{`defaults read loginwindow SystemVersionStampAsString`}"
+        version_number = "#{version.split(".")[1]}"
+        version_number.to_i >= MINIMUM_MACOS_VERSION_NUMBER
+      end
+
     end
   end
 end

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

@@ -3,12 +3,14 @@ require 'yaml'
 module Webdriver
   module UserAgent
     module Devices
-      
+
       def devices
         YAML.load_file devices_file
       end
 
-      def resolution_for(device_name, orientation)
+      def resolution_for(device_name, orientation, user_width, user_height)
+        return [user_width.to_i, user_height.to_i] if ((user_width.to_i + user_height.to_i) > 1)
+
         device = devices[device_name.downcase][orientation.downcase]
         [device[:width],device[:height]]
       end
@@ -21,7 +23,7 @@ module Webdriver
       end
 
       private
-      
+
       def random_user_agent
         File.foreach(user_agents_file).each_with_index.reduce(nil) do |picked,pair|
           rand < 1.0/(1+pair[1]) ? pair[0] : picked

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

@@ -1,4 +1,5 @@
 require 'json'
+require 'os'
 require 'selenium-webdriver'
 require 'webdriver-user-agent/browser_options'
 require 'webdriver-user-agent/devices'
@@ -14,27 +15,37 @@ module Webdriver
         user_agent_string ||= agent_string_for opts[:agent]
         options = BrowserOptions.new(opts, user_agent_string)
         build_driver_using options
+      ensure
+        if safari?(opts)
+          case
+          when opts[:safari_technology_preview].is_a?(TrueClass)
+            `defaults delete com.apple.SafariTechnologyPreview CustomUserAgent`
+            `defaults delete com.apple.SafariTechnologyPreview AppleLanguages`
+          else
+            `defaults delete com.apple.Safari CustomUserAgent`
+            `defaults delete com.apple.Safari AppleLanguages`
+          end
+        end
       end
 
       private
 
       def resize_inner_window(driver, width, height)
-        if driver.browser == :firefox or :chrome
-          driver.execute_script("window.open(#{driver.current_url.to_json},'_blank');")
-          driver.close
-          driver.switch_to.window driver.window_handles.first
-        end
-        driver.execute_script("window.innerWidth = #{width}; window.innerHeight = #{height};")
+        target_size = Selenium::WebDriver::Dimension.new(width.to_i, height.to_i)
+        driver.manage.window.resize_to target_size.width, target_size.height
       end
 
       def build_driver_using(options)
         driver = Selenium::WebDriver.for options.browser, options.browser_options
         unless options.agent == :random
-          resize_inner_window(driver, *resolution_for(options.agent, options.orientation))
+          resize_inner_window(driver, *resolution_for(options.agent, options.orientation, options.viewport_width, options.viewport_height))
         end
         driver
       end
 
+      def safari?(o = {})
+        o[:browser] == :safari
+      end
     end
   end
 end

data/spec/webdriver-user-agent_spec.rb

@@ -4,96 +4,385 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'webdriver-user-agent'
 require 'selenium-webdriver'
-require 'watir-webdriver'
+require 'watir'
+require 'webdrivers'
+
+CHROMEBROWSER_UICHROME_HEIGHT         = 123
+CHROMEBROWSER_UICHROME_HEIGHT_TALL    = 50
+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
-    @driver.quit if @driver
+    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
+  # do not accurately provide
+  # browser widths and heights
+  # http://stackoverflow.com/a/8876069/1651458
+
+  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 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 window.innerWidth')).to eq(375) 
-  	expect(@driver.execute_script('return window.innerHeight')).to eq(559)
+  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
 
-  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 window.innerWidth')).to eq(736) 
-  	expect(@driver.execute_script('return window.innerHeight')).to eq(414)
+  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 iPad (landscape)" do
-  	@driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :iPad, :orientation => :landscape)
+  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
+
+  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
+    # Testing the height will fail if your monitor is not tall enough.
+    # For instance, a 15" MacBook Pro at default scaled resolution cannot be.
+    # This will determine if your monitor is tall enough.
+    # Optionally, you can override with an environment variable:
+    # `I_HAVE_A_TALL_MONITOR=true rspec spec/this_file.rb`
+    width = 800; height = 1302
+    @driver = Webdriver::UserAgent.driver(:viewport_width => "#{width}", :viewport_height => height, :agent => :desktop)
+    browser_max_height = @driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')
+    @you_have_a_tall_monitor = (browser_max_height > (1302 - CHROMEBROWSER_UICHROME_HEIGHT))
+    @you_have_a_tall_monitor = true if ("#{ENV['I_HAVE_A_TALL_MONITOR']}".downcase == 'true')
+    @driver.quit if @driver
+    # Back to your regularly scheduled test.
+
+  	@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 window.innerWidth')).to eq(1024) 
-  	expect(@driver.execute_script('return window.innerHeight')).to eq(704)
+  	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 window.innerWidth')).to eq(480) 
-    expect(@driver.execute_script('return window.innerHeight')).to eq(196)
+
+  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 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 window.innerWidth')).to eq(768)
-    expect(@driver.execute_script('return window.innerHeight')).to eq(946)
+  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 window.innerWidth')).not_to eq(320) 
-    expect(@driver.execute_script('return window.innerHeight')).not_to eq(356)
+  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_behaves_like "random browser driver"
+    end
+
+    context "chrome browser" do
+      let(:device_key) { :random }
+      let(:browser) { :chrome }
+      let(:driver) do
+        Webdriver::UserAgent.driver(browser: browser, agent: device_key)
+      end
+
+      it_behaves_like "random browser driver"
+    end
   end
 
-  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 window.innerWidth')).not_to eq(320) 
-    expect(@driver.execute_script('return window.innerHeight')).not_to eq(356)
+  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 an existing firefox profile" do
-    profile = Selenium::WebDriver::Firefox::Profile.new
-    profile['browser.startup.homepage'] = "data:text/html,<title>hello</title>"
-    @driver = Webdriver::UserAgent.driver(:browser => :firefox, :profile => profile)
-    expect(@driver.browser).to eq(:firefox)
-    expect(@driver.execute_script('return navigator.userAgent')).to include 'iPhone'
-    expect(@driver.execute_script('return window.innerWidth')).to eq(375) 
-    expect(@driver.execute_script('return window.innerHeight')).to eq(559)
-    expect(@driver.title).to eq('hello')
+  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) }
+
+    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.userAgent")).to include("Mac_PowerPC")
+    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')).not_to be_nil
-   
-   @browser = Watir::Browser.new @driver
-   expect(@browser.url).to eq("about:blank") 
- 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.url).to eq("about:blank") 
+  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) }
+
+    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
 
+  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
 
+  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
+      )
+    }
 
-end
+    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
+
+  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

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Alister Scott", "Jeff Morgan"]
-  gem.email         = ["alister.scott@gmail.com", "jeff.morgan@leandog.com"]
+  gem.authors       = ["Alister Scott", "Jeff Morgan", "Sandeep Singh", "Sam Nissen"]
+  gem.email         = ["alister.scott@gmail.com", "jeff.morgan@leandog.com", "sandeepnagra@gmail.com", "scnissen@gmail.com"]
   gem.description   = %q{A helper gem to emulate populate device user agents and resolutions when using webdriver}
   gem.summary       = %q{A helper gem to emulate populate device user agents and resolutions when using webdriver}
   gem.homepage      = "https://github.com/alisterscott/webdriver-user-agent"
@@ -12,11 +12,16 @@ 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.2"
-  gem.add_dependency 'selenium-webdriver'
+  gem.version       = "7.8"
+  gem.requirements << 'chromedriver, v2.20'
+  # chromedriver v2.19 causes
+    # Selenium::WebDriver::Error::NoSuchDriverError: no such session errors
+  gem.add_dependency 'selenium-webdriver', '>= 3.4.0'
+  gem.add_dependency 'os'
   gem.add_dependency 'facets'
   gem.add_dependency 'json'
+  gem.add_dependency 'psych'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'watir-webdriver'
-
+  gem.add_development_dependency 'watir'
+  gem.add_development_dependency 'webdrivers'
 end

metadata

@@ -1,95 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: webdriver-user-agent
 version: !ruby/object:Gem::Version
-  version: '7.2'
-  prerelease: 
+  version: '7.8'
 platform: ruby
 authors:
 - Alister Scott
 - Jeff Morgan
+- Sandeep Singh
+- Sam Nissen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2020-07-10 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: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    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: facets
   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: json
   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: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !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
+    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
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: watir-webdriver
+  name: webdrivers
   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 helper gem to emulate populate device user agents and resolutions when
@@ -97,14 +130,16 @@ description: A helper gem to emulate populate device user agents and resolutions
 email:
 - alister.scott@gmail.com
 - jeff.morgan@leandog.com
+- sandeepnagra@gmail.com
+- scnissen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - ChangeLog
 - Gemfile
 - HISTORY.md
@@ -122,27 +157,26 @@ files:
 - webdriver-user-agent.gemspec
 homepage: https://github.com/alisterscott/webdriver-user-agent
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
+requirements:
+- chromedriver, v2.20
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A helper gem to emulate populate device user agents and resolutions when
   using webdriver
 test_files: