browser 2.5.3 → 5.3.1

data/lib/browser/accept_language.rb

@@ -14,8 +14,7 @@ module Browser
         .map {|string| string.squeeze(" ").strip }
         .map {|part| new(part) }
         .reject {|al| al.quality.zero? }
-        .sort_by(&:quality)
-        .reverse
+        .sort_by.with_index {|al, idx| [-al.quality, idx] }
     end
 
     attr_reader :part
@@ -35,14 +34,14 @@ module Browser
     def code
       @code ||= begin
         code = part[/\A([^-;]+)/, 1]
-        code.downcase if code
+        code&.downcase
       end
     end
 
     def region
       @region ||= begin
         region = part[/\A(?:.*?)-([^;-]+)/, 1]
-        region.upcase if region
+        region&.upcase
       end
     end
 
@@ -54,12 +53,10 @@ module Browser
       end
     end
 
-    private
-
-    def quality_value
+    private def quality_value
       qvalue = part[/;q=([\d.]+)/, 1]
-      qvalue = qvalue =~ /\A0\.0?\z/ ? "0.0" : qvalue
-      qvalue = qvalue.gsub(/\.+/, ".") if qvalue
+      qvalue = /\A0\.0?\z/.match?(qvalue) ? "0.0" : qvalue
+      qvalue = qvalue.squeeze(".") if qvalue
       qvalue
     end
   end

data/lib/browser/action_controller.rb

@@ -10,9 +10,7 @@ module Browser
       helper_method(:browser) if respond_to?(:helper_method)
     end
 
-    private
-
-    def browser
+    private def browser
       @browser ||= Browser.new(
         request.headers["User-Agent"],
         accept_language: request.headers["Accept-Language"]

data/lib/browser/aliases.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "browser"
+require_relative "../browser"
 require "forwardable"
 
 module Browser
@@ -15,10 +15,10 @@ module Browser
 
     DEVICE_ALIASES = %w[
       blackberry_playbook? console? ipad? iphone? ipod_touch? kindle?
-      kindle_fire? mobile? nintendo? nintendo_wii? nintendo_wiiu? playbook?
-      playstation3? playstation4? playstation? playstation_vita? ps3? ps4? psp?
-      psp_vita? silk? surface? tablet? tv? vita? wii? wiiu? xbox? xbox_360?
-      xbox_one?
+      kindle_fire? mobile? nintendo? nintendo_switch? nintendo_wii?
+      nintendo_wiiu? playbook? playstation3? playstation4? playstation?
+      playstation_vita? ps3? ps4? psp? psp_vita? silk? surface? tablet? tv?
+      vita? wii? wiiu? xbox? xbox_360? xbox_one?
     ].freeze
 
     def self.included(target)

data/lib/browser/alipay.rb

@@ -11,11 +11,11 @@ module Browser
     end
 
     def full_version
-      ua[%r[(?:AlipayClient)/([\d.]+)]i, 1] || "0.0"
+      ua[%r{(?:AlipayClient)/([\d.]+)}i, 1] || "0.0"
     end
 
     def match?
-      ua =~ /AlipayClient/i
+      ua.match?(/AlipayClient/i)
     end
   end
 end

data/lib/browser/base.rb

@@ -6,12 +6,11 @@ module Browser
 
     attr_reader :ua
 
-    # Return an array with all preferred languages that this browser accepts.
-    attr_reader :accept_language
-
     def initialize(ua, accept_language: nil)
+      validate_size(:user_agent, ua.to_s)
+
       @ua = ua
-      @accept_language = AcceptLanguage.parse(accept_language)
+      @accept_language_raw = accept_language.to_s
     end
 
     # Return a meta info about this browser.
@@ -19,6 +18,14 @@ module Browser
       Meta.get(self)
     end
 
+    # Return an array with all preferred languages that this browser accepts.
+    def accept_language
+      @accept_language ||= begin
+        validate_size(:accept_language, @accept_language_raw)
+        AcceptLanguage.parse(@accept_language_raw)
+      end
+    end
+
     alias_method :to_a, :meta
 
     # Return meta representation as string.
@@ -50,11 +57,6 @@ module Browser
       @device ||= Device.new(ua)
     end
 
-    # Return true if browser is modern (Webkit, Firefox 17+, IE9+, Opera 12+).
-    def modern?
-      Browser.modern_rules.any? {|rule| rule === self } # rubocop:disable Metrics/LineLength, Style/CaseEquality
-    end
-
     # Detect if browser is Microsoft Internet Explorer.
     def ie?(expected_version = nil)
       InternetExplorer.new(ua).match? &&
@@ -78,6 +80,18 @@ module Browser
       "0"
     end
 
+    # Detect if browser is Instagram.
+    def instagram?(expected_version = nil)
+      Instagram.new(ua).match? &&
+        detect_version?(full_version, expected_version)
+    end
+
+    # Detect if browser is Snapchat.
+    def snapchat?(expected_version = nil)
+      Snapchat.new(ua).match? &&
+        detect_version?(full_version, expected_version)
+    end
+
     # Detect if browser if Facebook.
     def facebook?(expected_version = nil)
       Facebook.new(ua).match? &&
@@ -92,19 +106,20 @@ module Browser
 
     # Detect if browser is WebKit-based.
     def webkit?(expected_version = nil)
-      ua =~ /AppleWebKit/i &&
-        !edge? &&
+      ua.match?(/AppleWebKit/i) &&
+        (!edge? || Edge.new(ua).chrome_based?) &&
         detect_version?(webkit_full_version, expected_version)
     end
 
     # Detect if browser is QuickTime
     def quicktime?(expected_version = nil)
-      ua =~ /QuickTime/i && detect_version?(full_version, expected_version)
+      ua.match?(/QuickTime/i) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Apple CoreMedia.
     def core_media?(expected_version = nil)
-      ua =~ /CoreMedia/ && detect_version?(full_version, expected_version)
+      ua.include?("CoreMedia") && detect_version?(full_version,
+                                                  expected_version)
     end
 
     # Detect if browser is PhantomJS
@@ -115,11 +130,11 @@ module Browser
 
     # Detect if browser is Safari.
     def safari?(expected_version = nil)
-      Safari.new(ua).match? && detect_version?(version, expected_version)
+      Safari.new(ua).match? && detect_version?(full_version, expected_version)
     end
 
     def safari_webapp_mode?
-      (device.ipad? || device.iphone?) && ua =~ /AppleWebKit/
+      (device.ipad? || device.iphone?) && ua.include?("AppleWebKit")
     end
 
     # Detect if browser is Firefox.
@@ -137,10 +152,16 @@ module Browser
       Opera.new(ua).match? && detect_version?(full_version, expected_version)
     end
 
+    # Detect if browser is Sputnik.
+    def sputnik?(expected_version = nil)
+      Sputnik.new(ua).match? && detect_version?(full_version, expected_version)
+    end
+
     # Detect if browser is Yandex.
     def yandex?(expected_version = nil)
-      ua =~ /YaBrowser/ && detect_version?(full_version, expected_version)
+      Yandex.new(ua).match? && detect_version?(full_version, expected_version)
     end
+    alias_method :yandex_browser?, :yandex?
 
     # Detect if browser is UCBrowser.
     def uc_browser?(expected_version = nil)
@@ -171,15 +192,65 @@ module Browser
 
     # Detect if browser is Opera Mini.
     def opera_mini?(expected_version = nil)
-      ua =~ /Opera Mini/ && detect_version?(full_version, expected_version)
+      ua.include?("Opera Mini") && detect_version?(full_version,
+                                                   expected_version)
+    end
+
+    # Detect if browser is DuckDuckGo.
+    def duck_duck_go?(expected_version = nil)
+      ua.include?("DuckDuckGo") && detect_version?(full_version,
+                                                   expected_version)
+    end
+
+    # Detect if browser is Samsung.
+    def samsung_browser?(expected_version = nil)
+      ua.include?("SamsungBrowser") && detect_version?(full_version,
+                                                       expected_version)
+    end
+
+    # Detect if browser is Huawei.
+    def huawei_browser?(expected_version = nil)
+      HuaweiBrowser.new(ua).match? &&
+        detect_version?(full_version, expected_version)
+    end
+
+    # Detect if browser is Xiaomi Miui.
+    def miui_browser?(expected_version = nil)
+      MiuiBrowser.new(ua).match? &&
+        detect_version?(full_version, expected_version)
+    end
+
+    # Detect if browser is Maxthon.
+    def maxthon?(expected_version = nil)
+      Maxthon.new(ua).match? && detect_version?(full_version, expected_version)
+    end
+
+    # Detect if browser is QQ.
+    def qq?(expected_version = nil)
+      QQ.new(ua).match? && detect_version?(full_version, expected_version)
+    end
+
+    # Detect if browser is Sougou.
+    def sougou_browser?(expected_version = nil)
+      SougouBrowser.new(ua).match? &&
+        detect_version?(full_version, expected_version)
+    end
+
+    # Detect if browser is Google Search App
+    def google_search_app?(expected_version = nil)
+      ua.include?("GSA") && detect_version?(full_version, expected_version)
     end
 
     def webkit_full_version
-      ua[%r[AppleWebKit/([\d.]+)], 1] || "0.0"
+      ua[%r{AppleWebKit/([\d.]+)}, 1] || "0.0"
     end
 
     def known?
-      id != :generic
+      !unknown?
+    end
+
+    def unknown?
+      id == :unknown_browser
     end
 
     # Detect if browser is a proxy browser.
@@ -191,5 +262,16 @@ module Browser
     def electron?(expected_version = nil)
       Electron.new(ua).match? && detect_version?(full_version, expected_version)
     end
+
+    private def validate_size(subject, input)
+      actual_bytesize = input.bytesize
+      size_limit = Browser.public_send("#{subject}_size_limit")
+
+      return if actual_bytesize < size_limit
+
+      raise Error,
+            "#{subject} cannot be larger than #{size_limit} bytes; " \
+            "actual size is #{actual_bytesize} bytes"
+    end
   end
 end

data/lib/browser/blackberry.rb

@@ -11,13 +11,13 @@ module Browser
     end
 
     def full_version
-      ua[%r[BlackBerry[\da-z]+/([\d.]+)], 1] ||
-        ua[%r[Version/([\d.]+)], 1] ||
+      ua[%r{BlackBerry[\da-z]+/([\d.]+)}, 1] ||
+        ua[%r{Version/([\d.]+)}, 1] ||
         "0.0"
     end
 
     def match?
-      ua =~ /BlackBerry|BB10/
+      ua.match?(/BlackBerry|BB10/)
     end
   end
 end

data/lib/browser/bot/empty_user_agent_matcher.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  class Bot
+    class EmptyUserAgentMatcher
+      def self.call(ua, _browser)
+        ua == ""
+      end
+    end
+  end
+end

data/lib/browser/bot/keyword_matcher.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  class Bot
+    class KeywordMatcher
+      def self.call(ua, _browser)
+        ua.match?(/crawl|fetch|search|monitoring|spider|bot/)
+      end
+    end
+  end
+end

data/lib/browser/bot/known_bots_matcher.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  class Bot
+    class KnownBotsMatcher
+      def self.call(ua, _browser)
+        Browser::Bot.bots.any? {|key, _| ua.include?(key) }
+      end
+    end
+  end
+end

data/lib/browser/bot.rb

@@ -2,64 +2,76 @@
 
 module Browser
   class Bot
-    def self.detect_empty_ua!
-      @detect_empty_ua = true
+    GENERIC_NAME = "Generic Bot"
+
+    def self.matchers
+      @matchers ||= default_matchers
+    end
+
+    def self.default_matchers
+      [
+        EmptyUserAgentMatcher,
+        KnownBotsMatcher,
+        KeywordMatcher
+      ]
     end
 
-    def self.detect_empty_ua?
-      @detect_empty_ua
+    def self.load_yaml(path)
+      YAML.load_file(Browser.root.join(path))
     end
 
     def self.bots
-      @bots ||= YAML.load_file(Browser.root.join("bots.yml"))
+      @bots ||= load_yaml("bots.yml")
     end
 
     def self.bot_exceptions
-      @bot_exceptions ||= YAML
-                          .load_file(Browser.root.join("bot_exceptions.yml"))
+      @bot_exceptions ||= load_yaml("bot_exceptions.yml")
     end
 
     def self.search_engines
-      @search_engines ||= YAML
-                          .load_file(Browser.root.join("search_engines.yml"))
+      @search_engines ||= load_yaml("search_engines.yml")
+    end
+
+    def self.why?(ua)
+      ua = ua.downcase.strip
+      browser = Browser.new(ua)
+      matchers.find {|matcher| matcher.call(ua, browser) }
     end
 
-    attr_reader :ua
+    attr_reader :ua, :browser
 
     def initialize(ua)
-      @ua = ua
+      @ua = ua.downcase.strip
+      @browser = Browser.new(@ua)
     end
 
     def bot?
-      bot_with_empty_ua? || (!bot_exception? && detect_bot?)
+      !bot_exception? && detect_bot?
+    end
+
+    def why?
+      self.class.matchers.find {|matcher| matcher.call(ua, self) }
     end
 
     def search_engine?
-      self.class.search_engines.any? {|key, _| downcased_ua.include?(key) }
+      self.class.search_engines.any? {|key, _| ua.include?(key) }
     end
 
     def name
       return unless bot?
-      return "Generic Bot" if bot_with_empty_ua?
-      self.class.bots.find {|key, _| downcased_ua.include?(key) }.last
-    end
 
-    private
-
-    def bot_with_empty_ua?
-      self.class.detect_empty_ua? && ua.strip == ""
+      self.class.bots.find {|key, _| ua.include?(key) }&.last || GENERIC_NAME
     end
 
-    def bot_exception?
-      self.class.bot_exceptions.any? {|key| downcased_ua.include?(key) }
+    private def bot_exception?
+      self.class.bot_exceptions.any? {|key| ua.include?(key) }
     end
 
-    def detect_bot?
-      self.class.bots.any? {|key, _| downcased_ua.include?(key) }
+    private def detect_bot?
+      self.class.matchers.any? {|matcher| matcher.call(ua, browser) }
     end
 
-    def downcased_ua
-      @downcased_ua ||= ua.downcase
-    end
+    private :ua
+    private :browser
   end
 end

data/lib/browser/browser.rb

@@ -4,43 +4,66 @@ require "set"
 require "yaml"
 require "pathname"
 
-require "browser/version"
-require "browser/detect_version"
-require "browser/accept_language"
-require "browser/base"
-require "browser/safari"
-require "browser/chrome"
-require "browser/internet_explorer"
-require "browser/firefox"
-require "browser/edge"
-require "browser/opera"
-require "browser/blackberry"
-require "browser/generic"
-require "browser/phantom_js"
-require "browser/uc_browser"
-require "browser/nokia"
-require "browser/micro_messenger"
-require "browser/weibo"
-require "browser/qq"
-require "browser/alipay"
-require "browser/electron"
-require "browser/facebook"
-require "browser/otter"
+require_relative "version"
+require_relative "detect_version"
+require_relative "accept_language"
+require_relative "base"
+require_relative "safari"
+require_relative "chrome"
+require_relative "internet_explorer"
+require_relative "firefox"
+require_relative "edge"
+require_relative "opera"
+require_relative "blackberry"
+require_relative "unknown"
+require_relative "phantom_js"
+require_relative "uc_browser"
+require_relative "nokia"
+require_relative "micro_messenger"
+require_relative "weibo"
+require_relative "qq"
+require_relative "alipay"
+require_relative "electron"
+require_relative "facebook"
+require_relative "otter"
+require_relative "instagram"
+require_relative "yandex"
+require_relative "sputnik"
+require_relative "snapchat"
+require_relative "duck_duck_go"
+require_relative "samsung_browser"
+require_relative "huawei_browser"
+require_relative "miui_browser"
+require_relative "maxthon"
+require_relative "sougou_browser"
+require_relative "google_search_app"
 
-require "browser/bot"
-require "browser/middleware"
+require_relative "bot"
+require_relative "bot/empty_user_agent_matcher"
+require_relative "bot/keyword_matcher"
+require_relative "bot/known_bots_matcher"
 
-require "browser/platform"
-require "browser/device"
-require "browser/meta"
+require_relative "middleware"
+require_relative "platform"
+require_relative "device"
+require_relative "meta"
 
 module Browser
-  EMPTY_STRING = "".freeze
+  EMPTY_STRING = ""
+
+  Error = Class.new(StandardError)
 
   def self.root
-    @root ||= Pathname.new(File.expand_path("../../..", __FILE__))
+    @root ||= Pathname.new(File.expand_path("../..", __dir__))
+  end
+
+  class << self
+    attr_accessor :user_agent_size_limit, :accept_language_size_limit
   end
 
+  self.user_agent_size_limit = 2048
+  self.accept_language_size_limit = 2048
+
   # Hold the list of browser matchers.
   # Order is important.
   def self.matchers
@@ -55,40 +78,28 @@ module Browser
       Firefox,
       Otter,
       Facebook,             # must be placed before Chrome and Safari
+      Instagram,            # must be placed before Chrome and Safari
+      Snapchat,             # must be placed before Chrome and Safari
       Weibo,                # must be placed before Chrome and Safari
+      MicroMessenger,       # must be placed before QQ
       QQ,                   # must be placed before Chrome and Safari
       Alipay,               # must be placed before Chrome and Safari
       Electron,             # must be placed before Chrome and Safari
+      Yandex,               # must be placed before Chrome and Safari
+      Sputnik,              # must be placed before Chrome and Safari
+      DuckDuckGo,           # must be placed before Chrome and Safari
+      SamsungBrowser,       # must be placed before Chrome and Safari
+      HuaweiBrowser,        # must be placed before Chrome and Safari
+      MiuiBrowser,          # must be placed before Chrome and Safari
+      Maxthon,              # must be placed before Chrome and Safari
+      SougouBrowser,        # must be placed before Chrome and Safari
+      GoogleSearchApp,      # must be placed before Chrome and Safari
       Chrome,
       Safari,
-      MicroMessenger,
-      Generic
+      Unknown
     ]
   end
 
-  # Define the rules which define a modern browser.
-  # A rule must be a proc/lambda or any object that implements the method
-  # === and accepts the browser object.
-  #
-  # To redefine all rules, clear the existing rules before adding your own.
-  #
-  #   # Only Chrome Canary is considered modern.
-  #   Browser.modern_rules.clear
-  #   Browser.modern_rules << -> b { b.chrome? && b.version >= "37" }
-  #
-  def self.modern_rules
-    @modern_rules ||= []
-  end
-
-  modern_rules.tap do |rules|
-    rules << ->(b) { b.webkit? }
-    rules << ->(b) { b.firefox? && b.version.to_i >= 17 }
-    rules << ->(b) { b.ie? && b.version.to_i >= 9 && !b.compatibility_view? }
-    rules << ->(b) { b.edge? && !b.compatibility_view? }
-    rules << ->(b) { b.opera? && b.version.to_i >= 12 }
-    rules << ->(b) { b.firefox? && b.device.tablet? && b.platform.android? && b.version.to_i >= 14 } # rubocop:disable Metrics/LineLength
-  end
-
   def self.new(user_agent, **kwargs)
     matchers
       .map {|klass| klass.new(user_agent || EMPTY_STRING, **kwargs) }

data/lib/browser/chrome.rb

@@ -12,15 +12,28 @@ module Browser
 
     def full_version
       # Each regex on its own line to enforce precedence.
-      ua[%r[Chrome/([\d.]+)], 1] ||
-        ua[%r[CriOS/([\d.]+)], 1] ||
-        ua[%r[Safari/([\d.]+)], 1] ||
-        ua[%r[AppleWebKit/([\d.]+)], 1] ||
+      ua[%r{Chrome/([\d.]+)}, 1] ||
+        ua[%r{CriOS/([\d.]+)}, 1] ||
+        ua[%r{Safari/([\d.]+)}, 1] ||
+        ua[%r{AppleWebKit/([\d.]+)}, 1] ||
         "0.0"
     end
 
     def match?
-      ua =~ /Chrome|CriOS/ && !opera? && !edge?
+      ua.match?(/Chrome|CriOS/) &&
+        !ua.match?(/PhantomJS|FxiOS|ArchiveBot/) &&
+        !opera? &&
+        !edge? &&
+        !duck_duck_go? &&
+        !yandex? &&
+        !sputnik? &&
+        !samsung_browser? &&
+        !huawei_browser? &&
+        !miui_browser? &&
+        !maxthon? &&
+        !qq? &&
+        !sougou_browser? &&
+        !google_search_app?
     end
   end
 end

data/lib/browser/detect_version.rb

@@ -2,9 +2,7 @@
 
 module Browser
   module DetectVersion
-    private
-
-    def detect_version?(actual_version, expected_version)
+    private def detect_version?(actual_version, expected_version)
       return true unless expected_version
       return false if expected_version && !actual_version
 
@@ -13,10 +11,12 @@ module Browser
 
       Gem::Requirement.create(expected_version)
                       .satisfied_by?(Gem::Version.create(actual_version))
+    rescue ArgumentError
+      false
     end
 
-    def parse_version(version)
-      version.kind_of?(Numeric) ? version.to_s : version
+    private def parse_version(version)
+      version.is_a?(Numeric) ? version.to_s : version
     end
   end
 end