Add API versionning

diff --git a/public/javascripts/index.js b/public/javascripts/index.js
index 95caf7eb4081ccfaf1e385bfad6ca03fdba9155d..c67e22c7bfe127c504e4d17e8d1242680b01d287 100644 (file)
--- a/public/javascripts/index.js
+++ b/public/javascripts/index.js
@@ -38,7 +38,7 @@
 
     if (e.keyCode === 13) {
       $.ajax({
-        url: '/api/videos/search/' + search,
+        url: '/api/v1/videos/search/' + search,
         type: 'GET',
         dataType: 'json',
         success: function (videos) {
@@ -51,7 +51,7 @@
   // Join a new network
   function makeFriends () {
     $.ajax({
-      url: '/api/pods/makefriends',
+      url: '/api/v1/pods/makefriends',
       type: 'GET',
       dataType: 'json',
       success: function () {
@@ -140,7 +140,7 @@
     $form_video.fileupload({
       singleFileUploads: true,
       multipart: true,
-      url: '/api/videos',
+      url: '/api/v1/videos',
       autoupload: false,
       add: function (e, data) {
         var $text = $('<span></span>').addClass('name_file').text(data['files'][0]['name'])
@@ -170,7 +170,7 @@
   // Print the list of all the videos
   function getVideos () {
     $.ajax({
-      url: '/api/videos/',
+      url: '/api/v1/videos/',
       dataType: 'json',
       type: 'GET',
       success: function (videos) {
@@ -181,7 +181,7 @@
 
   function removeVideo (video) {
     $.ajax({
-      url: '/api/videos/' + video._id,
+      url: '/api/v1/videos/' + video._id,
       type: 'DELETE',
       success: function (response, status) {
         getVideos()

diff --git a/routes/api/index.js b/routes/api/index.js
deleted file mode 100644 (file)
index 9a4ec84..0000000
--- a/routes/api/index.js
+++ /dev/null
@@ -1,10 +0,0 @@
-;(function () {
-  'use strict'
-
-  var api = {}
-  api.videos = require('./videos')
-  api.remoteVideos = require('./remoteVideos')
-  api.pods = require('./pods')
-
-  module.exports = api
-})()

diff --git a/routes/api/pods.js b/routes/api/pods.js
deleted file mode 100644 (file)
index 8fa29b4..0000000
--- a/routes/api/pods.js
+++ /dev/null
@@ -1,38 +0,0 @@
-;(function () {
-  'use strict'
-
-  var express = require('express')
-  var router = express.Router()
-  var middleware = require('../../middlewares')
-  var pods = require('../../src/pods')
-
-  function listPods (req, res, next) {
-    pods.list(function (err, pods_list) {
-      if (err) return next(err)
-
-      res.json(pods_list)
-    })
-  }
-
-  function addPods (req, res, next) {
-    pods.add(req.body.data, function (err, json) {
-      if (err) return next(err)
-
-      res.json(json)
-    })
-  }
-
-  function makeFriends (req, res, next) {
-    pods.makeFriends(function (err) {
-      if (err) return next(err)
-
-      res.sendStatus(204)
-    })
-  }
-
-  router.get('/', middleware.cache(false), listPods)
-  router.get('/makefriends', middleware.cache(false), makeFriends)
-  router.post('/', middleware.cache(false), addPods)
-
-  module.exports = router
-})()

diff --git a/routes/api/remoteVideos.js b/routes/api/remoteVideos.js
deleted file mode 100644 (file)
index 2ae3ce5..0000000
--- a/routes/api/remoteVideos.js
+++ /dev/null
@@ -1,29 +0,0 @@
-;(function () {
-  'use strict'
-
-  var express = require('express')
-  var router = express.Router()
-  var middleware = require('../../middlewares')
-  var videos = require('../../src/videos')
-
-  function addRemoteVideos (req, res, next) {
-    videos.addRemote(req.body.data, function (err, video) {
-      if (err) return next(err)
-
-      res.json(video)
-    })
-  }
-
-  function removeRemoteVideo (req, res, next) {
-    videos.removeRemote(req.body.signature.url, req.body.data.magnetUri, function (err) {
-      if (err) return next(err)
-
-      res.status(204)
-    })
-  }
-
-  router.post('/add', middleware.cache(false), middleware.decryptBody, addRemoteVideos)
-  router.post('/remove', middleware.cache(false), middleware.decryptBody, removeRemoteVideo)
-
-  module.exports = router
-})()

diff --git a/routes/api/v1/index.js b/routes/api/v1/index.js
new file mode 100644 (file)
index 0000000..9a4ec84
--- /dev/null
+++ b/routes/api/v1/index.js
@@ -0,0 +1,10 @@
+;(function () {
+  'use strict'
+
+  var api = {}
+  api.videos = require('./videos')
+  api.remoteVideos = require('./remoteVideos')
+  api.pods = require('./pods')
+
+  module.exports = api
+})()

diff --git a/routes/api/v1/pods.js b/routes/api/v1/pods.js
new file mode 100644 (file)
index 0000000..961388f
--- /dev/null
+++ b/routes/api/v1/pods.js
@@ -0,0 +1,38 @@
+;(function () {
+  'use strict'
+
+  var express = require('express')
+  var router = express.Router()
+  var middleware = require('../../../middlewares')
+  var pods = require('../../../src/pods')
+
+  function listPods (req, res, next) {
+    pods.list(function (err, pods_list) {
+      if (err) return next(err)
+
+      res.json(pods_list)
+    })
+  }
+
+  function addPods (req, res, next) {
+    pods.add(req.body.data, function (err, json) {
+      if (err) return next(err)
+
+      res.json(json)
+    })
+  }
+
+  function makeFriends (req, res, next) {
+    pods.makeFriends(function (err) {
+      if (err) return next(err)
+
+      res.sendStatus(204)
+    })
+  }
+
+  router.get('/', middleware.cache(false), listPods)
+  router.get('/makefriends', middleware.cache(false), makeFriends)
+  router.post('/', middleware.cache(false), addPods)
+
+  module.exports = router
+})()

diff --git a/routes/api/v1/remoteVideos.js b/routes/api/v1/remoteVideos.js
new file mode 100644 (file)
index 0000000..88b8e87
--- /dev/null
+++ b/routes/api/v1/remoteVideos.js
@@ -0,0 +1,29 @@
+;(function () {
+  'use strict'
+
+  var express = require('express')
+  var router = express.Router()
+  var middleware = require('../../../middlewares')
+  var videos = require('../../../src/videos')
+
+  function addRemoteVideos (req, res, next) {
+    videos.addRemote(req.body.data, function (err, video) {
+      if (err) return next(err)
+
+      res.json(video)
+    })
+  }
+
+  function removeRemoteVideo (req, res, next) {
+    videos.removeRemote(req.body.signature.url, req.body.data.magnetUri, function (err) {
+      if (err) return next(err)
+
+      res.status(204)
+    })
+  }
+
+  router.post('/add', middleware.cache(false), middleware.decryptBody, addRemoteVideos)
+  router.post('/remove', middleware.cache(false), middleware.decryptBody, removeRemoteVideo)
+
+  module.exports = router
+})()

diff --git a/routes/api/v1/videos.js b/routes/api/v1/videos.js
new file mode 100644 (file)
index 0000000..246620a
--- /dev/null
+++ b/routes/api/v1/videos.js
@@ -0,0 +1,61 @@
+;(function () {
+  'use strict'
+
+  var express = require('express')
+  var router = express.Router()
+  var middleware = require('../../../middlewares')
+  var videos = require('../../../src/videos')
+
+  function listVideos (req, res, next) {
+    videos.list(function (err, videos_list) {
+      if (err) return next(err)
+
+      res.json(videos_list)
+    })
+  }
+
+  function searchVideos (req, res, next) {
+    videos.search(req.params.name, function (err, videos_list) {
+      if (err) return next(err)
+
+      res.json(videos_list)
+    })
+  }
+
+  function addVideos (req, res, next) {
+    videos.add({ video: req.files.input_video, data: req.body }, function (err) {
+      if (err) return next(err)
+
+      // TODO : include Location of the new video
+      res.sendStatus(201)
+    })
+  }
+
+  function getVideos (req, res, next) {
+    videos.get(req.params.id, function (err, video) {
+      if (err) return next(err)
+
+      if (video === null) {
+        return res.sendStatus(404)
+      }
+
+      res.json(video)
+    })
+  }
+
+  function removeVideo (req, res, next) {
+    videos.remove(req.params.id, function (err) {
+      if (err) return next(err)
+
+      res.sendStatus(204)
+    })
+  }
+
+  router.get('/', middleware.cache(false), listVideos)
+  router.post('/', middleware.cache(false), addVideos)
+  router.get('/search/:name', middleware.cache(false), searchVideos)
+  router.get('/:id', middleware.cache(false), getVideos)
+  router.delete('/:id', middleware.cache(false), removeVideo)
+
+  module.exports = router
+})()

diff --git a/routes/api/videos.js b/routes/api/videos.js
deleted file mode 100644 (file)
index 087fc96..0000000
--- a/routes/api/videos.js
+++ /dev/null
@@ -1,61 +0,0 @@
-;(function () {
-  'use strict'
-
-  var express = require('express')
-  var router = express.Router()
-  var middleware = require('../../middlewares')
-  var videos = require('../../src/videos')
-
-  function listVideos (req, res, next) {
-    videos.list(function (err, videos_list) {
-      if (err) return next(err)
-
-      res.json(videos_list)
-    })
-  }
-
-  function searchVideos (req, res, next) {
-    videos.search(req.params.name, function (err, videos_list) {
-      if (err) return next(err)
-
-      res.json(videos_list)
-    })
-  }
-
-  function addVideos (req, res, next) {
-    videos.add({ video: req.files.input_video, data: req.body }, function (err) {
-      if (err) return next(err)
-
-      // TODO : include Location of the new video
-      res.sendStatus(201)
-    })
-  }
-
-  function getVideos (req, res, next) {
-    videos.get(req.params.id, function (err, video) {
-      if (err) return next(err)
-
-      if (video === null) {
-        return res.sendStatus(404)
-      }
-
-      res.json(video)
-    })
-  }
-
-  function removeVideo (req, res, next) {
-    videos.remove(req.params.id, function (err) {
-      if (err) return next(err)
-
-      res.sendStatus(204)
-    })
-  }
-
-  router.get('/', middleware.cache(false), listVideos)
-  router.post('/', middleware.cache(false), addVideos)
-  router.get('/search/:name', middleware.cache(false), searchVideos)
-  router.get('/:id', middleware.cache(false), getVideos)
-  router.delete('/:id', middleware.cache(false), removeVideo)
-
-  module.exports = router
-})()

diff --git a/server.js b/server.js
index 96c493f29d9ba9eaae6c1751d1704519c8e0af5f..d3718f8de31b59e99b6e9d98c2523376ab94ef44 100644 (file)
--- a/server.js
+++ b/server.js
@@ -1,6 +1,9 @@
 ;(function () {
   'use strict'
 
+  // ----------- Constantes -----------
+  global.API_VERSION = 'v1'
+
   // ----------- Node modules -----------
   var express = require('express')
   var path = require('path')
@@ -28,7 +31,7 @@
   var config = require('config')
   var logger = require('./src/logger')
   var routes = require('./routes')
-  var api = require('./routes/api')
+  var api = require('./routes/api/' + global.API_VERSION)
   var utils = require('./src/utils')
   var videos = require('./src/videos')
   var webtorrent = require('./src/webTorrentNode')
@@ -88,9 +91,10 @@
   }
 
   // ----------- Routes -----------
-  app.use('/api/videos', api.videos)
-  app.use('/api/remotevideos', api.remoteVideos)
-  app.use('/api/pods', api.pods)
+  var api_route = '/api/' + global.API_VERSION
+  app.use(api_route + '/videos', api.videos)
+  app.use(api_route + '/remotevideos', api.remoteVideos)
+  app.use(api_route + '/pods', api.pods)
 
   // ----------- Tracker -----------
 

diff --git a/src/pods.js b/src/pods.js
index 30d465ee5fbc8ae7451d14f113ddabf75c8cce21..db159a46610372b5d34f1d5266691186aa3ebfac 100644 (file)
--- a/src/pods.js
+++ b/src/pods.js
@@ -18,7 +18,7 @@
   // ----------- Private functions -----------
 
   function getForeignPodsList (url, callback) {
-    var path = '/api/pods'
+    var path = '/api/' + global.API_VERSION + '/pods'
 
     request.get(url + path, function (err, response, body) {
       if (err) throw err
@@ -143,7 +143,7 @@
         logger.debug('Make requests...')
 
         utils.makeMultipleRetryRequest(
-          { method: 'POST', path: '/api/pods/', data: data },
+          { method: 'POST', path: '/api/' + global.API_VERSION + '/pods/', data: data },
 
           pods_list,
 

diff --git a/src/videos.js b/src/videos.js
index 48ec19d4d5df05864abfe850104713f410f31777..f787ae49cddacfec8ba153244d6ea84170806720 100644 (file)
--- a/src/videos.js
+++ b/src/videos.js
@@ -73,7 +73,7 @@
         logger.debug('Sending this video Uri to friends...')
 
         var data = {
-          path: '/api/remotevideos/add',
+          path: '/api/' + global.API_VERSION + '/remotevideos/add',
           method: 'POST',
           data: params
         }
@@ -130,7 +130,7 @@
             }
 
             var data = {
-              path: '/api/remotevideos/remove',
+              path: '/api/' + global.API_VERSION + '/remotevideos/remove',
               method: 'POST',
               data: {
                 magnetUri: video.magnetUri

diff --git a/test/api/friends.js b/test/api/friends.js
index 033d3799a2961b56528efc4ed8f52148e39d3975..845ccd1a8d0ec8e6d461afd22aecccb039ae3d31 100644 (file)
--- a/test/api/friends.js
+++ b/test/api/friends.js
@@ -9,7 +9,7 @@
   var utils = require('../utils')
 
   function getFriendsList (url, end) {
-    var path = '/api/pods/'
+    var path = '/api/v1/pods/'
 
     request(url)
       .get(path)
@@ -75,7 +75,7 @@
         })
       }
 
-      var path = '/api/pods/makefriends'
+      var path = '/api/v1/pods/makefriends'
 
       // The second pod make friend with the third
       request(urls[1])

diff --git a/test/api/multiplePods.js b/test/api/multiplePods.js
index 3b69738f4ebb7352e2431fdf42a8faa4f77c0f59..1edfc1ce3b8c485c8900c6a991779030f5c5e79a 100644 (file)
--- a/test/api/multiplePods.js
+++ b/test/api/multiplePods.js
@@ -11,7 +11,7 @@
   webtorrent.silent = true
 
   describe('Test multiple pods', function () {
-    var path = '/api/videos'
+    var path = '/api/v1/videos'
     var apps = []
     var urls = []
     var video_id = -1
@@ -38,7 +38,7 @@
 
     before(function (done) {
       this.timeout(30000)
-      var path_friends = '/api/pods/makefriends'
+      var path_friends = '/api/v1/pods/makefriends'
 
       utils.runMultipleServers(3, function (apps_run, urls_run) {
         apps = apps_run

diff --git a/test/api/singlePod.js b/test/api/singlePod.js
index 5c4c892bba7221fb78a24f643876e5db57df6c08..bc9243c1c7fb302a926e9a996915157764967fdd 100644 (file)
--- a/test/api/singlePod.js
+++ b/test/api/singlePod.js
@@ -3,6 +3,7 @@
 
   var request = require('supertest')
   var chai = require('chai')
+  var fs = require('fs')
   var expect = chai.expect
   var webtorrent = require(__dirname + '/../../src/webTorrentNode')
   webtorrent.silent = true
@@ -10,7 +11,7 @@
   var utils = require('../utils')
 
   describe('Test a single pod', function () {
-    var path = '/api/videos'
+    var path = '/api/v1/videos'
     var app = null
     var url = ''
     var video_id = -1
@@ -98,7 +99,13 @@
         .expect(204)
         .end(function (err, res) {
           if (err) throw err
-          done()
+
+          fs.readdir(__dirname + '/../../test1/uploads/', function (err, files) {
+            if (err) throw err
+
+            expect(files.length).to.equal(0)
+            done()
+          })
         })
     })