Merge pull request #25 from manosim/link-encodings

Link / Encoding

lib/codecs/corejson.js

@@ -83,7 +83,7 @@ function primitiveToNode (data, baseUrl) {
       let field = new document.Field(name, required, location, fieldDescription)
       fields.push(field)
     }
-    return new document.Link(url, method, fields, title, description)
+    return new document.Link(url, method, 'application/json', fields, title, description)
   } else if (isObject) {
     // Object
     let content = {}

lib/document.js

@@ -8,7 +8,7 @@ class Document {
 }
 
 class Link {
-  constructor (url, method, fields = [], title = '', description = '') {
+  constructor (url, method, encoding = 'application/json', fields = [], title = '', description = '') {
     if (url === undefined) {
       throw new Error('url argument is required')
     }
@@ -19,6 +19,7 @@ class Link {
 
     this.url = url
     this.method = method
+    this.encoding = encoding
     this.fields = fields
     this.title = title
     this.description = description

lib/transports/http.js

@@ -63,9 +63,29 @@ class HTTPTransport {
     }
 
     let options = {method: method, headers: {}}
+
     if (hasBody) {
-      options.body = JSON.stringify(formParams)
-      options.headers['Content-Type'] = 'application/json'
+      if (link.encoding === 'application/json') {
+        options.body = JSON.stringify(formParams)
+        options.headers = {
+          'Content-Type': 'application/json'
+        }
+      } else if (link.encoding === 'multipart/form-data') {
+        // FIXME!
+      } else if (link.encoding === 'application/x-www-form-urlencoded') {
+        var formBody = []
+        for (var paramKey in formParams) {
+          var encodedKey = encodeURIComponent(paramKey)
+          var encodedValue = encodeURIComponent(formParams[paramKey])
+          formBody.push(encodedKey + '=' + encodedValue)
+        }
+        formBody = formBody.join('&')
+
+        options.body = formBody
+        options.headers = {
+          'Content-Type': 'application/x-www-form-urlencoded'
+        }
+      }
     }
 
     if (this.csrf) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "coreapi",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "Javascript client library for Core API",
   "main": "lib/index.js",
   "scripts": {

tests/__helpers__/utils.js

@@ -29,17 +29,17 @@ const mockedFetch = function (responseBody, contentType, statusCode = 200) {
 
 const echo = function (url, options = {}) {
   const method = options.method
-  const headers = JSON.stringify(options.headers)
+  const headers = options.headers
   const body = options.body
 
   return new Promise((resolve, reject) => {
     const textPromise = () => {
       return new Promise((resolve, reject) => {
         let result
         if (body) {
-          result = `{"url": "${url}", "method": "${method}", "headers": ${headers}, "body": ${body}}`
+          result = JSON.stringify({url: url, method: method, headers: headers, body: body})
         } else {
-          result = `{"url": "${url}", "method": "${method}", "headers": ${headers}}`
+          result = JSON.stringify({url: url, method: method, headers: headers})
         }
         process.nextTick(
           resolve(result)

tests/codecs/corejson.js

@@ -35,7 +35,7 @@ describe('Test the CoreJSON Codec', function () {
     const node = codec.decode(text)
 
     expect(node instanceof document.Document).toBeTruthy()
-    expect(node.content).toEqual({link: new document.Link('http://example.com/', 'get', [new document.Field('page', false, 'query')])})
+    expect(node.content).toEqual({link: new document.Link('http://example.com/', 'get', 'application/json', [new document.Field('page', false, 'query')])})
   })
 
   it('should test decoding a document (including a nested link)', function () {

tests/transports/http.js

@@ -27,6 +27,36 @@ describe('Test the HTTPTransport', function () {
       .then(res => expect(res).toEqual({text: 'Hello, world'}))
   })
 
+  xit('should check the action function of an HTTP transport (multipart/form-data)', function () {
+    const url = 'http://www.example.com/'
+    const link = new document.Link(url, 'get', 'multipart/form-data')
+    const transport = new transports.HTTPTransport(testUtils.mockedFetch('{"text": "Hello, world"}', 'application/json'))
+
+    return transport.action(link, decoders)
+      .then(res => expect(res).toEqual({text: 'Hello, world'}))
+  })
+
+  it('should check the action function of an HTTP transport (application/x-www-form-urlencoded)', function () {
+    const url = 'http://www.example.com/'
+    const fields = [new document.Field('firstField', true, 'form'), new document.Field('secondField', true, 'form')]
+    const link = new document.Link(url, 'post', 'application/x-www-form-urlencoded', fields)
+    const transport = new transports.HTTPTransport(null, testUtils.echo)
+    const params = {
+      firstField: 'hello',
+      secondField: 'world'
+    }
+
+    return transport.action(link, decoders, params)
+      .then(res => expect(res).toEqual({
+        url: 'http://www.example.com/',
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/x-www-form-urlencoded'
+        },
+        body: 'firstField=hello&secondField=world'
+      }))
+  })
+
   it('should check the action function of an HTTP transport (network fail)', function () {
     const url = 'http://www.example.com/'
     const link = new document.Link(url, 'get')
@@ -42,7 +72,7 @@ describe('Test the HTTPTransport', function () {
   it('should check the action function of an HTTP transport (json) with query params', function () {
     const url = 'http://www.example.com/'
     const fields = [new document.Field('page', false, 'query')]
-    const link = new document.Link(url, 'get', fields)
+    const link = new document.Link(url, 'get', 'application/json', fields)
     const transport = new transports.HTTPTransport(null, testUtils.echo)
     const params = {
       page: 23
@@ -57,7 +87,7 @@ describe('Test the HTTPTransport', function () {
   it('should check the action function of an HTTP transport (json) with path params', function () {
     const url = 'http://www.example.com/{user}/'
     const fields = [new document.Field('user', true, 'path')]
-    const link = new document.Link(url, 'get', fields)
+    const link = new document.Link(url, 'get', 'application/json', fields)
     const transport = new transports.HTTPTransport(null, testUtils.echo)
     const params = {
       user: 23
@@ -107,37 +137,37 @@ describe('Test the HTTPTransport', function () {
   it('should check the action function of an HTTP transport (json) with post request and form parameters', function () {
     const url = 'http://www.example.com/'
     const fields = [new document.Field('hello', true, 'form')]
-    const link = new document.Link(url, 'post', fields)
+    const link = new document.Link(url, 'post', 'application/json', fields)
     const transport = new transports.HTTPTransport(null, testUtils.echo)
     const params = {
       hello: 'world'
     }
 
     return transport.action(link, decoders, params)
       .then((res) => {
-        expect(res).toEqual({url: 'http://www.example.com/', method: 'POST', headers: {'Content-Type': 'application/json'}, body: {hello: 'world'}})
+        expect(res).toEqual({url: 'http://www.example.com/', method: 'POST', headers: {'Content-Type': 'application/json'}, body: JSON.stringify({hello: 'world'})})
       })
   })
 
   it('should check the action function of an HTTP transport (json) with post request and a body parameter', function () {
     const url = 'http://www.example.com/'
     const fields = [new document.Field('hello', true, 'body')]
-    const link = new document.Link(url, 'post', fields)
+    const link = new document.Link(url, 'post', 'application/json', fields)
     const transport = new transports.HTTPTransport(null, testUtils.echo)
     const params = {
       hello: 'world'
     }
 
     return transport.action(link, decoders, params)
       .then((res) => {
-        expect(res).toEqual({url: 'http://www.example.com/', method: 'POST', headers: {'Content-Type': 'application/json'}, body: 'world'})
+        expect(res).toEqual({url: 'http://www.example.com/', method: 'POST', headers: {'Content-Type': 'application/json'}, body: JSON.stringify('world')})
       })
   })
 
   it('should check the action function of an HTTP transport (json) with missing optional query params', function () {
     const url = 'http://www.example.com/'
     const fields = [new document.Field('page', false, 'query')]
-    const link = new document.Link(url, 'get', fields)
+    const link = new document.Link(url, 'get', 'application/json', fields)
     const transport = new transports.HTTPTransport(null, testUtils.echo)
     const params = {}
 
@@ -150,7 +180,7 @@ describe('Test the HTTPTransport', function () {
   it('should check the action function of an HTTP transport (json) with missing required parameter', function () {
     const url = 'http://www.example.com/{user}/'
     const fields = [new document.Field('user', true, 'path')]
-    const link = new document.Link(url, 'get', fields)
+    const link = new document.Link(url, 'get', 'application/json', fields)
     const transport = new transports.HTTPTransport(null, testUtils.echo)
     const params = {}