nurls 0.1.0-alpha

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto

package/.jshintrc

@@ -0,0 +1,18 @@
+{
+  "boss": true,
+  "camelcase": true,
+  "curly": false,
+  "eqeqeq": true,
+  "immed": true,
+  "latedef": true,
+  "laxcomma": true,
+  "maxlen": 100,
+  "newcap": true,
+  "noarg": true,
+  "node": true,
+  "nonew": true,
+  "quotmark": "single",
+  "strict": true,
+  "undef": true,
+  "unused": true
+}

package/.npmignore

@@ -0,0 +1,7 @@
+node_modules/
+npm-debug.log
+
+.DS_Store
+ehthumbs.db
+Icon?
+Thumbs.db

package/.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "0.8"
+  - "0.10"
+before_script:
+  - npm install -g grunt-cli

package/AUTHORS.md

@@ -0,0 +1,3 @@
+# Authors ordered by first contribution
+
+* Alasdair Mercer <mercer.alasdair@gmail.com>

package/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Contributing
+
+Here are some guidelines that we'd like contributors to follow so that we can have a chance of
+keeping things right.
+
+## Getting Starting
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a ticket for your issue if one does not already exist
+  * Clearly describe the issue including steps to reproduce when it is a bug
+  * Include the earliest version that you know has the issue
+* Fork the repository on GitHub
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work
+  * This is usually the master branch
+  * Only target release branches if you are certain your fix must be on that branch
+  * To quickly create a topic branch based on master;
+    `git branch fix/master/my_contribution master` then checkout the new branch with
+    `git checkout fix/master/my_contribution`
+  * Avoid working directly on the `master` branch
+* Make commits of logical units
+* Check for unnecessary whitespace with `git diff --check` before committing
+* Make sure your commit messages are in the proper format
+```
+    (#99999) Make the example in CONTRIBUTING imperative and concrete
+
+    Without this patch applied the example commit message in the CONTRIBUTING document is not a
+    concrete example. This is a problem because the contributor is left to imagine what the commit
+    message should look like based on a description rather than an example. This patch fixes the
+    problem by making the example concrete and imperative.
+
+    The first line is a real life imperative statement with a ticket number from our issue tracker.
+    The body describes the behavior without the patch, why this is a problem, and how the patch
+    fixes the problem when applied.
+```
+* Make sure you have added the necessary tests for your changes
+* Run *all* the tests to assure nothing else was accidentally broken
+
+## Submitting Changes
+
+* Ensure you added your details to `AUTHORS.md` in the correct format
+```
+    * Joe Bloggs <joe.bloggs@example.com>
+```
+* Push your changes to a topic branch in your fork of the repository
+* Submit a pull request to NURLS repository
+* Update your issue to mark that you have submitted code and are ready for it to be reviewed
+  * Include a link to the pull request in the issue
+
+# Additional Resources
+
+* [NURLS repository](https://github.com/NURLS/nurls)
+* [Issue tracker](https://github.com/NURLS/nurls/issues)
+* [General GitHub documentation](http://help.github.com)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests)

package/Gruntfile.js

@@ -0,0 +1,34 @@
+module.exports = function(grunt) {
+
+  // Configuration
+  // -------------
+
+  grunt.initConfig({
+
+      jshint: {
+          all: [
+              'Gruntfile.js'
+            , 'lib/**/*.js'
+            , '<%= nodeunit.tests %>'
+          ]
+        , options: {
+            jshintrc: '.jshintrc'
+          }
+      }
+
+    , nodeunit: {
+        all: ['test/**/*_test.js']
+      }
+
+  });
+
+  // Tasks
+  // -----
+
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+  grunt.loadNpmTasks('grunt-contrib-nodeunit');
+
+  grunt.registerTask('default', ['jshint', 'test']);
+  grunt.registerTask('test', ['nodeunit']);
+
+};

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (C) 2013 Alasdair Mercer, http://nurls.org
+
+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.

package/README.md

@@ -0,0 +1,18 @@
+     __  __  __  __  ____    __       ____
+    /\ \/\ \/\ \/\ \/\  _`\ /\ \     /\  _`\
+    \ \ `\\ \ \ \ \ \ \ \L\ \ \ \    \ \,\L\_\
+     \ \ , ` \ \ \ \ \ \ ,  /\ \ \  __\/_\__ \
+      \ \ \`\ \ \ \_\ \ \ \\ \\ \ \L\ \ /\ \L\ \
+       \ \_\ \_\ \_____\ \_\ \_\ \____/ \ `\____\
+        \/_/\/_/\/_____/\/_/\/ /\/___/   \/_____/
+
+NURLS: **N**ode **URL** **S**hortener
+[![Build Status](https://secure.travis-ci.org/NURLS/nurls.png)](http://travis-ci.org/NURLS/nurls)
+
+> This project is currently a work in progress
+
+## Documentation
+
+The [nurls.org][] website should have all you need to know.
+
+[nurls.org]: http://nurls.org

package/lib/index.js

@@ -0,0 +1,6 @@
+// [NURLS](http://nurls.org)  
+// (c) 2013 Alasdair Mercer  
+// Freely distributable under the MIT license:  
+// <http://nurls.org/license>
+
+module.exports = require('./view');

package/lib/view/app.js

@@ -0,0 +1,90 @@
+// [NURLS](http://nurls.org)  
+// (c) 2013 Alasdair Mercer  
+// Freely distributable under the MIT license:  
+// <http://nurls.org/license>
+
+// Module dependencies
+// -------------------
+
+var int17     = require('int17').create('nurls')
+  , express   = require('express')
+  , validator = require('express-validator');
+
+// Internationalization
+// --------------------
+
+// Initialize the `int17` library.  
+// This is done synchronously to avoid wrapping everything else in one big callback.
+int17.initSync();
+
+// Express
+// -------
+
+// Create the express application.
+var app = module.exports = express();
+
+// Configure the application.
+// TODO: session, view engine, authentication/passport
+app.set('views', __dirname + '/../views');
+app.use(express.static(__dirname + '/../static'));
+app.use(express.logger());
+app.use(express.bodyParser());
+app.use(validator);
+app.use(express.methodOverride());
+app.use(express.cookieParser());
+int17.express(app);
+app.use(app.router);
+
+// Handle errors correctly (i.e. log -> handle client -> handle server).
+app.use(function (err, req, res, next) {
+  console.error(err.stack);
+  next(err);
+});
+app.use(function (err, req, res, next) {
+  if (req.xhr) {
+    res.send(500, { error: int17.get('error_xhr_message') });
+  } else {
+    next(err);
+  }
+});
+app.use(function (err, req, res, next) {
+  res.status(500);
+  res.render('error', {
+    error: {
+        err:     err
+      , header:  int17.get('error_500_header')
+      , message: int17.get('error_500_message')
+    }
+  });
+});
+
+// Show *page not found* view when the router found no matching handlers.
+app.use(function (req, res, next) {
+  res.status(404);
+  res.render('error', {
+    error: {
+        header:  int17.get('error_404_header')
+      , message: int17.get('error_404_message', req.url)
+    }
+  });
+});
+
+// Environment-specific support.
+switch (app.get('env')) {
+  case 'development':
+    app.use(express.errorHandler({
+        dumpExceptions: true
+      , showStack:      true
+    }));
+    break;
+  case 'production':
+    app.use(express.errorHandler());
+    break;
+}
+
+// Open for business.
+// TODO: Derive port from ENV
+var port = 3000;
+app.listen(port, function () {
+  console.log('NURLS listening on port ' + port);
+});

package/lib/view/index.js

@@ -0,0 +1,6 @@
+// [NURLS](http://nurls.org)  
+// (c) 2013 Alasdair Mercer  
+// Freely distributable under the MIT license:  
+// <http://nurls.org/license>
+
+module.exports = require('./app');

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "nurls",
+  "description": "Node URL Shortener",
+  "version": "0.1.0alpha",
+  "homepage": "http://nurls.org",
+  "bugs": {
+    "url": "https://github.com/NURLS/nurls/issues"
+  },
+  "author": {
+    "name": "Alasdair Mercer",
+    "email": "mercer.alasdair@gmail.com",
+    "url": "http://neocotic.com"
+  },
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "http://nurls.org/license"
+    }
+  ],
+  "keywords": [
+    "url",
+    "shortener"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/NURLS/nurls.git"
+  },
+  "dependencies": {
+    "express": "~3.2.2",
+    "express-validator": "~0.3.2",
+    "int17": "~0.2.1",
+    "underscore": "~1.4.4"
+  },
+  "devDependencies": {
+    "grunt": "~0.4.1",
+    "grunt-contrib-jshint": "~0.4.3",
+    "grunt-contrib-nodeunit": "~0.1.2"
+  },
+  "scripts": {
+    "test": "grunt test"
+  },
+  "main": "lib"
+}