browser_sniffer 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1d2a14cbaa027eb267424ec34f049c2a383471036e9dad156d40c26a5b78fd6
-  data.tar.gz: a4fcca71e6189f943587910085a966a8fe7f5673600271b85f87cd82467b0281
+  metadata.gz: 6a77c63b7563c544ce8ca42c0025fb9bad4dffe07be91652510f78d8e95c1c77
+  data.tar.gz: dd49278682198e0563dcd22171fdaa7fa5a2f7364e3c0e5bd52dad6c2fd68b41
 SHA512:
-  metadata.gz: 8abab760e9d58a527f5dc971ccbc93d1d524c38ccd7e6ef01fb2ca5536c9558f9e7811a2c63f1efcf6b3ddb2d4976cfc142454d86b49f9f1f455428888f61f74
-  data.tar.gz: f4f0d813479f3d374e6a1104211052c0954768ff7af20525175dfb7971ed569f353ba3122f6e3595944d04cda1fc76519bcbded668388e5a05dceb352405983c
+  metadata.gz: ab86e531c4cebcd5d6a5537e6a41cba81865b875f588d0d44296f89773321b935d9026ef5e3e2d05f1b30ae2082a603f6899b0b72e2eb3cf566141466ba347b7
+  data.tar.gz: 35fc400e3501ff5ed0f3682c914c80221c7c9c83a02f3f924792edf0eed98c8e32708c3b44658afbf68fe71577624e4a916d025e6a7ccca646c7f6d8ef6012af

data/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Ruby CI
+
+on:
+  pull_request:
+  push:
+    branches: master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - 2.0
+          - 2.1
+          - 2.2
+          - 2.3
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+          - 3.1
+          - jruby
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.version }}
+      - name: Run Tests
+        run: bundle exec rake test

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/Shopify/browser_sniffer.png?branch=master)](http://travis-ci.org/Shopify/browser_sniffer)
+[![Build Status](https://github.com/Shopify/browser_sniffer/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/Shopify/browser_sniffer/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/browser_sniffer.png)](http://badge.fury.io/rb/browser_sniffer)
 
 # BrowserSniffer

data/browser_sniffer.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = ">= 2.0.0"
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 

data/lib/browser_sniffer/patterns.rb

@@ -59,6 +59,12 @@ class BrowserSniffer
       ], [:name, :version], [
         # Shopify POS for Android (Native App)
         %r{.*(\sPOS\s-).*\s([\d+\.]+)(\/\d*)*\s}i,
+      ], [[:name, 'Shopify POS'], :version], [
+        # Shopify POS for Android (React Native App)
+        %r{(Shopify POS)\/([\d\.]+)[^\/]*\/(Android)\/(\d+)}i,
+      ], [[:name, 'Shopify POS'], :version], [
+        # Shopify POS for iOS (React Native App)
+        %r{(Shopify POS)\/([\d\.]+)[^\/]*\/(iOS)\/([\d\.]+)}i,
       ], [[:name, 'Shopify POS'], :version], [
         # Shopify POS for Android (SmartWebView)
         %r{.*(Shopify\sPOS)\s.*Android.*\s([\d+\.]+)(\/\d*)*\s}i,
@@ -171,6 +177,12 @@ class BrowserSniffer
         # Shopify POS Next for iPod touch
         %r{.*(?:Shopify POS Next|Shopify POS)/(?:iPhone\sOS|iOS)/[\d\.]+ \((iPod)([\d,]+)}i
       ], [[:type, :handheld], :model], [
+        # Shopify POS for iOS iPhone/iPod (React Native App)
+        %r{.*Shopify POS\/[\d\.]+[^\/]*\/(iOS)\/[\d\.]+\/Apple\/((iPhone|iPod)[^\/]*)\/}i,
+      ], [[:type, :handheld], :model], [
+        # Shopify POS for iOS iPad (React Native App)
+        %r{.*Shopify POS\/[\d\.]+[^\/]*\/(iOS)\/[\d\.]+\/Apple\/(iPad[^\/]*)\/}i,
+      ], [[:type, :tablet], :model], [
         # Shopify Ping for iPhone
         %r{.*Shopify Ping/(?:iPhone\sOS|iOS)/[\d\.]+ \((iPhone)([\d,]+)}i
       ], [[:type, :handheld], :model], [
@@ -294,6 +306,9 @@ class BrowserSniffer
         # Shopify POS Next for iPhone or iPad
         %r{.*(Shopify POS Next|Shopify POS)\/(?:iPhone\sOS|iOS)[\/\d\.]* \((iPhone|iPad|iPod).*\/([\d\.]+)\)}i
       ], [[:type, :ios], [:name, 'iOS'], :version], [
+        # Shopify POS for iOS (React Native App)
+        %r{.*Shopify POS\/[\d\.]+[^\/]*\/(iOS)\/([\d\.]+)\/(Apple)\/(iPhone|iPad|iPod)[^\/]*\/}i
+      ], [[:type, :ios], :version, [:name, 'iOS']], [
         # Shopify Ping for iOS
         %r{.*Shopify Ping\/(iOS)\/[\d\.]+ \(.*\/([\d\.]+)\)}i
       ], [[:type, :ios], :version, [:name, 'iOS']], [

data/lib/browser_sniffer/version.rb

@@ -1,3 +1,3 @@
 class BrowserSniffer
-  VERSION = "1.2.2"
+  VERSION = "2.0.0"
 end

data/lib/browser_sniffer.rb

@@ -24,6 +24,15 @@ class BrowserSniffer
     browser == :ie && major_browser_version == 11
   end
 
+  # This method checks ie 11 mobile or ie11 rendering an older version in compatibility mode, in addition to `ie11?`.
+  # The `ie11?` method would return false in both those scenarios.
+  def ie11_actual?
+    ie11_engine = major_engine_version == 7 && engine_name == 'Trident'
+    ie_mobile11 = major_browser_version == 11 && browser_name == 'IEMobile'
+
+    ie11? || ie11_engine || ie_mobile11
+  end
+
   def handheld?
     form_factor == :handheld
   end

data/test/browser_sniffer_test.rb

@@ -454,6 +454,7 @@ class BrowserSnifferTest < Minitest::Test
       :android? => false,
       :desktop? => true,
       :ie11? => false,
+      :ie11_actual? => false,
       :engine => nil,
       :major_engine_version => nil,
       :os => :mac,
@@ -467,6 +468,7 @@ class BrowserSnifferTest < Minitest::Test
       :form_factor => :desktop,
       :ios? => false,
       :ie11? => true,
+      :ie11_actual? => true,
       :android? => false,
       :desktop? => true,
       :engine => :trident,
@@ -481,6 +483,7 @@ class BrowserSnifferTest < Minitest::Test
       :form_factor => :desktop,
       :ios? => false,
       :ie11? => true,
+      :ie11_actual? => true,
       :android? => false,
       :desktop? => true,
       :engine => :trident,
@@ -495,6 +498,7 @@ class BrowserSnifferTest < Minitest::Test
       :form_factor => :desktop,
       :ios? => false,
       :ie11? => true,
+      :ie11_actual? => true,
       :android? => false,
       :desktop? => true,
       :engine => :trident,
@@ -509,6 +513,7 @@ class BrowserSnifferTest < Minitest::Test
       :form_factor => :desktop,
       :ios? => false,
       :ie11? => true,
+      :ie11_actual? => true,
       :android? => false,
       :desktop? => true,
       :engine => :trident,
@@ -523,6 +528,7 @@ class BrowserSnifferTest < Minitest::Test
       :form_factor => :desktop,
       :ios? => false,
       :ie11? => false,
+      :ie11_actual? => false,
       :android? => false,
       :desktop? => true,
       :engine => :webkit,
@@ -558,6 +564,38 @@ class BrowserSnifferTest < Minitest::Test
       :browser => :chrome,
       :major_browser_version => 81,
     },
+    :windows_phone_8_1_ie11 => {
+      :user_agent => "Mozilla/5.0 (Mobile; Windows Phone 8.1; Android 4.0; ARM; Trident/7.0; Touch; rv:11.0; IEMobile/11.0; Microsoft; " \
+       "Lumia 640 XL) like iPhone OS 7_0_3 Mac OS X AppleWebKit/537 (KHTML, like Gecko) Mobile Safari/537",
+      :form_factor => :handheld,
+      :ios? => false,
+      :ie11? => false,
+      :ie11_actual? => true,
+      :android? => false,
+      :desktop? => false,
+      :engine => :webkit,
+      :major_engine_version => 53,
+      :os => :windows,
+      :os_version => "8.1",
+      :browser => nil,
+      :major_browser_version => 11
+    },
+    :win10_ie11_in_ie7_compatibility_mode => {
+      :user_agent => "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 10.0; WOW64; Trident/7.0; .NET4.0C; .NET4.0E; .NET CLR 2.0.50727; " \
+       ".NET CLR 3.0.30729; .NET CLR 3.5.30729; InfoPath.3; Tablet PC 2.0; Zoom 3.6.0)",
+      :form_factor => :desktop,
+      :ios? => false,
+      :ie11? => false,
+      :ie11_actual? => true,
+      :android? => false,
+      :desktop? => true,
+      :engine => :trident,
+      :major_engine_version => 7,
+      :os => :windows,
+      :os_version => "10",
+      :browser => :ie,
+      :major_browser_version => 7
+    },
   }
 
   AGENTS.each do |agent, attributes|

data/test/shopify_agents_test.rb

@@ -554,6 +554,97 @@ describe "Shopify agents" do
     assert_equal sniffer.os_info, sniffer_with_suffix.os_info
   end
 
+  it "Shopify POS on Android can be sniffed (React Native App)" do
+    user_agent = "com.jadedpixel.pos Shopify POS/4.23.0/Android/12/google/Pixel 5/production MobileMiddlewareSupported"
+    sniffer = BrowserSniffer.new(user_agent)
+
+    user_agent_with_mal = "com.jadedpixel.pos Shopify POS/4.23.0-mal+30112/Android/12/google/Android SDK built for " \
+    "x86/development MobileMiddlewareSupported"
+    sniffer_with_suffix = BrowserSniffer.new(user_agent_with_mal)
+
+    assert_equal ({
+      name: 'Shopify POS',
+      version: '4.23.0',
+    }), sniffer.browser_info
+
+    assert_equal ({
+      type: :handheld,
+    }), sniffer.device_info
+
+    assert_equal ({
+      type: :android,
+      version: '12',
+      name: 'Android',
+    }), sniffer.os_info
+
+    assert_equal sniffer.browser_info, sniffer_with_suffix.browser_info
+    assert_equal sniffer.device_info, sniffer_with_suffix.device_info
+    assert_equal sniffer.os_info, sniffer_with_suffix.os_info
+  end
+
+  it "Shopify POS on iPhone can be sniffed (React Native App)" do
+    user_agent = "com.jadedpixel.pos Shopify POS/7.0.0/iOS/15.4/Apple/iPhone 11/production"
+    sniffer = BrowserSniffer.new(user_agent)
+
+    assert_equal ({
+      name: 'Shopify POS',
+      version: '7.0.0',
+    }), sniffer.browser_info
+
+    assert_equal ({
+      type: :handheld,
+      model: 'iPhone 11',
+    }), sniffer.device_info
+
+    assert_equal ({
+      type: :ios,
+      version: '15.4',
+      name: 'iOS',
+    }), sniffer.os_info
+  end
+
+  it "Shopify POS on iPad can be sniffed (React Native App)" do
+    user_agent = "com.jadedpixel.pos Shopify POS/7.0.0/iOS/15.4/Apple/iPad/production"
+    sniffer = BrowserSniffer.new(user_agent)
+
+    assert_equal ({
+      name: 'Shopify POS',
+      version: '7.0.0',
+    }), sniffer.browser_info
+
+    assert_equal ({
+      type: :tablet,
+      model: 'iPad',
+    }), sniffer.device_info
+
+    assert_equal ({
+      type: :ios,
+      version: '15.4',
+      name: 'iOS',
+    }), sniffer.os_info
+  end
+
+  it "Shopify POS on iPod Touch can be sniffed (React Native App)" do
+    user_agent = "com.jadedpixel.pos Shopify POS/7.0.0/iOS/15.4/Apple/iPod Touch/production"
+    sniffer = BrowserSniffer.new(user_agent)
+
+    assert_equal ({
+      name: 'Shopify POS',
+      version: '7.0.0',
+    }), sniffer.browser_info
+
+    assert_equal ({
+      type: :handheld,
+      model: 'iPod Touch',
+    }), sniffer.device_info
+
+    assert_equal ({
+      type: :ios,
+      version: '15.4',
+      name: 'iOS',
+    }), sniffer.os_info
+  end
+
   it "Shopify Mobile in debug mode can be parsed" do
     user_agent = "Shopify Mobile/Android/6.0.0 (debug) (Build 1 with API 25 on Unknown Android SDK built for x86)"
     sniffer = BrowserSniffer.new(user_agent)
@@ -680,33 +771,68 @@ describe "Shopify agents" do
     }), sniffer.os_info
   end
 
-  INCOMPATIBLE_USER_AGENTS = [
-    "Mozilla/5.0 (iPhone; CPU iPhone OS 12_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko)"\
-      " GSA/87.0.279142407 Mobile/15E148 Safari/605.1",
-    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko)"\
-      " Version/12.1.2 Safari/605.1.15",
-    "Mozilla/5.0 (Linux; U; Android 7.0; en-US; SM-G935F Build/NRD90M) AppleWebKit/534.30 (KHTML, like Gecko) "\
-      "Version/4.0 UCBrowser/11.3.8.976 U3/0.8.0 Mobile Safari/534.30",
-  ]
+  INCOMPATIBLE_USER_AGENTS = {
+    'missing' => nil,
+
+    # Safari on iOS 12 is broken
+    'iOS 12.0' => "Mozilla/5.0 (iPhone; CPU iPhone OS 12_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) GSA/87.0.279142407 Mobile/15E148 Safari/605.1",
+    'iOS 12.2' => "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1 Mobile/15E148 Safari/604.1",
+
+    # Safari on MacOS 14 is broken
+    'MacOS 10.14 Safari' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Safari/605.1.15",
+    'MacOS 10.14 WebKit' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/605.1.15 (KHTML, like Gecko)",
+
+    # UC Browser versions before 12.13.2 are broken
+    'UC Browser 11.3.8' => "Mozilla/5.0 (Linux; U; Android 7.0; en-US; SM-G935F Build/NRD90M) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 UCBrowser/11.3.8.976 U3/0.8.0 Mobile Safari/534.30",
+    'UC Browser 12.13.0' => "Mozilla/5.0 (Linux; U; Android 8.0.0; en-US; moto g⁶ play Build/OPP27.91-88) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/57.0.2987.108 UCBrowser/12.13.0.1207 Mobile Safari/537.36",
+
+    # Chrome and Chromium versions between 51 and 66 inclusive are broken
+    'Chrome 51' => "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
+    'Chrome 66' => "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
 
-  INCOMPATIBLE_USER_AGENTS.each do |user_agent|
-    it "user agent #{user_agent} is correctly marked as incompatible" do
+    'Chromium 51' => "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/51.0.2704.79 Chrome/51.0.2704.79 Safari/537.36",
+    'Chromium 66' => "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/66.0.3359.181 Chrome/66.0.3359.181 Safari/537.36",
+  }
+
+  INCOMPATIBLE_USER_AGENTS.each do |label, user_agent|
+    it "#{label} user agent is correctly marked as incompatible" do
       sniffer = BrowserSniffer.new(user_agent)
 
       refute sniffer.same_site_none_compatible?
     end
   end
 
-  COMPATIBLE_USER_AGENTS = [
-    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.117"\
-      " Safari/537.36",
-    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:72.0) Gecko/20100101 Firefox/72.0",
-    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.4"\
-      " Safari/605.1.15",
-  ]
+  COMPATIBLE_USER_AGENTS = {
+    'iOS 13' => "Mozilla/5.0 (iPhone; CPU iPhone OS 13_3_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.5 Mobile/15E148 Safari/604.1",
+
+    'MacOS 10.13 Safari' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/604.5.6 (KHTML, like Gecko) Version/11.0.3 Safari/604.5.6",
+
+    'MacOS 10.14 Chrome' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36",
+
+    'MacOS 10.15 Safari' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_1) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Safari/605.1.15",
+
+    'MacOS 10.15 Firefox' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:72.0) Gecko/20100101 Firefox/72.0",
+
+    'UC Browser 13.3.8' => "Mozilla/5.0 (Linux; U; Android 11; en-US; SM-A715F Build/RP1A.200720.012) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/78.0.3904.108 UCBrowser/13.3.8.1305 Mobile Safari/537.36",
+
+    'Chrome 50' => "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 Safari/537.36",
+    'Chrome 67' => "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.87 Safari/537.36",
+
+    'Chromium 50' => "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/50.0.2661.102 Chrome/50.0.2661.102 Safari/537.36",
+    'Chromium 67' => "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/67.0.3396.99 Chrome/67.0.3396.99 Safari/537.36",
+
+    # False negative: library doesn't recognise WebKit user agents that aren't Safari or Chrome
+    # (These may be e.g. Webkit nightly builds)
+    # 'MacOS 10.13 WebKit' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/605.1.15 (KHTML, like Gecko)",
+    # 'MacOS 10.15 WebKit' => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko)",
+
+    # False negative: library explicitly treats iOS 11 Safari as incompatible while reference code does not:
+    # https://www.chromium.org/updates/same-site/incompatible-clients
+    # 'iOS 11' => "Mozilla/5.0 (iPhone; CPU iPhone OS 11_4_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/11.0 Mobile/15E148 Safari/604.1",
+  }
 
-  COMPATIBLE_USER_AGENTS.each do |user_agent|
-    it "user agent #{user_agent} is correctly marked as compatible" do
+  COMPATIBLE_USER_AGENTS.each do |label, user_agent|
+    it "#{label} user agent is correctly marked as compatible" do
       sniffer = BrowserSniffer.new(user_agent)
 
       assert sniffer.same_site_none_compatible?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browser_sniffer
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,8 +60,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/probots.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -89,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Parses user agent strings and boils it all down to a few simple classifications.

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.4
-  - 2.5
-  - 2.6
-  - truffleruby-19.2.0.1 # like 2.6.2
-  - jruby
-
-before_install: gem update bundler
-script: bundle exec rake test