small changes

.github/USAGE.md

@@ -1,16 +1,15 @@
 ## | `Shadowsocks (Outline VPN) api wrapper`
-*You can found full example-code in:* [LINK](https://github.com/suuft/shadowsocks-java-wrapper/blob/master/src/test/java/net/suuft/shadowsocks)
+*You can found full example-code in:* [LINK](https://github.com/dynomake/outline-java-wrapper/blob/master/src/test/java/me/dynomake/outline)
 
 First initialize the instance of ShadowSocks Wrapper:
 ```java
-ShadowsocksWrapper shadowsocks = ShadowsocksFactory
-        .createWrapper(API_URL);
+OutlineWrapper outlineWrapper = OutlineWrapper.create(API_URL);
 ```
 
 Cool! Now you can work with the outline api, for example, create a key, and output a link to the console:
 
 ```java
-int newKeyId = shadowsocks.generateKey().id;
+int newKeyId = outlineWrapper.generateKey().id;
 System.out.println("new key: " + newKeyId);
 ```
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2023 suuft (aka: Juhani Layne, Valeriy Shushpanov)
+Copyright 2023 Valeriy Shushpanov (dynomake)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,5 +1,43 @@
 ## | `Shadowsocks (Outline VPN) api wrapper`
 Library for working with ShadowSocks remote servers (Outline VPN API) in Java.
-### | `Links`:
-* [Add as Depend](https://github.com/suuft/shadowsocks-java-wrapper/blob/master/.github/DEPEND.md)
-* [Usage Example](https://github.com/suuft/shadowsocks-java-wrapper/blob/master/.github/USAGE.md)
+* [Usage Example](https://github.com/dynomake/outline-java-wrapper/blob/master/.github/USAGE.md)
+
+## | `Add to project:`:
+Here is how to add this library depending on your project.
+### | `Gradle`:
+Repository:
+```groovy
+maven {
+    name = "clojars.org"
+    url = uri("https://repo.clojars.org")
+}
+```
+Depend:
+```groovy
+implementation 'io.github.dynomake:outline-java-wrapper:1.0.0'
+```
+
+### | `Maven`:
+
+Repository:
+
+```xml
+<repository>
+    <id>clojars.org</id>
+    <url>https://repo.clojars.org</url>
+</repository>
+```
+
+Depend:
+
+```xml
+
+<dependency>
+    <groupId>io.github.dynomake</groupId>
+    <artifactId>outline-java-wrapper</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```
+
+### | `Donations`:
+If you want to support my pet-projects and open-source projects, you always can send me crypro to my USDC wallet address on POLYGON network: `0xAE8840E02C52F4a289af083465d78C2329E6ca7B`

build.gradle

@@ -3,7 +3,7 @@ plugins {
     id 'maven-publish'
 }
 
-group 'works.naifu'
+group 'io.github.dynomake'
 version '1.0.0'
 
 sourceCompatibility = 1.8

settings.gradle

@@ -1,2 +1,2 @@
-rootProject.name = 'shadowsocks-java-wrapper'
+rootProject.name = 'outline-java-wrapper'
 

src/main/java/me/dynomake/outline/OutlineWrapper.java

@@ -0,0 +1,27 @@
+package me.dynomake.outline;
+
+import lombok.NonNull;
+import me.dynomake.outline.implementation.RealOutlineWrapper;
+import me.dynomake.outline.model.OutlineKey;
+import me.dynomake.outline.model.OutlineKeyList;
+import me.dynomake.outline.model.OutlineServer;
+
+/**
+ * Shadowsocks Java Wrapper written by dynomake developer.
+ * Distributed by MIT License.
+ */
+public interface OutlineWrapper {
+
+    static OutlineWrapper create(@NonNull String apiAddress) {
+        return new RealOutlineWrapper(apiAddress);
+    }
+
+    OutlineKeyList getKeys();
+
+    OutlineKey generateKey();
+
+    boolean removeKey(int keyIdentifier);
+
+    OutlineServer getServerInformation();
+
+}

src/main/java/net/suuft/shadowsocks/gson/GsonUtil.java → src/main/java/me/dynomake/outline/gson/GsonUtil.java

@@ -1,4 +1,4 @@
-package net.suuft.shadowsocks.gson;
+package me.dynomake.outline.gson;
 
 import com.google.gson.Gson;
 import lombok.Getter;

src/main/java/net/suuft/shadowsocks/implementation/RealShadowsocksWrapper.java → src/main/java/me/dynomake/outline/implementation/RealOutlineWrapper.java

@@ -1,12 +1,13 @@
-package net.suuft.shadowsocks.implementation;
+package me.dynomake.outline.implementation;
 
 import lombok.AllArgsConstructor;
 import lombok.NonNull;
-import net.suuft.shadowsocks.ShadowsocksWrapper;
-import net.suuft.shadowsocks.implementation.model.Response;
-import net.suuft.shadowsocks.model.OutlineKey;
-import net.suuft.shadowsocks.model.OutlineKeyList;
-import net.suuft.shadowsocks.model.OutlineServer;
+import me.dynomake.outline.OutlineWrapper;
+import me.dynomake.outline.gson.GsonUtil;
+import me.dynomake.outline.model.OutlineKey;
+import me.dynomake.outline.model.OutlineKeyList;
+import me.dynomake.outline.model.OutlineServer;
+import me.dynomake.outline.implementation.model.Response;
 
 import javax.net.ssl.*;
 import java.io.InputStream;
@@ -18,25 +19,23 @@
 import java.security.cert.X509Certificate;
 import java.util.Scanner;
 
-import static net.suuft.shadowsocks.gson.GsonUtil.unparseJson;
-
 /**
- * Shadowsocks Java Wrapper written by suuft developer.
+ * Shadowsocks Java Wrapper written by dynomake developer.
  * Distributed by MIT License.
  */
 @AllArgsConstructor
-public class RealShadowsocksWrapper implements ShadowsocksWrapper {
+public class RealOutlineWrapper implements OutlineWrapper {
 
     private String apiAddress;
 
     @Override
     public OutlineKeyList getKeys() {
-        return unparseJson(getResponse("/access-keys", "GET", null).responseString, OutlineKeyList.class);
+        return GsonUtil.unparseJson(getResponse("/access-keys", "GET", null).responseString, OutlineKeyList.class);
     }
 
     @Override
     public OutlineKey generateKey() {
-        return unparseJson(getResponse("/access-keys", "POST", null).responseString, OutlineKey.class);
+        return GsonUtil.unparseJson(getResponse("/access-keys", "POST", null).responseString, OutlineKey.class);
     }
 
     @Override
@@ -47,7 +46,7 @@ public boolean removeKey(int keyIdentifier) {
 
     @Override
     public OutlineServer getServerInformation() {
-        return unparseJson(getResponse("/server", "GET", null).responseString, OutlineServer.class);
+        return GsonUtil.unparseJson(getResponse("/server", "GET", null).responseString, OutlineServer.class);
     }
 
     private Response getResponse(@NonNull String requestAddress, @NonNull String method, String writableJson) {

src/main/java/net/suuft/shadowsocks/implementation/model/Response.java → src/main/java/me/dynomake/outline/implementation/model/Response.java

@@ -1,11 +1,11 @@
-package net.suuft.shadowsocks.implementation.model;
+package me.dynomake.outline.implementation.model;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.experimental.FieldDefaults;
 
 /**
- * Shadowsocks Java Wrapper written by suuft developer.
+ * Shadowsocks Java Wrapper written by dynomake developer.
  * Distributed by MIT License.
  */
 @AllArgsConstructor

src/main/java/net/suuft/shadowsocks/model/LimitModel.java → src/main/java/me/dynomake/outline/model/LimitModel.java

@@ -1,11 +1,11 @@
-package net.suuft.shadowsocks.model;
+package me.dynomake.outline.model;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.experimental.FieldDefaults;
 
 /**
- * Shadowsocks Java Wrapper written by suuft developer.
+ * Shadowsocks Java Wrapper written by dynomake developer.
  * Distributed by MIT License.
  */
 @AllArgsConstructor

src/main/java/net/suuft/shadowsocks/model/OutlineKey.java → src/main/java/me/dynomake/outline/model/OutlineKey.java

@@ -1,11 +1,11 @@
-package net.suuft.shadowsocks.model;
+package me.dynomake.outline.model;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.experimental.FieldDefaults;
 
 /**
- * Shadowsocks Java Wrapper written by suuft developer.
+ * Shadowsocks Java Wrapper written by dynomake developer.
  * Distributed by MIT License.
  */
 @AllArgsConstructor

src/main/java/net/suuft/shadowsocks/model/OutlineKeyList.java → src/main/java/me/dynomake/outline/model/OutlineKeyList.java

@@ -1,4 +1,4 @@
-package net.suuft.shadowsocks.model;
+package me.dynomake.outline.model;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
@@ -7,7 +7,7 @@
 import java.util.List;
 
 /**
- * Shadowsocks Java Wrapper written by suuft developer.
+ * Shadowsocks Java Wrapper written by dynomake developer.
  * Distributed by MIT License.
  */
 @AllArgsConstructor

src/main/java/net/suuft/shadowsocks/model/OutlineServer.java → src/main/java/me/dynomake/outline/model/OutlineServer.java

@@ -1,4 +1,4 @@
-package net.suuft.shadowsocks.model;
+package me.dynomake.outline.model;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
@@ -7,7 +7,7 @@
 import java.util.UUID;
 
 /**
- * Shadowsocks Java Wrapper written by suuft developer.
+ * Shadowsocks Java Wrapper written by dynomake developer.
  * Distributed by MIT License.
  */
 @AllArgsConstructor

src/test/java/me/dynomake/outline/LittleTest.java

@@ -0,0 +1,14 @@
+package me.dynomake.outline;
+
+public class LittleTest {
+    public static void main(String[] args) {
+        OutlineWrapper outlineWrapper = OutlineWrapper.create("https://127.0.0.1:50912/api");
+
+        System.out.println("server: " + outlineWrapper.getServerInformation().name);
+        System.out.println("in server keys: " + outlineWrapper.getKeys().accessKeys.size());
+        int newKeyId = outlineWrapper.generateKey().id;
+        System.out.println("new key: " + newKeyId);
+        System.out.println("new key delete result: " + outlineWrapper.removeKey(newKeyId));
+
+    }
+}