Initial commit

I should have commit days ago but I've been carried away
This commit is contained in:
William Brawner 2023-01-23 21:48:52 -07:00
commit 544b97f31c
Signed by: wbrawner
GPG key ID: 8FF12381C6C90D35
16 changed files with 1711 additions and 0 deletions

42
.gitignore vendored Normal file
View file

@ -0,0 +1,42 @@
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/
### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/
### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
### VS Code ###
.vscode/
### Mac OS ###
.DS_Store

8
.idea/.gitignore vendored Normal file
View file

@ -0,0 +1,8 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml

20
.idea/gradle.xml Normal file
View file

@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="GradleMigrationSettings" migrationVersion="1" />
<component name="GradleSettings">
<option name="linkedExternalProjectsSettings">
<GradleProjectSettings>
<option name="delegatedBuild" value="true" />
<option name="testRunner" value="GRADLE" />
<option name="distributionType" value="DEFAULT_WRAPPED" />
<option name="externalProjectPath" value="$PROJECT_DIR$" />
<option name="gradleJvm" value="#JAVA_HOME" />
<option name="modules">
<set>
<option value="$PROJECT_DIR$" />
</set>
</option>
</GradleProjectSettings>
</option>
</component>
</project>

6
.idea/kotlinc.xml Normal file
View file

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="KotlinJpsPluginSettings">
<option name="version" value="1.8.0" />
</component>
</project>

10
.idea/misc.xml Normal file
View file

@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ExternalStorageConfigurationManager" enabled="true" />
<component name="FrameworkDetectionExcludesConfiguration">
<file type="web" url="file://$PROJECT_DIR$" />
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="17" project-jdk-type="JavaSDK">
<output url="file://$PROJECT_DIR$/out" />
</component>
</project>

6
.idea/vcs.xml Normal file
View file

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

56
build.gradle.kts Normal file
View file

@ -0,0 +1,56 @@
import java.net.HttpURLConnection
import java.net.URL
plugins {
java
application
id("com.github.johnrengelman.shadow") version "7.1.2"
kotlin("jvm") version "1.8.0"
}
group = "com.wbrawner"
version = "1.0-SNAPSHOT"
repositories {
mavenCentral()
}
dependencies {
implementation("org.telegram:telegrambots:6.4.0")
testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.1")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.1")
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
}
kotlin {
jvmToolchain(17)
}
tasks.getByName<Test>("test") {
useJUnitPlatform()
}
val main = "com.wbrawner.MainKt"
application {
mainClass.set(main)
}
tasks.shadowJar {
manifest {
attributes("Main-Class" to main)
archiveBaseName.set("civics-quiz-bot")
archiveClassifier.set("")
archiveVersion.set("")
}
}
tasks.register("updateQuestions") {
val urlConnection = URL("https://www.uscis.gov/sites/default/files/document/questions-and-answers/100q.txt")
.openConnection() as HttpURLConnection
urlConnection.connect()
val text = urlConnection.inputStream.bufferedReader().use {
it.readText()
}
File(projectDir, "src/main/resources/questions.txt").writeText(text)
}

BIN
gradle/wrapper/gradle-wrapper.jar vendored Normal file

Binary file not shown.

View file

@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

240
gradlew vendored Executable file
View file

@ -0,0 +1,240 @@
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
APP_NAME="Gradle"
APP_BASE_NAME=${0##*/}
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

91
gradlew.bat vendored Normal file
View file

@ -0,0 +1,91 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

2
settings.gradle.kts Normal file
View file

@ -0,0 +1,2 @@
rootProject.name = "CivicsQuizBot"

View file

@ -0,0 +1,165 @@
package com.wbrawner
import org.telegram.telegrambots.bots.TelegramLongPollingBot
import org.telegram.telegrambots.meta.api.methods.send.SendMessage
import org.telegram.telegrambots.meta.api.objects.Update
import org.telegram.telegrambots.meta.api.objects.replykeyboard.ReplyKeyboardMarkup
import org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.KeyboardButton
import org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.KeyboardRow
import org.telegram.telegrambots.meta.exceptions.TelegramApiException
import java.security.SecureRandom
import java.util.concurrent.ConcurrentHashMap
class CivicsQuizHandler : TelegramLongPollingBot() {
private val acknowledgementPhrases = listOf(
"Got it",
"Understood",
"Done",
"Roger roger",
"👍",
""
)
private val random = SecureRandom()
private lateinit var questions: Map<Int, Question>
// TODO: Persist this in DB
private val buckets = ConcurrentHashMap<Long, List<MutableList<Int>>>()
// TODO: Persist this in DB
private val lastChatQuestions = ConcurrentHashMap<Long, Question>()
override fun getBotUsername(): String = "CivicsQuizBot"
override fun getBotToken(): String = System.getenv("TELEGRAM_TOKEN")
override fun onUpdateReceived(update: Update) {
println(update)
val message = update.message
if (message == null) {
println("No message, returning early")
return
}
// TODO: Add option to enable smart reminders
when (val command = message.text.asCommand()) {
Command.SHOW_ANSWER -> sendAnswer(message.chatId)
Command.NEW_QUESTION -> sendQuestion(message.chatId)
Command.NEED_PRACTICE, Command.TOO_EASY -> handleFeedback(message.chatId, command)
else -> sendOptions(message.chatId)
}
}
private fun sendQuestion(chatId: Long) {
val question = randomQuestion(chatId)
lastChatQuestions[chatId] = question
sendMessage(chatId, question.prompt, Command.SHOW_ANSWER)
}
private fun handleFeedback(chatId: Long, command: Command) {
val userBuckets = buckets[chatId] ?: run {
val userBuckets = listOf(
questions.values.map { it.number }.toMutableList(),
mutableListOf(),
mutableListOf(),
mutableListOf()
)
buckets[chatId] = userBuckets
userBuckets
}
val lastQuestion = requireNotNull(lastChatQuestions[chatId])
for (i in userBuckets.indices) {
if (userBuckets[i].contains(lastQuestion.number)) {
if (command == Command.TOO_EASY && i < userBuckets.lastIndex) {
userBuckets[i].remove(lastQuestion.number)
userBuckets[i + 1].add(lastQuestion.number)
} else if (command == Command.NEED_PRACTICE && i > 0) {
userBuckets[i].remove(lastQuestion.number)
userBuckets[i - 1].add(lastQuestion.number)
}
break
}
}
println(userBuckets)
sendMessage(chatId, acknowledgementPhrases.random())
sendQuestion(chatId)
}
private fun sendAnswer(chatId: Long) {
lastChatQuestions[chatId]?.let {
sendMessage(chatId, it.answer, Command.NEED_PRACTICE, Command.TOO_EASY)
} ?: run {
sendMessage(chatId, "I can't answer a question that hasn't been asked", Command.NEW_QUESTION)
}
}
private fun sendOptions(chatId: Long) = sendMessage(
chatId,
"I'm not sure how to respond to that. Here are a few actions I can help you with:",
Command.NEW_QUESTION
)
init {
try {
javaClass.getResourceAsStream("/questions.txt")
?.bufferedReader()
?.let { questionsResource ->
val parser = QuestionTextParser()
questions = parser.parseQuestions(questionsResource.readText()).associateBy { it.number }
} ?: throw RuntimeException("Questions resource was null")
} catch (e: Exception) {
throw RuntimeException(e)
}
}
private fun sendMessage(chatId: Long, text: String, vararg keyboardButtons: Command) {
val keyboard = keyboardButtons.map {
KeyboardRow(listOf(KeyboardButton(it.text.first())))
}
val response = SendMessage.builder()
.text(text)
.chatId(chatId)
.replyMarkup(ReplyKeyboardMarkup(keyboard, true, true, false, null, true))
.build()
try {
execute(response)
} catch (e: TelegramApiException) {
e.printStackTrace()
}
}
private fun randomQuestion(chatId: Long): Question {
val userBuckets = buckets[chatId] ?: run {
val userBuckets = listOf(
questions.values.map { it.number }.toMutableList(),
mutableListOf(),
mutableListOf(),
mutableListOf()
)
buckets[chatId] = userBuckets
userBuckets
}
if (userBuckets.first().isNotEmpty()) {
return requireNotNull(questions[userBuckets.first().removeFirst()]) { "Failed to retrieve a question" }
}
var bucket = when (random.nextInt(10)) {
in 0..5 -> 1
in 6..8 -> 2
else -> 3
}
var question = userBuckets[bucket].shuffled().firstOrNull()
while (question == null) {
if (--bucket == -1) {
bucket = 2
}
question = userBuckets[bucket].shuffled().firstOrNull()
}
return requireNotNull(questions[question]) { "Failed to retrieve a question" }
}
}
fun String.asCommand() = Command.values().firstOrNull { it.text.contains(this) }
enum class Command(vararg val text: String) {
NEW_QUESTION("New question", "/start"),
SHOW_ANSWER("Show answer"),
NEED_PRACTICE("I need to practice this"),
TOO_EASY("This was easy"),
}

View file

@ -0,0 +1,14 @@
package com.wbrawner
import org.telegram.telegrambots.meta.TelegramBotsApi
import org.telegram.telegrambots.meta.exceptions.TelegramApiException
import org.telegram.telegrambots.updatesreceivers.DefaultBotSession
fun main() {
try {
val telegramBotsApi = TelegramBotsApi(DefaultBotSession::class.java)
telegramBotsApi.registerBot(CivicsQuizHandler())
} catch (e: TelegramApiException) {
e.printStackTrace()
}
}

View file

@ -0,0 +1,34 @@
package com.wbrawner
class QuestionTextParser {
private val promptRegex = Regex("^(\\d+)\\.\\s+(.*)$")
fun parseQuestions(text: String): Set<Question> {
val questions = mutableSetOf<Question>()
var number: Int? = null
var prompt: String? = null
var answer: MutableList<String> = mutableListOf()
text.lines().forEach { line ->
if (line.isBlank()) return@forEach
val matches = promptRegex.find(line)
matches?.let {
number?.let { num ->
questions.add(Question(num, prompt!!, answer.joinToString("\n")))
number = null
prompt = null
answer.clear()
}
val (_, numberString, promptString) = it.groupValues
number = numberString.toInt()
prompt = promptString
}
if (line.startsWith(".")) {
answer.add(line.substringAfter(" "))
}
}
questions.add(Question(number!!, prompt!!, answer.joinToString("\n")))
return questions
}
}
data class Question(val number: Int, val prompt: String, val answer: String)

File diff suppressed because it is too large Load diff