Merge pull request #26 from GlitchLib/dev

Release v0.3.0

Author: stachu540

README.md

@@ -12,27 +12,27 @@
 # Glitch
 A hybrid-reactive Java wrapper for the Twitch. Supports using:
 
-* [OkHttpClient](http://square.github.io/okhttp) - a Retrofit alternatives
+* [OkHttpClient](http://square.github.io/okhttp) - http client
 * [Gson](https://github.com/google/gson) - JSON
 * [Project Reactor](http://projectreactor.io/)
 
 # Module Supports
-| Name | JVM (Tested) | Android (Not Tested) | 
+| Name | JVM | Android | 
 |:---:|:---:|:---:|
-| [glitch-core](core) | 1.8+ | ✔ (unknown) |
-| [glitch-kraken](kraken) | 1.8+ | ✔ (unknown) |
-| [glitch-helix](helix) | 1.8+ | ✔ (unknown) |
-| [glitch-auth](auth) | 1.8+ | ✔ (unknown) |
+| [glitch-core](core) | 1.8+ | ✔ SDK 26 |
+| [glitch-kraken](kraken) | 1.8+ | ✔ SDK 26 |
+| [glitch-helix](helix) | 1.8+ | ✔ SDK 26 |
+| [glitch-auth](auth) | 1.8+ | ✔ SDK 26 |
 | [glitch-chat](chat) | 1.8+ | ❌ |
 | [glitch-pubsub](pubsub) | 1.8+ | ❌ |
 
 # Getting started
 
-check the [BOM](./BOM) dependency how to import versions. Then get some examples below.
+Please introduce the [wiki page](https://glitchlib.github.io/wiki/getting-started/welcome/)
 
 ## Examples 
 
-Examples has been on [wiki page](./wiki)
+All example are be in **Basic Tutorials** on [wiki page](https://glitchlib.github.io/wiki/basic-tutorials/client/)
 
 # Licence
 

build.gradle

@@ -1,19 +1,14 @@
 plugins {
-    id "net.ltgt.apt" version "0.18"
+    id "net.ltgt.apt" version "0.19"
     id "com.jfrog.bintray" version "1.8.4"
-    id "com.jfrog.artifactory" version "4.7.5"
     id "de.lukaskoerfer.gradle.delombok" version "0.2"
-    id "io.spring.dependency-management" version "1.0.6.RELEASE"
 }
 
 allprojects {
-    apply plugin: "io.spring.dependency-management"
-
-    dependencyManagement {
-        imports {
-            mavenBom "io.projectreactor:reactor-bom:Californium-SR2"
-        }
-    }
+    apply plugin: "net.ltgt.apt"
+    apply plugin: "net.ltgt.apt-idea"
+    apply plugin: "net.ltgt.apt-eclipse"
+    apply plugin: "de.lukaskoerfer.gradle.delombok"
 
     repositories {
         jcenter()
@@ -22,11 +17,7 @@ allprojects {
 
 subprojects {
     apply plugin: "java"
-    apply plugin: "net.ltgt.apt"
     apply plugin: "maven-publish"
-    apply plugin: "net.ltgt.apt-idea"
-    apply plugin: "net.ltgt.apt-eclipse"
-    apply plugin: "de.lukaskoerfer.gradle.delombok"
 
     tasks.withType(JavaCompile) {
         options.incremental = true
@@ -40,6 +31,9 @@ subprojects {
 
     dependencies {
         if (project.name != "BOM" && project.name != "docs") {
+            // https://docs.gradle.org/5.0/userguide/managing_transitive_dependencies.html#sec:bom_import
+            compile enforcedPlatform("io.projectreactor:reactor-bom:Californium-SR3")
+
             compile "org.slf4j:slf4j-api:1.7.25"
 
             compileOnly "org.projectlombok:lombok:1.18.4"
@@ -59,6 +53,6 @@ subprojects {
 }
 
 wrapper {
-    gradleVersion = "4.10.2"
+    gradleVersion = "5.0"
     distributionType = Wrapper.DistributionType.ALL
 }

chat/src/main/java/glitch/chat/GlitchChat.java

@@ -30,7 +30,6 @@
 import java.time.Duration;
 import java.util.*;
 import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.function.Consumer;
 
 @Slf4j
 public class GlitchChat extends AbstractWebSocketService<GlitchChat> {
@@ -198,7 +197,7 @@ private Mono<Credential> createBotConfig() {
             return client.getCredentialManager().buildFromCredentials(botCredential);
         }
 
-        public Mono<GlitchChat> build() {
+        public Mono<GlitchChat> buildAsync() {
             return createBotConfig().map(credential -> new GlitchChat(client, new Configuration(credential, forceQuery.get()), eventProcessor, secure.get(), getApi()))
                     .doOnSuccess(client -> {
                         channels.forEach(client::joinChannel);
@@ -220,12 +219,8 @@ private GlitchKraken getApi() {
             }
         }
 
-        public void buildConsume(Consumer<GlitchChat> chat) {
-            build().subscribe(chat);
-        }
-
-        public GlitchChat buildBlocking() {
-            return build().block();
+        public GlitchChat build() {
+            return buildAsync().block();
         }
     }
 }

chat/src/main/java/glitch/chat/object/entities/ChannelEntity.java

@@ -32,7 +32,7 @@ public class ChannelEntity implements AbstractEntity<Channel> {
 
     public ChannelEntity(GlitchChat client, String channelName) {
         this.client = client;
-        this.data = (client.getApi() != null) ? client.getApi().use(UserService.class).flatMap(service -> service.getUser(channelName).next())
+        this.data = (client.getApi() != null) ? client.getApi().use(UserService.class).flatMap(service -> service.getUsers(channelName).next())
                 .flatMap(u -> client.getApi().use(ChannelService.class).flatMap(service -> service.getChannel(u.getId()))).switchIfEmpty(Mono.empty()) : Mono.empty();
         this.channelName = channelName;
 

chat/src/main/java/glitch/chat/object/entities/ChannelUserEntity.java

@@ -58,7 +58,7 @@ public GlitchChat getClient() {
     }
 
     public Mono<User> getData() {
-        return (getClient().getApi() != null) ? getClient().getApi().use(UserService.class).flatMap(service -> service.getUser(username).next()).switchIfEmpty(Mono.empty()) : Mono.empty();
+        return (getClient().getApi() != null) ? getClient().getApi().use(UserService.class).flatMap(service -> service.getUsers(username).next()).switchIfEmpty(Mono.empty()) : Mono.empty();
     }
 
     public Mono<Long> getFollowTime() {

chat/src/main/java/glitch/chat/object/entities/UserEntity.java

@@ -17,7 +17,7 @@ public UserEntity(GlitchChat client, String username) {
         this.client = client;
         this.username = username;
         this.data = (getClient().getApi() != null) ? getClient().getApi()
-                .use(UserService.class).zipWhen(service -> service.getUser(username).next())
+                .use(UserService.class).zipWhen(service -> service.getUsers(username).next())
                 .flatMap(tuple -> tuple.getT1().getChatUserState(tuple.getT2())) :
                 Mono.empty();
     }

core/build.gradle

@@ -3,10 +3,10 @@ plugins {
 }
 
 dependencies {
-    compile "com.google.guava:guava:27.0-jre"
+    compile "com.google.guava:guava:27.0.1-jre"
 
-    compile "com.squareup.okhttp3:okhttp:3.11.0"
-    compile "com.squareup.okhttp3:logging-interceptor:3.11.0"
+    compile "com.squareup.okhttp3:okhttp:3.12.0"
+    compile "com.squareup.okhttp3:logging-interceptor:3.12.0"
 
     compile "com.google.code.gson:gson:2.8.5"
 

core/src/main/java/glitch/api/AbstractHttpService.java

@@ -6,6 +6,7 @@
 import glitch.api.http.HttpRequest;
 import glitch.api.http.HttpResponse;
 import glitch.auth.Scope;
+import glitch.exceptions.http.ScopeIsMissingException;
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
@@ -28,7 +29,7 @@ public abstract class AbstractHttpService {
      */
     @Getter
     private final GlitchClient client;
-    private final GlitchHttpClient http;
+    protected final GlitchHttpClient http;
 
     /**
      * Create {@link HttpMethod#GET GET} Request
@@ -109,7 +110,24 @@ protected final <T> HttpResponse<T> exchange(HttpRequest<T> request) {
         return http.exchange(request);
     }
 
+    /**
+     * Checks Required scopes
+     *
+     * @param scopes        list of {@link Scope}
+     * @param requiredScope required {@link Scope}
+     * @return scope is exist
+     */
     protected final boolean checkRequiredScope(Collection<Scope> scopes, Scope requiredScope) {
         return scopes.contains(requiredScope);
     }
+
+    /**
+     * Handling {@link ScopeIsMissingException}
+     *
+     * @param requiredScope required {@link Scope}
+     * @return throwable exception called {@link ScopeIsMissingException}
+     */
+    protected ScopeIsMissingException handleScopeMissing(Scope requiredScope) {
+        return new ScopeIsMissingException(requiredScope);
+    }
 }

core/src/main/java/glitch/api/http/GlitchHttpClient.java

@@ -3,6 +3,7 @@
 import com.google.common.collect.ImmutableListMultimap;
 import com.google.common.collect.LinkedListMultimap;
 import com.google.common.collect.Multimap;
+import com.google.gson.FieldNamingPolicy;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import glitch.api.objects.adapters.ColorAdapter;
@@ -135,7 +136,7 @@ public static Builder builder() {
 
     private Request doRequest(HttpRequest<?> httpRequest) {
         return new Request.Builder()
-                .method(httpRequest.method.name(), getBody(httpRequest.body))
+                .method(httpRequest.method.name(), getBody(httpRequest.body, httpRequest.serializeNullsBody.get()))
                 .url(buildUrl(httpRequest.endpoint, httpRequest.queryParams))
                 .headers(buildHeaders(httpRequest.headers)).build();
     }
@@ -163,14 +164,16 @@ private String buildUrl(String endpoint, Multimap<String, ? extends Serializable
     }
 
     @Nullable
-    private RequestBody getBody(@Nullable Object body) {
+    private RequestBody getBody(@Nullable Object body, boolean serializeNulls) {
+        String requestBody = (serializeNulls) ? gson.newBuilder().serializeNulls().create().toJson(body) : gson.toJson(body);
         if (body == null) return null;
-        else return RequestBody.create(MediaType.get("application/json"), gson.toJson(body));
+        else return RequestBody.create(MediaType.get("application/json"), requestBody);
     }
 
     public static class Builder {
         private final Multimap<String, String> headers = LinkedListMultimap.create();
-        private final GsonBuilder gsonBuilder = new GsonBuilder();
+        private final GsonBuilder gsonBuilder = new GsonBuilder()
+                .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES);
         private String baseUrl;
 
         @Nullable

core/src/main/java/glitch/api/http/HttpRequest.java

@@ -6,6 +6,7 @@
 import javax.annotation.Nullable;
 import java.io.Serializable;
 import java.util.Map;
+import java.util.concurrent.atomic.AtomicBoolean;
 
 /**
  * HTTP Request created by {@code {@link GlitchHttpClient#create(HttpMethod, String, Class)}}.
@@ -19,6 +20,7 @@ public class HttpRequest<T> {
 
     @Nullable
     Object body;
+    final AtomicBoolean serializeNullsBody = new AtomicBoolean(false);
 
     final Multimap<String, String> headers = HashMultimap.create();
     final Multimap<String, ? extends Serializable> queryParams = HashMultimap.create();
@@ -32,13 +34,25 @@ public class HttpRequest<T> {
     /**
      * Set Request Body
      * @param body body Object
+     * @param serializeNulls serialize nulls
      * @return this
      */
-    public HttpRequest<T> body(Object body) {
+    public HttpRequest<T> body(Object body, boolean serializeNulls) {
         this.body = body;
+        this.serializeNullsBody.set(serializeNulls);
         return this;
     }
 
+    /**
+     * Set Request Body without serializing nulls
+     *
+     * @param body body Object
+     * @return this
+     */
+    public HttpRequest<T> body(Object body) {
+        return body(body, false);
+    }
+
     /**
      * Add Header to the Request
      * @param key Header Key

core/src/main/java/glitch/api/objects/json/interfaces/CursorList.java

@@ -0,0 +1,8 @@
+package glitch.api.objects.json.interfaces;
+
+import com.google.gson.annotations.SerializedName;
+
+public interface CursorList<E> extends OrdinalList<E> {
+    @SerializedName(value = "cursor", alternate = ("_cursor"))
+    String getCursor();
+}

core/src/main/java/glitch/api/objects/json/interfaces/OrdinalList.java

@@ -3,12 +3,30 @@
 import com.google.common.collect.ImmutableList;
 import com.google.gson.annotations.SerializedName;
 
-public interface OrdinalList<E extends IDObject<?>> {
+public interface OrdinalList<E> {
     @SerializedName(value = "data", alternate = {
-            "rooms"
+            "rooms",
+            "users",
+            "follows",
+            "teams",
+            "subscriptions",
+            "videos",
+            "communities",
+            "emoticons",
+            "clips",
+            "top",
+            "ingests",
+            "channels",
+            "games",
+            "streams",
+            "teams",
+            "vods",
+            "featured"
     })
     ImmutableList<E> getData();
 
     @SerializedName("_total")
-    int size();
+    default int size() {
+        return getData().size();
+    }
 }