Skip to content

xzima/telegraff

 
 

Repository files navigation

Telegraff

Подключение

repositories {
    maven {
        url "https://dl.bintray.com/ruslanys/maven"
    }
}

Gradle:

compile("me.ruslanys.telegraff:telegraff-starter:1.0.0")

Maven:

<dependency>
    <groupId>me.ruslanys.telegraff</groupId>
    <artifactId>telegraff-starter</artifactId>
    <version>1.0.0</version>
</dependency>

Сборка

Локальная сборка

./mvnw clean install

Локальная сборка без тестов

./mvnw clean install -DskipTests

Релиз

./mvnw release:prepare  # проверка релиза, обновление версий на релиз, создание тега, обновление версии на следующий snapshot
## отправка релиза с тегом в github
## указать в pom.xml в fromRef и toRef значения предыдущего и нового релизов соответственно
./mvnw compile -Prelease-note # генерация release-note
## создать релиз вручную указав имя как версию и поместив в тело сгенерированный RELEASE_NOTES.md без заголовков
./mvnw clean release:clean # очистка метаданных

Обновление changelog

./mvnw compile -Pchangelog

Отчет о покрытии тестами

./mvnw clean verify -Pcoverage
## see coverage/target/site/jacoco-aggregate/index.html

Настройка

telegram.access-key=                  # api key
telegram.mode=                        # polling (default), webhook
telegram.webhook-base-url=            # required for webhook mode
telegram.webhook-endpoint-url=        # optional

Использование

Положите файл с расширением .kts в папку c ресурсами handlers: resources/handlers/ExampleHandler.kts.

enum class PaymentMethod {
    CARD, CASH
}

handler("/taxi", "такси") {
    step<String>("locationFrom") {
        question {
            MarkdownMessage("Откуда поедем?")
        }
    }

    step<String>("locationTo") {
        question {
            MarkdownMessage("Куда поедем?")
        }
    }

    step<PaymentMethod>("paymentMethod") {
        question {
            MarkdownMessage("Оплата картой или наличкой?", "Картой", "Наличкой")
        }

        validation {
            when (it.toLowerCase()) {
                "картой" -> PaymentMethod.CARD
                "наличкой" -> PaymentMethod.CASH
                else -> throw ValidationException("Пожалуйста, выбери один из вариантов")
            }
        }
    }

    process { state, answers ->
        val from = answers["locationFrom"] as String
        val to = answers["locationTo"] as String
        val paymentMethod = answers["paymentMethod"] as PaymentMethod

        // Business logic

        MarkdownMessage("Заказ принят. Поедем из $from в $to. Оплата $paymentMethod.")
    }
}

Устройство

Обработка сообщений

About

Kotlin DSL для разработки Telegram ботов

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Kotlin 95.2%
  • Mustache 4.8%