Shorty

URL shortening service like bit.ly implement with Sithara and Redis

API Documentation

POST /shorten

{
  "url": "http://example.com",
  "shortcode": "example"
}

Attribute	Description
url	url to shorten
shortcode	preferential shortcode

Returns:

201 Created
Content-Type: "application/json"

{
  "shortcode": :shortcode
}

A random shortcode is generated if none is requested, the generated short code has exactly 6 alpahnumeric characters and passes the following regexp: ^[0-9a-zA-Z_]{6}$.

Errors:

Error	Description
400	url is not present
409	The desired shortcode is already in use. Shortcodes are case-sensitive.
422	The shortcode fails to meet the following regexp: ^[0-9a-zA-Z_]{4,}$.

GET /:shortcode

GET /:shortcode
Content-Type: "application/json"

Attribute	Description
shortcode	url encoded shortcode

Returns

302 response with the location header pointing to the shortened URL

HTTP/1.1 302 Found
Location: http://www.example.com

Errors

Error	Description
404	The shortcode is not found in the system

GET /:shortcode/stats

GET /:shortcode/stats
Content-Type: "application/json"

Attribute	Description
shortcode	url encoded shortcode

Returns

200 OK
Content-Type: "application/json"

{
  "startDate": "2012-04-23T18:25:43.511Z",
  "lastSeenDate": "2012-04-23T18:25:43.511Z",
  "redirectCount": 1
}

Attribute	Description
startDate	date when the url was encoded, conformant to ISO8601
redirectCount	number of times the endpoint GET /shortcode was called
lastSeenDate	date of the last time the a redirect was issued, not present if redirectCount == 0

Errors

Error	Description
404	The shortcode cannot be found in the system

Setup

All commands need to be run from the project folder.

$ ./setup.sh
$ bundle install

* change the setup.sh file permissions accordingly, if it shows 'Permission denied' while running.

Run

$ ruby app/service.rb. The app will running in http://localhost:4567

Tests

$ rspec

That's it. :-)