Add Ruby Faraday target

Based on upstream

Author: pimterry

src/targets/ruby/faraday.js

@@ -0,0 +1,104 @@
+const CodeBuilder = require('../../helpers/code-builder')
+
+module.exports = ({ uriObj, queryObj, method: rawMethod, postData, allHeaders }) => {
+  const code = new CodeBuilder()
+
+  // To support custom methods we check for the supported methods
+  // and if doesn't exist then we build a custom class for it
+  const method = rawMethod.toUpperCase()
+  const methods = [
+    'GET',
+    'POST',
+    'HEAD',
+    'DELETE',
+    'PATCH',
+    'PUT',
+    'OPTIONS',
+    'COPY',
+    'LOCK',
+    'UNLOCK',
+    'MOVE',
+    'TRACE'
+  ]
+
+  if (!methods.includes(method)) {
+    code.push(`# Faraday cannot currently run ${method} requests. Please use another client.`)
+    return code.join()
+  }
+
+  code.push("require 'faraday'")
+  code.blank()
+
+  // Write body to beginning of script
+  if (postData.mimeType === 'application/x-www-form-urlencoded') {
+    if (postData.params) {
+      code.push('data = {')
+      postData.params.forEach(param => {
+        code.push(`  :${param.name} => ${JSON.stringify(param.value)},`)
+      })
+      code.push('}')
+      code.blank()
+    }
+  }
+
+  code.push('conn = Faraday.new(')
+  code.push(`  url: '${uriObj.protocol}//${uriObj.host}',`)
+  if (allHeaders['content-type'] || allHeaders['Content-Type']) {
+    code.push(`  headers: {'Content-Type' => '${allHeaders['content-type'] || allHeaders['Content-Type']}'}`)
+  }
+  code.push(')')
+
+  code.blank()
+  code.push(`response = conn.${method.toLowerCase()}('${uriObj.pathname}') do |req|`)
+
+  const headers = Object.keys(allHeaders)
+  if (headers.length) {
+    headers.forEach(key => {
+      if (key.toLowerCase() !== 'content-type') {
+        code.push("  req.headers['%qs'] = '%qs'", key, allHeaders[key])
+      }
+    })
+  }
+
+  Object.keys(queryObj).forEach(name => {
+    const value = queryObj[name]
+    if (Array.isArray(value)) {
+      code.push(`  req.params['%qs'] = ${JSON.stringify(value)}`, name)
+    } else {
+      code.push("  req.params['%qs'] = '%qs'", name, value)
+    }
+  })
+
+  switch (postData.mimeType) {
+    case 'application/x-www-form-urlencoded':
+      if (postData.params) {
+        code.push('  req.body = URI.encode_www_form(data)')
+      }
+      break
+
+    case 'application/json':
+      if (postData.jsonObj) {
+        code.push(`  req.body = ${JSON.stringify(postData.text)}`)
+      }
+      break
+
+    default:
+      if (postData.text) {
+        code.push(`  req.body = ${JSON.stringify(postData.text)}`)
+      }
+  }
+
+  code.push('end')
+  code.blank()
+  code.push('puts response.status')
+  code.push('puts response.body')
+
+  return code.join()
+}
+
+module.exports.info = {
+  key: 'faraday',
+  title: 'faraday',
+  link: 'https://github.com/lostisland/faraday',
+  description: 'Faraday HTTP client'
+}

src/targets/ruby/index.js

@@ -8,5 +8,6 @@ module.exports = {
     default: 'native'
   },
 
-  native: require('./native')
+  native: require('./native'),
+  faraday: require('./faraday')
 }

test/fixtures/available-targets.json

@@ -330,6 +330,12 @@
         "title": "net::http",
         "link": "http://ruby-doc.org/stdlib-2.2.1/libdoc/net/http/rdoc/Net/HTTP.html",
         "description": "Ruby HTTP client"
+      },
+      {
+        "key": "faraday",
+        "title": "faraday",
+        "link": "https://github.com/lostisland/faraday",
+        "description": "Faraday HTTP client"
       }
     ]
   },

test/fixtures/output/ruby/faraday/application-form-encoded.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+
+data = {
+  :foo => "bar",
+  :hello => "world",
+}
+
+conn = Faraday.new(
+  url: 'http://mockbin.com',
+  headers: {'Content-Type' => 'application/x-www-form-urlencoded'}
+)
+
+response = conn.post('/har') do |req|
+  req.body = URI.encode_www_form(data)
+end
+
+puts response.status
+puts response.body

test/fixtures/output/ruby/faraday/application-json.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+
+conn = Faraday.new(
+  url: 'http://mockbin.com',
+  headers: {'Content-Type' => 'application/json'}
+)
+
+response = conn.post('/har') do |req|
+  req.body = "{\"number\":1,\"string\":\"f\\\"oo\",\"arr\":[1,2,3],\"nested\":{\"a\":\"b\"},\"arr_mix\":[1,\"a\",{\"arr_mix_nested\":{}}],\"boolean\":false}"
+end
+
+puts response.status
+puts response.body

test/fixtures/output/ruby/faraday/compression.rb

@@ -0,0 +1,12 @@
+require 'faraday'
+
+conn = Faraday.new(
+  url: 'http://mockbin.com',
+)
+
+response = conn.get('/har') do |req|
+  req.headers['accept-encoding'] = 'deflate, gzip, br'
+end
+
+puts response.status
+puts response.body

test/fixtures/output/ruby/faraday/cookies.rb

@@ -0,0 +1,12 @@
+require 'faraday'
+
+conn = Faraday.new(
+  url: 'http://mockbin.com',
+)
+
+response = conn.post('/har') do |req|
+  req.headers['cookie'] = 'foo=bar; bar=baz'
+end
+
+puts response.status
+puts response.body

test/fixtures/output/ruby/faraday/custom-method.rb

@@ -0,0 +1 @@
+# Faraday cannot currently run PROPFIND requests. Please use another client.

test/fixtures/output/ruby/faraday/full.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+
+data = {
+  :foo => "bar",
+}
+
+conn = Faraday.new(
+  url: 'http://mockbin.com',
+  headers: {'Content-Type' => 'application/x-www-form-urlencoded'}
+)
+
+response = conn.post('/har') do |req|
+  req.headers['cookie'] = 'foo=bar; bar=baz'
+  req.headers['accept'] = 'application/json'
+  req.params['foo'] = ["bar","baz"]
+  req.params['baz'] = 'abc'
+  req.params['key'] = 'value'
+  req.body = URI.encode_www_form(data)
+end
+
+puts response.status
+puts response.body

test/fixtures/output/ruby/faraday/headers.rb

@@ -0,0 +1,14 @@
+require 'faraday'
+
+conn = Faraday.new(
+  url: 'http://mockbin.com',
+)
+
+response = conn.get('/har') do |req|
+  req.headers['accept'] = 'application/json'
+  req.headers['x-foo'] = 'Bar'
+  req.headers['quoted-value'] = '"quoted" \'string\''
+end
+
+puts response.status
+puts response.body