feat(target/http) add raw HTTP request string (RFC 7230) (#99)

* feat(option) default autoContentLength to true
* test(fixtures) add test fixtures

Author: irvinlim

src/targets/http/http1.1.js

@@ -0,0 +1,99 @@
+/**
+ * @description
+ * HTTP code snippet generator to generate raw HTTP/1.1 request strings,
+ * in accordance to the RFC 7230 (and RFC 7231) specifications.
+ *
+ * @author
+ * @irvinlim
+ *
+ * For any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+
+'use strict'
+
+var CRLF = '\r\n'
+var CodeBuilder = require('../../helpers/code-builder')
+var util = require('util')
+
+/**
+ * Request follows the request message format in accordance to RFC 7230, Section 3.
+ * Each section is prepended with the RFC and section number.
+ * See more at https://tools.ietf.org/html/rfc7230#section-3.
+ */
+module.exports = function (source, options) {
+  var opts = Object.assign(
+    {
+      absoluteURI: false,
+      autoContentLength: true,
+      autoHost: true
+    },
+    options
+  )
+
+  // RFC 7230 Section 3. Message Format
+  // All lines have no indentation, and should be terminated with CRLF.
+  var code = new CodeBuilder('', CRLF)
+
+  // RFC 7230 Section 5.3. Request Target
+  // Determines if the Request-Line should use 'absolute-form' or 'origin-form'.
+  // Basically it means whether the "http://domain.com" will prepend the full url.
+  var requestUrl = opts.absoluteURI ? source.fullUrl : source.uriObj.path
+
+  // RFC 7230 Section 3.1.1. Request-Line
+  code.push('%s %s %s', source.method, requestUrl, source.httpVersion)
+
+  // RFC 7231 Section 5. Header Fields
+  Object.keys(source.allHeaders).forEach(function (key) {
+    // Capitalize header keys, even though it's not required by the spec.
+    var keyCapitalized = key.toLowerCase().replace(/(^|-)(\w)/g, function (x) {
+      return x.toUpperCase()
+    })
+
+    code.push(
+      '%s',
+      util.format('%s: %s', keyCapitalized, source.allHeaders[key])
+    )
+  })
+
+  // RFC 7230 Section 5.4. Host
+  // Automatically set Host header if option is on and on header already exists.
+  if (opts.autoHost && Object.keys(source.allHeaders).indexOf('host') === -1) {
+    code.push('Host: %s', source.uriObj.host)
+  }
+
+  // RFC 7230 Section 3.3.3. Message Body Length
+  // Automatically set Content-Length header if option is on, postData is present and no header already exists.
+  if (
+    opts.autoContentLength &&
+    source.postData.text &&
+    Object.keys(source.allHeaders).indexOf('content-length') === -1
+  ) {
+    code.push(
+      'Content-Length: %d',
+      Buffer.byteLength(source.postData.text, 'ascii')
+    )
+  }
+
+  // Add extra line after header section.
+  code.blank()
+
+  // Separate header section and message body section.
+  var headerSection = code.join()
+  var messageBody = ''
+
+  // RFC 7230 Section 3.3. Message Body
+  if (source.postData.text) {
+    messageBody = source.postData.text
+  }
+
+  // RFC 7230 Section 3. Message Format
+  // Extra CRLF separating the headers from the body.
+  return headerSection + CRLF + messageBody
+}
+
+module.exports.info = {
+  key: '1.1',
+  title: 'HTTP/1.1',
+  link: 'https://tools.ietf.org/html/rfc7230',
+  description: 'HTTP/1.1 request string in accordance with RFC 7230'
+}

src/targets/http/index.js

@@ -0,0 +1,12 @@
+'use strict'
+
+module.exports = {
+  info: {
+    key: 'http',
+    title: 'HTTP',
+    extname: '',
+    default: '1.1'
+  },
+
+  '1.1': require('./http1.1')
+}

src/targets/index.js

@@ -5,6 +5,7 @@ module.exports = {
   clojure: require('./clojure'),
   csharp: require('./csharp'),
   go: require('./go'),
+  http: require('./http'),
   java: require('./java'),
   javascript: require('./javascript'),
   node: require('./node'),

test/fixtures/available-targets.json

@@ -137,7 +137,7 @@
     "extname": ".m",
     "default": "nsurlsession",
     "clients": [
-       {
+      {
         "key": "nsurlsession",
         "title": "NSURLSession",
         "link": "https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html",
@@ -151,7 +151,7 @@
     "extname": ".swift",
     "default": "nsurlsession",
     "clients": [
-       {
+      {
         "key": "nsurlsession",
         "title": "NSURLSession",
         "link": "https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html",
@@ -165,7 +165,7 @@
     "extname": ".go",
     "default": "native",
     "clients": [
-       {
+      {
         "key": "native",
         "title": "NewRequest",
         "link": "http://golang.org/pkg/net/http/#NewRequest",
@@ -268,5 +268,19 @@
         "title": "Invoke-RestMethod"
       }
     ]
+  },
+  {
+    "default": "1.1",
+    "extname": "",
+    "key": "http",
+    "title": "HTTP",
+    "clients": [
+      {
+        "description": "HTTP/1.1 request string in accordance with RFC 7230",
+        "key": "1.1",
+        "link": "https://tools.ietf.org/html/rfc7230",
+        "title": "HTTP/1.1"
+      }
+    ]
   }
 ]

test/fixtures/output/http/1.1/application-form-encoded

@@ -0,0 +1,6 @@
+POST /har HTTP/1.1
+Content-Type: application/x-www-form-urlencoded
+Host: mockbin.com
+Content-Length: 19
+
+foo=bar&hello=world

test/fixtures/output/http/1.1/application-json

@@ -0,0 +1,6 @@
+POST /har HTTP/1.1
+Content-Type: application/json
+Host: mockbin.com
+Content-Length: 118
+
+{"number":1,"string":"f\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}

test/fixtures/output/http/1.1/cookies

@@ -0,0 +1,5 @@
+POST /har HTTP/1.1
+Cookie: foo=bar; bar=baz
+Host: mockbin.com
+
+

test/fixtures/output/http/1.1/custom-method

@@ -0,0 +1,4 @@
+PROPFIND /har HTTP/1.1
+Host: mockbin.com
+
+

test/fixtures/output/http/1.1/full

@@ -0,0 +1,8 @@
+POST /har?foo=bar&foo=baz&baz=abc&key=value HTTP/1.1
+Cookie: foo=bar; bar=baz
+Accept: application/json
+Content-Type: application/x-www-form-urlencoded
+Host: mockbin.com
+Content-Length: 7
+
+foo=bar

test/fixtures/output/http/1.1/headers

@@ -0,0 +1,6 @@
+GET /har HTTP/1.1
+Accept: application/json
+X-Foo: Bar
+Host: mockbin.com
+
+