https://github.com/niqdev/mobile-carrier-bot
[WIP] Scala FP bot deployed on k8s
https://github.com/niqdev/mobile-carrier-bot
cats cats-effect circe ciris doobie enumeratum fs2 http4s kubernetes monocle refined scala-scraper telegram-bot
Last synced: 16 days ago
JSON representation
[WIP] Scala FP bot deployed on k8s
- Host: GitHub
- URL: https://github.com/niqdev/mobile-carrier-bot
- Owner: niqdev
- Created: 2019-03-18T14:19:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-20T20:45:30.000Z (over 5 years ago)
- Last Synced: 2025-05-16T01:09:50.386Z (about 1 month ago)
- Topics: cats, cats-effect, circe, ciris, doobie, enumeratum, fs2, http4s, kubernetes, monocle, refined, scala-scraper, telegram-bot
- Language: Scala
- Homepage:
- Size: 162 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mobile-carrier-bot
[![Build Status][travis-image]][travis-url]
[travis-image]: https://travis-ci.org/niqdev/mobile-carrier-bot.svg?branch=master
[travis-url]: https://travis-ci.org/niqdev/mobile-carrier-bot
A bot to access mobile carrier services, currently supports
* [x] Three IE
* [x] TIM
* [ ] Iliad
---
:construction::construction::construction::construction::construction::construction::construction::construction::construction::construction:
:warning: **Heavy Work in Progress** :warning:
:construction::construction::construction::construction::construction::construction::construction::construction::construction::construction:
*TODO (not in order):*
- [x] skeleton, plugins, setup
- [ ] architecture docs and diagrams
- [x] healtcheck status/info/env
- [ ] expose prometheus metrics via endpoint
- [ ] expose JVM metrics via JMX
- [ ] scalatest and scalacheck
- [ ] codecov or alternatives
- [x] telegram client (polling)
- [ ] slack client (webhook)
- [x] scrape at least 2 mobile carrier services to check balance
- [ ] (polling) notify for low credits and expiry date
- [x] in-memory db with Ref
- [ ] doobie db with PostgreSQL and H2
- [ ] if/how store credentials in a safe way
- [ ] authenticated endpoints as alternative to telegram/slack
- [ ] write pure FP lib alternative to scala-scraper and jsoup (I will never do this!)
- [ ] fix scalastyle and scalafmt
- [ ] [slate](https://lord.github.io/slate) static site for api
- [ ] [gitpitch](https://gitpitch.com) for 5@4 presentation
- [ ] constrain all types with refined where possible
- [x] travis
- [ ] travis automate publish to dockerhub
- [x] publish to dockerhub
- [x] create deployment k8s chart
- [x] create argocd app
- [ ] statefulset with PostgreSQL
- [ ] alerting with prometheus to slack
- [ ] grafana dashboard
- [ ] backup/restore logs and metrics even if re-create cluster
- [ ] generate and publish scaladoc
- [x] fix manual Circe codecs with withSnakeCaseMemberNames config
- [ ] add gatling stress tests
- [ ] add integration tests
- [ ] manage secrets in k8s
---
## Endpoints
```
# healt checks
http :8080/status
http :8080/info
http :8080/env
```
## Development
```bash
# test
sbt test -jvm-debug 5005
sbt "test:testOnly *HealthCheckEndpointsSpec"
sbt "test:testOnly *HealthCheckEndpointsSpec -- -z statusEndpoint"
# run with default
TELEGRAM_API_TOKEN=123:xyz sbt app/run
```
### sbt aliases
* `checkFormat` checks format
* `format` formats sources
* `update` checks outdated dependencies
* `build` checks format and runs tests
### Other sbt plugins
* `dependencyTree` shows project dependencies
## Deployment
* [dockerhub](https://hub.docker.com/u/niqdev)
```bash
# build image
sbt clean docker:publishLocal
# run temporary container
docker run \
--rm \
--name mobile-carrier-bot \
niqdev/mobile-carrier-bot-app:0.1
# access container
docker exec -it mobile-carrier-bot bash
# publish
docker login
docker tag niqdev/mobile-carrier-bot-app:0.1 niqdev/mobile-carrier-bot-app:latest
docker push niqdev/mobile-carrier-bot-app:latest
```
### Charts
* [Docs](https://helm.sh/docs/developing_charts/#charts)
```bash
# print chart
helm template -f charts/app/values.yaml charts/app/
# apply chart
helm template -f charts/app/values.yaml charts/app/ | kubectl apply -f -
# verify healtcheck
kubectl port-forward deployment/ 8888:8080
http :8888/status
# logs
kubectl logs -f
```