Skip to content

Commit 36e0a96

Browse files
Andre601Andre601
authored
Merge pull request #3 from botblock/v2.3/cache-implementation
v2.3: Start of implementing caching for get methods.
2 parents a5c2a49 + d4ae195 commit 36e0a96

35 files changed

+650
-437
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[issues]: https://github.com/botblock/JavaBotBlockAPI/issues
22
[Code of Conduct]: ./CODE_OF_CONDUCT.md
3+
[BotBlock API]: https://botblock.org/api/docs
34

45
## Contributing Guidelines
56
We welcome everyone to contribute to the JavaBotBlockAPI project.

‎README.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010

1111
[image]: https://raw.githubusercontent.com/botblock/JavaBotBlockAPI/master/src/main/resources/JavaBotBlockAPI.png
1212

13+
[JDA]: https://github.com/DV8FromTheWorld/JDA
14+
[OkHttp]: https://github.com/square/okhttp/
15+
[JSON]: https://json.org
16+
[JetBrains annotations]: https://github.com/JetBrains/java-annotations
17+
[Caffeine]: https://github.com/ben-manes/caffeine
18+
1319
![image]
1420

1521
JavaBotBlockAPI is a continued and updated Java Wrapper for [BotBlock], a website that makes it possible to update guild counts on multiple lists with one API.
@@ -34,7 +40,7 @@ dependencies{
3440
```
3541

3642
## Maven
37-
For maven use this code snipped:
43+
For maven use this code snippet:
3844
```xml
3945
<dependencies>
4046
<dependency>
@@ -207,6 +213,16 @@ This shouldn't be the case with auto-posting since it has a minimum delay of 1 m
207213
- `NullPointerException`
208214
Thrown when BotBlock.org sends an empty response, meaning something got messed up on their side.
209215

216+
# Libraries
217+
JavaBotBlockAPI utilizes different APIs to provide the functionality it offers right now.
218+
We have a list of those libraries listed here.
219+
- [JDA] - Java library used for creating bots.
220+
- [OkHttp] - Library for creating and managing http requests.
221+
- [JSON] - Used for JSON management.
222+
- [JetBrains annotations] - Used for annotations like `@NotNull` or `@Nullable`.
223+
- [Caffeine] - Library used for caching.
224+
225+
210226
# Links
211227
Here are some useful links:
212228
- [BotBlock.org][BotBlock] Site for which this wrapper was made.

‎build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ dependencies{
2727
api(group: 'net.dv8tion', name: 'JDA', version: '4.0.0_40'){
2828
exclude(module: 'opus-java')
2929
}
30+
api group: 'com.github.ben-manes.caffeine', name: 'caffeine', version: '2.7.0'
3031
}
3132

3233
task sourcesJar(type: Jar, dependsOn: classes){

‎docs/allclasses-frame.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
22
<!-- NewPage -->
3-
<html lang="de">
3+
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 23:45:54 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Mon Aug 19 19:55:34 CEST 2019 -->
66
<title>All Classes (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-31">
7+
<meta name="date" content="2019-08-19">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

‎docs/allclasses-noframe.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
22
<!-- NewPage -->
3-
<html lang="de">
3+
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 23:45:54 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Mon Aug 19 19:55:34 CEST 2019 -->
66
<title>All Classes (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-31">
7+
<meta name="date" content="2019-08-19">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

‎docs/com/andre601/javabotblockapi/BotBlockAPI.Builder.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
22
<!-- NewPage -->
3-
<html lang="de">
3+
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 23:45:54 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Mon Aug 19 19:55:34 CEST 2019 -->
66
<title>BotBlockAPI.Builder (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-31">
7+
<meta name="date" content="2019-08-19">
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>

‎docs/com/andre601/javabotblockapi/BotBlockAPI.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
22
<!-- NewPage -->
3-
<html lang="de">
3+
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 23:45:54 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Mon Aug 19 19:55:34 CEST 2019 -->
66
<title>BotBlockAPI (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-31">
7+
<meta name="date" content="2019-08-19">
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>

‎docs/com/andre601/javabotblockapi/RequestHandler.html‎

Lines changed: 265 additions & 208 deletions
Large diffs are not rendered by default.

‎docs/com/andre601/javabotblockapi/Site.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
22
<!-- NewPage -->
3-
<html lang="de">
3+
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 23:45:54 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Mon Aug 19 19:55:34 CEST 2019 -->
66
<title>Site (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-31">
7+
<meta name="date" content="2019-08-19">
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>

‎docs/com/andre601/javabotblockapi/exceptions/RatelimitedException.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
22
<!-- NewPage -->
3-
<html lang="de">
3+
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_101) on Wed Jul 31 23:45:54 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_101) on Mon Aug 19 19:55:34 CEST 2019 -->
66
<title>RatelimitedException (JavaBotBlockAPI Javadocs)</title>
7-
<meta name="date" content="2019-07-31">
7+
<meta name="date" content="2019-08-19">
88
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../script.js"></script>
1010
</head>

0 commit comments

Comments
 (0)