[api] Added Internet.userAgent #16

3 files changed, 222 insertions, 1 deletions

diff --git a/lib/internet.js b/lib/internet.js
index 41065538..761c27fb 100644
--- a/lib/internet.js
+++ b/lib/internet.js
@@ -1,4 +1,5 @@
-var faker = require('../index');
+var faker = require('../index'),
+    random_ua = require('../vendor/user-agent');
 
 var internet = {
     email: function () {
@@ -39,6 +40,10 @@ var internet = {
         return result.join(".");
     },
 
+    userAgent: function () {
+      return random_ua.generate();
+    },
+
     color: function (baseRed255, baseGreen255, baseBlue255) {
 
         // based on awesome response : http://stackoverflow.com/questions/43044/algorithm-to-randomly-generate-an-aesthetically-pleasing-color-palette
diff --git a/test/internet.unit.js b/test/internet.unit.js
index 59af887a..97502e51 100644
--- a/test/internet.unit.js
+++ b/test/internet.unit.js
@@ -83,6 +83,13 @@ describe("internet.js", function () {
         });
     });
 
+    describe("userAgent()", function () {
+        it("returns a valid user-agent", function () {
+            var ua = faker.Internet.userAgent();
+            assert.ok(ua);
+        });
+    });
+
     describe("color()", function () {
         it("returns a valid hex value (like #ffffff)", function () {
             var color = faker.Internet.color(100, 100, 100);
diff --git a/vendor/user-agent.js b/vendor/user-agent.js
new file mode 100644
index 00000000..ee449bc7
--- /dev/null
+++ b/vendor/user-agent.js
@@ -0,0 +1,209 @@
+/*
+
+Copyright (c) 2012-2014 Jeffrey Mealo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+------------------------------------------------------------------------------------------------------------------------
+
+Based loosely on Luka Pusic's PHP Script: http://360percents.com/posts/php-random-user-agent-generator/
+
+The license for that script is as follows:
+
+"THE BEER-WARE LICENSE" (Revision 42):
+
+<[email protected]> wrote this file. As long as you retain this notice you can do whatever you want with this stuff.
+If we meet some day, and you think this stuff is worth it, you can buy me a beer in return. Luka Pusic
+*/
+
+function rnd(a, b) {
+    //calling rnd() with no arguments is identical to rnd(0, 100)
+    a = a || 0;
+    b = b || 100;
+
+    if (typeof b === 'number' && typeof a === 'number') {
+        //rnd(int min, int max) returns integer between min, max
+        return (function (min, max) {
+            if (min > max) {
+                throw new RangeError('expected min <= max; got min = ' + min + ', max = ' + max);
+            }
+            return Math.floor(Math.random() * (max - min + 1)) + min;
+        }(a, b));
+    }
+
+    if (Object.prototype.toString.call(a) === "[object Array]") {
+        //returns a random element from array (a), even weighting
+        return a[Math.floor(Math.random() * a.length)];
+    }
+
+    if (a && typeof a === 'object') {
+        //returns a random key from the passed object; keys are weighted by the decimal probability in their value
+        return (function (obj) {
+            var rand = rnd(0, 100) / 100, min = 0, max = 0, key, return_val;
+
+            for (key in obj) {
+                if (obj.hasOwnProperty(key)) {
+                    max = obj[key] + min;
+                    return_val = key;
+                    if (rand >= min && rand <= max) {
+                        break;
+                    }
+                    min = min + obj[key];
+                }
+            }
+
+            return return_val;
+        }(a));
+    }
+
+    throw new TypeError('Invalid arguments passed to rnd. (' + (b ? a + ', ' + b : a) + ')');
+}
+
+function randomLang() {
+    return rnd(['AB', 'AF', 'AN', 'AR', 'AS', 'AZ', 'BE', 'BG', 'BN', 'BO', 'BR', 'BS', 'CA', 'CE', 'CO', 'CS',
+                'CU', 'CY', 'DA', 'DE', 'EL', 'EN', 'EO', 'ES', 'ET', 'EU', 'FA', 'FI', 'FJ', 'FO', 'FR', 'FY',
+                'GA', 'GD', 'GL', 'GV', 'HE', 'HI', 'HR', 'HT', 'HU', 'HY', 'ID', 'IS', 'IT', 'JA', 'JV', 'KA',
+                'KG', 'KO', 'KU', 'KW', 'KY', 'LA', 'LB', 'LI', 'LN', 'LT', 'LV', 'MG', 'MK', 'MN', 'MO', 'MS',
+                'MT', 'MY', 'NB', 'NE', 'NL', 'NN', 'NO', 'OC', 'PL', 'PT', 'RM', 'RO', 'RU', 'SC', 'SE', 'SK',
+                'SL', 'SO', 'SQ', 'SR', 'SV', 'SW', 'TK', 'TR', 'TY', 'UK', 'UR', 'UZ', 'VI', 'VO', 'YI', 'ZH']);
+}
+
+function randomBrowserAndOS() {
+    var browser = rnd({
+        chrome:    .45132810566,
+        iexplorer: .27477061836,
+        firefox:   .19384170608,
+        safari:    .06186781118,
+        opera:     .01574236955
+    }),
+    os = {
+        chrome:  {win: .89,  mac: .09 , lin: .02},
+        firefox: {win: .83,  mac: .16,  lin: .01},
+        opera:   {win: .91,  mac: .03 , lin: .06},
+        safari:  {win: .04 , mac: .96  },
+        iexplorer: ['win']
+    };
+
+    return [browser, rnd(os[browser])];
+}
+
+function randomProc(arch) {
+    var procs = {
+        lin:['i686', 'x86_64'],
+        mac: {'Intel' : .48, 'PPC': .01, 'U; Intel':.48, 'U; PPC' :.01},
+        win:['', 'WOW64', 'Win64; x64']
+    };
+    return rnd(procs[arch]);
+}
+
+function randomRevision(dots) {
+    var return_val = '';
+    //generate a random revision
+    //dots = 2 returns .x.y where x & y are between 0 and 9
+    for (var x = 0; x < dots; x++) {
+        return_val += '.' + rnd(0, 9);
+    }
+    return return_val;
+}
+
+var version_string = {
+    net: function () {
+        return [rnd(1, 4), rnd(0, 9), rnd(10000, 99999), rnd(0, 9)].join('.');
+    },
+    nt: function () {
+        return rnd(5, 6) + '.' + rnd(0, 3);
+    },
+    ie: function () {
+        return rnd(7, 11);
+    },
+    trident: function () {
+        return rnd(3, 7) + '.' + rnd(0, 1);
+    },
+    osx: function (delim) {
+        return [10, rnd(5, 10), rnd(0, 9)].join(delim || '.');
+    },
+    chrome: function () {
+        return [rnd(13, 39), 0, rnd(800, 899), 0].join('.');
+    },
+    presto: function () {
+        return '2.9.' + rnd(160, 190);
+    },
+    presto2: function () {
+        return rnd(10, 12) + '.00';
+    },
+    safari: function () {
+        return rnd(531, 538) + '.' + rnd(0, 2) + '.' + rnd(0,2);
+    }
+};
+
+var browser = {
+    firefox: function firefox(arch) {
+        //https://developer.mozilla.org/en-US/docs/Gecko_user_agent_string_reference
+        var firefox_ver = rnd(5, 15) + randomRevision(2),
+            gecko_ver = 'Gecko/20100101 Firefox/' + firefox_ver,
+            proc = randomProc(arch),
+            os_ver = (arch === 'win') ? '(Windows NT ' + version_string.nt() + ((proc) ? '; ' + proc : '')
+            : (arch === 'mac') ? '(Macintosh; ' + proc + ' Mac OS X ' + version_string.osx()
+            : '(X11; Linux ' + proc;
+
+        return 'Mozilla/5.0 ' + os_ver + '; rv:' + firefox_ver.slice(0, -2) + ') ' + gecko_ver;
+    },
+
+    iexplorer: function iexplorer() {
+        var ver = version_string.ie();
+
+        if (ver >= 11) {
+            //http://msdn.microsoft.com/en-us/library/ie/hh869301(v=vs.85).aspx
+            return 'Mozilla/5.0 (Windows NT 6.' + rnd(1,3) + '; Trident/7.0; ' + rnd(['Touch; ', '']) + 'rv:11.0) like Gecko';
+        }
+
+        //http://msdn.microsoft.com/en-us/library/ie/ms537503(v=vs.85).aspx
+        return 'Mozilla/5.0 (compatible; MSIE ' + ver + '.0; Windows NT ' + version_string.nt() + '; Trident/' +
+            version_string.trident() + ((rnd(0, 1) === 1) ? '; .NET CLR ' + version_string.net() : '') + ')';
+    },
+
+    opera: function opera(arch) {
+        //http://www.opera.com/docs/history/
+        var presto_ver = ' Presto/' + version_string.presto() + ' Version/' + version_string.presto2() + ')',
+            os_ver = (arch === 'win') ? '(Windows NT ' + version_string.nt() + '; U; ' + randomLang() + presto_ver
+            : (arch === 'lin') ? '(X11; Linux ' + randomProc(arch) + '; U; ' + randomLang() + presto_ver
+            : '(Macintosh; Intel Mac OS X ' + version_string.osx() + ' U; ' + randomLang() + ' Presto/' +
+            version_string.presto() + ' Version/' + version_string.presto2() + ')';
+
+        return 'Opera/' + rnd(9, 14) + '.' + rnd(0, 99) + ' ' + os_ver;
+    },
+
+    safari: function safari(arch) {
+        var safari = version_string.safari(),
+            ver = rnd(4, 7) + '.' + rnd(0,1) + '.' + rnd(0,10),
+            os_ver = (arch === 'mac') ? '(Macintosh; ' + randomProc('mac') + ' Mac OS X '+ version_string.osx('_') + ' rv:' + rnd(2, 6) + '.0; '+ randomLang() + ') '
+            : '(Windows; U; Windows NT ' + version_string.nt() + ')';
+
+        return 'Mozilla/5.0 ' + os_ver + 'AppleWebKit/' + safari + ' (KHTML, like Gecko) Version/' + ver + ' Safari/' + safari;
+    },
+
+    chrome: function chrome(arch) {
+        var safari = version_string.safari(),
+            os_ver = (arch === 'mac') ? '(Macintosh; ' + randomProc('mac') + ' Mac OS X ' + version_string.osx('_') + ') '
+            : (arch === 'win') ? '(Windows; U; Windows NT ' + version_string.nt() + ')'
+            : '(X11; Linux ' + randomProc(arch);
+
+        return 'Mozilla/5.0 ' + os_ver + ' AppleWebKit/' + safari + ' (KHTML, like Gecko) Chrome/' + version_string.chrome() + ' Safari/' + safari;
+    }
+};
+
+exports.generate = function generate() {
+    var random = randomBrowserAndOS();
+    return browser[random[0]](random[1]);
+};