Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bugthesystem/reducio
❱ 🐇 URL shortener service is written in Scala using Akka-Http and Redis ❰
https://github.com/bugthesystem/reducio
akka-http redis scala url-shortener
Last synced: about 5 hours ago
JSON representation
❱ 🐇 URL shortener service is written in Scala using Akka-Http and Redis ❰
- Host: GitHub
- URL: https://github.com/bugthesystem/reducio
- Owner: bugthesystem
- License: unlicense
- Created: 2017-11-28T13:12:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T12:18:23.000Z (6 months ago)
- Last Synced: 2025-01-18T18:55:11.156Z (5 days ago)
- Topics: akka-http, redis, scala, url-shortener
- Language: Scala
- Homepage:
- Size: 107 KB
- Stars: 68
- Watchers: 2
- Forks: 5
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ❱ reduc.io ❰
> URL shortener service `http://reduc.io/wuXaq`
[](https://travis-ci.org/ziyasal/reducio) [](https://coveralls.io/github/ziyasal/reducio?branch=master)
## Tech stack
- [Scala](https://www.scala-lang.org/)
- [Akka Http](https://github.com/akka/akka-http)
- [Circe](https://github.com/circe/circe)
- [Redis](https://github.com/antirez/redis)
- [ScalaTest](http://www.scalatest.org/)
- [Specs2](https://github.com/etorreborre/specs2)
- [Mockito](https://github.com/mockito/mockito)
- [Gatling](https://gatling.io/)
## Alternative solutions
We could use following short code gen also:
```
substr(base62(md5(url)), 6) = 62 ^ 6 //unique short urls
```
## Commands
### Run
Run `docker-compose`, it will start `api`, `redis` and will expose api port to host.
```sh
docker-compose up
```
## Sample usage
```sh
# Shorten
curl -i http://localhost:9001 -F "url=https://www.amazon.com/Star-Wars-Battlefront-II-Digital/dp/B072JZZ4XD"
# Call shortened url
for ((i=1;i<=100;i++)); do curl -i "http://localhost:9001/SEwuXHhBQw"; done
# Get Stats
curl -i "http://localhost:9001/stats/?url=https://www.amazon.com/Star-Wars-Battlefront-II-Digital/dp/B072JZZ4XD"
# returns: {"callCount":100}
```
### Create executable
```sh
sbt packageBin
```
### Test
```sh
sbt test
```
#### Gatling Simulation
Simulation users count can be set in `application.conf` in test resources.
```sh
# terminal 1
sbt run
# Run simulation in terminal 2
sbt gatling:test gatling:latestReport
```
### Coverage with Report
```sh
sbt clean coverage test coverageReport
```
## Improvements
- Seperate read and write API's
- Move statistics to different data store and API
- Add DB support by having write master/replicas and have read replicas
- Move hit counts to MapReduce job and generate them from the Web Server logs
- Implement Authentication using JWT authentication protocol with OAuth2 authentication framework
- API Documentation using swagger or similar
- Add Host denyList
- Add Retry policies for `Redis` calls using [Retry](https://github.com/softprops/retry) or similar one
- Add Throttling using [akka-http-contrib](https://github.com/adhoclabs/akka-http-contrib)
- Add Metrics support using [akka-http-metrics](https://github.com/Backline/akka-http-metrics)
z i λ a s a l.