mobile-carrier-bot

A bot to access mobile carrier services, currently supports

• Three IE
• TIM
• Iliad

---

🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧 ⚠️ Heavy Work in Progress ⚠️ 🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧

TODO (not in order):

• skeleton, plugins, setup
• architecture docs and diagrams
• healtcheck status/info/env
• expose prometheus metrics via endpoint
• expose JVM metrics via JMX
• scalatest and scalacheck
• codecov or alternatives
• telegram client (polling)
• slack client (webhook)
• scrape at least 2 mobile carrier services to check balance
• (polling) notify for low credits and expiry date
• 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 static site for api
• gitpitch for 5@4 presentation
• constrain all types with refined where possible
• travis
• travis automate publish to dockerhub
• publish to dockerhub
• create deployment k8s chart
• 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
• 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

# 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

# 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

# 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/<DEPLOYMENT_NAME> 8888:8080
http :8888/status

# logs
kubectl logs <POD_NAME> -f