feat($http): change $http to allow removing/replacing individual requests in $http cache

Adds $http.removeCache method.
Adds/implements replaceCache property in $http request configuration.

Closes #5968

Author: njs50

src/ng/http.js

@@ -425,7 +425,18 @@ function $HttpProvider() {
      * If you set the default cache to `false` then only requests that specify their own custom
      * cache object will be cached.
      *
-     * ## Interceptors
+     * If you need to bypass and overwrite the cache you can set the `replaceCache` property to
+     * `true` in the request configuration.
+     *
+     * If you wish to purge stale data from the cache without making a request you can use the
+     * {@link ng.$http#methods_removeCache $http.removeCache} method and pass it the configuration
+     * object that was used to create the request you wish to purge.
+     * ```js
+     *    $http.removeCache({method: 'GET', url: '/someUrl'})
+     * ```
+     *
+     *
+     * # Interceptors
      *
      * Before you start creating interceptors, be sure to understand the
      * {@link ng.$q $q and deferred/promise APIs}.
@@ -595,6 +606,8 @@ function $HttpProvider() {
      *      GET request, otherwise if a cache instance built with
      *      {@link ng.$cacheFactory $cacheFactory}, this cache will be used for
      *      caching.
+     *    - **replaceCache** - `{boolean}` - If true this request will bypas the cache and  replace
+     *      any previously cached value.
      *    - **timeout** – `{number|Promise}` – timeout in milliseconds, or {@link ng.$q promise}
      *      that should abort the request when resolved.
      *    - **withCredentials** - `{boolean}` - whether to set the `withCredentials` flag on the
@@ -653,20 +666,20 @@ function $HttpProvider() {
         $scope.method = 'GET';
         $scope.url = 'http-hello.html';
 
-        $scope.fetch = function() {
-          $scope.code = null;
-          $scope.response = null;
-
-          $http({method: $scope.method, url: $scope.url, cache: $templateCache}).
-            success(function(data, status) {
-              $scope.status = status;
-              $scope.data = data;
-            }).
-            error(function(data, status) {
-              $scope.data = data || "Request failed";
-              $scope.status = status;
-          });
-        };
+    $scope.fetch = function() {
+      $scope.code = null;
+      $scope.response = null;
+
+      $http({method: $scope.method, url: $scope.url, cache: $templateCache}).
+        success(function(data, status) {
+          $scope.status = status;
+          $scope.data = data;
+        }).
+        error(function(data, status) {
+          $scope.data = data || "Request failed";
+          $scope.status = status;
+      });
+    };
 
         $scope.updateModel = function(method, url) {
           $scope.method = method;
@@ -756,7 +769,7 @@ function $HttpProvider() {
         }
       });
 
-      while (chain.length) {
+      while(chain.length) {
         var thenFn = chain.shift();
         var rejectFn = chain.shift();
 
@@ -926,6 +939,29 @@ function $HttpProvider() {
       */
     createShortMethodsWithData('post', 'put', 'patch');
 
+    /**
+     * @ngdoc method
+     * @name $http#removeCache
+     *
+     * @description
+     * Removes a request from the cache without generating a new request.
+     *
+     * @param {Object} config configuration object (as per the request that created the cache entry)
+     */
+     $http.removeCache = function(config) {
+
+        var url = buildUrl(config.url, config.params);
+
+        var cache = isObject(config.cache) ? config.cache
+              : isObject(defaults.cache) ? defaults.cache
+              : defaultCache;
+
+        if (cache) {
+          cache.remove(url);
+        }
+
+     };
+
         /**
          * @ngdoc property
          * @name $http#defaults
@@ -992,7 +1028,11 @@ function $HttpProvider() {
       }
 
       if (cache) {
-        cachedResp = cache.get(url);
+        if (config.replaceCache) {
+          cache.remove(url);
+        } else {
+          cachedResp = cache.get(url);
+        }
         if (isDefined(cachedResp)) {
           if (isPromiseLike(cachedResp)) {
             // cached request has already been sent, but there is no response yet
@@ -1084,11 +1124,11 @@ function $HttpProvider() {
 
 
     function buildUrl(url, params) {
-      if (!params) return url;
-      var parts = [];
-      forEachSorted(params, function(value, key) {
-        if (value === null || isUndefined(value)) return;
-        if (!isArray(value)) value = [value];
+          if (!params) return url;
+          var parts = [];
+          forEachSorted(params, function(value, key) {
+            if (value === null || isUndefined(value)) return;
+            if (!isArray(value)) value = [value];
 
         forEach(value, function(v) {
           if (isObject(v)) {

test/ng/httpSpec.js

@@ -1250,6 +1250,24 @@ describe('$http', function() {
       });
 
 
+      it('should be able to remove a request from the cache', function() {
+        doFirstCacheRequest();
+
+        $http.removeCache({method: 'GET', url: '/url', cache: cache});
+
+        $httpBackend.expect('GET', '/url').respond();
+        $http({method: 'GET', url: '/url', cache: cache});
+      });
+
+
+      it('should be able to bypass and overwrite the cache for a request', function() {
+        doFirstCacheRequest();
+
+        $httpBackend.expect('GET', '/url').respond();
+        $http({method: 'GET', url: '/url', cache: cache, replaceCache: true});
+      });
+
+
       it('should always call callback asynchronously', function() {
         doFirstCacheRequest();
         $http({method: 'get', url: '/url', cache: cache}).then(callback);