webdriver-user-agent 7.4 → 7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ebfa0b02eb28f97547b5cfbdddd07cd6fe4340a5
-  data.tar.gz: 665d1e9598eaed543589057ca2ebbace6e0e0448
+SHA256:
+  metadata.gz: 9260c1a33a202278f16eadeb8c2e3e925e28896eccf6aaf778bc127460e4dbd2
+  data.tar.gz: 70e9b164502d0c04e60c8391e8c6b8164ea6259846cecbe29212353cbf3d45cd
 SHA512:
-  metadata.gz: da3d4026092a697e09d2817dc7d2116bba3b1dadf01421483fa7e8d06aad03e38b4e5b3769bf8454bd4f8e297ac564077e538ff05a29af6e7c091926c357c879
-  data.tar.gz: a5512aec12f716e47000854cbca511d98a8663ffab9196a855f3946c8897047b0a8209a95bd68db207b00bd326474030c198c3a250255ad33b2ae6255bee4d80
+  metadata.gz: e81485d6bf53586daae8c220ce77a8795bf576744eb19e6f6a45951f2dfea4079faadbc86ef540a8a939af0d240c35d9b5c460a719d089453e40ee2102d74736
+  data.tar.gz: 25524c3865c8a54ce01f3c62d46c214fa33b6f1475aea1f5321268ab5c003796f0d40a807efcd16e8198bef8b02f3cfbeffbcf909842cb12162c0f7997621297

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.1
+ruby-2.4.1

data/ChangeLog

@@ -1,3 +1,11 @@
+=== 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)
@@ -17,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

@@ -11,44 +11,59 @@
      :width: 1366
      :height: 768
 :iphone_default: &iphone_default
-   :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"
+   :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"
    :portrait:
      :width: 375
-     :height: 559
+     :height: 635
    :landscape:
-     :width: 667
+     :width: 724
      :height: 375
-:iphone:
+:iphone: &iphone
    <<: *iphone_default
-:iphone6splus:
+:iphonex:
+  <<: *iphone_default
+:iphone8plus: &iphone8plus
   <<: *iphone_default
   :portrait:
     :width: 414
-    :height: 628
+    :height: 622
   :landscape:
     :width: 736
     :height: 414
-:iphone6s:
-  <<: *iphone_default
-:iphone6plus:
+:iphone8: &iphone8
   <<: *iphone_default
   :portrait:
-    :width: 414
-    :height: 628
+    :width: 375
+    :height: 553
   :landscape:
-    :width: 736
-    :height: 414
+    :width: 667
+    :height: 375
+:iphone7plus:
+  <<: *iphone8plus
+:iphone7:
+  <<: *iphone8
+  :portrait:
+:iphone6splus:
+  <<: *iphone8plus
+:iphone6s:
+  <<: *iphone8
+:iphone6plus:
+  <<: *iphone8plus
 :iphone6:
-  <<: *iphone_default
-:iphone5s:
+  <<: *iphone8
+:iphone5s: &iphone5s
   <<: *iphone_default
   :portrait:
     :width: 320
-    :height: 460
+    :height: 454
   :landscape:
     :width: 568
-    :height: 212
-:iphone4s:
+    :height: 320
+:iphonese:
+  <<: *iphone5s
+:iphone5:
+  <<: *iphone5s
+:iphone4s: &iphone4s
   <<: *iphone_default
   :portrait:
     :width: 320
@@ -56,22 +71,44 @@
   :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/600.1.4"
+: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"
   :portrait:
     :width: 768
-    :height: 960
+    :height: 954
   :landscape:
     :width: 1024
-    :height: 704
-:ipad_pro:
-  :user_agent: "Mozilla/5.0 (iPad; CPU OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B137 Safari/601.1"
+    :height: 698
+:ipad_default:
+  <<: *ipad
+:ipad_pro: &ipad_pro
+  <<: *ipad
   :portrait:
     :width: 1024
-    :height: 1302
+    :height: 1296
   :landscape:
     :width: 1366
-    :height: 960
+    :height: 954
+:ipad_pro_12:
+  <<: *ipad_pro
+:ipad_pro_10:
+  <<: *ipad
+  :portrait:
+    :width: 834
+    :height: 1042
+  :landscape:
+    :width: 1112
+    :height: 764
+:ipad_pro_9:
+  <<: *ipad
+  :portrait:
+    :width: 768
+    :height: 954
+  :landscape:
+    :width: 1024
+    :height: 698
 :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"
   :portrait:

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

@@ -2,6 +2,9 @@ require 'facets/hash/except'
 
 module Webdriver
   module UserAgent
+
+    MINIMUM_MACOS_VERSION_NUMBER = 12
+
     class BrowserOptions
 
       def initialize(opts, user_agent_string)
@@ -9,9 +12,10 @@ module Webdriver
         options[:browser] ||= :firefox
         options[:agent] ||= :iphone
         options[:orientation] ||= :portrait
-        
+        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)
       end
 
@@ -32,25 +36,68 @@ module Webdriver
         @options ||= {}
       end
 
+      def set_preview_option(opt)
+        @stp = opt
+        @stp = false unless @stp.is_a?(TrueClass)
+      end
+
       def initialize_for_browser(user_agent_string)
         case options[:browser]
         when :firefox
-          options[:profile] ||= Selenium::WebDriver::Firefox::Profile.new
-          options[:profile]['general.useragent.override'] = user_agent_string
+          profile ||= Selenium::WebDriver::Firefox::Profile.new
+          profile['general.useragent.override'] = user_agent_string
+
+          options[:options] ||= Selenium::WebDriver::Firefox::Options.new
+          options[:options].profile = profile
         when :chrome
-          options[:switches] ||= []
-          options[:switches] << "--user-agent=#{user_agent_string}"
+          options[:options] ||= Selenium::WebDriver::Chrome::Options.new
+          options[:options].add_argument "--user-agent=#{user_agent_string}"
+        when :safari
+          change_safari_user_agent_string(user_agent_string)
+          options
         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)
+        raise "Safari requires a Mac" unless OS.mac?
+
+        ua  = "\\\"#{user_agent_string}\\\"" # escape for shell quoting
+        if @stp
+          Selenium::WebDriver::Safari.technology_preview!
+          cmd = "defaults write com.apple.SafariTechnologyPreview CustomUserAgent \"#{ua}\""
+        else
+          cmd = "defaults write com.apple.Safari CustomUserAgent \"#{ua}\""
+        end
+
+        output = `#{cmd}`
+
+        error_message  = "Unable to execute '#{cmd}'. "
+        error_message += "Error message reported: '#{output}'"
+        error_message += "Please execute the command manually and correct any errors."
+
+        raise error_message unless $?.success?
+      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/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,18 +15,22 @@ 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`
+          else
+            `defaults delete com.apple.Safari CustomUserAgent`
+          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
         target_size = Selenium::WebDriver::Dimension.new(width.to_i, height.to_i)
-        driver.manage.window.size = target_size
+        driver.manage.window.resize_to target_size.width, target_size.height
       end
 
       def build_driver_using(options)
@@ -36,6 +41,9 @@ module Webdriver
         driver
       end
 
+      def safari?(o = {})
+        o[:browser] == :safari
+      end
     end
   end
 end

data/spec/webdriver-user-agent_spec.rb

@@ -4,15 +4,18 @@ $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'
 
-CHROMEBROWSER_UICHROME_HEIGHT   = 72
-CHROMEBROWSER_UI_MINIMUM_HEIGHT = 200
-FIREFOXBROWSER_UICHROME_HEIGHT  = 79
+CHROMEBROWSER_UICHROME_HEIGHT         = 114
+CHROMEBROWSER_UICHROME_HEIGHT_TALL    = 41
+CHROMEBROWSER_UI_MINIMUM_HEIGHT       = 158
+FIREFOXBROWSER_UICHROME_HEIGHT        = 74
+SAFARIBROWSER_UICHROME_HEIGHT         = 38
 
 describe "webdriver user agent" do
   after :each do
-    @driver.quit if @driver
+    @browser.close if @browser rescue nil
+    @driver.quit if @driver rescue nil
   end
 
   # window.innerWidth and window.innerHeight
@@ -25,7 +28,16 @@ describe "webdriver user agent" do
   	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(559 - FIREFOXBROWSER_UICHROME_HEIGHT)
+  	expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(635 - FIREFOXBROWSER_UICHROME_HEIGHT)
+  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 eq(:safari)
+
+  	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)
   end
 
   it "can create a new webdriver driver using chrome and iphone 6 plus (landscape)" do
@@ -37,16 +49,16 @@ describe "webdriver user agent" do
   end
 
   it "can create a new webdriver driver using chrome and iPad (landscape)" do
-  	@driver = Webdriver::UserAgent.driver(:browser => :chrome, :agent => :iPad, :orientation => :landscape)
+  	@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(704 - CHROMEBROWSER_UICHROME_HEIGHT)
+  	expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(698 - CHROMEBROWSER_UICHROME_HEIGHT)
   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 cannot be.
+    # 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`
@@ -86,7 +98,7 @@ describe "webdriver user agent" do
     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)
+    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(873 - CHROMEBROWSER_UICHROME_HEIGHT_TALL)
   end
 
   it "can create a new webdriver driver using firefox and desktop (landscape)" do
@@ -116,11 +128,14 @@ describe "webdriver user agent" do
   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)
+    options = Selenium::WebDriver::Firefox::Options.new
+    options.profile = profile
+    @driver = Webdriver::UserAgent.driver(:browser => :firefox, options: options)
+
     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(559 - FIREFOXBROWSER_UICHROME_HEIGHT)
+    expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(635 - FIREFOXBROWSER_UICHROME_HEIGHT)
   end
 
   it "can create a new webdriver driver using firefox and user-specified user agent" do
@@ -141,15 +156,16 @@ describe "webdriver user agent" do
  end
 
   it "can create a new webdriver driver, handling for nonsense height and widths" do
-    @driver = Webdriver::UserAgent.driver(:viewport_width => "abc", :agent => :iphone6)
+    @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(559 - FIREFOXBROWSER_UICHROME_HEIGHT)
+  	expect(@driver.execute_script('return Math.max(document.documentElement.clientHeight, window.innerHeight || 0)')).to eq(553 - FIREFOXBROWSER_UICHROME_HEIGHT)
  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 include("mozilla.org")
+    expect(@browser).to be_a(Watir::Browser)
+    expect(@browser.url).to be_a(String)
   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,14 +12,15 @@ 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.4"
+  gem.version       = "7.5"
   gem.requirements << 'chromedriver, v2.20'
   # chromedriver v2.19 causes
     # Selenium::WebDriver::Error::NoSuchDriverError: no such session errors
-  gem.add_dependency 'selenium-webdriver'
+  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'
 end

metadata

@@ -1,18 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: webdriver-user-agent
 version: !ruby/object:Gem::Version
-  version: '7.4'
+  version: '7.5'
 platform: ruby
 authors:
 - Alister Scott
 - Jeff Morgan
+- Sandeep Singh
+- Sam Nissen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    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:
     - - ">="
@@ -82,7 +98,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: watir-webdriver
+  name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,6 +116,8 @@ 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: []
@@ -143,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - chromedriver, v2.20
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A helper gem to emulate populate device user agents and resolutions when