URL Shortener based on Python, Tornado, Redis
apt-get install redis-server
pip install tornado redis hashids
git clone https://github.com/nellessen/tornado-shortener.git
To run a webserver on a given port with a default domain localhost used for short URLs run the following command:
cd tornado-shortener
python app.py --port=80 --domain=localhost
This assumes you have redis listen on the standard port on localhost.
You can change your redis database connection settings with the parameters
redis_host, redis_port and redis_db. And you can also define a namespace
for redis under which all keys will be stored using the parameter redis_namespace.
For every URL shortened by this application a uniquie hash is generated. This hash
is based on the the current day and an incrementing index for the current day.
These two values are used to generate the final hash using hashids. Note that
collisions are prevented even if you run this application in multiple processes
because the the index used is stored and incremented in Redis. If you want the
hashes to be more obscure you can provide a salt as the parameter salt.
By default all URLs and hashes will live forever. If you want you can set a TTL
(time to live) for all URLs as the parameter ttl. Note that this will only
effect new URLs/hashes.
In a real-world scenario you would want to run multiple application process behind a load balancer like nginx. You can find an nginx configuration in conf/nginx.conf as well as a supervisor configuration in conf/supervisord.conf.
Currently there is no support for authentication. Though there is a configurable limit on API calls. All API endpoints return JSON.
Given a shortened URL or hash, returns the target (long) URL.
- shortUrl - refers to one shortened link. e.g.: http://yourshortener.com/aN8gR.
- hash - refers to one URL hash. e.g.: aN8gR.
Either shortUrl or hash must be given as a parameter.
You can only provide one shortUrl or hash.
- short_url - an echo back of the shortUrl request parameter.
- hash - an echo back of the hash request parameter.
- error - indicates there was an error retrieving data for a given shortUrl or hash. An example error is "NOT_FOUND".
- long_url - the URL that the requested short_url or hash points to.
API Address: https://yourshortener.com/
GET /expand?shortUrl=http%3A%2F%2Fyourshortener.com%2FaN8gR
{
"data": {
"expand": [
{
"long_url": "http://yourdomain.com/yourcategorie/2014-04-02/yourtitle/",
"short_url": "http://yourshortener.com/aN8gR",
"hash": "aN8gR",
}
]
},
"status_code": 200,
"status_txt": "OK"
}
Given a long URL, returns a short URL.
- longUrl - a long URL to be shortened (example: http://yourdomain.com/yourcategorie/2014-04-02/yourtitle/).
- domain - (optional) the short domain to use; this can be a custom short domain. The default for this parameter can be configured. Passing a specific domain via this parameter will override the default settings.
Long URLs should be URL-encoded. You can not include a longUrl in the request that has &, ?, #, or other reserved parameters without first encoding it.
- url - the shortened URL.
- hash - an identifier for long_url which is unique.
- global_hash - the same as hash (might change when authentication is implemented)
- long_url - an echo back of the longUrl request parameter. This may not always be equal to the URL requested, as some URL normalization may occur (e.g., due to encoding differences, or case differences in the domain). This long_url will always be functionally identical the the request parameter.
API Address: https://yourshortener.com/
GET /shorten?longUrl=http%3A%2F%2Fyourdomain.com%2Fyourcategorie%2F2014-04-02%2Fyourtitle%2F
{
"data": {
"global_hash": "aN8gR",
"hash": "aN8gR",
"long_url": "http://yourdomain.com/yourcategorie/2014-04-02/yourtitle/",
"url": "http://yourshortener.com/aN8gR"
},
"status_code": 200,
"status_txt": "OK"
}