https://github.com/fabiogaming/jartilities
An unofficial Java Wrapper for Artilities REST API
https://github.com/fabiogaming/jartilities
api api-wrapper art artilities java package rest rest-api rest-wrapper wrapper
Last synced: about 1 month ago
JSON representation
An unofficial Java Wrapper for Artilities REST API
- Host: GitHub
- URL: https://github.com/fabiogaming/jartilities
- Owner: FabioGaming
- License: mit
- Created: 2022-07-10T00:40:59.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-17T23:14:15.000Z (almost 4 years ago)
- Last Synced: 2025-03-13T15:43:24.909Z (over 1 year ago)
- Topics: api, api-wrapper, art, artilities, java, package, rest, rest-api, rest-wrapper, wrapper
- Language: Java
- Homepage:
- Size: 23.4 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JARtilities
An unofficial Java Wrapper for the [Artilities REST API](https://artilities.github.io/artilities-api/)
# What can this Wrapper do?
This wrapper currently supports `getting an Idea`, `Getting a challenge Idea`, `Looking up artist slang`, `getting Atilities Banners`. The other API functions like `getting patreons` will hopefully follow soon.
# Where can I get the Wrapper?
You can grab the latest release from this github page!
# How to Install
1. Navigate to Releases and download the latest version of JARtilities
2. Open Your Project in any Java IDE (my example: IntelliJ)
3. Head to File > Project Structure
4. Go to Library and click the + sign, then proceed to click on Java
5. Select JARtilities.jar and click OK
6. After it's added to the list you can click Apply
7. That's it.
# DOCUMENTATION
### Getting an Idea
You can get a random Idea from the Artilities Database using the `getIdea()` function, this function will return a HashMap with the following keys: `english`, `executionTime`, `statusCode`, `russian`, `raw`, `WebResponseCode`.
- `english` - Will return a random Idea in english
- `russian` - Will return a random Idea in russian
- `executionTime` - Will return the amount of time it took the server to respond (in ms).
- `statusCode` - Will return the Servers response code (in best case `200`).
- `WebResponseCode` - Will return the response code of the request itself (in best case it matches `statusCode`)
- `raw` - Will return the raw JSON output of the server
#### Note
- If there was an error during the request, the HashMap will return `null`
- You might need to change your encoding to display `russian`
#### Example Usage:
```Java
HashMap testMap = Artilities.getIdea();
if(testMap != null) {
System.out.println("Your Idea: " + testMap.get("english"));
System.out.println("Russian: " + testMap.get("russian"));
System.out.println("Server Response " + testMap.get("statusCode"));
System.out.println("Server Response Time: " + testMap.get("executionTime") + "ms");
System.out.println("Raw JSON: " + testMap.get("raw"));
} else {
System.out.println("There was an error during the request.");
}
```
#### Output:
```
Your Idea: God of gambling
Russian: Бог азартных игр
Server Response 200
Server Response Time: 136ms
Raw JSON: {"status_code":200,"generated_idea":{"ru":"Бог азартных игр","eng":"God of gambling"},"execution_time":136}
```
### Getting a challenge
You can get a random Challenge from Artilities Database using the `getChallenge()` function, this function will return a HashMap with the following keys: `english`, `executionTime`, `statusCode`, `russian`, `raw`, `WebResponseCode`.
- `english` - Will return a random Idea in english
- `russian` - Will return a random Idea in russian
- `executionTime` - Will return the amount of time it took the server to respond (in ms).
- `statusCode` - Will return the Servers response code (in best case `200`).
- `WebResponseCode` - Will return the response code of the request itself (in best case it matches `statusCode`)
- `raw` - Will return the raw JSON output of the server
#### Note
- If there was an error during the request, the HashMap will return `null`
- You might need to change your encoding to display `russian`
- #### Example Usage:
```Java
HashMap testMap = Artilities.getChallenge();
if(testMap != null) {
System.out.println("Your Challenge: " + testMap.get("english"));
System.out.println("Russian: " + testMap.get("russian"));
System.out.println("Server Response " + testMap.get("statusCode"));
System.out.println("Server Response Time: " + testMap.get("executionTime") + "ms");
System.out.println("Raw JSON: " + testMap.get("raw"));
} else {
System.out.println("There was an error during the request.");
}
```
#### Output:
```
Your Challenge: Generate a palette and make a drawing with these colors but in negative
Russian: Сгенерируй палитру и выполни работу в сгенерированных цветах, но в негативе
Server Response 200
Server Response Time: 24ms
Raw JSON: {"status_code":200,"generated_challenge":{"eng":"Generate a palette and make a drawing with these colors but in negative","ru":"Сгенерируй палитру и выполни работу в сгенерированных цветах, но в негативе"},"execution_time":24}
```
### Looking up artist slang on the Artilities Database
You can look up artist slang from the Artilities Database using the `getDictionaryEntry()` function, this function will return a HashMap with the following keys: `term`, `desription`, `statusCode`, `executionTime`, `WebResponseCode`, `raw`.
- `term` - Will return the result term
- `description` - Will return the meaning / description of the searched term
- `executionTime` - Will return the amount of time it took the server to respond (in ms).
- `statusCode` - Will return the Servers response code (in best case `200`).
- `WebResponseCode` - Will return the response code of the request itself (in best case it matches `statusCode`)
- `raw` - Will return the raw JSON output of the server
#### Note
- If there was an error during the request, the HashMap will return `null`
- If no result was found, `term` and `description` will return `null`
- `getDictionaryEntry()` requires a String as argument input.
#### Example Usage:
```Java
HashMap testMap = Artilities.getDictionaryEntry("UFO"); //In this case im looking up the term "UFO" which means "up for offers"
if(testMap != null) {
if(testMap.get("term") != null) {
System.out.println("Your term: " + testMap.get("term"));
System.out.println("Description: " + testMap.get("description"));
System.out.println("Server Response " + testMap.get("statusCode"));
System.out.println("Server Response Time: " + testMap.get("executionTime") + "ms");
System.out.println("Raw JSON: " + testMap.get("raw"));
} else {
System.out.println("No term found for given query.");
}
} else {
System.out.println("There was an error during the request.");
}
```
#### Output:
```
Your term: UFO
Description: Short for Up For Offers.
Server Response 200
Server Response Time: 52ms
Raw JSON: {"status_code":200,"query_results":[["UFO","Short for Up For Offers."]],"execution_time":52}
```
### Get Artilities Banners
You can get Artilities Banners using the `getBanners()` function, this function will return a HashMap with the following keys: `bannerLink`, `bannerImage`, `language`, `raw`, `executionTime`, `statusCode`, `WebResponseCode`.
- `language` - Will return the language of the banner (usually "")
- `bannerImage` - Will return the link of the banner Image
- `bannerLink` - Will return the link the banner is linked to
- `executionTime` - Will return the amount of time it took the server to respond (in ms).
- `statusCode` - Will return the Servers response code (in best case `200`).
- `WebResponseCode` - Will return the response code of the request itself (in best case it matches `statusCode`)
- `raw` - Will return the raw JSON output of the server
#### Note
- If there was an error during the request, the HashMap will return `null`
- `getBanners()` is not part if the `main` functions of the API, which is why the wrapper marks it as `other`, meaning to use `getBanners()` you need to use `Artilities.other.getBanners()`
#### Example Usage
```Java
HashMap testMap = Artilities.other.getBanners();
if(testMap != null) {
System.out.println("Banner Image: " + testMap.get("bannerImage"));
System.out.println("Banner Link: " + testMap.get("bannerLink"));
System.out.println("Server Response " + testMap.get("statusCode"));
System.out.println("Server Response Time: " + testMap.get("executionTime") + "ms");
System.out.println("Raw JSON: " + testMap.get("raw"));
} else {
System.out.println("There was an error during the request.");
}
```
#### Output:
```
Banner Image: https://i.imgur.com/pKmfznm.gif
Banner Link: https://discord.com/invite/u7dBmKyMWa
Server Response 200
Server Response Time: 54ms
Raw JSON: {"status_code":200,"details":{"banner_url":"https://discord.com/invite/u7dBmKyMWa","banner_image":"https://i.imgur.com/pKmfznm.gif","language":""},"execution_time":54}
```