Merge pull request #157 from PokemonGoers/descriptionFeature

Description feature

Author: jonas-he

app/api/pokemon.js

@@ -161,6 +161,28 @@ module.exports = {
                 res.status(404).json({message: 'Failure. No pokemon details with this name exists!', data: {'name': req.params.name}});
         });
     },
+
+    /**
+     * @api {get} /api/pokemon/description/:description/ GetPokemonByDescription
+     * @apiVersion 0.0.1
+     * @apiName GetPokemonByDescription
+     * @apiDescription Get pokemon by specific description
+     * @apiGroup Pokemon
+     * @apiParam {String} description Description of the pokemon
+     *
+     * @apiUse SamplePokemon
+     * @apiUse NoRecords
+     *
+     */
+    getByDescription: function(req, res) {
+        logger.info('Get Pokemon description');
+        pokemon.getByDescription(req.params.description, function (success, message) {
+            if(success === 1)
+                res.status(200).json({message: 'Success', data: message});
+            else
+                res.status(404).json({message: 'Failure. No pokemon description of that kind exists!', data: {'description': req.params.description}});
+        });
+    },
     /**
      * @api {get} /api/pokemon/type/:type/ GetPokemonByType
      * @apiVersion 0.0.1

app/controllers/filler/pokemon.js

@@ -20,6 +20,7 @@ module.exports = {
 
             base.pokemonId = Number(pokemon[i]['Number']);
             base.name = pokemon[i]['Name'];
+            base.description = pokemon[i]['Description'];
             base.classification = pokemon[i]['Classification'];
 
             base.types = [];

app/models/pokemon.js

@@ -5,6 +5,7 @@ var Schema = mongoose.Schema;
 
 let pokemon = {
     pokemonId: Number,
+    description: {type: String},
     name: {type: String},
     icon: {type: String},
     classification: {type: String},

app/stores/pokemon.js

@@ -85,6 +85,32 @@ module.exports = {
         });
         callback(1, matches);
     },
+    /*
+     * searching the pokemon details by closest description
+     */
+    getClosestDescription: function (description, data, callback) {
+        description = description.toLowerCase();
+
+        /*Filter the records that match the first 3 characters of the query*/
+        let data_clone = _.filter(data, function (datum) {
+            let datumDescription = datum.description.toLowerCase();
+            return datum.description.length > 8 && description.substring(0, 7) === datumDescription.substring(0, 7);
+        });
+        /*Loop through the data and compute the distance between the query and each name value in the data*/
+        data_clone.forEach(function (pokemon) {
+            let pokemonDescription = pokemon.description.toLowerCase();
+            pokemon.distance = this.getStrDistance(description, pokemonDescription);
+        }.bind(this));
+
+        /*Sort the data in ascending order of distance*/
+        data_clone = _.sortBy(data_clone, "distance");
+        /*Select the first 3 data records (3 records that are closest to the query).
+         * Remove the "distance"  */
+        let matches = _.map(_.first(data_clone, 3), function (match) {
+            return match;//_.omit(match, "distance");
+        });
+        callback(1, matches);
+    },
     /*
      * searching the pokemonIcon details by Id
      */
@@ -128,6 +154,26 @@ module.exports = {
             }
         }.bind(this));
     },
+    /*
+     * get the pokemon details of particular pokemon based on description
+     */
+    getByDescription : function (description, callback) {
+        this.get({'description': new RegExp('^.*' + description + '.*$', 'i')}, function (status, response) {
+            if (status === 1 && _.isEmpty(response) && description.length > 8) {
+                this.getAll(function (status, response) {
+                    if (status === 1) {
+                        this.getClosestDescription(description, response, function (status, response) {
+                            callback(status, response);
+                        });
+                    } else {
+                        callback(status, response);
+                    }
+                }.bind(this));
+            } else {
+                callback(status, response);
+            }
+        }.bind(this));
+    },
     /*
      * get the pokemon details of particular pokemon based on type
      */