agentry 3.0.0

data/lib/browser/device.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+require_relative "device/base"
+require_relative "device/android"
+require_relative "device/unknown"
+require_relative "device/ipad"
+require_relative "device/ipod_touch"
+require_relative "device/iphone"
+require_relative "device/playstation3"
+require_relative "device/playstation4"
+require_relative "device/psp"
+require_relative "device/psvita"
+require_relative "device/kindle"
+require_relative "device/kindle_fire"
+require_relative "device/wii"
+require_relative "device/wiiu"
+require_relative "device/blackberry_playbook"
+require_relative "device/surface"
+require_relative "device/switch"
+require_relative "device/tv"
+require_relative "device/xbox_one"
+require_relative "device/xbox_360"
+require_relative "device/samsung"
+
+module Browser
+  class Device
+    attr_reader :ua
+
+    # Hold the list of device matchers.
+    # Order is important.
+    def self.matchers
+      @matchers ||= [
+        Samsung,
+        XboxOne,
+        Xbox360,
+        Surface,
+        TV,
+        BlackBerryPlaybook,
+        WiiU,
+        Wii,
+        Switch,
+        KindleFire,
+        Kindle,
+        PlayStation4,
+        PlayStation3,
+        PSVita,
+        PSP,
+        Ipad,
+        Iphone,
+        IpodTouch,
+        Android,
+        Unknown
+      ]
+    end
+
+    def initialize(ua, platform: nil, client_hints: nil)
+      @ua = ua
+      @platform = platform
+      @client_hints = client_hints
+    end
+
+    # This device, or one built with the client hints when Sec-CH-UA-Mobile or
+    # the platform they gave change its answers.
+    def with_client_hints(client_hints, platform:)
+      mobile = client_hints.mobile?
+      return self if platform.equal?(self.platform) && (mobile.nil? || mobile == detect_mobile?)
+
+      self.class.new(ua, platform:, client_hints:)
+    end
+
+    def subject
+      @subject ||= self.class.matchers.each do |matcher|
+        candidate = matcher.new(ua)
+        break candidate if candidate.match?
+      end
+    end
+
+    def id
+      subject.id
+    end
+
+    def name
+      subject.name
+    end
+
+    # Detect if browser is tablet (currently iPad, Android, Surface or
+    # Playbook).
+    def tablet?
+      ipad? ||
+        (platform.android? && !detect_mobile?) ||
+        surface? ||
+        playbook?
+    end
+
+    # Detect if browser is mobile.
+    def mobile?
+      detect_mobile? && !tablet?
+    end
+
+    def ipad?
+      id == :ipad
+    end
+
+    def unknown?
+      id == :unknown_device
+    end
+
+    def ipod_touch?
+      id == :ipod_touch
+    end
+    alias_method :ipod?, :ipod_touch?
+
+    def iphone?
+      id == :iphone
+    end
+
+    def ps3?
+      id == :ps3
+    end
+    alias_method :playstation3?, :ps3?
+
+    def ps4?
+      id == :ps4
+    end
+    alias_method :playstation4?, :ps4?
+
+    def psp?
+      id == :psp
+    end
+
+    def playstation_vita?
+      id == :psvita
+    end
+    alias_method :vita?, :playstation_vita?
+    alias_method :psp_vita?, :playstation_vita?
+
+    def kindle?
+      id == :kindle || kindle_fire?
+    end
+
+    def kindle_fire?
+      id == :kindle_fire
+    end
+
+    def nintendo_wii?
+      id == :wii
+    end
+    alias_method :wii?, :nintendo_wii?
+
+    def nintendo_wiiu?
+      id == :wiiu
+    end
+    alias_method :wiiu?, :nintendo_wiiu?
+
+    def nintendo_switch?
+      id == :switch
+    end
+    alias_method :switch?, :nintendo_switch?
+
+    def blackberry_playbook?
+      id == :playbook
+    end
+    alias_method :playbook?, :blackberry_playbook?
+
+    def surface?
+      id == :surface
+    end
+
+    def tv?
+      id == :tv
+    end
+
+    # Detect if browser is Silk.
+    def silk?
+      ua.include?("Silk")
+    end
+
+    # Detect if browser is running under Xbox.
+    def xbox?
+      ua.include?("Xbox")
+    end
+
+    # Detect if browser is running under Xbox 360.
+    def xbox_360?
+      id == :xbox_360
+    end
+
+    # Detect if browser is running under Xbox One.
+    def xbox_one?
+      id == :xbox_one
+    end
+
+    # Detect if browser is running under PlayStation.
+    def playstation?
+      ps3? || ps4?
+    end
+
+    # Detect if browser is Nintendo.
+    def nintendo?
+      wii? || wiiu? || switch?
+    end
+
+    # Detect if browser is console (currently Xbox, PlayStation, or Nintendo).
+    def console?
+      xbox? || playstation? || nintendo?
+    end
+
+    # Detect if device is a Samsung.
+    def samsung?
+      id == :samsung
+    end
+
+    # Regex taken from http://detectmobilebrowsers.com
+    MOBILE_REGEX = %r{(android|bb\d+|meego).+mobile|avantgo|bada/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino}i
+    MOBILE_PREFIX_REGEX = %r{1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw-(n|u)|c55/|capi|ccwa|cdm-|cell|chtm|cldc|cmd-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc-s|devi|dica|dmob|do(c|p)o|ds(12|-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(-|_)|g1 u|g560|gene|gf-5|g-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd-(m|p|t)|hei-|hi(pt|ta)|hp( i|ip)|hs-c|ht(c(-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i-(20|go|ma)|i230|iac( |-|/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |/)|klon|kpt |kwc-|kyo(c|k)|le(no|xi)|lg( g|/(k|l|u)|50|54|-[a-w])|libw|lynx|m1-w|m3ga|m50/|ma(te|ui|xo)|mc(01|21|ca)|m-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|-([1-8]|c))|phil|pire|pl(ay|uc)|pn-2|po(ck|rt|se)|prox|psio|pt-g|qa-a|qc(07|12|21|32|60|-[2-7]|i-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55/|sa(ge|ma|mm|ms|ny|va)|sc(01|h-|oo|p-)|sdk/|se(c(-|0|1)|47|mc|nd|ri)|sgh-|shar|sie(-|m)|sk-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h-|v-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl-|tdg-|tel(i|m)|tim-|t-mo|to(pl|sh)|ts(70|m-|m3|m5)|tx-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas-|your|zeto|zte-}i
+    # Both are lowercase: on an ASCII user agent, matching its downcased copy
+    # without /i gives the same answer several times faster. Every prefix is 4
+    # characters long, so anchoring it tests the first 4 without copying them.
+    MOBILE_LOWERCASE_REGEX = Regexp.new(MOBILE_REGEX.source)
+    MOBILE_PREFIX_LOWERCASE_REGEX = Regexp.new("\\A(?:#{MOBILE_PREFIX_REGEX.source})")
+    private_constant :MOBILE_REGEX, :MOBILE_PREFIX_REGEX, :MOBILE_LOWERCASE_REGEX,
+      :MOBILE_PREFIX_LOWERCASE_REGEX
+
+    private def detect_mobile?
+      return @detect_mobile if defined?(@detect_mobile)
+
+      mobile = @client_hints&.mobile?
+      @detect_mobile = mobile.nil? ? psp? || /zunewp7|crios/i.match?(ua) || mobile_user_agent? : mobile
+    end
+
+    private def mobile_user_agent?
+      return MOBILE_REGEX.match?(ua) || MOBILE_PREFIX_REGEX.match?(ua[0..3]) unless ua.ascii_only?
+
+      lowercase_ua = ua.downcase
+      MOBILE_LOWERCASE_REGEX.match?(lowercase_ua) ||
+        MOBILE_PREFIX_LOWERCASE_REGEX.match?(lowercase_ua)
+    end
+
+    private def platform
+      @platform ||= Platform.new(ua)
+    end
+
+    private :subject
+    private :ua
+  end
+end

data/lib/browser/duck_duck_go.rb

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

data/lib/browser/edge.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Browser
+  class Edge < InternetExplorer
+    def id
+      :edge
+    end
+
+    def name
+      "Microsoft Edge"
+    end
+
+    def full_version
+      ua[%r{(?:Edge|Edg|EdgiOS|EdgA)/([\d.]+)}, 1] || super
+    end
+
+    def match?
+      ua.match?(%r{((?:Edge|Edg|EdgiOS|EdgA)/[\d.]+|Trident/8)})
+    end
+
+    def chromium_based?
+      match? && ua.match?(/\bEdg\b/)
+    end
+  end
+end

data/lib/browser/electron.rb

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

data/lib/browser/epiphany.rb

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

data/lib/browser/facebook.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Browser
+  class Facebook < Base
+    def id
+      :facebook
+    end
+
+    def name
+      "Facebook"
+    end
+
+    def full_version
+      ua[%r{FBAV/([\d.]+)}, 1] ||
+        ua[%r{AppleWebKit/([\d.]+)}, 0] ||
+        "0.0"
+    end
+
+    def match?
+      ua.match?(/FBAV|FBAN/)
+    end
+  end
+end

data/lib/browser/firefox.rb

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

data/lib/browser/google_search_app.rb

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

data/lib/browser/huawei_browser.rb

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

data/lib/browser/instagram.rb

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

data/lib/browser/internet_explorer.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Browser
+  class InternetExplorer < Base
+    # https://msdn.microsoft.com/en-us/library/ms537503(v=vs.85).aspx#TriToken
+    TRIDENT_MAPPING = {
+      "4.0" => "8",
+      "5.0" => "9",
+      "6.0" => "10",
+      "7.0" => "11",
+      "8.0" => "12"
+    }.freeze
+
+    def id
+      :ie
+    end
+
+    def name
+      "Internet Explorer"
+    end
+
+    def full_version
+      "#{ie_version}.0"
+    end
+
+    def msie_full_version
+      case ua.match(%r{MSIE ([\d.]+)|Trident/.*?; rv:([\d.]+)})
+      in [msie, trident_rv] then msie || trident_rv
+      else "0.0"
+      end
+    end
+
+    def msie_version
+      msie_full_version.split(".").first
+    end
+
+    def match?
+      msie? || modern_ie?
+    end
+
+    # Detect if IE is running in compatibility mode.
+    def compatibility_view?
+      trident_version && msie_version.to_i < (trident_version.to_i + 4)
+    end
+
+    private def ie_version
+      TRIDENT_MAPPING[trident_version] || msie_version
+    end
+
+    # Return the trident version.
+    private def trident_version
+      ua[%r{Trident/([0-9.]+)}, 1]
+    end
+
+    private def msie?
+      ua.include?("MSIE") && !ua.include?("Opera")
+    end
+
+    private def modern_ie?
+      ua.match?(%r{Trident/.*?; rv:(.*?)})
+    end
+  end
+end

data/lib/browser/maxthon.rb

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

data/lib/browser/meta/base.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    def self.rules
+      @rules ||= [
+        Device,
+        GenericBrowser,
+        Id,
+        IE,
+        IOS,
+        Mobile,
+        Platform,
+        Proxy,
+        Safari,
+        Tablet,
+        Webkit
+      ]
+    end
+
+    def self.get(browser)
+      rules.flat_map { |rule| rule.new(browser).to_a }.uniq
+    end
+
+    class Base
+      # Set the browser instance.
+      attr_reader :browser
+
+      def initialize(browser)
+        @browser = browser
+      end
+
+      def meta
+        nil
+      end
+
+      def to_a
+        meta.to_s.squeeze(" ").split
+      end
+    end
+  end
+end

data/lib/browser/meta/device.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    class Device < Base
+      def meta
+        browser.device.id
+      end
+    end
+  end
+end

data/lib/browser/meta/generic_browser.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    class GenericBrowser < Base
+      def meta
+        "#{browser.id} #{browser.id}#{browser.version}" if generic?
+      end
+
+      private def generic?
+        !browser.safari? && !browser.chrome?
+      end
+    end
+  end
+end

data/lib/browser/meta/id.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    class Id < Base
+      def meta
+        browser.id
+      end
+    end
+  end
+end

data/lib/browser/meta/ie.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    class IE < Base
+      def version
+        @version ||= browser.version.to_i
+      end
+
+      def meta
+        return unless browser.ie?
+
+        meta = []
+        meta << "oldie lt-ie8 lt-ie9" if version < 8
+        meta << "lt-ie9" if version == 8
+        meta.join(" ")
+      end
+    end
+  end
+end

data/lib/browser/meta/ios.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    class IOS < Base
+      def meta
+        "ios" if browser.platform.ios?
+      end
+    end
+  end
+end

data/lib/browser/meta/mobile.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    class Mobile < Base
+      def meta
+        "mobile" if browser.device.mobile?
+      end
+    end
+  end
+end

data/lib/browser/meta/platform.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    class Platform < Base
+      def meta
+        browser.platform.id
+      end
+    end
+  end
+end

data/lib/browser/meta/proxy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Browser
+  module Meta
+    class Proxy < Base
+      def meta
+        "proxy" if browser.proxy?
+      end
+    end
+  end
+end