Tag v0.2.1

package.json

@@ -0,0 +1,40 @@
+{
+  "title"       : "UA-Parser.js",
+  "name"        : "ua-parser-js",
+  "version"     : "0.2.1",
+  "author"      : {
+      "name"      : "Faisal Salman",
+      "email"     : "fyzlman@gmail.com",
+      "url"       : "http://faisalman.com"
+  },
+  "description" : "Lightweight JavaScript-based user-agent parser",
+  "keywords"    : [
+    "user-agent",
+    "parser",
+    "browser"
+  ],
+  "homepage"    : "http://faisalman.github.com/ua-parser-js",
+  "contributors": [
+    {
+      "name"    : "Faisal Salman",
+      "email"   : "fyzlman@gmail.com"
+    }
+  ],
+  "main"        : "ua-parser.js",
+  "repositories": [
+    {
+      "type"    : "git",
+      "url"     : "https://github.com/faisalman/ua-parser-js.git"
+    }
+  ],
+  "licenses"    : [
+    {
+      "type"    : "GPLv2",
+      "url"     : "http://www.gnu.org/licenses/gpl-2.0.html" 
+    },
+    {
+      "type"    : "MIT",
+      "url"     : "http://www.opensource.org/licenses/mit-license.php" 
+    }
+  ]
+}

readme.md

@@ -1,33 +1,63 @@
-# Sniff-js
+# UA-Parser.js
 
-Small script to extract detailed system data based on user-agent string
+JavaScript-based user-agent parser
 
-* Author	: Faisalman <<fyzlman@gmail.com>>
-* Source	: http://github.com/faisalman/sniff-js
-* License	: GPL2
+* Author    : Faisalman <<fyzlman@gmail.com>>
+* Home      : http://faisalman.github.com/ua-parser-js
+* Source    : https://github.com/faisalman/ua-parser-js
+* License   : GPLv2
 
 ## Features
 
 Get detailed type and version of web browser, layout engine, and operating system.
 
+## Methods
+
+* `getBrowser([uastring])`
+* `getDevice([uastring])`
+* `getEngine([uastring])`
+* `getOS([uastring])`
+* `setUA(uastring)`
+
 ## Example
 
 ```html
-<script type="text/javascript" src="sniff.js"></script>
+<script type="text/javascript" src="ua-parser.js"></script>
 <script type="text/javascript">
-```
-```js
-var s = new sniff();
-var browser = s.getBrowser();
-console.log(browser); // will print object contains current browser info
 
-// testing custom user-agent string
-s.ua = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2";
-browser = s.getBrowser();
-console.log(browser.name); // will print "Chromium"
-console.log(s.getOS()); // will print object {name: "Ubuntu", version: "11.10"}
-```
-```html
+    var p = new UAParser();     // if no string given as parameter, by default it takes ua string from current browser's window.navigator
+    
+    console.log(p.result);
+    /*
+        /// this will print an object structured like this:
+        {
+            browser: {
+                name: "",
+                version: "",
+                major: ""
+            },
+            device: {
+                name: "",
+                version: ""
+            },
+            engine: {
+                name: "",
+                version: ""
+            },
+            os: {
+                name: "",
+                version: ""
+            }
+        }
+    */
+
+    // let's test a custom user-agent string as an example
+    p.setUA("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2");
+    
+    console.log(p.result.browser);  // {name: "Chromium", major: "15", version: "15.0.874.106"}
+    console.log(p.result.engine);   // {name: "AppleWebKit", version: "535.2"}
+    console.log(p.result.os);       // {name: "Ubuntu", version: "11.10"}
+    
 </script>
 ```
 

src/sniff.js

@@ -1,159 +0,0 @@
-/**
- * Sniff-js v0.1
- * Small script to extract detailed system data based on user-agent string
- * http://github.com/faisalman/sniff-js
- *
- * Copyright © 2012 Faisalman <fyzlman@gmail.com>
- * Licensed under GPL2 http://www.gnu.org/licenses/gpl-2.0.html
- */
-
-function sniff(){
-
-    // regexp mapper
-    var regxMap = function(ua){
-        var i, j;
-        for(j = 1; j < arguments.length; j += 2){
-            var rx  = arguments[j],
-                asc = arguments[j+1],
-                k, l, m, n, o, p;                     
-            for(l = 0; l < rx.length; l++){                            
-                m = rx[l].exec(ua);
-                //console.log(m);                      
-                if(!!m){
-                    k = {};
-                    o = 1;
-                    for(n = 0; n < asc.length; n++){
-                        if(typeof asc[n] === 'object' && asc[n].length === 2){
-                            k[asc[n][0]] = asc[n][1];
-                            o -= 1;
-                        } else if(typeof asc[n] === 'object' && asc[n].length === 3){
-                            k[asc[n][0]] = (!!m[n+o]) ? m[n+o].replace(asc[n][1], asc[n][2]) : 'unknown';
-                        } else {
-                            k[asc[n]] = (!!m[n+o]) ? m[n+o] : 'unknown';
-                        }
-                    };
-                    i = k;
-                    p = true;
-                    break;
-                }
-            };
-            if(!p){
-                k = {};
-                for(l in asc){
-                    if(asc.hasOwnProperty(l)){
-                        k[asc[l]] = 'unknown';
-                    }
-                };                        
-                i = k;
-            }
-            if(p) break;
-        };
-        return i;
-    };
-
-    var winMap  = function(){
-        switch(arguments[1]){
-            case 'nt 5.0':
-                return '2000';
-            case 'nt 5.1':
-            case 'nt 5.2':
-                return 'XP';
-            case 'nt 6.0':
-                return 'Vista';
-            case 'nt 6.1':
-                return '7';
-            case 'nt 6.2':
-                return '8';
-            default:
-                return arguments[1];
-        };
-    };
-    
-    this.ua = window.navigator.userAgent;
-    
-    this.getBrowser = function(){
-    
-        return regxMap(this.ua, [
-
-            // Mixed
-            /(kindle)\/((\d+)?[\w\.]+)/i,                                       // Kindle
-            /(lunascape|maxthon|netfront|jasmine)[\/\s]?((\d+)?[\w\.]+)/i,      // Lunascape/Maxthon/Netfront/Jasmine
-            
-            // Presto based
-            /(opera\smini)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mini
-            /(opera\smobi)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mobile
-            /(opera).*\/((\d+)?[\w\.]+)/i,                                      // Opera
-
-            // Trident based
-            /(avant\sbrowser|iemobile)[\/\s]?((\d+)?[\w\.]+)/i,                 // Avant/IEMobile
-            /ms(ie)\s((\d+)?[\w\.]+)/i,                                         // Internet Explorer
-                                        
-            // Webkit/KHTML based
-            /(chromium|flock|rockmelt|midori|epiphany)\/((\d+)?[\w\.]+)/i,      // Chromium/Flock/RockMelt/Midori/Epiphany
-            /(chrome|omniweb|arora|dolfin)\/((\d+)?[\w\.]+)/i,                  // Chrome/OmniWeb/Arora/Dolphin            
-            /(mobile\ssafari|safari|konqueror)\/((\d+)?[\w\.]+)/i,              // Safari/Konqueror
-            /(applewebkit|khtml)\/((\d+)?[\w\.]+)/i,
-            
-            // Gecko based
-            /(iceweasel|camino|fennec|maemo|minimo)[\/\s]?((\d+)?[\w\.\+]+)/i,  // Iceweasel/Camino/Fennec/Maemo/Minimo
-            /(firefox|seamonkey|netscape|navigator)\/((\d+)?[\w\.]+)/i,         // Firefox/SeaMonkey/Netscape
-            /(mozilla)\/([\w\.]+).+rv\:.+gecko\/\d+/i,                          // Mozilla
-            
-            // Other
-            /(lynx)\/?((\d+)?[\w\.]+)/i,                                        // Lynx
-            ], ['name', 'release', 'version']);  
-    };
-        
-    this.getEngine = function(){
-        
-        return regxMap(this.ua, [
-
-            /(presto|[aple]*webkit|trident)\/([\w\.]+)/i,                       // Presto/Webkit/Trident
-            /(khtml)\/([\w\.]+)/i                                               // KHTML
-            ], ['name', 'version'], [
-            
-            /rv\:([\w\.]+).*(gecko)/i                                           // Gecko
-            ], ['version', 'name']);
-    };
-        
-    this.getOS = function(){ 
-        
-        return regxMap(this.ua, [
-
-            // Windows based
-            /(windows)\s?([\w\.\s]+)*/i,                                        // Windows
-            ], ['name', ['version', /(nt\s[\d\.]+)/gi, this.winMap]], [
-            
-            // Mobile/Embedded OS
-            /(blackberry).+version\/([\w\.]+)/i,                                // Blackberry
-            /(android|symbianos|symbos|webos|palm\os|qnx)[\/\s]?([\w\.]+)*/i,   // Android/Symbian/WebOS/Palm/QNX
-            /(nintendo)\s([wids]+)/i,                                           // Nintendo Wii/DS
-
-            // GNU/Linux based
-            /(mint)[\s\(]?(\w+)*/i,                                             // Mint
-            /(joli|ubuntu|debian|suse|gentoo|arch|slackware|fedora|mandriva|centos|pclinuxos|redhat)[\/\s]?([\w\.-]+)*/i,                  
-                                                                                // Joli/Ubuntu/Debian/SUSE/Gentoo/Arch/Slackware
-                                                                                // Fedora/Mandriva/CentOS/PCLinuxOS/RedHat
-            /(gnu|linux)\s?([\w\.]+)*/i                                         // Other GNU/Linux
-            ], ['name', 'version'], [
-            
-            /cros\s([\w\.\s]+)/i                                                // Chromium OS
-            ], [['name', 'Chromium OS'], 'version'],[
-
-            /sunos\s?([\w\.\s]+)*/i                                             // Solaris
-            ], [['name', 'Solaris'], 'version'], [
-            
-            // BSD based
-            /\s(\w*bsd|dragonfly)\s?([\w\.]+)*/i,                               // FreeBSD/NetBSD/OpenBSD/DragonFly
-            ], ['name', 'version'],[
-            
-            /(ip[honead]+).*os\s*([\w]+)*\slike\smac/i                          // iOS
-            ], [['name', /.+/g, 'iOS'], ['version', /_/g, '.']], [
-            
-            /(mac)\s([\w\s\.]+)/i,                                              // Mac
-                                        
-            // Other
-            /(unix|minix)[\/\s]?()*/i
-            ], ['name', 'version']);
-    };
-};

ua-parser.js

@@ -0,0 +1,220 @@
+// UA-Parser.js v0.2.1
+// Lightweight JavaScript-based user-agent parser
+// https://github.com/faisalman/ua-parser-js
+//
+// Copyright © 2012 Faisalman
+// Licensed under GPLv2
+
+function UAParser (uastring) {
+
+    var ua = uastring || window.navigator.userAgent;
+
+    // regexp mapper
+    var regxMap = function (ua) {
+        var result;
+        var i, j, k, l;
+        for (i = 1; i < arguments.length; i += 2) {
+            var regex = arguments[i];
+            var props = arguments[i + 1];
+            var isMatchFound = false;
+            for (j = 0; j < regex.length; j++) {
+                var match = regex[j].exec(ua);
+                //console.log(match);
+                if (!!match) {
+                    result = {};
+                    l = 1;
+                    for (k = 0; k < props.length; k++) {
+                        if (typeof props[k] === 'object' && props[k].length === 2) {
+                            result[props[k][0]] = props[k][1];
+                            l -= 1;
+                        } else if (typeof props[k] === 'object' && props[k].length === 3) {
+                            result[props[k][0]] = (!!match[k + l]) ? match[k + l].replace(props[k][1], props[k][2]) : undefined;
+                        } else {
+                            result[props[k]] = (!!match[k + l]) ? match[k + l] : undefined;
+                        }
+                    }
+                    isMatchFound = true;
+                    break;
+                }
+            }
+            if (!isMatchFound) {
+                result = {};
+                for (k in props) {
+                    if (props.hasOwnProperty(k)) {
+                        if (typeof props[k] == 'object') {
+                            result[props[k][0]] = undefined;
+                        } else {
+                            result[props[k]] = undefined;
+                        }
+                    }
+                }
+            } else {
+                return result;
+            }
+        }
+        return result;
+    };
+
+    var mapper = {
+        os : {        
+            win: function (str, match) {
+                switch (match.toLowerCase()) {
+                    case 'nt 5.0':
+                        return '2000';
+                    case 'nt 5.1':
+                    case 'nt 5.2':
+                        return 'XP';
+                    case 'nt 6.0':
+                        return 'Vista';
+                    case 'nt 6.1':
+                        return '7';
+                    case 'nt 6.2':
+                        return '8';
+                    default:
+                        return match;
+                };
+            }
+        }
+    };
+
+    this.getBrowser = function (uastring) {
+
+        return regxMap(uastring || ua, [
+
+            // Mixed
+            /(kindle)\/((\d+)?[\w\.]+)/i,                                       // Kindle
+            /(lunascape|maxthon|netfront|jasmine)[\/\s]?((\d+)?[\w\.]+)/i,      // Lunascape/Maxthon/Netfront/Jasmine
+            
+            // Presto based
+            /(opera\smini)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mini
+            /(opera\smobi)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mobile
+            /(opera).*\/((\d+)?[\w\.]+)/i,                                      // Opera
+
+            // Trident based
+            /(avant\sbrowser|iemobile|slimbrowser)[\/\s]?((\d+)?[\w\.]*)/i,     // Avant/IEMobile/SlimBrowser
+            /ms(ie)\s((\d+)?[\w\.]+)/i,                                         // Internet Explorer
+
+            // Webkit/KHTML based
+            /(chromium|flock|rockmelt|midori|epiphany)\/((\d+)?[\w\.]+)/i,      // Chromium/Flock/RockMelt/Midori/Epiphany
+            /(chrome|omniweb|arora|dolfin)\/((\d+)?[\w\.]+)/i,                  // Chrome/OmniWeb/Arora/Dolphin
+            ], ['name', 'version', 'major'], [
+            /android.+crmo\/((\d+)?[\w\.]+)/i,                                  // Chrome for Android
+            ], [['name', 'Chrome'], 'version', 'major'], [
+            /(mobile\ssafari|safari|konqueror)\/((\d+)?[\w\.]+)/i,              // Safari/Konqueror
+            /(applewebkit|khtml)\/((\d+)?[\w\.]+)/i,
+
+            // Gecko based
+            /(iceweasel|camino|fennec|maemo|minimo)[\/\s]?((\d+)?[\w\.\+]+)/i,  // Iceweasel/Camino/Fennec/Maemo/Minimo
+            /(firefox|seamonkey|netscape|navigator|k-meleon|icecat|iceape)\/((\d+)?[\w\.]+)/i,
+                                                                                // Firefox/SeaMonkey/Netscape/K-Meleon/IceCat/IceApe
+            /(mozilla)\/([\w\.]+).+rv\:.+gecko\/\d+/i,                          // Mozilla
+
+            // Other
+            /(lynx|dillo|icab)[\/\s]?((\d+)?[\w\.]+)/i,                         // Lynx/Dillo/iCab
+            ], ['name', 'version', 'major']);  
+    };
+
+    this.getEngine = function (uastring) {
+
+        return regxMap(uastring || ua, [
+
+            /(presto)\/([\w\.]+)/i,                                             // Presto
+            /([aple]*webkit|trident)\/([\w\.]+)/i,                              // Webkit/Trident
+            /(khtml)\/([\w\.]+)/i                                               // KHTML
+            ], ['name', 'version'], [
+
+            /rv\:([\w\.]+).*(gecko)/i                                           // Gecko
+            ], ['version', 'name']);
+    };
+
+    this.getOS = function (uastring) { 
+
+        return regxMap(uastring || ua, [
+
+            // Windows based
+            /(windows\sphone\sos|windows)\s+([\w\.\s]+)*/i,                     // Windows
+            ], ['name', ['version', /(nt\s[\d\.]+)/gi, mapper.os.win]], [
+
+            // Mobile/Embedded OS
+            /(blackberry).+version\/([\w\.]+)/i,                                // Blackberry
+            /(android|symbianos|symbos|webos|palm\os|qnx|bada|rim\stablet\sos)[\/\s-]?([\w\.]+)*/i,
+                                                                                // Android/Symbian/WebOS/Palm/QNX/Bada/RIM
+            /(nintendo|playstation)\s([wids3portable]+)/i,                      // Nintendo/Playstation
+
+            // GNU/Linux based
+            /(mint)[\/\s\(]?(\w+)*/i,                                           // Mint
+            /(joli|[kxln]?ubuntu|debian|[open]*suse|gentoo|arch|slackware|fedora|mandriva|centos|pclinuxos|redhat|zenwalk)[\/\s-]?([\w\.-]+)*/i,
+                                                                                // Joli/Ubuntu/Debian/SUSE/Gentoo/Arch/Slackware
+                                                                                // Fedora/Mandriva/CentOS/PCLinuxOS/RedHat/Zenwalk
+            /(gnu|linux)\s?([\w\.]+)*/i                                         // Other GNU/Linux
+            ], ['name', 'version'], [
+
+            /cros\s([\w\.\s]+)/i                                                // Chromium OS
+            ], [['name', 'Chromium OS'], 'version'],[
+
+            // Solaris
+            /sunos\s?([\w\.\s]+)*/i                                             // Solaris
+            ], [['name', 'Solaris'], 'version'], [
+
+            // BSD based
+            /\s(\w*bsd|dragonfly)\s?([\w\.]+)*/i,                               // FreeBSD/NetBSD/OpenBSD/DragonFly
+            ], ['name', 'version'],[
+
+            /(ip[honead]+).*os\s*([\w]+)*\slike\smac/i                          // iOS
+            ], [['name', /.+/g, 'iOS'], ['version', /_/g, '.']], [
+
+            /(mac\sos)\sx\s([\w\s\.]+)/i,                                       // Mac OS
+            ], ['name', ['version', /_/g, '.']], [
+
+            // Other
+            /(macintosh|unix|minix|beos)[\/\s]?()*/i
+            ], ['name', 'version']);
+    };
+
+    this.getDevice = function (uastring) { 
+
+        return regxMap(uastring || ua, [
+
+            /\((ip[honead]+|playbook);/i,                                       // iPod/iPhone/iPad/PlayBook
+            /(blackberry)[\s-]?(\w+)/i,                                         // BlackBerry
+            /(blackberry|benq|nokia|palm(?=\-)|sonyericsson|acer|asus|dell|nexus|zte)[\s_-]?([\w-]+)*/i,  
+                                                                                // BenQ/Nokia/Palm/Sony-Ericsson/Acer/Asus/Dell/Nexus/ZTE
+            /(hp)\s([\w\s]+)/i,                                                 // HP iPAQ
+            /(hp).+(touchpad)/i,                                                // HP TouchPad
+            /(kindle)\/([\w\.]+)/i,                                             // Kindle
+            /(lg)[e;\s-]+(\w+)*/i,                                              // LG
+            /(nintendo|playstation)\s([wids3portable]+)/i                       // Nintendo/Playstation
+            ], ['name', 'version'], [
+            
+            /(htc)[;_\s-]+([\w\s]+(?=\))|[\w]+)*/i,                             // HTC
+            /(zte)-([\w]+)*/i
+            ], ['name', ['version', /_/g, ' ']], [
+                        
+            /\s(milestone|mz601|droid[2x]?|xoom)[globa\s]*\sbuild\//i,          // Motorola
+            /mot[\s-]?(\w+)*/i
+            ], [['name', 'Motorola'], 'version'], [
+            
+            /(s[cgp]h-\w+|gt-\w+|galaxy\snexus)/i,                              // Samsung
+            /sam[sung]*[\s-]*(\w+-?[\w-]*)*/i,
+            /sec-(sgh\w+)/i
+            ], [['name', 'Samsung'], 'version'], [
+            
+            /(transfo[prime\s]{4,10}\s\w+|(?:android).*eeepc)/i                 // Asus
+            ], [['name', 'Asus'], 'version'], [
+
+            /sie-(\w+)*/i                                                       // Siemens
+            ], [['name', 'Siemens'], 'version']);
+    };
+
+    this.setUA = function (uastring) {
+        ua = uastring || ua;
+        return this.result = {
+            browser : this.getBrowser(),
+            engine  : this.getEngine(),
+            os      : this.getOS(),
+            device  : this.getDevice()
+        };
+    };
+
+    this.setUA(ua);
+};