From fed9de3fd00e66e1c00a98bbebd91063ba435649 Mon Sep 17 00:00:00 2001 From: "jacek.wolniewicz" Date: Mon, 1 Jul 2024 23:28:38 +0200 Subject: [PATCH] Due to convention, interfaces should not have TikTok name inside, but they should have prefix Live instead - rename TikTokMapper to LiveMapper - rename TikTokLiveMapperHelper to LiveMapperHelper Create interface: LiveEventsHandler for TikTokLiveEventHandler LiveMessagesHandler for TikTokLiveMessageHandler --- .../tiktok/CusomizationExample.java | 7 ++++- pom.xml | 2 +- .../pom.xml | 7 ++++- tools-readme/readme.md | 3 +++ .../jwdeveloper/tiktok/CodeExample.java | 0 .../tiktok/CodeExamplesGenerator.java | 0 .../jwdeveloper/tiktok/EventsDecorator.java | 0 .../tiktok/EventsInfoGenerator.java | 0 .../jwdeveloper/tiktok/FilesUtility.java | 0 .../tiktok/ListenerExampleGenerator.java | 0 .../io/github/jwdeveloper/tiktok/Main.java | 1 + .../io/github/jwdeveloper/tiktok/Main2.java | 27 +++++++++++++++++++ .../jwdeveloper/tiktok/ReadmeGenerator.java | 0 .../jwdeveloper/tiktok/TemplateUtility.java | 0 .../src/main/resources/logo.svg | 0 .../src/main/resources/output.md | 0 .../src/main/resources/readme-template.html | 6 ++++- .../src/main/resources/template.md | 6 ++--- 18 files changed, 52 insertions(+), 7 deletions(-) rename {Tools-ReadmeGenerator => tools-readme}/pom.xml (89%) create mode 100644 tools-readme/readme.md rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/CodeExample.java (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/CodeExamplesGenerator.java (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/EventsDecorator.java (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/FilesUtility.java (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/ListenerExampleGenerator.java (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/Main.java (99%) create mode 100644 tools-readme/src/main/java/io/github/jwdeveloper/tiktok/Main2.java rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/java/io/github/jwdeveloper/tiktok/TemplateUtility.java (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/resources/logo.svg (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/resources/output.md (100%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/resources/readme-template.html (72%) rename {Tools-ReadmeGenerator => tools-readme}/src/main/resources/template.md (98%) diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/CusomizationExample.java b/Examples/src/main/java/io/github/jwdeveloper/tiktok/CusomizationExample.java index 8b61618..371784d 100644 --- a/Examples/src/main/java/io/github/jwdeveloper/tiktok/CusomizationExample.java +++ b/Examples/src/main/java/io/github/jwdeveloper/tiktok/CusomizationExample.java @@ -3,6 +3,9 @@ package io.github.jwdeveloper.tiktok; import io.github.jwdeveloper.tiktok.data.events.common.TikTokEvent; import io.github.jwdeveloper.tiktok.data.events.gift.TikTokGiftEvent; import io.github.jwdeveloper.tiktok.data.models.gifts.Gift; +import io.github.jwdeveloper.tiktok.data.settings.LiveClientSettings; +import io.github.jwdeveloper.tiktok.http.HttpClientBuilder; +import io.github.jwdeveloper.tiktok.http.HttpClientFactory; import io.github.jwdeveloper.tiktok.live.GiftsManager; import io.github.jwdeveloper.tiktok.live.LiveClient; @@ -17,6 +20,7 @@ import java.util.function.Predicate; public class CusomizationExample { public static void main(String[] args) { + var customEventHandler = new CustomEventsHandler(); var client = TikTokLive.newClient("john") .configure(liveClientSettings -> { @@ -30,7 +34,7 @@ public class CusomizationExample { .customize(container -> { //overriding default implementation of GiftsManager, with own one - container.registerSingleton(TikTokLiveEventHandler.class, CustomEventsHandler.class); + container.registerSingleton(TikTokLiveEventHandler.class, customEventHandler); }).build(); client.connect(); @@ -38,6 +42,7 @@ public class CusomizationExample { client.publishEvent(TikTokGiftEvent.of("stone", 2, 12)); } + public static class CustomEventsHandler extends TikTokLiveEventHandler { @Override diff --git a/pom.xml b/pom.xml index 8f6b0a8..07e272e 100644 --- a/pom.xml +++ b/pom.xml @@ -12,7 +12,7 @@ API Client Examples - Tools-ReadmeGenerator + tools-readme extension-recorder extension-collector diff --git a/Tools-ReadmeGenerator/pom.xml b/tools-readme/pom.xml similarity index 89% rename from Tools-ReadmeGenerator/pom.xml rename to tools-readme/pom.xml index a74e215..59ce99b 100644 --- a/Tools-ReadmeGenerator/pom.xml +++ b/tools-readme/pom.xml @@ -9,7 +9,7 @@ 4.0.0 - Tools-ReadmeGenerator + tools-readme jitpack.io @@ -23,6 +23,11 @@ + + com.hubspot.jinjava + jinjava + 2.7.2 + commons-io commons-io diff --git a/tools-readme/readme.md b/tools-readme/readme.md new file mode 100644 index 0000000..2ea9b92 --- /dev/null +++ b/tools-readme/readme.md @@ -0,0 +1,3 @@ +Generates documentation from template +that can be found under +- `src/main/resources/readme-template.html` diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/CodeExample.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/CodeExample.java similarity index 100% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/CodeExample.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/CodeExample.java diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/CodeExamplesGenerator.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/CodeExamplesGenerator.java similarity index 100% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/CodeExamplesGenerator.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/CodeExamplesGenerator.java diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/EventsDecorator.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/EventsDecorator.java similarity index 100% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/EventsDecorator.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/EventsDecorator.java diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java similarity index 100% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/EventsInfoGenerator.java diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/FilesUtility.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/FilesUtility.java similarity index 100% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/FilesUtility.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/FilesUtility.java diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/ListenerExampleGenerator.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/ListenerExampleGenerator.java similarity index 100% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/ListenerExampleGenerator.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/ListenerExampleGenerator.java diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/Main.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/Main.java similarity index 99% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/Main.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/Main.java index 9f987cd..7968d22 100644 --- a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/Main.java +++ b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/Main.java @@ -22,6 +22,7 @@ public class Main var output = System.getProperty("user.dir"); + DescriptionGenerator generator = Descrabble.create() .withTemplate(targetFile) .withVariable("version", version) diff --git a/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/Main2.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/Main2.java new file mode 100644 index 0000000..c811539 --- /dev/null +++ b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/Main2.java @@ -0,0 +1,27 @@ +package io.github.jwdeveloper.tiktok; + +import com.google.common.base.Charsets; +import com.google.common.collect.Maps; +import com.google.common.io.Resources; +import com.hubspot.jinjava.Jinjava; + +import java.io.IOException; +import java.util.HashMap; + + +public class Main2 { + public static void main(String[] args) throws IOException { + var version = System.getenv("VERSION"); + if (version == null || version.equals("")) { + version = "[Replace with current version]"; + } + + var template = Resources.toString(Resources.getResource("my-template.html"), Charsets.UTF_8); + + var jinjava = new Jinjava(); + var context = new HashMap(); + context.put("version", version); + + var renderedTemplate = jinjava.render(template, context); + } +} diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java similarity index 100% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/ReadmeGenerator.java diff --git a/Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/TemplateUtility.java b/tools-readme/src/main/java/io/github/jwdeveloper/tiktok/TemplateUtility.java similarity index 100% rename from Tools-ReadmeGenerator/src/main/java/io/github/jwdeveloper/tiktok/TemplateUtility.java rename to tools-readme/src/main/java/io/github/jwdeveloper/tiktok/TemplateUtility.java diff --git a/Tools-ReadmeGenerator/src/main/resources/logo.svg b/tools-readme/src/main/resources/logo.svg similarity index 100% rename from Tools-ReadmeGenerator/src/main/resources/logo.svg rename to tools-readme/src/main/resources/logo.svg diff --git a/Tools-ReadmeGenerator/src/main/resources/output.md b/tools-readme/src/main/resources/output.md similarity index 100% rename from Tools-ReadmeGenerator/src/main/resources/output.md rename to tools-readme/src/main/resources/output.md diff --git a/Tools-ReadmeGenerator/src/main/resources/readme-template.html b/tools-readme/src/main/resources/readme-template.html similarity index 72% rename from Tools-ReadmeGenerator/src/main/resources/readme-template.html rename to tools-readme/src/main/resources/readme-template.html index 09257ce..771e75d 100644 --- a/Tools-ReadmeGenerator/src/main/resources/readme-template.html +++ b/tools-readme/src/main/resources/readme-template.html @@ -4,7 +4,6 @@ - TikTok Live Java
@@ -19,6 +18,11 @@ + + A Java library inspired by [TikTokLive](https://github.com/isaackogan/TikTokLive) and [TikTokLiveSharp](https://github.com/frankvHoof93/TikTokLiveSharp). Use it to receive live stream events such as comments and gifts in realtime from [TikTok LIVE](https://www.tiktok.com/live) by connecting to TikTok's internal WebCast push service. + The library includes a wrapper that connects to the WebCast service using just the username (`uniqueId`). This allows you to connect to your own live chat as well as the live chat of other streamers. + No credentials are required. Events such as [Members Joining](#member), [Gifts](#gift), [Subscriptions](#subscribe), [Viewers](#roomuser), [Follows](#social), [Shares](#social), [Questions](#questionnew), [Likes](#like) and [Battles](#linkmicbattle) can be tracked. +
diff --git a/Tools-ReadmeGenerator/src/main/resources/template.md b/tools-readme/src/main/resources/template.md similarity index 98% rename from Tools-ReadmeGenerator/src/main/resources/template.md rename to tools-readme/src/main/resources/template.md index 24dda0d..c496dad 100644 --- a/Tools-ReadmeGenerator/src/main/resources/template.md +++ b/tools-readme/src/main/resources/template.md @@ -81,9 +81,10 @@ Do you prefer other programming languages? ## Events -{{events-content}} -{{for item of data }} +@{events-content} + +{{for item of data}} {{if item is 2}} @@ -102,6 +103,5 @@ my name is {{item.name}} {{listener-content}} ``` - ## Contributing Your improvements are welcome! Feel free to open an issue or pull request.