Merge #128: Add custom remote data function

- Rename attribute name
- Add a test

Author: ghiden

CONTRIBUTORS.md

@@ -32,6 +32,10 @@
 
 * Escape regular expression #123
 
+### [@jbuquet: Javier Buquet](https://github.com/jbuquet)
+
+* Add custom API handler #128
+
 ### [@jermspeaks: Jeremy Wong](https://github.com/jermspeaks)
 
 * Support withCredentials for $http #113

README.md

@@ -38,6 +38,7 @@ To see a demo go here: http://ghiden.github.io/angucomplete-alt
 * Clear input by sending $broadcast from parent scope. Thanks to @Leocrest for #61.
 * Override template with your own. When you use this feature, test throughly as it might break other features. Thanks to @sdbondi for #74.
 * Show all items.
+* Custom remote API handler which allows you to fully control how to communicate with your remote API. Thanks to @jbuquet
 
 ### Getting Started
 Download the package, and include the dist/angucomplete-alt.min.js file in your page.
@@ -96,7 +97,6 @@ var app = angular.module('app', ["angucomplete-alt"]);
 | pause | The time to wait (in milliseconds) before searching when the user enters new characters. [example](http://ghiden.github.io/angucomplete-alt/#example1) | No | 400 |
 | selected-object | Either an object in your scope or callback function. If you set an object, it will be two-way-bound data as usual. If you set a callback, it gets called when selection is made. [example](http://ghiden.github.io/angucomplete-alt/#example1) | Yes | selectedObject or objectSelectedCallback |
 | remote-url | The remote URL to hit to query for results in JSON. angucomplete will automatically append the search string on the end of this, so it must be a GET request. [example](http://ghiden.github.io/angucomplete-alt/#example5) | No | http://myserver.com/api/users/find?searchstr= |
-| get-remote-data-function | A function in the controller that would receive the string and some parameters like the timeout promise, and would return a promise with the request for the data | No | - |
 | remote-url-data-field | The name of the field in the JSON object returned back that holds the Array of objects to be used for the autocomplete list. [example](http://ghiden.github.io/angucomplete-alt/#example5) | No | results |
 | title-field | The name of the field in the JSON objects returned back that should be used for displaying the title in the autocomplete list. Note, if you want to combine fields together, you can comma separate them here (e.g. for a first and last name combined). If you want to access nested field, use dot to connect attributes (e.g. name.first). [example](http://ghiden.github.io/angucomplete-alt/#example1) | Yes | firstName,lastName |
 | description-field | The name of the field in the JSON objects returned back that should be used for displaying the description in the autocomplete list. [example](http://ghiden.github.io/angucomplete-alt/#example6) | No | twitterUsername |
@@ -111,6 +111,7 @@ var app = angular.module('app', ["angucomplete-alt"]);
 | remote-url-request-with-credentials | A boolean that accepts parameters with credentials. | No | true or false |
 | remote-url-response-formatter | A function on the scope that will modify raw response from remote API before it is rendered in the drop-down.  Useful for adding data that may not be available from the API.  The specified function must return the object in the format that angucomplete understands. | No | addImageUrlToObject |
 | remote-url-error-callback | A callback funciton to handle error response from $http.get | No | httpErrorCallbackFn |
+| remote-api-handler | This gives a way to fully delegate handling of remote search API. This function takes user input string and timeout promise, and it needs to return a promise. For example, if your search API is based on POST, you can use this function to create your own http handler. See example below | No | - |
 | clear-selected | To clear out input field upon selecting an item, set this attribute to true. [example](http://ghiden.github.io/angucomplete-alt/#example3) | No | true |
 | override-suggestions | To override suggestions and set the value in input field to selectedObject. [example](http://ghiden.github.io/angucomplete-alt/#example4) | No | true |
 | field-required | Set field to be required. Requirement for this to work is that this directive needs to be in a form. Default class name is "autocomplete-required". [example](http://ghiden.github.io/angucomplete-alt/#example8) | No | true |
@@ -150,6 +151,23 @@ To clear an angucomplete-alt input field, send this message with id of the direc
 $scope.$broadcast('angucomplete-alt:clearInput', 'autocomplete-1');
 ```
 
+### Remote API Handler
+
+This is an example calling search API with POST.
+Pass this searchAPI function to the directive as remote-api-hander.
+
+```js
+$scope.searchAPI = function(userInputString, timeoutPromise) {
+  return $http.post('/yourownapi/', {q: userInputString}, {timeout: timeoutPromise});
+}
+```
+When you use remote-api-handler, these attributes are ignored:
+```
+remote-url
+remote-url-request-formatter
+remote-url-request-with-credentials
+```
+
 ### Contributors
 
 Here is the list of [contributors](CONTRIBUTORS.md).

angucomplete-alt.js

@@ -79,7 +79,7 @@
         remoteUrlRequestWithCredentials: '@',
         remoteUrlResponseFormatter: '=',
         remoteUrlErrorCallback: '=',
-        getRemoteDataFunction: '=',
+        remoteApiHandler: '=',
         id: '@',
         type: '@',
         placeholder: '@',
@@ -405,6 +405,10 @@
 
         function httpSuccessCallbackGen(str) {
           return function(responseData, status, headers, config) {
+            // normalize return obejct from promise
+            if (!status && !headers && !config) {
+              responseData = responseData.data;
+            }
             scope.searching = false;
             processResults(
               extractValue(responseFormatter(responseData), scope.remoteUrlDataField),
@@ -413,6 +417,10 @@
         }
 
         function httpErrorCallback(errorRes, status, headers, config) {
+          // normalize return obejct from promise
+          if (!status && !headers && !config) {
+            status = errorRes.status;
+          }
           if (status !== 0) {
             if (scope.remoteUrlErrorCallback) {
               scope.remoteUrlErrorCallback(errorRes, status, headers, config);
@@ -449,13 +457,12 @@
             .error(httpErrorCallback);
         }
 
-        function getResourceResults(str) {
+        function getRemoteResultsWithCustomHandler(str) {
           cancelHttpRequest();
 
           httpCanceller = $q.defer();
-          var params    = { timeout: httpCanceller.promise };
 
-          scope.getRemoteDataFunction(str, params).$promise
+          scope.remoteApiHandler(str, httpCanceller.promise)
             .then(httpSuccessCallbackGen(str))
             .catch(httpErrorCallback);
         }
@@ -515,8 +522,8 @@
               getLocalResults(str);
             });
           }
-          else if (scope.getRemoteDataFunction) {
-            getResourceResults(str);
+          else if (scope.remoteApiHandler) {
+            getRemoteResultsWithCustomHandler(str);
           } else {
             getRemoteResults(str);
           }
@@ -570,6 +577,9 @@
           if (scope.localData) {
             processResults(scope.localData, '');
           }
+          else if (scope.remoteApiHandler) {
+            getRemoteResultsWithCustomHandler('');
+          }
           else {
             getRemoteResults('');
           }

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "angucomplete-alt",
-  "version": "0.0.40",
+  "version": "0.0.41",
   "homepage": "http://ghiden.github.io/angucomplete-alt/",
   "authors": [
     "Hidenari Nozaki <hidenari@gmail.com>"

dist/angucomplete-alt.min.js

@@ -1,6 +1,6 @@
 {
   "name": "angucomplete-alt",
-  "version": "0.0.40",
+  "version": "0.0.41",
   "description": "Awesome Autocompleteness for AngularJS",
   "author": "ghiden",
   "email": "hidenari@gmail.com",

package.json

@@ -395,6 +395,32 @@ describe('angucomplete-alt', function() {
       $httpBackend.verifyNoOutstandingRequest();
     });
 
+    it('should process via custom handler', inject(function($http) {
+      var element = angular.element('<div angucomplete-alt id="ex1" placeholder="Search names" selected-object="selected" remote-api-handler="postFn" search-fields="name" title-field="name" remote-url-data-field="data" minlength="1"/>');
+      var url = '/api';
+      $scope.postFn = function(str, timeout) {
+        return $http.post(url, {q: str}, {timeout: timeout});
+      };
+      $compile(element)($scope);
+      $scope.$digest();
+
+      var queryTerm = 'j';
+      var results = {data: [{name: 'john'}]};
+      $httpBackend.expectPOST('/api', {q: queryTerm}).respond(200, results);
+
+      var inputField = element.find('#ex1_value');
+      var eKeyup = $.Event('keyup');
+      eKeyup.which = queryTerm.charCodeAt(0);
+      inputField.val(queryTerm);
+      inputField.trigger('input');
+      inputField.trigger(eKeyup);
+      expect(element.isolateScope().searching).toBe(true);
+      $timeout.flush();
+      $httpBackend.flush();
+
+      expect(element.find('.angucomplete-row').length).toBe(1);
+    }));
+
     it('should url encode input string', function() {
       var element = angular.element('<div angucomplete-alt id="ex1" placeholder="Search names" selected-object="selected" remote-url="names?q=" search-fields="name" remote-url-data-field="data" title-field="name" remote-url-error-callback="errorCB" minlength="1"/>');
       $scope.errorCB = jasmine.createSpy('errorCB');