erik/akismet-kotlin
erik/akismet-kotlin
1
1
Fork 0
Code Issues Pull requests Releases Activity

Added Akismet Servlet example.

Browse source
This commit is contained in:
Erik C. Thauvin 2019-09-23 21:05:23 -07:00
parent 47210fd592
commit 697e74da79
4 changed files with 82 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -3,9 +3,9 @@
# [Akismet](https://www.akismet.com) for Kotlin/Java
Akismet for Kotlin/Java is a pretty complete and straightforward implementation of the [Automattic's Akismet](https://www.akismet.com/) API, a free service that can be used to actively stop comments spam.
Akismet for Kotlin/Java is a pretty complete and straightforward implementation of the [Automattic's Akismet](https://akismet.com/development/api/) API, a free service that can be used to actively stop comments spam.
## Examples
## Examples (TL;DR)
#### Kotlin
@ -20,6 +20,7 @@ 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.");
// ...
val isSpam = akismet.checkComment(comment)
if (isSpam) {
@ -27,6 +28,8 @@ if (isSpam) {
}
```
[View Full Example](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/src/main/kotlin/com/example/AkismetExample.kt)
#### Java
```java
@ -40,6 +43,7 @@ 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) {
@ -47,6 +51,8 @@ if (isSpam) {
}
```
[View Full Example](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/src/main/java/com/example/AkismetSample.java)
### HttpServletRequest
The more information is sent to Akismet, the more accurate the response is. An [HttpServletRequest](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/http/HttpServletRequest.html) can be used as a parameter so that all of the relevant information is automatically included.
@ -55,6 +61,8 @@ The more information is sent to Akismet, the more accurate the response is. An [
AkismetComment(request = context.getRequest())
```
[View Full Example](https://github.com/ethauvin/akismet-kotlin/blob/master/examples/src/main/kotlin/com/example/AkismetServlet.kt)
This will ensure that the user's IP, agent, referrer and various environment variables are automatically extracted from the request.
### JSON
@ -67,7 +75,7 @@ var json = comment.toString()
At a latter time, the comment can the be submitted:
```
```kotlin
akismet.submitSpam(Akismet.jsonComment(json))
```