Node library functionality with tests

Author: Ashwinvalento

README.md

@@ -1,20 +1,74 @@
 
+Node.js cartoon avatar library
+========================
+A library to generate cartoon style avatar URLs in Node.js
 
-# cartoon-avatar
 
+Installation
+-----------
+```sh
+$ npm install cartoon-avatar
+```
 
+Usage
+------
 
-## Usage
+```javascript
+var toonavatar = require('cartoon-avatar');
 
+toonavatar.generate_avatar();
+toonavatar.generate_avatar(options);
 
+```
 
-## Developing
+ `options`:
+ * `Gender` can be `male` or `m` or `female` or `f` .
+ * `id` can be any number within the Range limit specified below. 
+ 
+  ` id Range` for a given gender :
+	* MALE : 129
+	* FEMALE : 114
 
+### Examples
 
+```javascript
 
-### Tools
+var toonavatar = require('cartoon-avatar');
 
-Created with [Nodeclipse](https://github.com/Nodeclipse/nodeclipse-1)
- ([Eclipse Marketplace](http://marketplace.eclipse.org/content/nodeclipse), [site](http://www.nodeclipse.org))   
+var url = toonavatar.generate_avatar()
+//Generates Image URL with random gender avatar.
+//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/female/10.png
+//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/male/86.png
+
+var url = toonavatar.generate_avatar({"gender":"male"})
+//Generates Image URL with random Male avatars
+//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/male/45.png
+
+
+var url = toonavatar.generate_avatar({"gender":"female"})
+//Generates Image URL with random Female avatars
+//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/female/68.png
+
+
+var url = toonavatar.generate_avatar({"gender":"male","id":5})
+//Generates Image URL with Male avatar having id 5
+//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/male/5.png
+
+
+var url = toonavatar.generate_avatar({"gender":"female","id":5})
+//Generates Image URL with Female avatar having id 5
+//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/female/5.png
+
+
+```
+
+##Running test
+
+```sh
+$ npm test
+```
+
+## Avatar Image Credits
+ [People vector designed by Skydesign - Freepik.com](http://www.freepik.com/free-photos-vectors/people).
+ 
 
-Nodeclipse is free open-source project that grows with your contributions.

config.js

@@ -0,0 +1,2 @@
+module.exports.MALE_IMAGE_COUNT = 129;
+module.exports.FEMALE_IMAGE_COUNT = 114;

lib/cartoon-avatar.js

@@ -1,5 +1,52 @@
+var config = require("../config");
 
 var toonavatar = module.exports = {
-		
-		
-};
+	/**
+	 * generate_avatar will generate a cartoon avatar.
+	 * 
+	 * @param {Object}
+	 *            options
+	 * @return {String}
+	 */
+	generate_avatar : function(options) {
+		/*
+		 * options = { "gender": "male" , "id":xxx}
+		 * 
+		 */
+		var baseURL = "https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/";
+		var gender, id;
+		if (typeof options != 'undefined' && options) {
+			if (typeof options.gender === 'undefined') {
+				gender = getRandomInt(0, 1) % 2 ? "male" : "female";
+			} else {
+				gender = getGender(options.gender);
+			}
+
+			if ( typeof options.id === 'undefined') {
+				id = getRandomInt(1,
+						gender === "male" ? config.MALE_IMAGE_COUNT
+								: config.FEMALE_IMAGE_COUNT);
+			} else {
+				id = options.id;
+			}
+		}
+		return baseURL + gender + "/" + id + ".png";
+
+	}
+
+};
+
+function getGender(gender) {
+
+	gender = gender.trim().toLowerCase();
+	if (gender === "male" || gender === "m") {
+		return "male";
+	} else if (gender === "female" || gender === "f") {
+		return "female";
+
+	}
+}
+
+function getRandomInt(min, max) {
+	return Math.floor(Math.random() * (max - min + 1)) + min;
+}

package.json

@@ -4,16 +4,22 @@
   "description": "A Node js library for cartoon style avatars",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node ./node_modules/mocha/bin/mocha -R spec"
   },
   "keywords": [
     "gravatar",
     "avatar",
     "cartoon",
     "avatar",
     "cartoon-avatar",
-    "cartoon-gravatar"
+    "cartoon-gravatar",
+    "toon",
+    "toon avatar"
   ],
   "author": "Ashwin Valento <[email protected]> (https://ashwinvalento.github.io)",
-  "license": "ISC"
+  "license": "ISC",
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "mocha": "^2.5.3"
+  }
 }

test/index.js

@@ -0,0 +1,67 @@
+var should = require('chai').should(),
+	toonavatar = require("../lib/cartoon-avatar");
+
+describe('generate_avatar', function() {
+	var baseURL = "https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/";
+	
+	  it('should generate correct uri given no options', function() {
+		  toonavatar.generate_avatar().should.be.ok;
+	  });
+	  
+	  it('should generate correct uri given gender as male and an id', function() {
+		  toonavatar.generate_avatar({"gender":"male","id":1}).should.equal(baseURL+"male/1.png");
+		  toonavatar.generate_avatar({"gender":"male","id":75}).should.equal(baseURL+"male/75.png");
+		  toonavatar.generate_avatar({"gender":"male","id":129}).should.equal(baseURL+"male/129.png");
+		  toonavatar.generate_avatar({"gender":"male","id":129}).should.not.equal(baseURL+"female/129.png");
+
+		  
+	  });
+	  
+	  it('should generate correct uri given gender as male using shorthand and an id', function() {
+		  toonavatar.generate_avatar({"gender":"m","id":1}).should.equal(baseURL+"male/1.png");
+		  toonavatar.generate_avatar({"gender":"m","id":75}).should.equal(baseURL+"male/75.png");
+		  toonavatar.generate_avatar({"gender":"m","id":129}).should.equal(baseURL+"male/129.png");
+		  toonavatar.generate_avatar({"gender":"m","id":129}).should.not.equal(baseURL+"female/129.png");
+
+		  
+	  });
+	  
+	  it('should generate correct uri given gender as female and an id', function() {
+		  toonavatar.generate_avatar({"gender":"female","id":1}).should.equal(baseURL+"female/1.png");
+		  toonavatar.generate_avatar({"gender":"female","id":75}).should.equal(baseURL+"female/75.png");
+		  toonavatar.generate_avatar({"gender":"female","id":114}).should.equal(baseURL+"female/114.png");
+		  toonavatar.generate_avatar({"gender":"female","id":114}).should.not.equal(baseURL+"male/114.png");
+
+	  });
+	  
+	  it('should generate correct uri given gender as female using shorthand and an id', function() {
+		  toonavatar.generate_avatar({"gender":"f","id":1}).should.equal(baseURL+"female/1.png");
+		  toonavatar.generate_avatar({"gender":"f","id":75}).should.equal(baseURL+"female/75.png");
+		  toonavatar.generate_avatar({"gender":"f","id":114}).should.equal(baseURL+"female/114.png");
+		  toonavatar.generate_avatar({"gender":"f","id":114}).should.not.equal(baseURL+"male/114.png");
+
+	  });
+	  
+	  it('should generate correct uri given gender as male and No id', function() {
+		  toonavatar.generate_avatar({"gender":"male"}).should.have.string("male");
+		  toonavatar.generate_avatar({"gender":"male"}).should.not.have.string("female");
+
+	  });
+	  
+	  it('should generate correct uri given gender as male as shorthand and No id', function() {
+		  toonavatar.generate_avatar({"gender":"m"}).should.have.string("male");
+		  toonavatar.generate_avatar({"gender":"m"}).should.not.have.string("female");
+
+	  });
+	  
+	  it('should generate correct uri given gender as female and No id', function() {
+		  toonavatar.generate_avatar({"gender":"female"}).should.have.string("female");
+
+	  });
+	  
+	  it('should generate correct uri given gender as female as shorthand and No id', function() {
+		  toonavatar.generate_avatar({"gender":"f"}).should.have.string("female");
+
+	  });
+	  
+});