new info() method for exposing more info to each traget

ahmadnassri · ahmadnassri · commit 7e0b64723596 · 2015-03-01T18:22:13.000-05:00
diff --git a/README.md b/README.md
@@ -122,7 +122,7 @@ At the heart of this module is the [HAR Request object](http://www.softwareishar
 
 ### Output Targets
 
-output [targets](/src/targets) are simple modules that expose a constructor *(which handles the transformation)* and a utility method `extname` *(used in CLI for writing output into disk)*
+output [targets](/src/targets) are simple modules that expose a constructor *(which handles the transformation)* and a utility `info` method
 
 ```js
 module.exports = function (opts) {
@@ -133,8 +133,14 @@ module.exports = function (opts) {
   // return processed output as string
 };
 
-module.exports.extname = function () {
-  // return preferred filename extention
+module.exports.info = function () {
+  // return target info
+  return {
+    key: 'node',    // target key
+    ext: '.js',     // preferred extension
+    title: '',      // target label
+    description: '' // target description
+  }
 };
 ```
 
diff --git a/bin/httpsnippet b/bin/httpsnippet
@@ -86,7 +86,7 @@ async.waterfall([
 
         var filename = path.format({
           dir: dir,
-          base: name + HTTPSnippet.extname(cmd.target)
+          base: name + HTTPSnippet.info(cmd.target).ext
         });
 
         fs.writeFile(filename, snippets[index]);
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0-beta",
+  "version": "1.0.0-beta.1",
   "name": "httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "main": "./src/index.js",
diff --git a/src/index.js b/src/index.js
@@ -73,6 +73,6 @@ module.exports._targets = function () {
   return Object.keys(targets);
 };
 
-module.exports.extname = function (lang) {
-  return targets[lang].extname();
+module.exports.info = function (lang) {
+  return targets[lang].info();
 };
diff --git a/src/targets/curl.js b/src/targets/curl.js
@@ -42,6 +42,12 @@ module.exports = function (options) {
   return code.join(opts.indent !== false ? ' \\\n' + opts.indent : ' ');
 };
 
-module.exports.extname = function () {
-  return '.sh';
+module.exports.info = function () {
+  return {
+    key: 'curl',
+    ext: '.sh',
+    title: 'cURL',
+    link: 'http://curl.haxx.se/',
+    description: 'curl is a command line tool and library for transferring data with URL syntax'
+  };
 };
diff --git a/src/targets/httpie.js b/src/targets/httpie.js
@@ -105,6 +105,12 @@ module.exports = function (options) {
   return code.join(opts.indent !== false ? ' \\\n' + opts.indent : ' ');
 };
 
-module.exports.extname = function () {
-  return '.sh';
+module.exports.info = function () {
+  return {
+    key: 'httpie',
+    ext: '.sh',
+    title: 'HTTPie',
+    link: 'http://httpie.org/',
+    description: 'a CLI, cURL-like tool for humans'
+  };
 };
diff --git a/src/targets/node.js b/src/targets/node.js
@@ -63,6 +63,12 @@ module.exports = function (options) {
   return code.join('\n');
 };
 
-module.exports.extname = function () {
-  return '.js';
+module.exports.info = function () {
+  return {
+    key: 'node',
+    ext: '.js',
+    title: 'Node.JS',
+    link: 'http://nodejs.org/api/http.html#http_http_request_options_callback',
+    description: 'Node.js native HTTP interface'
+  };
 };
diff --git a/src/targets/php.js b/src/targets/php.js
@@ -102,6 +102,12 @@ module.exports = function (options) {
   return code.join('\n');
 };
 
-module.exports.extname = function () {
-  return '.php';
+module.exports.info = function () {
+  return {
+    key: 'php',
+    ext: '.php',
+    title: 'PHP',
+    link: 'http://php.net/manual/en/book.curl.php',
+    description: 'PHP with libcurl'
+  };
 };
diff --git a/src/targets/wget.js b/src/targets/wget.js
@@ -45,6 +45,12 @@ module.exports = function (options) {
   return code.join(opts.indent !== false ? ' \\\n' + opts.indent : ' ');
 };
 
-module.exports.extname = function () {
-  return '.sh';
+module.exports.info = function () {
+  return {
+    key: 'wget',
+    ext: '.sh',
+    title: 'Wget',
+    link: 'https://www.gnu.org/software/wget/',
+    description: 'a free software package for retrieving files using HTTP, HTTPS'
+  };
 };
diff --git a/test/extname.js b/test/extname.js
diff --git a/test/info.js b/test/info.js
@@ -0,0 +1,16 @@
+'use strict';
+
+var async  = require('async');
+var should = require('should');
+var targets = require('../src/targets');
+
+async.each(Object.keys(targets), function (target) {
+  describe(target + '.info()', function () {
+    it('should have info method', function (done) {
+      targets[target].should.have.property('info');
+      targets[target].info.should.be.a.Function;
+
+      done();
+    });
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "version": "1.0.0-beta",`
	`2`	`+ "version": "1.0.0-beta.1",`
`3`	`3`	`"name": "httpsnippet",`
`4`	`4`	`"description": "HTTP Request snippet generator for most languages",`
`5`	`5`	`"main": "./src/index.js",`