allow URIs in prefix option

Author: gr0uch

README.md

@@ -37,7 +37,7 @@ server.listen(8080)
 
 The `options` object is as follows:
 
-- `prefix`: hyperlink prefix, without leading or trailing slashes. Default: `""` (empty string).
+- `prefix`: hyperlink prefix. If this prefix starts with `/`, then it will rewrite paths relative to the prefix. For example, a prefix valued `/api` will handle requests at that route like `/api/users/1`. Default: `""` (empty string).
 - `inflectType`: pluralize and dasherize the record type name in the URI. Can be Boolean to enable/disable all inflections or an object specifying each type in specific with unreferenced types set to default, ex: `{ faculty: false }`. Default: `true`.
 - `inflectKeys`: camelize the field names per record. Default: `true`.
 - `maxLimit`: maximum number of records to show per page. Default: `1000`.

lib/helpers.js

@@ -60,7 +60,7 @@ function initializeContext (contextRequest, request, response) {
     methodMap[request.method]
 
   // URL rewriting for prefix parameter.
-  if (prefix && request.url.indexOf(prefix) === 0)
+  if ((prefix || '').charAt(0) === '/' && request.url.indexOf(prefix) === 0)
     request.url = request.url.slice(prefix.length)
 
   // Decode URI Component only for the query string.

lib/index.js

@@ -75,10 +75,6 @@ module.exports = Serializer => {
         Object.getOwnPropertyNames(this.recordTypes)
       )
 
-      // Automatically prefix leading slash.
-      if (options.prefix && options.prefix.charAt(0) !== '/')
-        options.prefix = `/${options.prefix}`
-
       const uriTemplate = uriTemplates((options ?
         options.uriTemplate : null) || defaults.uriTemplate)
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "fortune-json-api",
   "description": "JSON API serializer for Fortune.",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "license": "MIT",
   "repository": {
     "type": "git",

test/index.js

@@ -45,6 +45,15 @@ const uncastNumericIdsTest = httpTest.bind(null, {
     ]
   ]
 })
+const prefixTest = httpTest.bind(null, {
+  serializers: [
+    [
+      jsonApi, {
+        prefix: 'https://example.com'
+      }
+    ]
+  ]
+})
 
 
 run((assert, comment) => {
@@ -773,3 +782,14 @@ run((assert, comment) => {
       'content type is correct')
   })
 })
+
+run((assert, comment) => {
+  comment('deserialize prefix')
+  return prefixTest('/', null, response => {
+    assert(response.status === 200, 'status is correct')
+    for (const key in response.body.links) {
+      const value = response.body.links[key]
+      assert(value.indexOf('https://') === 0, 'prefix is correct')
+    }
+  })
+})