.circleci | ||
.github/workflows | ||
.idea | ||
config | ||
docs | ||
examples | ||
gradle/wrapper | ||
src | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.gitlab-ci.yml | ||
bitbucket-pipelines.yml | ||
build.gradle.kts | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
LICENSE.txt | ||
pom.xml | ||
README.md | ||
settings.gradle.kts | ||
version.mustache | ||
version.properties |
Akismet for Kotlin, Java and Android
A pretty complete and straightforward implementation of the Automattic's Akismet API, a free service which can be used to actively stop comments spam.
Examples (TL;DR)
Kotlin
val akismet = Akismet(apiKey = "YOUR_API_KEY", blog = "YOUR_BLOG_URL")
val comment = AkismetComment(userIp = "127.0.0.1", userAgent = "curl/7.29.0")
with(comment) {
referrer = "https://www.google.com"
type = AkismetComment.TYPE_COMMENT
author = "admin"
authorEmail = "test@test.com"
authorUrl = "https://www.CheckOutMyCoolSite.com"
dateGmt = Akismet.dateToGmt(Date())
content = "It means a lot that you would take the time to review our software."
}
// ...
val isSpam = akismet.checkComment(comment)
if (isSpam) {
// ...
}
Java
final Akismet akismet = new Akismet("YOUR_API_KEY", "YOUR_BLOG_URL");
final AkismetComment comment = new AkismetComment("127.0.0.1", "curl/7.29.0");
comment.setReferrer("https://www.google.com");
comment.setType(AkismetComment.TYPE_COMMENT);
comment.setAuthor("admin");
comment.setAuthorEmail("test@test.com");
comment.setAuthorUrl("https://www.CheckOutMyCoolSite.com");
comment.setDateGmt(Akismet.dateToGmt(new Date()));
comment.setContent("It means a lot that you would take the time to review our software.");
//...
final boolean isSpam = akismet.checkComment(comment);
if (isSpam) {
// ...
}
Gradle
To use with Gradle, include the following dependency in your build file:
repositories {
mavenCentral()
}
dependencies {
implementation("net.thauvin.erik:akismet-kotlin:1.0.0")
}
Instructions for using with Maven, Ivy, etc. can be found on Maven Central.
HttpServletRequest
The more information is sent to Akismet, the more accurate the response is. An HttpServletRequest can be used as a parameter so that all the relevant information is automatically included.
AkismetComment(request = context.getRequest())
This will ensure that the user's IP, agent, referrer and various environment variables are automatically extracted from the request.
JSON
Since comments mis-identified as spam or ham can be submitted to Askimet to improve the service. A comment can be saved as a JSON object to be stored in a database, etc.
var json = comment.toJson()
At a latter time, the comment can then be submitted:
akismet.submitSpam(Akismet.jsonComment(json))
More...
If all else fails, there's always more Documentation.