Telegram APIGateway MicroService

Build

build war file with maven-wrapper:

./mvn clean package spring-boot:repackage

then build docker image:

docker build -t telegram-service:v1.0 .

Usage

minimal env variables for start is RABBIT_HOST and TELEGRAM_BOT_TOKEN

run in docker:

docker run -d -e RABBIT_HOST=dummy TELEGRAM_BOT_TOKEN=dummy telegram-service:v1.0

or in docker-compose.yml:

telegram-service:
    image: telegram-service:v1.0
    environment:
        RABBIT_HOST:
        RABBIT_USERNAME:
        RABBIT_PASSWORD:
        RABBIT_QUEUE_RECEIVE:
        RABBIT_QUEUE_TRANSMIT:
        TELEGRAM_BOT_TOKEN:
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8080/actuator/health/livenessState"]
      interval: 10s
      timeout: 10s
      retries: 3
      start_period: 10s
    restart: always

or in kubernetes (telegram-service-deployment.yml):

apiVersion: apps/v1
kind: Deployment
metadata:
  name: telegram-service-deployment
  labels:
    app: telegram-service
spec:
  replicas: 1
  selector:
    matchLabels:
      app: telegram-service
  template:
    metadata:
      labels:
        app: telegram-service
    spec:
      containers:
      - name: telegram-service
        image: telegram-service:v1.0
      env:
      - name: RABBIT_HOST
        value: ""
      - name: RABBIT_USERNAME
        value: ""
      - name: RABBIT_PASSWORD
        value: ""
      - name: RABBIT_QUEUE_RECEIVE
        value: ""
      - name: RABBIT_QUEUE_TRANSMIT
        value: ""
      - name: TELEGRAM_BOT_TOKEN
        value: ""
      startupProbe:
        tcpSocket:
          port: 8080
        initialDelaySeconds: 10
        periodSeconds: 10
        failureThreshold: 3
      livenessProbe:
        httpGet:
          path: /actuator/health/livenessState
          port: 8080
          initialDelaySeconds: 10
          periodSeconds: 30
          failureThreshold: 3

Environment variables

RABBIT_HOST - hostname for RabbitMQ connection (default: localhost).
RABBIT_USERNAME - username for RabbitMQ connection (default: guest).
RABBIT_PASSWORD - password for RabbitMQ connection (default: guest).
RABBIT_QUEUE_RECEIVE - name of the queue from which messages will be sent using the Telegram Service.
RABBIT_QUEUE_TRANSMIT - the name of the queue to which messages from Telegram users will be sent to your service.
TELEGRAM_BOT_TOKEN - Telegram Bot API token.

LOG_LEVEL - debug feature that allows to change root logging level of the application (default: INFO)

Message structure

JSON syntax:

{
    "chatId": 100,
    "payload": ["test message 1", "test message 2"]
}

where:
chatId - Telegram chat id for specific dialog (long);
payload - JSON array of strings (List<String>).

TODO

• Automatic pagination of huge messages!
• Complete about section of repo