README.md

Okaeri SDK for Java

Currently supported services:

• OK! AI.Censor
• OK! No.Proxy
• OK! OpenVote

Full documentation available on wiki.okaeri.cloud in:

• Polish
• English

Installation

Maven

Add repository to the repositories section:

<repository>
    <id>okaeri-releases</id>
    <url>https://repo.okaeri.cloud/releases</url>
</repository>

Add dependency to the dependencies section:

<dependency>
    <groupId>eu.okaeri</groupId>
    <artifactId>okaeri-sdk</artifactId>
    <version>1.4.6</version>
</dependency>

In public projects that are not standalone systems you may also like to relocate the following:

<relocation>
    <pattern>kong.unirest.</pattern>
    <shadedPattern>my.package.lib.unirest.</shadedPattern>
</relocation>
<relocation>
    <pattern>org.apache.</pattern>
    <shadedPattern>my.package.lib.apache.</shadedPattern>
</relocation>
<relocation>
    <pattern>com.google.gson.</pattern>
    <shadedPattern>my.package.lib.gson.</shadedPattern>
</relocation>

Gradle

Add repository to the repositories section:

maven { url "https://repo.okaeri.cloud/releases" }

Add dependency to the maven section:

implementation('eu.okaeri:okaeri-sdk:2.0.3')

Example usage

OK! AI.Censor

See full docs in: Polish, English

import eu.okaeri.sdk.aicensor.AiCensorClient;
import eu.okaeri.sdk.aicensor.error.AiCensorException;
import eu.okaeri.sdk.aicensor.model.AiCensorAnalysisDetails;

final class Demo {
    public static void main(String[] args) {
        AiCensorClient aicensor = new AiCensorClient("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
        AiCensorAnalysisDetails analysis;
        try {
            analysis = aicensor.getAnalysisDetails("o cie k u r//w@!");
        } catch (AiCensorException exception) {
            exception.printStackTrace(); // FIXME: error handling
            return;
        }
        boolean disdain = analysis.getJudgement().getDisdain() > 0; // pogardliwe
        boolean profane = analysis.getJudgement().getProfane() > 0; // obraźliwe
        boolean vulgar = analysis.getJudgement().getVulgar() > 0; // wulgarne
        boolean block = analysis.getSuggestions().isBlock(); // vulgar > 0
        boolean verify = analysis.getSuggestions().isBlock(); // disdain || profane || vulgar
        System.out.println("disdain: " + disdain + ", profane: " + profane + ", vulgar: " + vulgar + ", block: " + block + ", verify: " + verify);
    }
}

OK! No.Proxy

See full docs in: Polish, English

import eu.okaeri.sdk.noproxy.NoProxyClient;
import eu.okaeri.sdk.noproxy.error.NoProxyException;
import eu.okaeri.sdk.noproxy.model.NoProxyAddressInfo;

final class Demo {
    public static void main(String[] args) {
        NoProxyClient noproxy = new NoProxyClient("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
        NoProxyAddressInfo info;
        try {
            info = noproxy.getInfo("1.1.1.1");
        } catch (NoProxyException exception) {
            exception.printStackTrace(); // FIXME: error handling
            return;
        }
        boolean proxy = info.getRisks().isProxy();
        boolean verify = info.getSuggestions().isVerify();
        boolean block = info.getSuggestions().isBlock();
        System.out.println("proxy: " + proxy + ", verify: " + verify + ", block: " + block);
    }
}

OK! OpenVote

See full docs in: Polish, English

import eu.okaeri.sdk.openvote.OpenVoteClient;
import eu.okaeri.sdk.openvote.error.OpenVoteException;
import eu.okaeri.sdk.openvote.model.list.OpenVoteListVote;

import java.util.UUID;

final class Demo {
    public static void main(String[] args) {
        OpenVoteClient openvote = new OpenVoteClient();
        OpenVoteListVote vote;
        try {
            vote = openvote.getListVote(UUID.fromString("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"));
        } catch (OpenVoteException exception) {
            exception.printStackTrace(); // FIXME: error handling
            return;
        }
        String server = vote.getServer();
        String list = vote.getList();
        System.out.println("server: " + server + ", list: " + list);
    }
}