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
2020-03-07 16:26:11 -08:00
.circleci Switched to Java 13. 2019-09-30 17:49:19 -07:00
.idea Updated copyright. 2020-03-07 16:26:11 -08:00
config Added docs. 2020-03-05 22:46:41 -08:00
docs Added docs. 2020-03-05 22:46:41 -08:00
examples Updated examples. 2020-03-07 16:18:22 -08:00
gradle/wrapper Updated dependencies. 2020-03-05 22:48:34 -08:00
src Updated copyright. 2020-03-07 16:26:11 -08: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. 2020-03-05 22:48:34 -08:00
.travis.yml Switched to Java 13. 2019-09-30 17:49:19 -07:00
build.gradle.kts Updated dependencies. 2020-03-05 22:48:34 -08:00
detekt-baseline.xml Implemented errorMessage and JSON (de)serialization. 2019-09-22 12:03:53 -07:00
gradlew Updated dependencies. 2020-02-11 15:52:39 -08:00
gradlew.bat Updated dependencies. 2020-03-05 22:48:34 -08:00
LICENSE.txt Updated copyright. 2020-03-07 16:26:11 -08:00
pom.xml Version 0.9.1-beta 2020-03-07 16:17:52 -08:00
README.md Added toJson(). 2020-03-05 22:49:24 -08:00
settings.gradle.kts Updated dependencies. 2019-12-15 17:41:18 -08:00
version.mustache Added version template. 2019-09-19 18:07:38 -07:00
version.properties Version 0.9.1-beta 2020-03-07 16:17:52 -08:00

License (3-Clause BSD)
Known Vulnerabilities Quality Gate Status Build Status CircleCI

Akismet for Kotlin/Java

Akismet for Kotlin/Java is a pretty complete and straightforward implementation of the Automattic's Akismet API, a free service that 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 = "http://www.google.com"
    type = AkismetComment.TYPE_COMMENT
    author = "admin"
    authorEmail = "test@test.com"
    authorUrl = "http://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("http://www.google.com");
comment.setType(AkismetComment.TYPE_COMMENT);
comment.setAuthor("admin");
comment.setAuthorEmail("test@test.com");
comment.setAuthorUrl("http://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

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 of the relevant information is automatically included.

AkismetComment(request = context.getRequest())

View Full Example

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 the be submitted:

akismet.submitSpam(Akismet.jsonComment(json))