agentry 3.0.0

data/lib/browser/platform.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require_relative "platform/base"
+require_relative "platform/ios"
+require_relative "platform/linux"
+require_relative "platform/windows"
+require_relative "platform/mac"
+require_relative "platform/windows_phone"
+require_relative "platform/windows_mobile"
+require_relative "platform/firefox_os"
+require_relative "platform/blackberry"
+require_relative "platform/android"
+require_relative "platform/unknown"
+require_relative "platform/chrome_os"
+require_relative "platform/adobe_air"
+require_relative "platform/kai_os"
+
+module Browser
+  class Platform
+    include DetectVersion
+
+    attr_reader :ua
+
+    # Hold the list of platform matchers.
+    # Order is important.
+    def self.matchers
+      @matchers ||= [
+        AdobeAir,
+        ChromeOS,
+        WindowsMobile,
+        WindowsPhone,
+        Android,
+        BlackBerry,
+        IOS,
+        Mac,
+        KaiOS,
+        FirefoxOS,
+        Windows,
+        Linux,
+        Unknown
+      ]
+    end
+
+    def initialize(ua, client_hints: nil)
+      @ua = ua
+      @client_hints = client_hints
+    end
+
+    # This platform, or one built with the client hints when they tell more
+    # than the user agent: the cached platform of a user agent ignores them.
+    def with_client_hints(client_hints)
+      hinted_class = client_hints.platform_class
+      return self unless hinted_class
+      return self if subject.instance_of?(hinted_class) && client_hints.platform_version.nil?
+
+      self.class.new(ua, client_hints:)
+    end
+
+    def subject
+      @subject ||= @client_hints&.platform_class&.new(ua, self) || detect_subject
+    end
+
+    def adobe_air?(expected_version = nil)
+      id == :adobe_air && detect_version?(version, expected_version)
+    end
+
+    def chrome_os?(expected_version = nil)
+      id == :chrome_os && detect_version?(version, expected_version)
+    end
+
+    def android?(expected_version = nil)
+      id == :android && detect_version?(version, expected_version)
+    end
+
+    def unknown?
+      id == :unknown_platform
+    end
+
+    def linux?
+      id == :linux
+    end
+
+    def mac?(expected_version = nil)
+      id == :mac && detect_version?(version, expected_version)
+    end
+
+    def windows?(expected_version = nil)
+      id == :windows && detect_version?(version, expected_version)
+    end
+
+    def firefox_os?
+      id == :firefox_os
+    end
+
+    def kai_os?
+      id == :kai_os
+    end
+
+    def ios?(expected_version = nil)
+      id == :ios && detect_version?(version, expected_version)
+    end
+
+    def blackberry?(expected_version = nil)
+      id == :blackberry && detect_version?(version, expected_version)
+    end
+
+    def windows_phone?(expected_version = nil)
+      id == :windows_phone && detect_version?(version, expected_version)
+    end
+
+    def windows_mobile?(expected_version = nil)
+      id == :windows_mobile && detect_version?(version, expected_version)
+    end
+
+    def id
+      subject.id
+    end
+
+    def version
+      @version ||= hinted_version || subject.version
+    end
+
+    def name
+      subject.name
+    end
+
+    def to_s
+      id.to_s
+    end
+
+    def ==(other)
+      id == other
+    end
+
+    # Detect if running on iOS app webview.
+    def ios_app?
+      ios? && !ua.include?("Safari")
+    end
+
+    # Detect if is iOS webview.
+    def ios_webview?
+      ios_app?
+    end
+
+    # Detect if in an Android app webview (Lollipop and newer)
+    # https://developer.chrome.com/multidevice/user-agent#webview_user_agent
+    def android_app?
+      android? && ua.match?(/\bwv\b/)
+    end
+    alias_method :android_webview?, :android_app?
+
+    # http://msdn.microsoft.com/fr-FR/library/ms537503.aspx#PltToken
+    def windows_xp?
+      windows? && ua.match?(/Windows NT 5\.[12]/)
+    end
+
+    def windows_vista?
+      windows? && ua.include?("Windows NT 6.0")
+    end
+
+    def windows7?
+      windows? && ua.include?("Windows NT 6.1")
+    end
+
+    def windows8?
+      windows? && ua.match?(/Windows NT 6\.[2-3]/)
+    end
+
+    def windows8_1?
+      windows? && ua.include?("Windows NT 6.3")
+    end
+
+    def windows10?
+      windows? && ua.include?("Windows NT 10") && !windows11?
+    end
+
+    # Only the client hints tell Windows 11 apart (ClientHints#windows11?).
+    def windows11?
+      windows? && version == "11"
+    end
+
+    def windows_rt?
+      windows8? && ua.include?("ARM")
+    end
+
+    # Detect if current platform is Windows in 64-bit architecture.
+    def windows_x64?
+      windows? && ua.match?(/(Win64|x64|Windows NT 5\.2)/)
+    end
+
+    def windows_wow64?
+      windows? && ua.match?(/WOW64/i)
+    end
+
+    def windows_x64_inclusive?
+      windows_x64? || windows_wow64?
+    end
+
+    def windows_touchscreen_desktop?
+      windows? && ua.include?("Touch")
+    end
+
+    private def detect_subject
+      self.class.matchers.each do |matcher|
+        candidate = matcher.new(ua, self)
+        break candidate if candidate.match?
+      end
+    end
+
+    private def hinted_version
+      return unless @client_hints&.platform_class
+      return @client_hints.platform_version unless id == :windows
+
+      "11" if @client_hints.windows11?
+    end
+
+    private :subject
+    private :ua
+  end
+end

data/lib/browser/qq.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Browser
+  class QQ < Base
+    def id
+      :qq
+    end
+
+    def name
+      "QQ Browser"
+    end
+
+    def full_version
+      ua[%r{(?:Mobile MQQBrowser)/([\d.]+)}i, 1] ||
+        ua[%r{(?:QQBrowserLite)/([\d.]+)}i, 1] ||
+        ua[%r{(?:QQBrowser)/([\d.]+)}i, 1] ||
+        ua[%r{(?:QQ)/([\d.]+)}i, 1] ||
+        "0.0"
+    end
+
+    def match?
+      ua.match?(%r{QQ/|QQBrowser}i)
+    end
+  end
+end

data/lib/browser/rails.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails"
+require_relative "action_controller"
+require_relative "middleware/context/additions"
+
+module Browser
+  class Railtie < Rails::Railtie
+    config.browser = ActiveSupport::OrderedOptions.new
+    config.eager_load_namespaces << Browser
+
+    initializer "browser" do
+      ActiveSupport.on_load(:action_controller) do
+        ::ActionController::Base.include(Browser::ActionController)
+
+        ::ActionController::Metal.include(Browser::ActionController) if defined?(::ActionController::Metal) # rubocop:disable Layout/LineLength
+
+        Browser::Middleware::Context.include(
+          Browser::Middleware::Context::Additions
+        )
+      end
+    end
+  end
+end

data/lib/browser/safari.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Browser
+  class Safari < Base
+    def id
+      :safari
+    end
+
+    def name
+      "Safari"
+    end
+
+    def full_version
+      ua[%r{Version/([\d.]+)}, 1] ||
+        ua[%r{Safari/([\d.]+)}, 1] ||
+        ua[%r{AppleWebKit/([\d.]+)}, 1] ||
+        "0.0"
+    end
+
+    def match?
+      ua.include?("Safari") &&
+        !platform.linux? &&
+        !ua.match?(/PhantomJS|FxiOS/) &&
+        !edge? &&
+        !chrome? &&
+        !opera? &&
+        !samsung_browser? &&
+        !huawei_browser? &&
+        !miui_browser? &&
+        !duck_duck_go? &&
+        !yandex? &&
+        !sputnik? &&
+        !maxthon? &&
+        !qq? &&
+        !alipay? &&
+        !sougou_browser? &&
+        !google_search_app?
+    end
+  end
+end

data/lib/browser/samsung_browser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Browser
+  class SamsungBrowser < Chrome
+    def id
+      :samsung_browser
+    end
+
+    def name
+      "Samsung Browser"
+    end
+
+    def full_version
+      ua[%r{SamsungBrowser/([\d.]+)}, 1] || super
+    end
+
+    def match?
+      ua.include?("SamsungBrowser")
+    end
+  end
+end

data/lib/browser/snapchat.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Browser
+  class Snapchat < Base
+    def id
+      :snapchat
+    end
+
+    def name
+      "Snapchat"
+    end
+
+    def full_version
+      ua[%r{Snapchat( ?|/)([\d.]+)}, 2] || "0.0"
+    end
+
+    def match?
+      ua.include?("Snapchat")
+    end
+  end
+end

data/lib/browser/sougou_browser.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Browser
+  class SougouBrowser < Base
+    def id
+      :sougou_browser
+    end
+
+    def name
+      "Sougou Browser"
+    end
+
+    # We can't get the real version on desktop device from the ua string
+    def full_version
+      ua[%r{(?:SogouMobileBrowser)/([\d.]+)}, 1] || "0.0"
+    end
+
+    # SogouMobileBrowser for mobile device
+    # SE for desktop device
+    def match?
+      ua.match?(/SogouMobileBrowser/i) || ua.match?(/\bSE\b/)
+    end
+  end
+end

data/lib/browser/sputnik.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Browser
+  class Sputnik < Base
+    def id
+      :sputnik
+    end
+
+    def name
+      "Sputnik"
+    end
+
+    def full_version
+      ua[%r{SputnikBrowser/([\d.]+)}, 1] || "0.0"
+    end
+
+    def match?
+      ua.include?("SputnikBrowser")
+    end
+  end
+end

data/lib/browser/testing.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Browser
+  def self.user_agents
+    @user_agents ||= browser_user_agents
+      .merge(bot_user_agents)
+      .merge(search_engine_user_agents)
+  end
+
+  def self.browser_user_agents
+    @browser_user_agents ||= YAML.load_file(Browser.root.join("test/ua.yml"))
+  end
+
+  def self.bot_user_agents
+    @bot_user_agents ||= YAML.load_file(Browser.root.join("test/ua_bots.yml"))
+  end
+
+  def self.search_engine_user_agents
+    @search_engine_user_agents ||= YAML.load_file(
+      Browser.root.join("test/ua_search_engines.yml")
+    )
+  end
+
+  def self.[](key)
+    user_agents.fetch(key)
+  end
+end

data/lib/browser/uc_browser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Browser
+  class UCBrowser < Base
+    def id
+      :uc_browser
+    end
+
+    def name
+      "UCBrowser"
+    end
+
+    def full_version
+      ua[%r{UCBrowser/([\d.]+)}, 1] || "0.0"
+    end
+
+    def match?
+      ua.include?("UCBrowser")
+    end
+  end
+end

data/lib/browser/unknown.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Browser
+  class Unknown < Base
+    NAMES = {
+      "QuickTime" => "QuickTime",
+      "CoreMedia" => "Apple CoreMedia"
+    }.freeze
+
+    def id
+      :unknown_browser
+    end
+
+    def name
+      infer_name || "Unknown Browser"
+    end
+
+    def full_version
+      ua[%r{(?:QuickTime)/([\d.]+)}, 1] ||
+        ua[/CoreMedia v([\d.]+)/, 1] ||
+        "0.0"
+    end
+
+    def match?
+      true
+    end
+
+    private def infer_name
+      NAMES.find { |key, _| ua.include?(key) }&.last
+    end
+  end
+end

data/lib/browser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Browser
+  VERSION = "3.0.0"
+end

data/lib/browser/weibo.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Browser
+  class Weibo < Base
+    def id
+      :weibo
+    end
+
+    def name
+      "Weibo"
+    end
+
+    def full_version
+      ua[/(?:__weibo__)([\d.]+)/i, 1] || "0.0"
+    end
+
+    def match?
+      ua.match?(/__weibo__/i)
+    end
+  end
+end

data/lib/browser/yandex.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Browser
+  class Yandex < Base
+    def id
+      :yandex
+    end
+
+    def name
+      "Yandex"
+    end
+
+    def full_version
+      ua[%r{YaBrowser/([\d.]+)}, 1] || "0.0"
+    end
+
+    def match?
+      ua.include?("YaBrowser")
+    end
+  end
+end

data/lib/browser.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "browser/browser"
+require_relative "browser/rails" if defined?(Rails)