Akismet for Kotlin/Java/Android, a client library for accessing the Automattic Kismet (Akismet) spam comments filtering service. https://github.com/ethauvin/akismet-kotlin
Find a file
2023-09-24 18:38:25 -07:00
.circleci Upgraded to Kotlin 1.7.20 2022-09-30 22:40:48 -07:00
.github/workflows Added JDK 20 and make JDK 17 default 2023-09-24 16:16:57 -07:00
.idea Updated dependencies 2023-09-24 16:22:29 -07:00
config Cleanup before 1.0 release 2023-09-24 18:38:25 -07:00
docs Cleanup before 1.0 release 2023-09-24 18:38:25 -07:00
examples Cleanup before 1.0 release 2023-09-24 18:38:25 -07:00
gradle/wrapper Updated dependencies 2023-09-24 16:22:29 -07:00
src Support for postman-echo new format 2023-09-24 16:23:38 -07:00
.editorconfig Initial commit. 2019-09-18 05:16:01 -07:00
.gitattributes Initial commit. 2019-09-18 05:16:01 -07:00
.gitignore Updated dependencies 2023-09-24 16:22:29 -07:00
.gitlab-ci.yml Updated dependencies 2023-09-24 16:22:29 -07:00
bitbucket-pipelines.yml Upgraded to Kotlin 1.7.20 2022-09-30 22:40:48 -07:00
build.gradle.kts Cleanup before 1.0 release 2023-09-24 18:38:25 -07:00
gradle.properties Updated dependencies 2023-09-24 16:22:29 -07:00
gradlew Updated dependencies 2023-09-24 16:22:29 -07:00
gradlew.bat Updated dependencies 2023-09-24 16:22:29 -07:00
LICENSE.txt Updated dependencies and copyright. 2022-01-03 12:49:29 -08:00
pom.xml Cleanup before 1.0 release 2023-09-24 18:38:25 -07:00
README.md Cleanup before 1.0 release 2023-09-24 18:38:25 -07:00
settings.gradle.kts Upgrade to JDK 16, Kotlin 1.3.21 and Gradle 7.1.1 2021-07-27 14:41:16 -07:00
version.mustache Added version template. 2019-09-19 18:07:38 -07:00
version.properties Cleanup before 1.0 release 2023-09-24 18:38:25 -07:00

License (3-Clause BSD) Kotlin Release Nexus Snapshot Maven Central

Quality Gate Status GitHub CI CircleCI

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) {
    // ...
}

View Full Example

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) {
    // ...
}

View Full Example

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.

View Full Example

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.