Fix README merge

.gitignore

@@ -3,3 +3,4 @@ skins/*/*.png
 node_modules/
 .DS_Store
 *.rdb
+coverage/

.travis.yml

@@ -2,10 +2,10 @@ language: node_js
 node_js:
   - "0.10"
 notifications:
-  irc: 
+  irc:
     channels:
       - "irc.esper.net#spongy"
     skip_join: true
 services:
   - redis-server
-skip_join: true
+skip_join: true

README.md

@@ -1,4 +1,4 @@
-# Crafatar [![travis](https://api.travis-ci.org/Jake0oo0/Crafatar.svg)](https://travis-ci.org/Jake0oo0/Crafatar/)
+# Crafatar [![travis](https://api.travis-ci.org/Jake0oo0/crafatar.svg)](https://travis-ci.org/Jake0oo0/crafatar/) [![Coverage Status](https://img.shields.io/coveralls/Jake0oo0/crafatar.svg)](https://coveralls.io/r/Jake0oo0/crafatar)
 
 https://crafatar.com
 

app.js

@@ -1,6 +1,5 @@
 var express = require('express');
 var path = require('path');
-var favicon = require('serve-favicon');
 var logger = require('morgan');
 var cookieParser = require('cookie-parser');
 var bodyParser = require('body-parser');
@@ -14,7 +13,6 @@ var app = express();
 app.set('views', path.join(__dirname, 'views'));
 app.set('view engine', 'jade');
 
-app.use(favicon(__dirname + '/public/favicon.ico'));
 app.use(logger('dev'));
 app.use(bodyParser.json());
 app.use(bodyParser.urlencoded({ extended: false }));

clean_images.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# deletes old images on heroku
+# heroku provides only 300 MB available disk space
+
+# number of files to delete (2 files ~ 400B)
+amount="50000" # about 20MB
+
+# max free MB (on /) to trigger deletion
+trigger="50"
+
+available=`df -m / | awk 'NR==2 { print $4 }'` # MB available on /
+if [ "$available" -le "$trigger" ]; then
+  echo "Deleting old images"
+  for file in `ls -1tr "/app/skins/faces" | head -n $amount`; do
+    rm -rf "/app/skins/faces/$file"
+  done
+  for file in `ls -1tr "/app/skins/helms" | head -n $amount`; do
+    rm -rf "/app/skins/helms/$file"
+  done
+  echo "done."
+else
+  echo "More than $trigger MB are available ($available MB), not deleting!"
+fi

modules/cache.js

@@ -2,7 +2,7 @@ var config = require("./config");
 var redis = null;
 var fs = require("fs");
 
-
+// sets up redis connection, calls clear_cache
 function connect_redis() {
   console.log("connecting to redis...");
   if (process.env.REDISCLOUD_URL) {
@@ -13,8 +13,8 @@ function connect_redis() {
     redis = require("redis").createClient();
   }
   redis.on("ready", function() {
-    console.log("Redis connection established. Flushing all data.");
-    redis.flushall();
+    console.log("Redis connection established.");
+    clear_cache();
   });
   redis.on("error", function (err) {
     console.error(err);
@@ -24,7 +24,39 @@ function connect_redis() {
   });
 }
 
+
+// flushes redis, deletes faces + helms
+function clear_cache() {
+  console.log("Flushing redis");
+  redis.flushall();
+  console.log("Deleting all faces + helms...");
+  fs.readdir(config.faces_dir, function(err, files) {
+    if (err) {
+      console.error(err);
+    } else {
+      for (var i in files) {
+        var file = files[i];
+        if (file[0] != ".") {
+          // delete face file
+          fs.unlink(config.faces_dir + file, function(err){
+            if (err) {
+              console.error(err);
+            }
+          });
+          // delete helm file, we assume this exists as well
+          fs.unlink(config.helms_dir + file, function(err){
+            if (err) {
+              console.error(err);
+            }
+          });
+        }
+      }
+    }
+  });
+}
+
 // sets the date of the face file belonging to +hash+ to now
+// the helms file is ignored because we only need 1 file to read/write from
 function update_file_date(hash) {
   if (hash) {
     var path = config.faces_dir + hash + ".png";

modules/helpers.js

@@ -57,6 +57,7 @@ function store_images(uuid, details, callback) {
         }
       } else {
         // profile found, but has no skin
+        cache.save_hash(uuid, null);
         callback(null, null);
       }
     }
@@ -83,9 +84,10 @@ function skin_url(profile) {
 // callback contains error, status, hash
 // the status gives information about how the image was received
 //  -1: error
+//   0: cached as null
 //   1: found on disk
 //   2: profile requested/found, skin downloaded from mojang servers
-//   3: profile requested/found, but it has no skin
+//   3: profile requested/found, but it has not changed or no skin
 function get_image_hash(uuid, callback) {
   cache.get_details(uuid, function(err, details) {
     if (err) {
@@ -102,7 +104,7 @@ function get_image_hash(uuid, callback) {
             callback(err, -1, details && details.hash);
           } else {
             console.log(uuid + " hash: " + hash);
-            callback(null, (hash ? 2 : 3), hash);
+            callback(null, (hash != (details && details.hash) ? 2 : 3), hash);
           }
         });
       }

modules/skins.js

@@ -36,7 +36,7 @@ exp.extract_helm = function(facefile, buffer, outname, callback) {
         if (err) {
           callback(err);
         } else {
-          skin.crop(42, 8, 49, 15, function(err, helm_img) {
+          skin.crop(40, 8, 47, 15, function(err, helm_img) {
             if (err) {
               callback(err);
             } else {

package.json

@@ -4,9 +4,11 @@
   "private": true,
   "author": "Jake0oo0",
   "description": "A NodeJS application to server Minecraft avatars.",
-  "contributors": [{
-    "name": "Jomo"
-  }],
+  "contributors": [
+    {
+      "name": "Jomo"
+    }
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/Jake0oo0/crafatar"
@@ -20,19 +22,21 @@
   ],
   "scripts": {
     "start": "node server.js",
-    "test": "node_modules/.bin/mocha"
+    "test": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"
   },
   "dependencies": {
-    "express": "~4.9.0",
     "body-parser": "~1.8.1",
     "cookie-parser": "~1.3.3",
-    "morgan": "~1.3.0",
-    "serve-favicon": "~2.1.3",
+    "coveralls": "^2.11.2",
     "debug": "~2.0.0",
+    "express": "~4.9.0",
+    "istanbul": "^0.3.2",
     "jade": "~1.6.0",
     "lwip": "0.0.5",
-    "request": "2.45.0",
+    "mocha": "2.0.1",
+    "mocha-lcov-reporter": "0.0.1",
+    "morgan": "~1.3.0",
     "redis": "0.12.1",
-    "mocha": "2.0.1"
+    "request": "2.45.0"
   }
-}
+}

public/stylesheets/style.css

@@ -1,5 +1,8 @@
 body {
-  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
+  font-size: 14px;
+  font-family: "Helvetica Neue", Arial, sans-serif;
+  font-weight: 300;
+  color: #666;
 }
 
 p {
@@ -37,14 +40,42 @@ mark.green {
   padding: 0;
 }
 
+h1, h2, h3, h4, h5, h6 {
+  color: #333;
+  font-weight: normal;
+}
+
+h3 {
+  margin-top: 2em;
+}
+
+h4 {
+  margin-top: 1em;
+}
+
+.center {
+  text-align: center;
+}
+
 .code {
+  display: block;
   font-family: monospace;
   word-wrap: break-word;
+  min-height: 20px;
+  padding: 10px 20px;
+  margin-bottom: 20px;
+  background: #fafafa;
+  border-left: 3px solid;
+  border-radius: 0px 4px 4px 0px;
+  box-shadow: 0 0 1px inset;
 }
+
 .sideface {
   width: 160px;
   height: 160px;
+  display: inline-block;
 }
+
 .sideface.Jake0oo0 {
   background:url("/avatars/2d5aa9cdaeb049189930461fc9b91cc5?size=160");
 }
@@ -60,9 +91,10 @@ mark.green {
 .sideface.Notch {
   background:url("/avatars/069a79f444e94726a5befca90e38aaf5?size=160");
 }
+/* Notch please fid your skin -_-
 .sideface.Notch:hover {
   background:url("/avatars/069a79f444e94726a5befca90e38aaf5?size=160&helm=true");
-}
+}*/
 .sideface.sk89q {
   background:url("/avatars/0ea8eca3dbf647cc9d1ac64551ca975c?size=160");
 }

routes/avatars.js

@@ -4,6 +4,14 @@ var config = require('../modules/config');
 var skins = require('../modules/skins');
 var networking = require('../modules/networking')
 
+var human_status = {
+  0: "none",
+  1: "cached",
+  2: "checked",
+  3: "downloaded",
+  "-1": "error"
+};
+
 /* GET avatar request. */
 router.get('/:uuid.:ext?', function(req, res) {
   var uuid = req.params.uuid;
@@ -25,47 +33,37 @@ router.get('/:uuid.:ext?', function(req, res) {
 
   try {
     helpers.get_avatar(uuid, helm, size, function(err, status, image) {
-      console.log(uuid + " - " + status);
+      console.log(uuid + " - " + human_status[status]);
       if (err) {
         console.error(err);
-        if (image) {
-          console.warn("error occured, image found anyway");
-          sendimage(503, true, image);
-        } else {
-          handle_default(404);
-        }
-      } else if (status == 1 || status == 2) {
-        sendimage(200, status == 1, image);
-      } else if (status === 0 || status == 3) {
-        handle_default(404);
+      }
+      if (image) {
+        sendimage(err ? 503 : 200, status, image);
       } else {
-        console.error("unexpected error/status");
-        console.error("error: " + err);
-        console.error("status: " + status);
-        handle_default(404);
+        handle_default(404, status);
       }
     });
   } catch(e) {
     console.error("Error!");
     console.error(e);
-    handle_default(500);
+    handle_default(500, status);
   }
 
-  function handle_default(status) {
+  function handle_default(http_status, img_status) {
     if (def != "steve" && def != "alex") {
       def = skins.default_skin(uuid);
     }
     skins.resize_img("public/images/" + def + ".png", size, function(err, image) {
-      sendimage(status, true, image);
+      sendimage(http_status, img_status, image);
     });
   }
 
-  function sendimage(status, local, image) {
-    res.writeHead(status, {
+  function sendimage(http_status, img_status, image) {
+    res.writeHead(http_status, {
       'Content-Type': 'image/png',
       'Cache-Control': 'max-age=' + config.browser_cache_time + ', public',
       'Response-Time': new Date() - start,
-      'X-Storage-Type': local ? 'local' : 'downloaded'
+      'X-Storage-Type': human_status[img_status]
     });
     res.end(image);
   }

test/test.js

@@ -7,7 +7,7 @@ var config = require('../modules/config');
 var skins = require('../modules/skins');
 var cache = require("../modules/cache");
 
-var uuids = fs.readFileSync('test/uuids.txt').toString().split("\r\n");
+var uuids = fs.readFileSync('test/uuids.txt').toString().split("\n");
 // Get a random UUID in order to prevent rate limiting
 var uuid = uuids[Math.floor((Math.random() * 200) + 1)];
 
@@ -17,24 +17,37 @@ describe('Avatar Serving', function(){
   });
   describe('UUID', function(){
     it("should be an invalid uuid", function(done){
-      assert.equal(helpers.uuid_valid("invaliduuid"), false);
+      assert.strictEqual(helpers.uuid_valid("invaliduuid"), false);
       done();
     });
     it("should be a valid uuid", function(done){
-      assert.equal(helpers.uuid_valid("0098cb60fa8e427cb299793cbd302c9a"), true);
+      assert.strictEqual(helpers.uuid_valid("0098cb60fa8e427cb299793cbd302c9a"), true);
       done();
     });
+    it("should not exist", function(done){
+      networking.get_profile("00000000000000000000000000000000", function(err, profile) {
+        assert.strictEqual(err, 0);
+        done();
+      });
+    });
+    it("should exist without skin", function(done) {
+      // profile 'Alex'
+      helpers.get_avatar("ec561538f3fd461daff5086b22154bce", false, 160, function(err, status, image) {
+        assert.strictEqual(status, 3);
+        done();
+      });
+    });
   });
   describe('Avatar', function(){
     it("should be downloaded", function(done) {
       helpers.get_avatar(uuid, false, 160, function(err, status, image) {
-        assert.equal(status, 2);
+        assert.strictEqual(status, 2);
         done();
       });
     });
     it("should be local", function(done) {
       helpers.get_avatar(uuid, false, 160, function(err, status, image) {
-        assert.equal(status, 1);
+        assert.strictEqual(status, 1);
         done();
       });
     });
@@ -45,7 +58,7 @@ describe('Avatar Serving', function(){
     });
     it("should be rate limited", function(done) {
       helpers.get_avatar(uuid, false, 160, function(err, status, image) {
-        assert.equal(err, null);
+        assert.strictEqual(err, null);
         done();
       });
     });

views/index.jade

@@ -1,22 +1,22 @@
 extends layout
 
 block content
-  .container(style= "margin-top: 30px;")
+  .container(style= "margin-top: 70px;")
     .row
       .col-md-10
         h1 Crafatar
         hr
         p Welcome to Crafatar, an API for Minecraft's faces!
 
-        h2 API
         hr
+        h2 Documentation
 
         h3 Endpoint
         p
           | Replace 
           mark.green uuid
           |  with a Mojang UUID to get the related head. All images are PNGs.
-        .well.code
+        .code
           | <img src="#{domain}/avatars/
           mark.green uuid
           | ">
@@ -25,11 +25,11 @@ block content
         h4 size
         p The size of the image in pixels, 1 - 512. <br> Default is 160.
         h4 default
-        p The image to be returned when the uuid has no skin. <br> Valid options are 
+        p The image to be returned when the uuid has no skin (404). <br> Valid options are 
           a(href="/avatars/00000000000000000000000000000000?default=steve") steve
           |  or 
           a(href="/avatars/00000000000000000000000000000000?default=alex") alex
-          | .<br> The default is calculated based on the UUID (even = alex, odd = steve)
+          | .<br> The standard value is calculated based on the UUID (even = alex, odd = steve)
         h4 helm
         p Get an avatar with the second (helmet) layer applied. <br> The content of this parameter is ignored
 
@@ -38,22 +38,22 @@ block content
         h4 Response-Time
         p The time, in milliseconds, it took Crafatar to process the request.
         h4 X-Storage-Type
-        p Either 'local' or 'downloaded'. Local means that Crafatar already had the image on disk, while downloaded means that it was retrieved from Mojang's skin servers.
+        ul
+          li <b>none</b>: No external requests. Cached: User has no skin.
+          li <b>cached</b>: No external requests. Skin cached and stored locally.
+          li <b>checked</b>: 1 external request. Skin cached, checked for updates, no skin downloaded.<br>
+          | This happens either when the user has no skin or it didn't change.
+          li <b>downloaded</b>: 2 external requests. Skin changed or unknown, downloaded.
+          li <b>error</b>: This can happen, for example, when Mojang's servers are down. If possible, an outdated image will be served instead.
 
         h3 Examples
         p Get jeb_'s avatar, 160 × 160 pixels
-        img(src="/avatars/853c80ef3c3749fdaa49938b674adae6")
-        .well.code &lt;img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6"&gt;
+        .code &lt;img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6"&gt;
         p Get jeb_'s avatar, 64 × 64 pixels
-        img(src="/avatars/853c80ef3c3749fdaa49938b674adae6?size=64")
-        .well.code &lt;img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6?size=64"&gt;
+        .code &lt;img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6?size=64"&gt;
         p Get jeb_'s helmet avatar, 64 × 64 pixels
-        img(src="/avatars/853c80ef3c3749fdaa49938b674adae6?size=64&helm")
-        .well.code &lt;img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6?size=64&amp;helm"&gt;
-        p Get jeb_'s avatar, 64 × 64 pixels, or fall back to steve if his avatar is not found
-        img(src="/avatars/00000000000000000000000000000000?default=steve&size=64")
-        .well.code &lt;img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6?default=steve&amp;size=64"&gt;
-      .col-md-2
+        .code &lt;img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6?size=64&amp;helm"&gt;
+      .col-md-2.center
         .sideface.redstone_sheep(title="redstone_sheep")
         .sideface.Jake0oo0(title="Jake0oo0")
         .sideface.Notch(title="Notch")

views/layout.jade

@@ -2,15 +2,16 @@ doctype html
 html
   head
     title= title
-    link(rel='stylesheet', href='/stylesheets/style.css')
-    link(rel="icon", type="image/x-icon", href="/favicon.ico")
+    link(rel="icon", sizes="16x16", type="image/png", href="/favicon.png")
     link(href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.0/css/bootstrap.min.css", rel="stylesheet")
-    meta(name="viewport" content="initial-scale=1,maximum-scale=1")
-    //script(src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.0/js/bootstrap.min.js")
+    link(rel='stylesheet', href='/stylesheets/style.css')
+    meta(name="description", content="A Minecraft avatar service with UUID support")
+    meta(name="keywords", content="minecraft, avatar, uuid")
+    meta(name="viewport", content="initial-scale=1,maximum-scale=1")
   body
     a.forkme(href="https://github.com/Jake0oo0/crafatar", target="_blank") Fork me on GitHub
     .navbar.navbar-default.navbar-fixed-top
         .container
           .navbar-header
-            a.navbar-brand(href='/') Crafatar
+            a.navbar-brand(href="#") Crafatar
     block content