Merge pull request #4 from christianbundy/euankdev

Escape args, add some tests

Author: christianbundy

index.js

@@ -3,10 +3,30 @@
 var querystring = require('querystring');
 var request = require('request');
 
+function encodeURIComponentArray(arr) {
+  return arr.map(function(component) {
+    return encodeURIComponent(component);
+  });
+}
+
 var hn = {
-  // make a request to the specified endpoint
-  call: function (endpoint, cb) {
-    var query = 'https://hn.algolia.com/api/v1/' + endpoint;
+  // Make a request with the spicified uri component array
+  // and query argument object. If the queryObj is omitted,
+  // it will be assumed to be empty and the callback may be 
+  // there instead
+  call: function (components, queryObj, cb) {
+    if(!Array.isArray(components)) components = [components];
+    if(typeof queryObj === 'function') {
+      cb = queryObj;
+      queryObj = {};
+    }
+
+    var endpoint_parts = encodeURIComponentArray(components);
+    var query = 'https://hn.algolia.com/api/v1/' + endpoint_parts.join('/');
+
+    var query_args = querystring.stringify(queryObj);
+    if(query_args.length > 0) query += '?' + query_args;
+
     request(query, function (error, response, body) {
       if (!error && response.statusCode != 200)
         error = response.statusCode;
@@ -23,93 +43,93 @@ var hn = {
 
   // get popular/recent comments
   getComments: function (cb) {
-    hn.call('search?tags=comment', cb);
+    hn.call('search', {tags: 'comment'}, cb);
   },
   getLastComments: function (cb) {
-    hn.call('search_by_date?tags=comment', cb);
+    hn.call('search_by_date', {tags: 'comment'}, cb);
   },
 
   // get popular/recent polls
   getPolls: function (cb) {
-    hn.call('search?tags=poll', cb);
+    hn.call('search', {tags: 'poll'}, cb);
   },
   getLastPolls: function (cb) {
-    hn.call('search_by_date?tags=poll', cb);
+    hn.call('search_by_date', {tags: 'poll'}, cb);
   },
 
   // get popular/recent posts
   getPosts: function (cb) {
-    hn.call('search?tags=(story,poll)', cb);
+    hn.call('search', {tags: '(story,poll)'}, cb);
   },
   getLastPosts: function (cb) {
-    hn.call('search_by_date?tags=(story,poll)', cb);
+    hn.call('search_by_date', {tags: '(story,poll)'}, cb);
   },
 
   // get popular/recent stories
   getStories: function (cb) {
-    hn.call('search?tags=story', cb);
+    hn.call('search', {tags: 'story'}, cb);
   },
   getLastStories: function (cb) {
-    hn.call('search_by_date?tags=story', cb);
+    hn.call('search_by_date', {tags: 'story'}, cb);
   },
 
   // get unique post/comment
   getItem: function (id, cb) {
-    hn.call('items/' + id, cb);
+    hn.call(['items', id], cb);
   },
 
   // get unique user
   getUser: function (username, cb) {
-    hn.call('users/' + username, cb);
+    hn.call(['users', username], cb);
   },
 
   // get popular/recent user comments
   getUserComments: function (username, cb) {
-    hn.call('search?tags=comment,author_' + username, cb);
+    hn.call('search', {tags: 'comment,author_' + username}, cb);
   },
   getLastUserComments: function (username, cb) {
-    hn.call('search_by_date?tags=comment,author_' + username, cb);
+    hn.call('search_by_date', {tags: 'comment,author_' + username}, cb);
   },
 
   // get popular/recent user polls
   getUserPolls: function (username, cb) {
-    hn.call('search?tags=poll,author_' + username, cb);
+    hn.call('search', {tags: 'poll,author_' + username}, cb);
   },
   getLastUserPolls: function (username, cb) {
-    hn.call('search_by_date?tags=poll,author_' + username, cb);
+    hn.call('search_by_date', {tags: 'poll,author_' + username}, cb);
   },
 
   // get popular/recent user posts
   getUserPosts: function (username, cb) {
-    hn.call('search?tags=(story,poll),author_' + username, cb);
+    hn.call('search', {tags: '(story,poll),author_' + username}, cb);
   },
   getLastUserPosts: function (username, cb) {
-    hn.call('search_by_date?tags=(story,poll),author_' + username, cb);
+    hn.call('search_by_date', {tags: '(story,poll),author_' + username}, cb);
   },
 
   // get popular/recent user stories
   getUserStories: function (username, cb) {
-    hn.call('search?tags=story,author_' + username, cb);
+    hn.call('search', {tags: 'story,author_' + username}, cb);
   },
   getLastUserStories: function (username, cb) {
-    hn.call('search_by_date?tags=story,author_' + username, cb);
+    hn.call('search_by_date', {tags: 'story,author_' + username}, cb);
   },
 
 
   // search popular/recent comments
   searchComments: function (query, cb) {
-    hn.call('search?query=' + query + '&tags=comment', cb);
+    hn.call('search', {query: query, tags: 'comment'}, cb);
   },
   searchLastComments: function (query, cb) {
-    hn.call('search_by_date?query=' + query + '&tags=comment', cb);
+    hn.call('search_by_date', {query: query, tags: 'comment'}, cb);
   },
 
   // search popular/recent polls
   searchPolls: function (query, cb) {
-    hn.call('search?query=' + query + '&tags=poll', cb);
+    hn.call('search', {query: query, tags: 'poll'}, cb);
   },
   searchLastPolls: function (query, cb) {
-    hn.call('search_by_date?query=' + query + '&tags=poll', cb);
+    hn.call('search_by_date', {query: query, tags: 'poll'}, cb);
   },
 
   // search popular/recent posts
@@ -122,21 +142,19 @@ var hn = {
 
   // search popular/recent stories
   searchStories: function (query, cb) {
-    hn.call('search?query=' + query + '&tags=story', cb);
+    hn.call('search', {query: query, tags: 'story'}, cb);
   },
   searchLastStories: function (query, cb) {
-    hn.call('search_by_date?query=' + query + '&tags=story', cb);
+    hn.call('search_by_date', {query: query, tags: 'story'}, cb);
   },
 
 
   // search popular/recent
   search: function (obj, cb) {
-    var params = querystring.stringify(obj);
-    hn.call('search?' + params, cb);
+    hn.call('search', obj, cb);
   },
   searchLast: function (obj, cb) {
-    var params = querystring.stringify(obj);
-    hn.call('search_by_date?' + params, cb);
+    hn.call('search_by_date', obj, cb);
   }
 };
 

package.json

@@ -26,5 +26,10 @@
   "homepage": "https://github.com/christianbundy/node-hacker-news-api",
   "dependencies": {
     "request": "~2.34.0"
+  },
+  "devDependencies": {
+    "chai": "*",
+    "nock": "*",
+    "mocha": "*"
   }
 }

test/fixtures/fixtures.json

@@ -0,0 +1,31 @@
+var https = require('https');
+var async = require('async');
+var request = require('request');
+var fs = require('fs');
+
+var urls = [
+    '/api/v1/search?tags=comment',
+    '/api/v1/search_by_date?tags=comment',
+    '/api/v1/search?tags=poll',
+    '/api/v1/search_by_date?tags=poll',
+    '/api/v1/search?tags=(story%2Cpoll)',
+    '/api/v1/search_by_date?tags=(story%2Cpoll)',
+    '/api/v1/search?tags=story',
+    '/api/v1/search_by_date?tags=story',
+];
+
+async.mapSeries(urls, function(item, next) {
+  request.get('https://hn.algolia.com' + item, function(err, response, body) {
+    next(err, {
+      url: item,
+      reply: JSON.parse(body)
+    });
+  });
+}, function(err, results) {
+  if(err) {
+    console.err("Bad news: " + err);
+    process.exit();
+  }
+  fs.writeFileSync("./fixtures.json", JSON.stringify(results));
+  console.log("Wrote fixtures.json!");
+});

test/fixtures/generate_fixtures.js

@@ -0,0 +1,76 @@
+var hn = require("./../index.js");
+var fs = require('fs');
+var expect = require('chai').expect;
+var nock = require('nock');
+
+var fixtures = JSON.parse(fs.readFileSync(__dirname + "/fixtures/fixtures.json"));
+
+var api = nock('https://hn.algolia.com').persist();
+fixtures.forEach(function(f) {
+  console.log(f.url);
+  api.get(f.url).reply(200, f.reply);
+});
+
+
+var slice = function(arr){ return Array.prototype.slice.call(arr); };
+
+function crazy_curry(args, fn) {
+  args = slice(arguments);
+  fn = args.pop();
+
+  return function(innerArgs) {
+    console.log(arguments[0]);
+    innerArgs = slice(arguments);
+    Array.prototype.push.apply(innerArgs, args);
+    fn.apply(this, innerArgs);
+  };
+}
+
+
+
+describe('hn', function(){
+  function verifyDataHasOneOfTags(err, data, tags, done) {
+    if(err) {
+      return done("Error");
+    }
+    expect(data).to.have.property('hits');
+    data.hits.map(function(comment) {
+      var intersection = tags.filter(function(n) {
+        return comment._tags.indexOf(n) != -1;
+      });
+      expect(intersection).not.to.be.empty;
+    });
+    done();
+  }
+
+  it('should get comments', function(done) {
+    hn.getComments(crazy_curry(['comment'], done, verifyDataHasOneOfTags));
+  });
+  it('should get latest comments', function(done) {
+    hn.getLastComments(crazy_curry(['comment'], done, verifyDataHasOneOfTags));
+  });
+
+
+  it('should get polls', function(done) {
+    hn.getPolls(crazy_curry(['poll'], done, verifyDataHasOneOfTags));
+  });
+  it('should get latest polls', function(done) {
+    hn.getLastPolls(crazy_curry(['poll'], done, verifyDataHasOneOfTags));
+  });
+
+
+  it('should get posts', function(done) {
+    hn.getPosts(crazy_curry(['story', 'poll'], done, verifyDataHasOneOfTags));
+  });
+  it('should get latest posts', function(done) {
+    hn.getLastPosts(crazy_curry(['story', 'poll'], done, verifyDataHasOneOfTags));
+  });
+
+
+  it('should get stories', function(done) {
+    hn.getStories(crazy_curry(['story'], done, verifyDataHasOneOfTags));
+  });
+  it('should get latest stories', function(done) {
+    hn.getLastStories(crazy_curry(['story'], done, verifyDataHasOneOfTags));
+  });
+});