webdriver-user-agent 7.5 → 7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9260c1a33a202278f16eadeb8c2e3e925e28896eccf6aaf778bc127460e4dbd2
-  data.tar.gz: 70e9b164502d0c04e60c8391e8c6b8164ea6259846cecbe29212353cbf3d45cd
+  metadata.gz: 9589c34ef3fbb25e386f2c5b654f21564afe66a47c89dec46f78dff7cadb70e2
+  data.tar.gz: 44f41c6fabde58f65d1598813fe63ed659b5b430972b23fd9f08349251780f0a
 SHA512:
-  metadata.gz: e81485d6bf53586daae8c220ce77a8795bf576744eb19e6f6a45951f2dfea4079faadbc86ef540a8a939af0d240c35d9b5c460a719d089453e40ee2102d74736
-  data.tar.gz: 25524c3865c8a54ce01f3c62d46c214fa33b6f1475aea1f5321268ab5c003796f0d40a807efcd16e8198bef8b02f3cfbeffbcf909842cb12162c0f7997621297
+  metadata.gz: c07dacc751fdb9793a8d932d3fa11e468d2c10b940f52d0b3c9569fc3dec97b827012ae515ffc7c0c90b3b5d45ec76630cdd7464c14c3e7e8fde3d7fe921c1be
+  data.tar.gz: 8045ac3e0b908bb49609aa31ae7d00c7c98c5d8f8c59edfb8cfa92a1171df4906749255726c36446ab3e2e3f3e01013c10d1e9624968baab503ea917c610ef11

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

@@ -4,6 +4,9 @@ module Webdriver
   module UserAgent
 
     MINIMUM_MACOS_VERSION_NUMBER = 12
+    DEFAULT_BROWSER = :firefox
+    DEFAULT_AGENT = :iphone
+    DEFAULT_ORIENTATION = :portrait
 
     class BrowserOptions
 
@@ -16,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)
+        initialize_for_browser(user_agent_string, opts[:accept_language_string])
       end
 
       def method_missing(*args, &block)
@@ -27,7 +30,7 @@ module Webdriver
       end
 
       def browser_options
-        options.except(:browser, :agent, :orientation, :user_agent_string, :viewport_width, :viewport_height)
+        options.except(:browser, :agent, :orientation, :user_agent_string, :accept_language_string, :viewport_width, :viewport_height, :safari_technology_preview)
       end
 
       private
@@ -41,19 +44,22 @@ module Webdriver
         @stp = false unless @stp.is_a?(TrueClass)
       end
 
-      def initialize_for_browser(user_agent_string)
+      def initialize_for_browser(user_agent_string, accept_language_string)
         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
           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
         when :safari
           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."
@@ -67,23 +73,48 @@ module Webdriver
       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?
 
-        ua  = "\\\"#{user_agent_string}\\\"" # escape for shell quoting
+        cmd = "defaults write com.apple.#{safari_version} #{pref} #{setting}"
+
+        output = `#{cmd}`
+
+        raise prepare_safari_error_message(cmd, output) unless $?.success?
+      end
+
+      def safari_version
         if @stp
           Selenium::WebDriver::Safari.technology_preview!
-          cmd = "defaults write com.apple.SafariTechnologyPreview CustomUserAgent \"#{ua}\""
-        else
-          cmd = "defaults write com.apple.Safari CustomUserAgent \"#{ua}\""
+          return "SafariTechnologyPreview"
         end
 
-        output = `#{cmd}`
+        "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."
 
-        raise error_message unless $?.success?
+        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

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

@@ -3,14 +3,14 @@ require 'yaml'
 module Webdriver
   module UserAgent
     module Devices
-      
+
       def devices
         YAML.load_file devices_file
       end
 
       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
@@ -23,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

@@ -20,8 +20,10 @@ module Webdriver
           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

data/spec/webdriver-user-agent_spec.rb

@@ -5,10 +5,11 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'webdriver-user-agent'
 require 'selenium-webdriver'
 require 'watir'
+require 'webdrivers'
 
-CHROMEBROWSER_UICHROME_HEIGHT         = 114
-CHROMEBROWSER_UICHROME_HEIGHT_TALL    = 41
-CHROMEBROWSER_UI_MINIMUM_HEIGHT       = 158
+CHROMEBROWSER_UICHROME_HEIGHT         = 123
+CHROMEBROWSER_UICHROME_HEIGHT_TALL    = 50
+CHROMEBROWSER_UI_MINIMUM_HEIGHT       = 149
 FIREFOXBROWSER_UICHROME_HEIGHT        = 74
 SAFARIBROWSER_UICHROME_HEIGHT         = 38
 
@@ -33,7 +34,7 @@ describe "webdriver user agent" do
 
   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.browser}").to match(/safari/i)
 
   	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)
@@ -139,12 +140,36 @@ describe "webdriver user agent" do
   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'
+    @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
- end
+    @browser = Watir::Browser.new @driver
+  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'
+
+    @browser = Watir::Browser.new @driver
+  end
+
+  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
+  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'
+
+    @browser = Watir::Browser.new @driver
+  end
 
   it "can create a new webdriver driver using firefox and user-specified viewport sizes (string or int)" do
     width = 800
@@ -153,7 +178,7 @@ describe "webdriver user agent" do
     @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)
- 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)

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.5"
+  gem.version       = "7.6"
   gem.requirements << 'chromedriver, v2.20'
   # chromedriver v2.19 causes
     # Selenium::WebDriver::Error::NoSuchDriverError: no such session errors
@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'psych'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'watir'
+  gem.add_development_dependency 'webdrivers'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webdriver-user-agent
 version: !ruby/object:Gem::Version
-  version: '7.5'
+  version: '7.6'
 platform: ruby
 authors:
 - Alister Scott
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -111,6 +111,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A helper gem to emulate populate device user agents and resolutions when
   using webdriver
 email: