device_detector 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f73cba454031ad8e9b62806a487cf3fe52bc50a2
-  data.tar.gz: 677525ac1133c59eb2a7900faf31077546787e45
+  metadata.gz: 5cebfa5ab895685c658cb212632694961983b77a
+  data.tar.gz: 96f37aaa81a00446b3f74ce13dbc2983469c47a3
 SHA512:
-  metadata.gz: a196b3ad6f3da4dcf8eb447fb721fc1671870fb1fcd3fc7cf2326917896079777f4188b19ae2fe84433a050567bab5ff8917418112329021822f6490482b0f0d
-  data.tar.gz: 4f823b5ab1ce904da8202d12225c09db755d82876c06baaffb2371d838e9779440bedb67e98e03bb76be9f544942490463c95adeb04eb0210003e755165bf652
+  metadata.gz: 375d2e3f948dc4d94b03bf0a8222770da2c501af96eeebf772b59019d0f24398eca51656e7e7d47b7abb2beaf6186d96f403a273c62207a8204e4973bf758997
+  data.tar.gz: 1b9ac09cf40a683eaf5f15c7a50098b88747f3208c0efbb0a550783bd634c25b6e85a3e4513ddef98d12cc0e6ced63bb446f7fdcbff0fdd805d93f0f67c1b123

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0-p598
+  - 2.1.0
+  - 2.2.0
+  - ruby-head
+  - jruby-head
+  - rbx-2
+script:
+  bundle exec rspec

data/README.md

@@ -1,20 +1,21 @@
 # DeviceDetector
 
-This is a Ruby port of the Universal Device Detection library.
-You can find the original code here: [https://github.com/piwik/device-detector].
+![Podigee DeviceDetector Travisci Badge](https://travis-ci.org/podigee/device_detector.svg)
 
-The Universal Device Detection library will parse any User Agent and detect
-the browser, operating system, device used (desktop, tablet, mobile, tv, cars,
-console, etc.), brand and model.
+User agent parser and device detector backed by the largest, most precise and up-to-date agent and device database.
+
+DeviceDetector will parse any user agent and detect the browser, operating system, device used (desktop, tablet, mobile, tv, cars, console, etc.), brand and model.
+
+The DeviceDetector is optimized for speed of detection, by providing optimized code and in-memory caching.
+
+This project originated as a Ruby port of the Universal Device Detection library.
+You can find the original code here: https://github.com/piwik/device-detector.
 
 ## Disclaimer
 
-This port does not aspire to be a one-to-one copy from the original code, but
-rather an adaptation for the Ruby language.
+This port does not aspire to be a one-to-one copy from the original code, but rather an adaptation for the Ruby language.
 
-Still, our goal is to use the original, unchanged regex yaml files, in order to
-mutually benefit from updates and pull request to both the original and the
-ported versions.
+Still, our goal is to use the original, unchanged regex yaml files, in order to mutually benefit from updates and pull request to both the original and the ported versions.
 
 ## Installation
 
@@ -35,19 +36,19 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-user_agent = 'foo'
+user_agent = 'Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.17 Safari/537.36'
 client = DeviceDetector.new(user_agent)
 
 client.name # => 'Chrome'
 client.full_version # => '30.0.1599.69'
 
-client.os_name # => 'Mac'
-client.os_full_version # => '10_8_5'
+client.os_name # => 'Windows'
+client.os_full_version # => '8'
 
 # For many devices, you can also query the device name (usually the model name)
 # Look into regexes/devices/mobiles.yml to see what devices can be detected
 client.device_name # => 'iPhone 5'
-client.device_type # => 'smartphone'
+client.device_type # => 'smartphone' # device types can be one of `smartphone`, `tablet`, `console`, `portable media player`, `tv`, `car browser` or `camera`
 ```
 
 `DeviceDetector` will return `nil` on all attributes, if the `user_agent` is unknown.
@@ -65,10 +66,26 @@ You can tune the amount of keys that will get saved in the cache:
 ```ruby
 # You have to call this code **before** you initialize the Detector
 DeviceDetector.configure do |config|
-  config.max_cache_keys = 20_000 # if you have enough RAM, proceed with care
+  config.max_cache_keys = 20_000 # increment this if you have enough RAM, proceed with care
 end
 ```
 
+## Detectable clients, bots and devices
+
+Updated on 2015-03-17
+
+### Bots
+
+360Spider, Aboundexbot, Acoon, AddThis.com, aHrefs Bot, Alexa Crawler, Amorank Spider, Analytics SEO Crawler, archive.org bot, Ask Jeeves, Backlink-Ceck.de, BacklinkCrawler, Baidu Spider, BingBot, Blekkobot, BLEXBot Crawler, Bloglovin, Bountii Bot, Browsershots, Butterfly Robot, CareerBot, ccBot crawler, Cliqzbot, CloudFlare Always Online, CommaFeed, Dazoobot, Discobot, DotBot, Easou Spider, EMail Exractor, ExaBot, ExactSeek Crawler, Ezooms, Facebook External Hit, Feedbin, FeedBurner, Feedly, Feedspot, Fever, Genieo Web filter, Goo, Google PageSpeed Insights, Googlebot, Heritrix, HTTPMon, IIS Site Analysis, Kouio, Linkdex Bot, LinkedIn Bot, Mail.Ru Bot, Magpie-Crawler, MagpieRSS, Meanpath Bot, Mixrank Bot, MJ12 Bot, MojeekBot, NalezenCzBot, Netcraft Survey Bot, Netvibes, NewsBlur, NewsGator, NLCrawler, Omgili bot, Openindex Spider, OpenLinkProfiler, OpenWebSpider, PaperLiBot, Picsearch bot, Pingdom Bot, QuerySeekerSpider, Reddit Bot, Rogerbot, Screaming Frog SEO Spider, ScreenerBot, Semrush Bot, Sensika Bot, SEOENGBot, Seznam Bot, ShopWiki, SilverReader, SimplePie, SISTRIX Crawler, Sogou Spider, Soso Spider, Superfeedr Bot, Spinn3r, Sputnik Bot, Survey Bot, TinEye Crawler, Tiny Tiny RSS, TurnitinBot, TweetedTimes Bot, Tweetmeme Bot, Twitterbot, Uptime Robot, URLAppendBot, Visual Site Mapper Crawler, Voila Bot, W3C CSS Validator, W3C I18N Checker, W3C Link Checker, W3C Markup Validation Service, W3C MobileOK Checker, W3C Unified Validator, WeSEE:Search, WebbCrawler, Wotbox, YaCy, Yahoo! Slurp, Yandex Bot, Yeti/Naverbot, Youdao Bot, Yunyun Bot, Zookabot, ZumBot, Yottaa Site Monitor, Lycos, Inktomi Slurp, Speedy, ScoutJet, NetResearchServer, Scooter, Gigabot, Charlotte, Pompos, ichiro, PagePeeker, WebThumbnail, Willow Internet Crawler, EmailWolf, NetLyzer FastProbe, Bot, Nutch-based Bot, Generic Bot
+
+### Clients
+
+Internet Explorer, Sailfish Browser, Camino, Fennec, MicroB, Avant Browser, Amigo, Bunjalloo, Iceweasel, WebPositive, Pale Moon, CometBird, IceDragon, Flock, Kapiko, Swiftfox, Firefox, ANTGalio, Espial TV Browser, RockMelt, Fireweb Navigator, Netscape, Opera Mobile, Opera Mini, Opera Next, Opera, Rekonq, CoolNovo, Comodo Dragon, ChromePlus, Conkeror, Konqueror, Baidu Browser, Baidu Spark, Yandex Browser, Vivaldi, Midori, Mercury, Maxthon, Puffin, Iron, Epiphany, Liebao, Sogou Explorer, QQ Browser, Chrome Mobile, Chrome Mobile iOS, Chrome Frame, Chromium, Chrome, UC Browser, Tizen Browser, Palm Blazer, Palm Pre, wOSBrowser, Palm WebPro, Jasmine, Lynx, NCSA Mosaic, ABrowse, Amaya, Amiga Voyager, Amiga Aweb, Arora, Beonex, BlackBerry Browser, BrowseX, Charon, Cheshire, Dillo, Dolphin, Elinks, Firebird, Fluid, Galeon, Google Earth, HotJava, IBrowse, iCab, Sleipnir, Lunascape, IE Mobile, Kazehakase, Kindle Browser, K-meleon, Links, Openwave Mobile Browser, OmniWeb, Phoenix, Mobile Silk, MIUI Browser, Nokia Browser, Nokia OSS Browser, Nokia Ovi Browser, NetFront Life, NetFront, NetPositive, Obigo, Off By One, Oregano, Polaris, SEMC-Browser, Shiira, Snowshoe, Sunrise, WeTab Browser, Xiino, Android Browser, Mobile Safari, Safari, Akregator, Apple PubSub, FeedDemon, Feeddler RSS Reader, JetBrains Omea Reader, Liferea, NetNewsWire, NewsBlur Mobile App, NewsBlur, Newsbeuter, Pulp, ReadKit, Reeder, RSS Bandit, RSS Junkie, RSSOwl, Wget, curl, Python Requests, Python urllib, Java, Perl, Banshee, Clementine, iTunes, FlyCast, MediaMonkey, Miro, NexPlayer, Nightingale, QuickTime, Songbird, SubStream, VLC, Winamp, Windows Media Player, XBMC, Stagefright, AndroidDownloadManager, FeedR, WeChat, Sina Weibo, Outlook Express, Microsoft Outlook, Thunderbird, Airmail, Lotus Notes, Barca, Postbox, The Bat!
+
+### Devices
+
+3Q, Acer, Airness, Alcatel, Amoi, Apple, Archos, Arnova, Asus, Audiovox, Avvio, Axxion, BBK, BangOlufsen, Barnes & Noble, Becker, Beetel, BenQ, BenQ-Siemens, Bird, Blu, Bmobile, Capitel, Cat, Celkon, Cherry Mobile, CnM, Coby Kyros, Compal, ConCorde, Coolpad, Cowon, CreNova, Cricket, Crius Mea, Cube, DMM, Danew, Dbtel, Dell, Denver, Dicam, DoCoMo, Doogee, Dopod, E-Boda, Easypix, Ericsson, Ericy, Evertek, Ezio, Ezze, Fly, Gemini, Gigabyte, Gigaset, Gionee, Google, Gradiente, Grundig, HP, HTC, Haier, Hisense, Huawei, Humax, INQ, Ikea, Infinix, Inkti, Innostream, Intek, Intex, Inverto, Jiayu, Jolla, K-Touch, KDDI, KT-Tech, Karbonn, Kazam, Kindle, Konka, Kyocera, LCT, LG, Lanix, Lava, Lenco, Lenovo, Lexibook, Loewe, Logicom, MEU, Manta Multimedia, MediaTek, Medion, Memup, Metz, MicroMax, Microsoft, Mio, Mitsubishi, Mobistel, Motorola, Mpman, MyPhone, NEC, NGM, Newgen, Nexian, Nikon, Nintendo, Nokia, O2, OPPO, OUYA, Onda, Opsson, Orange, Oysters, PEAQ, Palm, Panasonic, Pantech, Philips, Polaroid, PolyPad, Positivo, Prestigio, Qilive, Qtek, Quechua, RIM, Ramos, Rikomagic, Rover, SFR, Sagem, Samsung, Sanyo, Sega, Selevision, Sendo, Sharp, Siemens, Smart, Smartfren, Softbank, Sony, Spice, Storex, Sumvision, SuperSonic, Symphony, T-Mobile, TCL, TIANYU, TVC, TechniSat, TechnoTrend, Tecno Mobile, Telefunken, Telit, Tesla, Thomson, TiPhone, Tolino, Toplux, Toshiba, Tunisie Telecom, UTStarcom, VK Mobile, Vertu, Vestel, Videocon, Videoweb, ViewSonic, Vitelcom, Voxtel, Web TV, WellcoM, Wiko, Wolder, Wonu, Woxter, Xiaomi, Yuandao, ZTE, Zonda, Zopo, bq, eTouch, i-mate, i-mobile, iBall, iBerry, iKoMo, iTel, phoneOne, teXet
+
 ## Maintainers
 
 - Mati Sojka: https://github.com/yagooar
@@ -82,8 +99,10 @@ Thanks a lot to the following contributors:
 
 ## Contributing
 
-1. Fork it ( https://github.com/podigee/device_detector/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request (compare with develop)
+1. Open an issue and explain your feature request or bug before writing any code (this can save a lot of time, both the contributor and the maintainers!)
+2. Fork the project (https://github.com/podigee/device_detector/fork)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request (compare with develop)
+7. When adding new data to the yaml files, please make sure to open a PR in the original project, as well (https://github.com/piwik/device-detector)

data/Rakefile

@@ -9,3 +9,33 @@ end
 
 task default: :spec
 
+task :detectable_names do
+  require 'device_detector'
+  bot_names = DeviceDetector::Bot.new.send(:regexes).map { |r| r['name'] }.uniq
+  bot_names.delete('$1')
+  client_names = DeviceDetector::Client.new.send(:regexes).map { |r| r['name'] }.uniq
+  client_names.delete('$1')
+  device_filepaths = DeviceDetector::Device.new.send(:filepaths)
+  device_regexes = DeviceDetector::Device.load_regexes(device_filepaths)
+  device_names = device_regexes.flat_map { |dn| dn.keys }.sort.uniq
+
+  today = Date.today.strftime
+
+  puts '## Detectable clients, bots and devices'
+  puts
+  puts "Updated on #{today}"
+  puts
+  puts '### Bots'
+  puts
+  puts bot_names.join(', ')
+  puts
+  puts '### Clients'
+  puts
+  puts client_names.join(', ')
+  puts
+  puts '### Devices'
+  puts
+  puts device_names.join(', ')
+  puts
+end
+

data/device_detector.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = DeviceDetector::VERSION
   spec.authors       = ['Mati Sójka', 'Ben Zimmer']
   spec.email         = ['yagooar@gmail.com']
-  spec.summary       = %q{Universal Device Detection}
-  spec.description   = %q{The Universal Device Detection library will parse any User Agent and detect the browser, operating system, device, brand and model.}
+  spec.summary       = %q{Precise and fast user agent parser and device detector}
+  spec.description   = %q{Precise and fast user agent parser and device detector, backed by the largest and most up-to-date agent and device database}
   spec.homepage      = 'https://github.com/podigee/device_detector'
   spec.license       = 'LGPLv3'
 

data/lib/device_detector/device.rb

@@ -15,28 +15,42 @@ class DeviceDetector
 
     private
 
+    # The order of files is relevant.
+    # portable_media_players has to come before mobiles because of devices like the iPod
+    # which would otherwise be detected as iPhones
+    # televisions.yml works best at the end
     def filenames
       [
-        'devices/mobiles.yml'
+        'devices/cameras.yml',
+        'devices/car_browsers.yml',
+        'devices/consoles.yml',
+        'devices/portable_media_players.yml',
+        'devices/mobiles.yml',
+        'devices/televisions.yml',
       ]
     end
 
-    def self.parse_regexes(regexes)
+    def self.parse_regexes(regexes, device = nil)
       regexes.map { |base, nest|
 
         if !nest.nil? && nest.key?('models')
-          parse_regexes nest['models']
+          default_device = nest['device']
+          parse_regexes(nest['models'], default_device)
         else
-          case base
-          when Hash
-            base['regex'] = Regexp.new base['regex']
-            base
-          when String
-            nest['regex'] = Regexp.new nest['regex']
-            nest
-          else
-            fail "#{filenames.join(', ')} regexes are either malformed or format has changes."
-          end
+          regex =
+            case base
+            when Hash
+              base
+            when String
+              nest
+            else
+              fail "#{filenames.join(', ')} regexes are either malformed or format has changes."
+            end
+
+          regex['device'] ||= device
+          regex['regex'] = Regexp.new(regex['regex'])
+
+          regex
         end
 
       }.flatten

data/lib/device_detector/parser.rb

@@ -37,23 +37,34 @@ class DeviceDetector
       end
     end
 
-    # This is a performance optimization.
-    # We cache the regexes on the class for better performance
-    # Thread-safety shouldn't be an issue, as we do only perform reads
-    def self.regexes_for(filepaths)
-      @regexes ||=
-        begin
-          raw_files = filepaths.map { |filepath| File.read(filepath) }.join
-          regexes = YAML.load(raw_files)
-          parse_regexes(regexes)
-        end
-    end
+    class << self
+
+      # This is a performance optimization.
+      # We cache the regexes on the class for better performance
+      # Thread-safety shouldn't be an issue, as we do only perform reads
+      def regexes_for(filepaths)
+        @regexes ||=
+          begin
+            regexes = load_regexes(filepaths)
+            parsed_regexes = regexes.map { |r| parse_regexes(r) }
+
+            parsed_regexes.flatten
+          end
+      end
 
-    def self.parse_regexes(regexes)
-      regexes.map do |meta|
-        meta['regex'] = Regexp.new(meta['regex'])
-        meta
+      def load_regexes(filepaths)
+        raw_files = filepaths.map { |path| File.read(path) }
+
+        raw_files.map { |f| YAML.load(f) }
       end
+
+      def parse_regexes(regexes)
+        regexes.map do |meta|
+          meta['regex'] = Regexp.new(meta['regex'])
+          meta
+        end
+      end
+
     end
 
   end

data/lib/device_detector/version.rb

@@ -1,3 +1,3 @@
 class DeviceDetector
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/regexes/bots.yml

@@ -977,10 +977,14 @@
 - regex: 'EmailWolf'
   name: 'EmailWolf'
 
+- regex: 'NetLyzer FastProbe'
+  name: 'NetLyzer FastProbe'
+
 
 - regex: '(nuhk|TsolCrawler|Yammybot|Openbot|Gulper Web Bot|grub-client|Download Demon|SearchExpress|Microsoft URL Control|borg|altavista|teoma|blitzbot|oegp|furlbot|http%20client|polybot|htdig|mogimogi|larbin|scrubby|searchsight|seekbot|semanticdiscovery|snappy|vortex|zao|zeal|fast-webcrawler|converacrawler|dataparksearch|findlinks|BrowserMob|HttpMonitor|ThumbShotsBot|URL2PNG|ZooShot|GomezA|Catchpoint bot|Google SketchUp|Read%20Later|Minimo|RackspaceBot)'
   name: 'Bot'
 
+
 # Generic detections
 
 - regex: 'Nutch'
@@ -991,12 +995,5 @@
     name: 'The Apache Software Foundation'
     url: 'http://www.apache.org/foundation/'
 
-# Original:
-# - regex: '[a-z0-9-_]*(bot|crawler|archiver|transcoder|spider)'
-#   name: 'Generic Bot'
-#
-# Adapted for Ruby:
-# Note the backslash added in [a-z0-9\-_], it is necessary to avoid
-# warnings from the interpreter
 - regex: '[a-z0-9\-_]*(bot|crawler|archiver|transcoder|spider)'
   name: 'Generic Bot'

data/regexes/browsers.yml

@@ -55,6 +55,15 @@
   engine:
     default: '' # multiple
 
+#Amigo
+- regex: 'Chrome/(\d+[\.\d]+).*MRCHROME'
+  name: 'Amigo'
+  version: '$1'
+  engine:
+    default: 'WebKit'
+    versions:
+      28: 'Blink'
+
 #Bunjalloo
 - regex: 'Bunjalloo(?:/(\d+[\.\d]+))?'
   name: 'Bunjalloo'
@@ -258,6 +267,13 @@
   engine:
     default: 'Blink'
 
+#Vivaldi
+- regex: 'Vivaldi(?:/(\d+[\.\d]+))?'
+  name: 'Vivaldi'
+  version: '$1'
+  engine:
+    default: 'Blink'
+
 #Midori
 - regex: 'Midori(?:/(\d+[\.\d]+))?'
   name: 'Midori'
@@ -319,6 +335,11 @@
   name: 'Sogou Explorer'
   version: '$1'
 
+# QQ Browser
+- regex: 'QQBrowser/([\.\d]+)'
+  name: 'QQ Browser'
+  version: '$1'
+
 #Chrome
 - regex: 'CrMo(?:/(\d+[\.\d]+))?'
   name: 'Chrome Mobile'
@@ -685,6 +706,11 @@
   name: 'Obigo'
   version: ''
 
+#Off By One
+- regex: 'OffByOne'
+  name: 'Off By One'
+  version: ''
+
 #Oregano
 - regex: 'Oregano(?:[ /](\d+[\.\d]+))?'
   name: 'Oregano'
@@ -719,6 +745,11 @@
   name: 'Sunrise'
   version: '$1'
 
+# WeTab Browser
+- regex: 'WeTab-Browser'
+  name: 'WeTab Browser'
+  version: ''
+
 #Xiino
 - regex: 'Xiino(?:/(\d+[\.\d]+))?'
   name: 'Xiino'
@@ -752,3 +783,4 @@
   version: '$1'
   engine:
     default: 'WebKit'
+

data/regexes/devices/cameras.yml

@@ -0,0 +1,26 @@
+###############
+# Device Detector - The Universal Device Detection library for parsing User Agents
+#
+# @link http://piwik.org
+# @license http://www.gnu.org/licenses/lgpl.html LGPL v3 or later
+###############
+
+#Nikon
+Nikon:
+  regex: 'Coolpix S800c'
+  device: 'camera'
+  model: 'Coolpix S800c'
+
+# Samsung
+Samsung:
+  regex: 'EK-GC[0-9]{3}'
+  device: 'camera'
+  models:
+    - regex: 'EK-GC100'
+      model: 'GALAXY Camera'
+    - regex: 'EK-GC110'
+      model: 'GALAXY Camera WiFi only'
+    - regex: 'EK-GC200'
+      model: 'GALAXY Camera 2'
+    - regex: 'EK-GC([0-9]{3})'
+      model: 'GALAXY Camera $1'

data/regexes/devices/car_browsers.yml

@@ -0,0 +1,13 @@
+###############
+# Device Detector - The Universal Device Detection library for parsing User Agents
+#
+# @link http://piwik.org
+# @license http://www.gnu.org/licenses/lgpl.html LGPL v3 or later
+###############
+
+# Tesla Model S
+Tesla:
+  regex: 'QtCarBrowser'
+  device: 'car browser'
+  model: 'Model S'
+

data/regexes/devices/consoles.yml

@@ -0,0 +1,41 @@
+###############
+# Device Detector - The Universal Device Detection library for parsing User Agents
+#
+# @link http://piwik.org
+# @license http://www.gnu.org/licenses/lgpl.html LGPL v3 or later
+###############
+
+Archos:
+  regex: 'Archos.*GAMEPAD([2]?)'
+  device: 'console'
+  model: 'Gamepad $1'
+
+Microsoft:
+  regex: 'Xbox'
+  device: 'console'
+  models:
+    - regex: 'Xbox One'
+      model: 'Xbox One'
+    - regex: 'Xbox'
+      model: 'Xbox 360'
+
+Nintendo:
+  regex: 'Nintendo (([3]?DS[i]?)|Wii[U]?)'
+  device: 'console'
+  model: '$1'
+
+OUYA:
+  regex: 'OUYA'
+  device: 'console'
+  model: 'OUYA'
+
+Sega:
+  regex: 'Dreamcast'
+  device: 'console'
+  model: 'Dreamcast'
+
+Sony:
+  regex: 'PlayStation (3|4|Portable|Vita)'
+  device: 'console'
+  model: 'PlayStation $1'
+