tough-cookie 2.4.2 → 3.0.1

package/README.md

@@ -57,7 +57,7 @@ Transforms a domain-name into a canonical domain-name.  The canonical domain-nam
 
 Answers "does this real domain match the domain in a cookie?".  The `str` is the "current" domain-name and the `domStr` is the "cookie" domain-name.  Matches according to RFC6265 Section 5.1.3, but it helps to think of it as a "suffix match".
 
-The `canonicalize` parameter will run the other two paramters through `canonicalDomain` or not.
+The `canonicalize` parameter will run the other two parameters through `canonicalDomain` or not.
 
 ### `defaultPath(path)`
 
@@ -186,7 +186,7 @@ sets the maxAge in seconds.  Coerces `-Infinity` to `"-Infinity"` and `Infinity`
 
 expiryTime() Computes the absolute unix-epoch milliseconds that this cookie expires. expiryDate() works similarly, except it returns a `Date` object.  Note that in both cases the `now` parameter should be milliseconds.
 
-Max-Age takes precedence over Expires (as per the RFC). The `.creation` attribute -- or, by default, the `now` paramter -- is used to offset the `.maxAge` attribute.
+Max-Age takes precedence over Expires (as per the RFC). The `.creation` attribute -- or, by default, the `now` parameter -- is used to offset the `.maxAge` attribute.
 
 If Expires (`.expires`) is set, that's returned.
 
@@ -198,7 +198,7 @@ compute the TTL relative to `now` (milliseconds).  The same precedence rules as
 
 The "number" `Infinity` is returned for cookies without an explicit expiry and `0` is returned if the cookie is expired.  Otherwise a time-to-live in milliseconds is returned.
 
-### `.canonicalizedDoman()`
+### `.canonicalizedDomain()`
 
 ### `.cdomain()`
 
@@ -354,6 +354,16 @@ The `store` argument is optional, but must be a _synchronous_ `Store` instance i
 
 The _source_ and _destination_ must both be synchronous `Store`s. If one or both stores are asynchronous, use `.clone` instead. Recall that `MemoryCookieStore` supports both synchronous and asynchronous API calls.
 
+### `.removeAllCookies(cb(err))`
+
+Removes all cookies from the jar.
+
+This is a new backwards-compatible feature of `tough-cookie` version 2.5, so not all Stores will implement it efficiently. For Stores that do not implement `removeAllCookies`, the fallback is to call `removeCookie` after `getAllCookies`. If `getAllCookies` fails or isn't implemented in the Store, that error is returned. If one or more of the `removeCookie` calls fail, only the first error is returned.
+
+### `.removeAllCookiesSync()`
+
+Sync version of `.removeAllCookies()`
+
 ## Store
 
 Base class for CookieJar stores. Available as `tough.Store`.
@@ -418,19 +428,29 @@ Removes matching cookies from the store.  The `path` parameter is optional, and
 
 Pass an error ONLY if removing any existing cookies failed.
 
+### `store.removeAllCookies(cb(err))`
+
+_Optional_. Removes all cookies from the store.
+
+Pass an error if one or more cookies can't be removed.
+
+**Note**: New method as of `tough-cookie` version 2.5, so not all Stores will implement this, plus some stores may choose not to implement this.
+
 ### `store.getAllCookies(cb(err, cookies))`
 
-Produces an `Array` of all cookies during `jar.serialize()`. The items in the array can be true `Cookie` objects or generic `Object`s with the [Serialization Format] data structure.
+_Optional_. Produces an `Array` of all cookies during `jar.serialize()`. The items in the array can be true `Cookie` objects or generic `Object`s with the [Serialization Format] data structure.
 
 Cookies SHOULD be returned in creation order to preserve sorting via `compareCookies()`. For reference, `MemoryCookieStore` will sort by `.creationIndex` since it uses true `Cookie` objects internally. If you don't return the cookies in creation order, they'll still be sorted by creation time, but this only has a precision of 1ms.  See `compareCookies` for more detail.
 
 Pass an error if retrieval fails.
 
+**Note**: not all Stores can implement this due to technical limitations, so it is optional.
+
 ## MemoryCookieStore
 
 Inherits from `Store`.
 
-A just-in-memory CookieJar synchronous store implementation, used by default. Despite being a synchronous implementation, it's usable with both the synchronous and asynchronous forms of the `CookieJar` API.
+A just-in-memory CookieJar synchronous store implementation, used by default. Despite being a synchronous implementation, it's usable with both the synchronous and asynchronous forms of the `CookieJar` API. Supports serialization, `getAllCookies`, and `removeAllCookies`.
 
 ## Community Cookie Stores
 
@@ -473,7 +493,7 @@ These are some Store implementations authored and maintained by the community. T
 
 # Copyright and License
 
-(tl;dr: BSD-3-Clause with some MPL/2.0)
+BSD-3-Clause:
 
 ```text
  Copyright (c) 2015, Salesforce.com, Inc.

package/lib/cookie.js

@@ -29,13 +29,14 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 'use strict';
-var net = require('net');
 var urlParse = require('url').parse;
+var util = require('util');
+var ipRegex = require('ip-regex')({ exact: true });
 var pubsuffix = require('./pubsuffix-psl');
 var Store = require('./store').Store;
 var MemoryCookieStore = require('./memstore').MemoryCookieStore;
 var pathMatch = require('./pathMatch').pathMatch;
-var VERSION = require('../package.json').version;
+var VERSION = require('./version');
 
 var punycode;
 try {
@@ -319,7 +320,7 @@ function domainMatch(str, domStr, canonicalize) {
   /* "All of the following [three] conditions hold:" (order adjusted from the RFC) */
 
   /* "* The string is a host name (i.e., not an IP address)." */
-  if (net.isIP(str)) {
+  if (ipRegex.test(str)) {
     return false;
   }
 
@@ -756,6 +757,12 @@ Cookie.prototype.inspect = function inspect() {
     '"';
 };
 
+// Use the new custom inspection symbol to add the custom inspect function if
+// available.
+if (util.inspect.custom) {
+  Cookie.prototype[util.inspect.custom] = Cookie.prototype.inspect;
+}
+
 Cookie.prototype.toJSON = function() {
   var obj = {};
 
@@ -1000,11 +1007,17 @@ CookieJar.prototype.setCookie = function(cookie, url, options, cb) {
   }
 
   // S5.3 step 1
-  if (!(cookie instanceof Cookie)) {
+  if (typeof(cookie) === 'string' || cookie instanceof String) {
     cookie = Cookie.parse(cookie, { loose: loose });
+    if (!cookie) {
+      err = new Error("Cookie failed to parse");
+      return cb(options.ignoreError ? null : err);
+    }
   }
-  if (!cookie) {
-    err = new Error("Cookie failed to parse");
+  else if (!(cookie instanceof Cookie)) {
+    // If you're seeing this error, and are passing in a Cookie object, 
+    // it *might* be a Cookie object from another loaded version of tough-cookie.
+    err = new Error("First argument to setCookie must be a Cookie object or string");
     return cb(options.ignoreError ? null : err);
   }
 
@@ -1364,7 +1377,6 @@ CookieJar.deserializeSync = function(strOrObj, store) {
 };
 CookieJar.fromJSON = CookieJar.deserializeSync;
 
-CAN_BE_SYNC.push('clone');
 CookieJar.prototype.clone = function(newStore, cb) {
   if (arguments.length === 1) {
     cb = newStore;
@@ -1375,10 +1387,61 @@ CookieJar.prototype.clone = function(newStore, cb) {
     if (err) {
       return cb(err);
     }
-    CookieJar.deserialize(newStore, serialized, cb);
+    CookieJar.deserialize(serialized, newStore, cb);
   });
 };
 
+CAN_BE_SYNC.push('removeAllCookies');
+CookieJar.prototype.removeAllCookies = function(cb) {
+  var store = this.store;
+
+  // Check that the store implements its own removeAllCookies(). The default
+  // implementation in Store will immediately call the callback with a "not
+  // implemented" Error.
+  if (store.removeAllCookies instanceof Function &&
+      store.removeAllCookies !== Store.prototype.removeAllCookies)
+  {
+    return store.removeAllCookies(cb);
+  }
+
+  store.getAllCookies(function(err, cookies) {
+    if (err) {
+      return cb(err);
+    }
+
+    if (cookies.length === 0) {
+      return cb(null);
+    }
+
+    var completedCount = 0;
+    var removeErrors = [];
+
+    function removeCookieCb(removeErr) {
+      if (removeErr) {
+        removeErrors.push(removeErr);
+      }
+
+      completedCount++;
+
+      if (completedCount === cookies.length) {
+        return cb(removeErrors.length ? removeErrors[0] : null);
+      }
+    }
+
+    cookies.forEach(function(cookie) {
+      store.removeCookie(cookie.domain, cookie.path, cookie.key, removeCookieCb);
+    });
+  });
+};
+
+CookieJar.prototype._cloneSync = syncWrap('clone');
+CookieJar.prototype.cloneSync = function(newStore) {
+  if (!newStore.synchronous) {
+    throw new Error('CookieJar clone destination store is not synchronous; use async API instead.');
+  }
+  return this._cloneSync(newStore);
+};
+
 // Use a closure to provide a true imperative API for synchronous stores.
 function syncWrap(method) {
   return function() {
@@ -1406,6 +1469,7 @@ CAN_BE_SYNC.forEach(function(method) {
   CookieJar.prototype[method+'Sync'] = syncWrap(method);
 });
 
+exports.version = VERSION;
 exports.CookieJar = CookieJar;
 exports.Cookie = Cookie;
 exports.Store = Store;

package/lib/memstore.js

@@ -50,6 +50,12 @@ MemoryCookieStore.prototype.inspect = function() {
   return "{ idx: "+util.inspect(this.idx, false, 2)+' }';
 };
 
+// Use the new custom inspection symbol to add the custom inspect function if
+// available.
+if (util.inspect.custom) {
+  MemoryCookieStore.prototype[util.inspect.custom] = MemoryCookieStore.prototype.inspect;
+}
+
 MemoryCookieStore.prototype.findCookie = function(domain, path, key, cb) {
   if (!this.idx[domain]) {
     return cb(null,undefined);
@@ -143,6 +149,11 @@ MemoryCookieStore.prototype.removeCookies = function(domain, path, cb) {
   return cb(null);
 };
 
+MemoryCookieStore.prototype.removeAllCookies = function(cb) {
+  this.idx = {};
+  return cb(null);
+}
+
 MemoryCookieStore.prototype.getAllCookies = function(cb) {
   var cookies = [];
   var idx = this.idx;

package/lib/store.js

@@ -66,6 +66,10 @@ Store.prototype.removeCookies = function(domain, path, cb) {
   throw new Error('removeCookies is not implemented');
 };
 
+Store.prototype.removeAllCookies = function(cb) {
+  throw new Error('removeAllCookies is not implemented');
+}
+
 Store.prototype.getAllCookies = function(cb) {
   throw new Error('getAllCookies is not implemented (therefore jar cannot be serialized)');
 };

package/lib/version.js

@@ -0,0 +1,2 @@
+// generated by genversion
+module.exports = '3.0.1'

package/package.json

@@ -43,7 +43,7 @@
     "RFC6265",
     "RFC2965"
   ],
-  "version": "2.4.2",
+  "version": "3.0.1",
   "homepage": "https://github.com/salesforce/tough-cookie",
   "repository": {
     "type": "git",
@@ -57,20 +57,23 @@
     "lib"
   ],
   "scripts": {
+    "version": "genversion lib/version.js && git add lib/version.js",
     "test": "vows test/*_test.js",
     "cover": "nyc --reporter=lcov --reporter=html vows test/*_test.js"
   },
   "engines": {
-    "node": ">=0.8"
+    "node": ">=6"
   },
   "devDependencies": {
     "async": "^1.4.2",
+    "genversion": "^2.1.0",
     "nyc": "^11.6.0",
     "string.prototype.repeat": "^0.2.0",
-    "vows": "^0.8.1"
+    "vows": "^0.8.2"
   },
   "dependencies": {
-    "psl": "^1.1.24",
-    "punycode": "^1.4.1"
+    "ip-regex": "^2.1.0",
+    "psl": "^1.1.28",
+    "punycode": "^2.1.1"
   }
 }