Rename proxy to corsProxy.

Making room for the authProxy option.

Author: RubenVerborgh

README.md

@@ -15,7 +15,7 @@
 - [x] [WebID+TLS Authentication](https://www.w3.org/2005/Incubator/webid/spec/tls/)
 - [x] [Real-time live updates](https://github.com/solid/solid-spec#subscribing) (using WebSockets)
 - [x] Identity provider for WebID
-- [x] Proxy for cross-site data access
+- [x] CORS proxy for cross-site data access
 - [ ] Group members in ACL
 - [x] Email account recovery
 
@@ -154,7 +154,7 @@ $ solid start --help
     --ssl-key [value]       Path to the SSL private key in PEM format
     --ssl-cert [value]      Path to the SSL certificate key in PEM format
     --idp                   Enable multi-user mode (users can sign up for accounts)
-    --proxy [value]         Serve proxy on path (default: '/proxy')
+    --corsProxy [value]     Serve the CORS proxy on this path
     --file-browser [value]  Url to file browser app (uses Warp by default)
     --data-browser          Enable viewing RDF resources using a default data browser application (e.g. mashlib)
     --suffix-acl [value]    Suffix for acl files (default: '.acl')
@@ -198,7 +198,7 @@ default settings.
   mount: '/', // Where to mount Linked Data Platform
   webid: false, // Enable WebID+TLS authentication
   suffixAcl: '.acl', // Suffix for acl files
-  proxy: false, // Where to mount the proxy
+  corsProxy: false, // Where to mount the CORS proxy
   errorHandler: false, // function(err, req, res, next) to have a custom error handler
   errorPages: false // specify a path where the error pages are
 }

bin/lib/options.js

@@ -135,17 +135,22 @@ module.exports = [
   //   help: 'URI to use as a default app for resources (default: https://linkeddata.github.io/warp/#/list/)'
   // },
   {
-    name: 'useProxy',
+    name: 'useCorsProxy',
     help: 'Do you want to have a CORS proxy endpoint?',
     flag: true,
     prompt: true,
     hide: true
   },
   {
     name: 'proxy',
-    help: 'Serve proxy on path',
+    help: 'Obsolete; use --corsProxy',
+    prompt: false
+  },
+  {
+    name: 'corsProxy',
+    help: 'Serve the CORS proxy on this path',
     when: function (answers) {
-      return answers.useProxy
+      return answers.useCorsProxy
     },
     default: '/proxy',
     prompt: true

lib/create-app.js

@@ -7,7 +7,7 @@ const uuid = require('uuid')
 const cors = require('cors')
 const LDP = require('./ldp')
 const LdpMiddleware = require('./ldp-middleware')
-const proxy = require('./handlers/proxy')
+const corsProxy = require('./handlers/cors-proxy')
 const SolidHost = require('./models/solid-host')
 const AccountManager = require('./models/account-manager')
 const vhost = require('vhost')
@@ -54,7 +54,12 @@ function createApp (argv = {}) {
 
   // Adding proxy
   if (argv.proxy) {
-    proxy(app, argv.proxy)
+    console.error('The proxy configuration option has been renamed to corsProxy.')
+    argv.corsProxy = argv.proxy
+    delete argv.proxy
+  }
+  if (argv.corsProxy) {
+    corsProxy(app, argv.corsProxy)
   }
 
   // Options handler

lib/handlers/proxy.js lib/handlers/cors-proxy.jslib/handlers/proxy.js renamed to lib/handlers/cors-proxy.js

@@ -75,8 +75,8 @@ class LDP {
       this.skin = true
     }
 
-    if (this.proxy && this.proxy[ 0 ] !== '/') {
-      this.proxy = '/' + this.proxy
+    if (this.corsProxy && this.corsProxy[ 0 ] !== '/') {
+      this.corsProxy = '/' + this.corsProxy
     }
 
     debug.settings('Server URI: ' + this.serverUri)

lib/ldp.js

@@ -6,10 +6,10 @@ var async = require('async')
 
 var ldnode = require('../../index')
 
-describe('proxy', () => {
+describe('CORS Proxy', () => {
   var ldp = ldnode({
     root: path.join(__dirname, '../resources'),
-    proxy: '/proxy',
+    corsProxy: '/proxy',
     webid: false
   })
   var server = supertest(ldp)