browser 1.1.0 → 2.0.0.rc1

data/lib/browser/accept_language.rb

@@ -0,0 +1,47 @@
+module Browser
+  class AcceptLanguage
+    def self.languages
+      @languages ||= YAML.load_file(Browser.root.join("languages.yml"))
+    end
+
+    def self.parse(accept_language)
+      return [] unless accept_language
+
+      accept_language
+        .split(",")
+        .map {|string| string.squeeze(" ").strip }
+        .map {|part| new(part) }
+        .sort_by(&:quality)
+        .reverse
+    end
+
+    attr_reader :part
+
+    def initialize(part)
+      @part = part
+    end
+
+    def full
+      @full ||= [code, region].compact.join("-")
+    end
+
+    def name
+      self.class.languages[full] || self.class.languages[code]
+    end
+
+    def code
+      @code ||= part[/\A([^-;]+)/, 1]
+    end
+
+    def region
+      @region ||= begin
+        region = part[/\A(?:.*?)-([^;-]+)/, 1]
+        region.upcase if region
+      end
+    end
+
+    def quality
+      @quality ||= Float(part[/;q=([\d.]+)/, 1] || 1.0)
+    end
+  end
+end

data/lib/browser/action_controller.rb

@@ -1,6 +1,6 @@
 require "action_controller/railtie"
 
-class Browser
+module Browser
   module ActionController
     extend ActiveSupport::Concern
 

data/lib/browser/base.rb

@@ -0,0 +1,159 @@
+module Browser
+  class Base
+    include DetectVersion
+
+    attr_reader :ua
+
+    # Return an array with all preferred languages that this browser accepts.
+    attr_reader :accept_language
+
+    def initialize(ua, accept_language: nil)
+      @ua = ua
+      @accept_language = AcceptLanguage.parse(accept_language)
+    end
+
+    # Return a meta info about this browser.
+    def meta
+      Meta.constants.each_with_object(Set.new) do |meta_name, meta|
+        meta_class = Meta.const_get(meta_name)
+        meta.merge(meta_class.new(self).to_a)
+      end.to_a
+    end
+
+    alias_method :to_a, :meta
+
+    # Return meta representation as string.
+    def to_s
+      meta.to_a.join(" ")
+    end
+
+    def version
+      full_version.split(".").first
+    end
+
+    # Return the platform.
+    def platform
+      @platform ||= Platform.new(ua)
+    end
+
+    # Return the bot info.
+    def bot
+      @bot ||= Bot.new(ua)
+    end
+
+    # Detect if current user agent is from a bot.
+    def bot?
+      bot.bot?
+    end
+
+    # Return the device info.
+    def device
+      @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? &&
+        detect_version?(version, expected_version)
+    end
+
+    # Detect if browser is Microsoft Edge.
+    def edge?
+      Edge.new(ua).match?
+    end
+
+    def compatibility_view?
+      false
+    end
+
+    def msie_full_version
+      "0.0"
+    end
+
+    def msie_version
+      "0"
+    end
+
+    # Detect if browser is WebKit-based.
+    def webkit?
+      ua =~ /AppleWebKit/i && !edge?
+    end
+
+    # Detect if browser is QuickTime
+    def quicktime?
+      ua =~ /QuickTime/i
+    end
+
+    # Detect if browser is Apple CoreMedia.
+    def core_media?
+      ua =~ /CoreMedia/
+    end
+
+    # Detect if browser is PhantomJS
+    def phantom_js?
+      PhantomJS.new(ua).match?
+    end
+
+    # Detect if browser is Safari.
+    def safari?(expected_version = nil)
+      Safari.new(ua).match? && detect_version?(version, expected_version)
+    end
+
+    def safari_webapp_mode?
+      (device.ipad? || device.iphone?) && ua =~ /AppleWebKit/
+    end
+
+    # Detect if browser is Firefox.
+    def firefox?
+      Firefox.new(ua).match?
+    end
+
+    # Detect if browser is Chrome.
+    def chrome?
+      Chrome.new(ua).match?
+    end
+
+    # Detect if browser is Opera.
+    def opera?
+      Opera.new(ua).match?
+    end
+
+    # Detect if browser is Yandex.
+    def yandex?
+      ua =~ /YaBrowser/
+    end
+
+    # Detect if browser is UCBrowser.
+    def uc_browser?
+      UCBrowser.new(ua).match?
+    end
+
+    # Detect if browser is Nokia S40 Ovi Browser.
+    def nokia?
+      Nokia.new(ua).match?
+    end
+
+    # Detect if browser is Opera Mini.
+    def opera_mini?
+      ua =~ /Opera Mini/
+    end
+
+    def webkit_full_version
+      ua[%r[AppleWebKit/([\d.]+)], 1] || "0.0"
+    end
+
+    def known?
+      id != :generic
+    end
+
+    # Detect if browser is a proxy browser.
+    def proxy?
+      nokia? || uc_browser? || opera_mini?
+    end
+  end
+end

data/lib/browser/blackberry.rb

@@ -0,0 +1,21 @@
+module Browser
+  class BlackBerry < Base
+    def id
+      :blackberry
+    end
+
+    def name
+      "BlackBerry"
+    end
+
+    def full_version
+      ua[%r[BlackBerry[\da-z]+/([\d.]+)], 1] ||
+        ua[%r[Version/([\d.]+)], 1] ||
+        "0.0"
+    end
+
+    def match?
+      ua =~ /BlackBerry|BB10/
+    end
+  end
+end

data/lib/browser/bot.rb

@@ -0,0 +1,63 @@
+module Browser
+  class Bot
+    def self.detect_empty_ua!
+      @detect_empty_ua = true
+    end
+
+    def self.detect_empty_ua?
+      !!@detect_empty_ua
+    end
+
+    def self.bots
+      @bots ||= YAML.load_file(Browser.root.join("bots.yml"))
+    end
+
+    def self.bot_exceptions
+      @bot_exceptions ||= YAML
+                          .load_file(Browser.root.join("bot_exceptions.yml"))
+    end
+
+    def self.search_engines
+      @search_engines ||= YAML
+                          .load_file(Browser.root.join("search_engines.yml"))
+    end
+
+    attr_reader :ua
+
+    def initialize(ua)
+      @ua = ua
+    end
+
+    def bot?
+      bot_with_empty_ua? || (!bot_exception? && detect_bot?)
+    end
+
+    def search_engine?
+      self.class.search_engines.any? {|key, _| downcased_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 == ""
+    end
+
+    def bot_exception?
+      self.class.bot_exceptions.any? {|key| downcased_ua.include?(key) }
+    end
+
+    def detect_bot?
+      self.class.bots.any? {|key, _| downcased_ua.include?(key) }
+    end
+
+    def downcased_ua
+      @downcased_ua ||= ua.downcase
+    end
+  end
+end

data/lib/browser/chrome.rb

@@ -0,0 +1,23 @@
+module Browser
+  class Chrome < Base
+    def id
+      :chrome
+    end
+
+    def name
+      "Chrome"
+    end
+
+    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]
+    end
+
+    def match?
+      ua =~ /Chrome|CriOS/ && !opera? && !edge?
+    end
+  end
+end

data/lib/browser/detect_version.rb

@@ -0,0 +1,19 @@
+module Browser
+  module DetectVersion
+    private
+
+    def detect_version?(actual_version, expected_version)
+      return true unless expected_version
+
+      expected_version = parse_version(expected_version)
+      actual_version = parse_version(actual_version)
+
+      Gem::Requirement.create(expected_version)
+        .satisfied_by?(Gem::Version.create(actual_version))
+    end
+
+    def parse_version(version)
+      version.kind_of?(Numeric) ? "#{version}" : version
+    end
+  end
+end

data/lib/browser/device.rb

@@ -0,0 +1,175 @@
+module Browser
+  class Device
+    attr_reader :ua
+
+    def initialize(ua)
+      @ua = ua
+    end
+
+    def subject
+      @subject ||= [
+        XboxOne.new(ua),
+        Xbox360.new(ua),
+        Surface.new(ua),
+        TV.new(ua),
+        BlackBerryPlaybook.new(ua),
+        WiiU.new(ua),
+        Wii.new(ua),
+        KindleFire.new(ua),
+        Kindle.new(ua),
+        PlayStation4.new(ua),
+        PlayStation3.new(ua),
+        PSVita.new(ua),
+        PSP.new(ua),
+        Iphone.new(ua),
+        Ipad.new(ua),
+        IpodTouch.new(ua),
+        Unknown.new(ua)
+      ].find(&:match?)
+    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
+    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?
+    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 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 =~ /Silk/
+    end
+
+    # Detect if browser is running under Xbox.
+    def xbox?
+      ua =~ /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?
+    end
+
+    # Detect if browser is console (currently Xbox, PlayStation, or Nintendo).
+    def console?
+      xbox? || playstation? || nintendo?
+    end
+
+    private
+
+    # Regex taken from http://detectmobilebrowsers.com
+    # rubocop:disable Metrics/LineLength
+    def detect_mobile?
+      !!(
+        psp? ||
+        /zunewp7/i.match(ua) ||
+        /(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.match(ua) ||
+        /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.match(ua[0..3])
+      )
+    end
+    # rubocop:enable Metrics/LineLength
+
+    def platform
+      @platform ||= Platform.new(ua)
+    end
+  end
+end