tough-cookie 0.9.15 → 0.12.1

package/.jshintrc

@@ -1,72 +1,70 @@
 {
-    // Settings
-    "passfail"      : false,  // Stop on first error.
-    "maxerr"        : 100,    // Maximum error before stopping.
+    "passfail"      : false,
+    "maxerr"        : 100,
 
-
-    // Predefined globals whom JSHint will ignore.
-    "browser"       : false,   // Standard browser globals e.g. `window`, `document`.
+    "browser"       : false,
     "node"          : true,
     "rhino"         : false,
     "couch"         : false,
-    "wsh"           : false,  // Windows Scripting Host.
+    "wsh"           : false,
 
     "jquery"        : false,
     "prototypejs"   : false,
     "mootools"      : false,
     "dojo"          : false,
 
-    "predef"        : [  // Custom globals.
-        "escape", "unescape"  // aren't picked up by node flag above :/
-    ],
-
-
-    // Development.
-    "debug"         : false,  // Allow debugger statements e.g. browser breakpoints.
-    "devel"         : false,  // Allow developments statements e.g. `console.log();`.
+    "debug"         : false,
+    "devel"         : false,
 
+    "esnext"        : true,
+    "strict"        : true,
+    "globalstrict"  : true,
 
-    // EcmaScript 5.
-    "es5"           : true,   // Allow EcmaScript 5 syntax.
-    "esnext"        : true,   // Allow ES "next" syntax, specifically 'const' (V8 has this)
-    "strict"        : false,  // Require `use strict` pragma  in every file.
-    "globalstrict"  : false,  // Allow global "use strict" (also enables 'strict').
+    "asi"           : false,
+    "laxbreak"      : false,
+    "bitwise"       : true,
+    "boss"          : false,
+    "curly"         : true,
+    "eqeqeq"        : false,
+    "eqnull"        : true,
+    "evil"          : false,
+    "expr"          : false,
+    "forin"         : false,
+    "immed"         : true,
+    "lastsemic"     : true,
+    "latedef"       : false,
+    "loopfunc"      : false,
+    "noarg"         : true,
+    "regexp"        : false,
+    "regexdash"     : false,
+    "scripturl"     : false,
+    "shadow"        : false,
+    "supernew"      : false,
+    "undef"         : true,
+    "unused"         : true,
 
+    "newcap"        : true,
+    "noempty"       : true,
+    "nonew"         : true,
+    "nomen"         : false,
+    "onevar"        : false,
+    "onecase"       : true,
+    "plusplus"      : false,
+    "proto"         : false,
+    "sub"           : true,
+    "trailing"      : true,
+    "white"         : false,
 
-    // The Good Parts.
-    "asi"           : false,  // Tolerate Automatic Semicolon Insertion (no semicolons).
-    "laxbreak"      : false,  // Tolerate unsafe line breaks e.g. `return [\n] x` without semicolons.
-    "bitwise"       : true,   // Prohibit bitwise operators (&, |, ^, etc.).
-    "boss"          : false,  // Tolerate assignments inside if, for & while. Usually conditions & loops are for comparison, not assignments.
-    "curly"         : false,  // Require {} for every new block or scope.
-    "eqeqeq"        : false,  // Require triple equals i.e. `===`.
-    "eqnull"        : true,   // Tolerate use of `== null`.
-    "evil"          : false,  // Tolerate use of `eval`.
-    "expr"          : true,   // Tolerate `ExpressionStatement` as Programs.
-    "forin"         : false,  // Tolerate `for in` loops without `hasOwnPrototype`.
-    "immed"         : true,   // Require immediate invocations to be wrapped in parens e.g. `( function(){}() );`
-    "latedef"       : false,  // Prohibit variable use before definition.
-    "loopfunc"      : false,  // Allow functions to be defined within loops.
-    "noarg"         : true,   // Prohibit use of `arguments.caller` and `arguments.callee`.
-    "regexp"        : true,   // Prohibit `.` and `[^...]` in regular expressions.
-    "regexdash"     : false,  // Tolerate unescaped last dash i.e. `[-...]`.
-    "scripturl"     : true,   // Tolerate script-targeted URLs.
-    "shadow"        : false,  // Allows re-define variables later in code e.g. `var x=1; x=2;`.
-    "supernew"      : false,  // Tolerate `new function () { ... };` and `new Object;`.
-    "undef"         : true,   // Require all non-global variables be declared before they are used.
-
-
-    // Personal styling prefrences.
-    "lastsemic"     : true,   // Prohibit missing semicolon for the last statement in a one-line block
-    "newcap"        : false,  // Require capitalization of all constructor functions e.g. `new F()`.
-    "noempty"       : true,   // Prohipit use of empty blocks.
-    "nonew"         : true,   // Prohibit use of constructors for side-effects.
-    "nomen"         : false,  // Prohibit use of initial or trailing underbars in names.
-    "onevar"        : false,  // Allow only one `var` statement per function.
-    "onecase"       : false,  // Allow switches with one case statement
-    "plusplus"      : false,  // Prohibit use of `++` & `--`.
-    "proto"         : false,  // Allow use of __proto__
-    "sub"           : true,   // Tolerate all forms of subscript notation besides dot notation e.g. `dict['key']` instead of `dict.key`.
-    "trailing"      : true,   // Prohibit trailing whitespaces.
-    "white"         : false   // Check against strict whitespace and indentation rules.
+    "predef": [
+      "describe",
+      "it",
+      "before",
+      "beforeEach",
+      "after",
+      "afterEach",
+      "expect",
+      "setTimeout",
+      "clearTimeout"
+    ],
+    "maxlen": 0
 }

package/.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+- "0.10"
+- "0.11"
+matrix:
+  fast_finish: true
+  allow_failures:
+    - node_js: 0.11

package/README.md

@@ -2,16 +2,21 @@
 
 ![Tough Cookie](http://www.goinstant.com.s3.amazonaws.com/tough-cookie.jpg)
 
+[![Build Status](https://travis-ci.org/goinstant/node-cookie.png?branch=master)](https://travis-ci.org/goinstant/node-cookie)
+
+[![NPM Stats](https://nodei.co/npm/tough-cookie.png?downloads=true&stars=true)](https://npmjs.org/package/tough-cookie)
+![NPM Downloads](https://nodei.co/npm-dl/tough-cookie.png?months=9)
+
 # Synopsis
 
 ``` javascript
-var cookies = require('tough-cookie'); // note: not 'cookie', 'cookies' or 'node-cookie'
-var Cookie = cookies.Cookie;
+var tough = require('tough-cookie'); // note: not 'cookie', 'cookies' or 'node-cookie'
+var Cookie = tough.Cookie;
 var cookie = Cookie.parse(header);
 cookie.value = 'somethingdifferent';
 header = cookie.toString();
 
-var cookiejar = new cookies.CookieJar();
+var cookiejar = new tough.CookieJar();
 cookiejar.setCookie(cookie, 'http://currentdomain.example.com/path', cb);
 // ...
 cookiejar.getCookies('http://example.com/otherpath',function(err,cookies) {
@@ -31,8 +36,8 @@ Why the name?  NPM modules `cookie`, `cookies` and `cookiejar` were already take
 
 # API
 
-cookies
-=======
+tough
+=====
 
 Functions on the module you get from `require('tough-cookie')`.  All can be used as pure functions and don't need to be "bound".
 
@@ -124,7 +129,7 @@ Here's how to process the Set-Cookie header(s) on a node HTTP/HTTPS response:
 
 ``` javascript
 if (res.headers['set-cookie'] instanceof Array)
-  cookies = res.headers['set-cookie'].map(Cookie.parse);
+  cookies = res.headers['set-cookie'].map(function (c) { return (Cookie.parse(c)); });
 else
   cookies = [Cookie.parse(res.headers['set-cookie'])];
 ```
@@ -146,7 +151,7 @@ Properties
   * _secure_ - boolean - the `Secure` cookie flag
   * _httpOnly_ - boolean - the `HttpOnly` cookie flag
   * _extensions_ - `Array` - any unrecognized cookie attributes as strings (even if equal-signs inside)
-               
+
 After a cookie has been passed through `CookieJar.setCookie()` it will have the following additional attributes:
 
   * _hostOnly_ - boolean - is this a host-only cookie (i.e. no Domain field was set, but was instead implied)
@@ -236,7 +241,7 @@ Attributes
 ----------
 
   * _rejectPublicSuffixes_ - boolean - reject cookies with domains like "com" and "co.uk" (default: `true`)
-                         
+
 Since eventually this module would like to support database/remote/etc. CookieJars, continuation passing style is used for CookieJar methods.
 
 .setCookie(cookieOrString, currentUrl, [{options},] cb(err,cookie))
@@ -254,11 +259,16 @@ The `options` object can be omitted and can have the following properties:
 
 As per the RFC, the `.hostOnly` property is set if there was no "Domain=" parameter in the cookie string (or `.domain` was null on the Cookie object).  The `.domain` property is set to the fully-qualified hostname of `currentUrl` in this case.  Matching this cookie requires an exact hostname match (not a `domainMatch` as per usual).
 
+.setCookieSync(cookieOrString, currentUrl, [{options}])
+-------------------------------------------------------
+
+Synchronous version of `setCookie`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).
+
 .storeCookie(cookie, [{options},] cb(err,cookie))
 -------------------------------------------------
 
 __REMOVED__ removed in lieu of the CookieStore API below
-                                                
+
 .getCookies(currentUrl, [{options},] cb(err,cookies))
 -----------------------------------------------------
 
@@ -276,20 +286,42 @@ The `options` object can be omitted and can have the following properties:
 
 The `.lastAccessed` property of the returned cookies will have been updated.
 
+.getCookiesSync(currentUrl, [{options}])
+----------------------------------------
+
+Synchronous version of `getCookies`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).
+
 .getCookieString(...)
 ---------------------
 
 Accepts the same options as `.getCookies()` but passes a string suitable for a Cookie header rather than an array to the callback.  Simply maps the `Cookie` array via `.cookieString()`.
 
+.getCookieStringSync(...)
+-------------------------
+
+Synchronous version of `getCookieString`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).
+
 .getSetCookieStrings(...)
 -------------------------
 
-Accepts the same options as `.getCookies()` but passes an array of strings suitable for Set-Cookie headers (rather than an array of `Cookie`s) to the callback.  Simply maps the cookie array via `.toString()`.
+Returns an array of strings suitable for **Set-Cookie** headers. Accepts the same options as `.getCookies()`.  Simply maps the cookie array via `.toString()`.
+
+.getSetCookieStringsSync(...)
+-----------------------------
+
+Synchronous version of `getSetCookieStrings`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).
+
+Store
+=====
+
+Base class for CookieJar stores.
 
 # CookieStore API
 
 The storage model for each `CookieJar` instance can be replaced with a custom implementation.  The default is `MemoryCookieStore` which can be found in the `lib/memstore.js` file.  The API uses continuation-passing-style to allow for asynchronous stores.
 
+Stores should inherit from the base `Store` class, which is available as `require('tough-cookie').Store`.  Stores are asynchronous by default, but if `store.synchronous` is set, then the `*Sync` methods on the CookieJar can be used.
+
 All `domain` parameters will have been normalized before calling.
 
 The Cookie store must have all of the following methods.
@@ -358,7 +390,7 @@ Pass an error ONLY if removing any existing cookies failed.
 
 (tl;dr: MIT with some MPL/1.1)
 
-Copyright GoInstant, Inc. and other contributors. All rights reserved.
+Copyright 2012- GoInstant, Inc. and other contributors. All rights reserved.
 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

package/generate-pubsuffix.js

@@ -18,13 +18,15 @@
  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  * IN THE SOFTWARE.
  */
-
+'use strict';
 var fs = require('fs');
 var assert = require('assert');
 var punycode = require('punycode');
 
 fs.readFile('./public-suffix.txt', 'utf8', function(err,string) {
-  if (err) throw err;
+  if (err) {
+    throw err;
+  }
   var lines = string.split("\n");
   process.nextTick(function() {
     processList(lines);
@@ -38,7 +40,9 @@ function processList(lines) {
   while (lines.length) {
     var line = lines.shift();
     line = line.replace(COMMENT,'').trim();
-    if (!line) continue;
+    if (!line) {
+      continue;
+    }
     addToIndex(index,line);
   }
 
@@ -47,7 +51,7 @@ function processList(lines) {
   var w = fs.createWriteStream('./lib/pubsuffix.js',{
     flags: 'w',
     encoding: 'utf8',
-    mode: 0644,
+    mode: parseInt('644',8)
   });
   w.on('end', process.exit);
   w.write("/****************************************************\n");
@@ -76,11 +80,12 @@ function addToIndex(index,line) {
     line = line.slice(prefix.length);
   }
   line = prefix + punycode.toASCII(line);
- 
-  if (line.substr(0,1) == '!')
+
+  if (line.substr(0,1) == '!') {
     index[line.substr(1)] = false;
-  else
+  } else {
     index[line] = true;
+  }
 }
 
 // include the licence in the function since it gets written to pubsuffix.js
@@ -105,8 +110,12 @@ function getPublicSuffix(domain) {
    * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
    * IN THE SOFTWARE.
    */
-  if (!domain) return null;
-  if (domain.match(/^\./)) return null;
+  if (!domain) {
+    return null;
+  }
+  if (domain.match(/^\./)) {
+    return null;
+  }
 
   domain = domain.toLowerCase();
   var parts = domain.split('.').reverse();