diff --git a/docs/data.html b/docs/data.html new file mode 100644 index 0000000..0a70556 --- /dev/null +++ b/docs/data.html @@ -0,0 +1,47 @@ + data.js
Jump To …

data.js

/*
+ * Copyright (C) 2011 by Christopher Johnson
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+exports.ArrayCollection = ArrayCollection;
+
+function ArrayCollection() {
+  this._data = [];
+}
+
+ArrayCollection.prototype = {
+  add : function (o) {
+    this._data[o._id] = o;
+  },
+  
+  remove : function (id) {
+    delete this._data[id];
+  },
+  
+  get : function (id) {
+    var o = this._data[id];
+    if (o === undefined) {
+      throw new Error('Object, ' + id + ', not found');
+    }
+    return o;
+  }
+};
+
+
\ No newline at end of file diff --git a/docs/docco.css b/docs/docco.css new file mode 100644 index 0000000..5aa0a8d --- /dev/null +++ b/docs/docco.css @@ -0,0 +1,186 @@ +/*--------------------- Layout and Typography ----------------------------*/ +body { + font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif; + font-size: 15px; + line-height: 22px; + color: #252519; + margin: 0; padding: 0; +} +a { + color: #261a3b; +} + a:visited { + color: #261a3b; + } +p { + margin: 0 0 15px 0; +} +h1, h2, h3, h4, h5, h6 { + margin: 0px 0 15px 0; +} + h1 { + margin-top: 40px; + } +#container { + position: relative; +} +#background { + position: fixed; + top: 0; left: 525px; right: 0; bottom: 0; + background: #f5f5ff; + border-left: 1px solid #e5e5ee; + z-index: -1; +} +#jump_to, #jump_page { + background: white; + -webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777; + -webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px; + font: 10px Arial; + text-transform: uppercase; + cursor: pointer; + text-align: right; +} +#jump_to, #jump_wrapper { + position: fixed; + right: 0; top: 0; + padding: 5px 10px; +} + #jump_wrapper { + padding: 0; + display: none; + } + #jump_to:hover #jump_wrapper { + display: block; + } + #jump_page { + padding: 5px 0 3px; + margin: 0 0 25px 25px; + } + #jump_page .source { + display: block; + padding: 5px 10px; + text-decoration: none; + border-top: 1px solid #eee; + } + #jump_page .source:hover { + background: #f5f5ff; + } + #jump_page .source:first-child { + } +table td { + border: 0; + outline: 0; +} + td.docs, th.docs { + max-width: 450px; + min-width: 450px; + min-height: 5px; + padding: 10px 25px 1px 50px; + overflow-x: hidden; + vertical-align: top; + text-align: left; + } + .docs pre { + margin: 15px 0 15px; + padding-left: 15px; + } + .docs p tt, .docs p code { + background: #f8f8ff; + border: 1px solid #dedede; + font-size: 12px; + padding: 0 0.2em; + } + .pilwrap { + position: relative; + } + .pilcrow { + font: 12px Arial; + text-decoration: none; + color: #454545; + position: absolute; + top: 3px; left: -20px; + padding: 1px 2px; + opacity: 0; + -webkit-transition: opacity 0.2s linear; + } + td.docs:hover .pilcrow { + opacity: 1; + } + td.code, th.code { + padding: 14px 15px 16px 25px; + width: 100%; + vertical-align: top; + background: #f5f5ff; + border-left: 1px solid #e5e5ee; + } + pre, tt, code { + font-size: 12px; line-height: 18px; + font-family: Monaco, Consolas, "Lucida Console", monospace; + margin: 0; padding: 0; + } + + +/*---------------------- Syntax Highlighting -----------------------------*/ +td.linenos { background-color: #f0f0f0; padding-right: 10px; } +span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; } +body .hll { background-color: #ffffcc } +body .c { color: #408080; font-style: italic } /* Comment */ +body .err { border: 1px solid #FF0000 } /* Error */ +body .k { color: #954121 } /* Keyword */ +body .o { color: #666666 } /* Operator */ +body .cm { color: #408080; font-style: italic } /* Comment.Multiline */ +body .cp { color: #BC7A00 } /* Comment.Preproc */ +body .c1 { color: #408080; font-style: italic } /* Comment.Single */ +body .cs { color: #408080; font-style: italic } /* Comment.Special */ +body .gd { color: #A00000 } /* Generic.Deleted */ +body .ge { font-style: italic } /* Generic.Emph */ +body .gr { color: #FF0000 } /* Generic.Error */ +body .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +body .gi { color: #00A000 } /* Generic.Inserted */ +body .go { color: #808080 } /* Generic.Output */ +body .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +body .gs { font-weight: bold } /* Generic.Strong */ +body .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +body .gt { color: #0040D0 } /* Generic.Traceback */ +body .kc { color: #954121 } /* Keyword.Constant */ +body .kd { color: #954121; font-weight: bold } /* Keyword.Declaration */ +body .kn { color: #954121; font-weight: bold } /* Keyword.Namespace */ +body .kp { color: #954121 } /* Keyword.Pseudo */ +body .kr { color: #954121; font-weight: bold } /* Keyword.Reserved */ +body .kt { color: #B00040 } /* Keyword.Type */ +body .m { color: #666666 } /* Literal.Number */ +body .s { color: #219161 } /* Literal.String */ +body .na { color: #7D9029 } /* Name.Attribute */ +body .nb { color: #954121 } /* Name.Builtin */ +body .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +body .no { color: #880000 } /* Name.Constant */ +body .nd { color: #AA22FF } /* Name.Decorator */ +body .ni { color: #999999; font-weight: bold } /* Name.Entity */ +body .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +body .nf { color: #0000FF } /* Name.Function */ +body .nl { color: #A0A000 } /* Name.Label */ +body .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +body .nt { color: #954121; font-weight: bold } /* Name.Tag */ +body .nv { color: #19469D } /* Name.Variable */ +body .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +body .w { color: #bbbbbb } /* Text.Whitespace */ +body .mf { color: #666666 } /* Literal.Number.Float */ +body .mh { color: #666666 } /* Literal.Number.Hex */ +body .mi { color: #666666 } /* Literal.Number.Integer */ +body .mo { color: #666666 } /* Literal.Number.Oct */ +body .sb { color: #219161 } /* Literal.String.Backtick */ +body .sc { color: #219161 } /* Literal.String.Char */ +body .sd { color: #219161; font-style: italic } /* Literal.String.Doc */ +body .s2 { color: #219161 } /* Literal.String.Double */ +body .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +body .sh { color: #219161 } /* Literal.String.Heredoc */ +body .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +body .sx { color: #954121 } /* Literal.String.Other */ +body .sr { color: #BB6688 } /* Literal.String.Regex */ +body .s1 { color: #219161 } /* Literal.String.Single */ +body .ss { color: #19469D } /* Literal.String.Symbol */ +body .bp { color: #954121 } /* Name.Builtin.Pseudo */ +body .vc { color: #19469D } /* Name.Variable.Class */ +body .vg { color: #19469D } /* Name.Variable.Global */ +body .vi { color: #19469D } /* Name.Variable.Instance */ +body .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/net.html b/docs/net.html new file mode 100644 index 0000000..7227a7e --- /dev/null +++ b/docs/net.html @@ -0,0 +1,139 @@ + net.js
Jump To …

net.js

/*
+ * Copyright (C) 2011 by Christopher Johnson
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+var http = require('http'),
+    _url = require('url'),
+    querystring = require('querystring');

net.request(url, options, callback)

+ +
 url : 'http://www.google.com/search?q=foo'
+ options : {
+   url : 'http://www.google.com/search',
+   data : { q:'foo' },
+   method : 'GET'
+ }
+ callback : function (err, response)
+
+ +

At least one of url or options is required. + A successful callback response will have the following format:

+ +
 response : {
+   statusCode : 200,
+   headers : {},
+   body : '',
+   trailers : {}
+ }
+
var request = exports.request = function (url, options, callback) {
+  if (typeof url === 'object') {
+    callback = options;
+    options = url;
+    url = options.url;
+  } else if (!callback && typeof options === 'function') {
+    callback = options;
+    options = {};
+  }
+  

convert url into an http request

  var parse = _url.parse(url);
+  var params = {
+    host   : parse.hostname,
+    port   : parseInt(parse.port, 10) || 80,
+    method : options.method ? options.method.toUpperCase() : 'GET',
+    path   : parse.pathname
+  };
+  

append the querystring to the url for get requests

  if (params.method === 'GET' && options.data) {
+    var query = querystring.stringify(options.data);
+    if (query) {
+      parse.search = (parse.search ? parse.search + '&' : '?') + query;
+    }
+  }
+  if (parse.search) {
+    params.path += parse.search;
+  }
+  

initialize the http request

  var request = http.request(params, function (response) {
+    callback && readHttpResponse(response, callback);
+  });
+  

add posted data

  if (options.method !== 'GET' && options.data) {
+    var post = querystring.stringify(options.data);
+    request.setHeader('Content-Type', 'application/x-www-form-urlencoded');
+    request.setHeader('Content-Length', post.length);
+    request.write(post);
+  }
+  

commit the request

  request.end();
+};

net.get(url, data, callback)

+ +

Simpler than net.request, get appends +data to the url and initiates an http get.

exports.get = function (url, data, callback) {
+  if (typeof data === 'function') {
+    callback = data;
+    data = null;
+  }
+  request(url, { method: 'GET', data: data }, callback);
+};

net.post(url, data, callback)

+ +

Like net.get, but for http posts

exports.post = function (url, data, callback) {
+  if (typeof data === 'function') {
+    callback = data;
+    data = null;
+  }
+  request(url, { method: 'POST', data: data }, callback);
+};

net.serverTest(server, options, test)

+ +

options is optional.

+ +

Open a new instance of the server. +Send a single test request. +Execute an assertion test against the response.

exports.serverTest = function (server, options, test) {
+  if (!test && typeof options === 'function') {
+    test = options;
+    options = {};
+  }
+  var port = 3000;
+  options.url = 'http://localhost:'+port+'/';
+  server.listen(port, function () {
+    exports.request(options, function (err, response) {
+      server.close();
+      test(err, response);
+    });
+  });
+};

net.readHttpResponse(res, callback)

+ +

Reads all data from an http response, +compiling the body into a single string. +See net.request for the format of a +successful response.

+ +

TODO: failure

var readHttpResponse = exports.readHttpResponse = function (res, callback) {
+  var result = {
+    statusCode : res.statusCode,
+    headers    : res.headers,
+    body       : ''
+  };
+  res.setEncoding('utf8');
+  res.on('data', function (chunk) {
+    result.body += chunk;
+  });
+  res.on('end', function () {
+    result.trailers = res.trailers;
+    callback(null, result);
+  });
+};
+
+
\ No newline at end of file diff --git a/lib/data.js b/lib/data.js index 6e009b4..b81de6e 100644 --- a/lib/data.js +++ b/lib/data.js @@ -1,3 +1,25 @@ +/* + * Copyright (C) 2011 by Christopher Johnson + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + exports.ArrayCollection = ArrayCollection; function ArrayCollection() { diff --git a/lib/net.js b/lib/net.js index 62e18e7..84d3476 100644 --- a/lib/net.js +++ b/lib/net.js @@ -24,43 +24,37 @@ var http = require('http'), _url = require('url'), querystring = require('querystring'); -// net.request(url, options, callback) +// ### net.request(url, options, callback) // -// [url] : 'http://www.google.com/search?q=foo' -// [options] : { -// url : 'http://www.google.com/search', -// data : { q:'foo' }, -// method : 'GET' -// } -// [callback] : function (err, response) +// url : 'http://www.google.com/search?q=foo' +// options : { +// url : 'http://www.google.com/search', +// data : { q:'foo' }, +// method : 'GET' +// } +// callback : function (err, response) // -// Format of response object +// At least one of `url` or `options` is required. +// A successful `callback` response will have the following format: // -// response : { -// statusCode : 200, -// headers : {}, -// body : '', -// trailers : {} -// } -// -// * One of url or options.url is required. -// * Data will be appended to the querystring for GET requests, -// or sent in the request body for all other request methods. +// response : { +// statusCode : 200, +// headers : {}, +// body : '', +// trailers : {} +// } // var request = exports.request = function (url, options, callback) { if (typeof url === 'object') { - // without url, options is required callback = options; options = url; - url = undefined; + url = options.url; } else if (!callback && typeof options === 'function') { - // with url, options are optional callback = options; options = {}; } - // turn the url into a request - url = url || options.url; + // convert url into an http request var parse = _url.parse(url); var params = { host : parse.hostname, @@ -68,7 +62,8 @@ var request = exports.request = function (url, options, callback) { method : options.method ? options.method.toUpperCase() : 'GET', path : parse.pathname }; - // setup the querystring + + // append the querystring to the url for get requests if (params.method === 'GET' && options.data) { var query = querystring.stringify(options.data); if (query) { @@ -79,7 +74,7 @@ var request = exports.request = function (url, options, callback) { params.path += parse.search; } - // initialize the request + // initialize the http request var request = http.request(params, function (response) { callback && readHttpResponse(response, callback); }); @@ -92,10 +87,15 @@ var request = exports.request = function (url, options, callback) { request.write(post); } - // fire the request + // commit the request request.end(); }; +// ### net.get(url, data, callback) +// +// Simpler than `net.request`, `get` appends +// data to the url and initiates an http get. +// exports.get = function (url, data, callback) { if (typeof data === 'function') { callback = data; @@ -104,6 +104,10 @@ exports.get = function (url, data, callback) { request(url, { method: 'GET', data: data }, callback); }; +// ### net.post(url, data, callback) +// +// Like `net.get`, but for http posts +// exports.post = function (url, data, callback) { if (typeof data === 'function') { callback = data; @@ -112,20 +116,22 @@ exports.post = function (url, data, callback) { request(url, { method: 'POST', data: data }, callback); }; +// ### net.serverTest(server, options, test) +// +// `options` is optional. +// +// Open a new instance of the server. +// Send a single test request. +// Execute an assertion test against the response. +// exports.serverTest = function (server, options, test) { - // options is optional if (!test && typeof options === 'function') { test = options; options = {}; } - - // defaults var port = 3000; options.url = 'http://localhost:'+port+'/'; - - // open a new instance of the server server.listen(port, function () { - // send a single test request exports.request(options, function (err, response) { server.close(); test(err, response); @@ -133,6 +139,13 @@ exports.serverTest = function (server, options, test) { }); }; +// ### net.readHttpResponse(res, callback) +// +// Reads all data from an http response, +// compiling the body into a single string. +// See `net.request` for the format of a +// successful response. +// // TODO: failure var readHttpResponse = exports.readHttpResponse = function (res, callback) { var result = { diff --git a/makefile b/makefile index 3aa913d..55c01c0 100644 --- a/makefile +++ b/makefile @@ -3,3 +3,8 @@ test: nodeunit nodeunit: nodeunit test + +docs: docco + +docco: + docco lib/*.js \ No newline at end of file