Merge pull request #11 from vikadata/polish

Polish 1.0.0 snapshot version

Author: shawndenggh

.travis.yml

@@ -27,9 +27,6 @@ before_install:
   # attention: only repo member can build, contribute user has no permission
   - openssl aes-256-cbc -K $encrypted_171b1c559d7b_key -iv $encrypted_171b1c559d7b_iv -in signingkey.asc.enc -out signingkey.asc -d
 
-script:
-  - mvn test -B
-
 deploy:
   - skip_cleanup: true
     provider: script

README.md

@@ -12,7 +12,7 @@
 
 [Vika](https://vika.cn) Official Java SDK
 
-Vikadata™ Java API (*vika.js*) provides a full featured and easy to consume Java
+Vikadata™ Java API (*vika.java*) provides a full featured and easy to consume Java
 library for working with vikadata via the Vikadata OpenAPI.<br/>
 
 --- 
@@ -34,7 +34,7 @@ Java 8+ is required to use sdk. not support Java 8 below
 <dependency>
     <groupId>cn.vika</groupId>
     <artifactId>vika-client</artifactId>
-    <version>0.1.0</version>
+    <version>1.0.0</version>
 </dependency>
 ```
 
@@ -43,7 +43,7 @@ Java 8+ is required to use sdk. not support Java 8 below
 ```groovy
 dependencies {
   ... ...
-  implementation('cn.vika:vika-client:0.1.0')
+  implementation('cn.vika:vika-client:1.0.0')
 }
 ```
 

client/pom.xml

@@ -23,6 +23,7 @@
             <artifactId>assertj-core</artifactId>
             <scope>test</scope>
         </dependency>
+
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>

client/src/main/java/cn/vika/client/api/AttachmentApi.java

@@ -47,7 +47,7 @@ public AttachmentApi(ApiHttpClient apiHttpClient) {
     }
 
     public Attachment upload(String datasheetId, ResourceLoader loader) throws ApiException {
-        HttpHeader httpHeader = HttpHeader.EMPTY;
+        HttpHeader httpHeader = new HttpHeader();
         httpHeader.setContentType(HttpMediaType.MULTIPART_FORM_DATA);
         FormDataMap formDataMap = new FormDataMap();
         formDataMap.put("file", loader);
@@ -63,7 +63,7 @@ public Attachment upload(String datasheetId, File file) throws ApiException {
     }
 
     public Attachment upload(String datasheetId, FormDataMap formData) throws ApiException {
-        HttpHeader httpHeader = HttpHeader.EMPTY;
+        HttpHeader httpHeader = new HttpHeader();
         httpHeader.setContentType(HttpMediaType.MULTIPART_FORM_DATA);
         HttpResult<Attachment> result = getDefaultHttpClient().post(String.format(PATH, datasheetId), httpHeader, formData, new GenericTypeReference<HttpResult<Attachment>>() {});
         return result.getData();

client/src/main/java/cn/vika/client/api/RecordApi.java

@@ -29,8 +29,8 @@
 import cn.vika.client.api.model.ApiQueryParam;
 import cn.vika.client.api.model.CreateRecordRequest;
 import cn.vika.client.api.model.HttpResult;
-import cn.vika.client.api.model.PagerInfo;
 import cn.vika.client.api.model.Pager;
+import cn.vika.client.api.model.PagerInfo;
 import cn.vika.client.api.model.Record;
 import cn.vika.client.api.model.Records;
 import cn.vika.client.api.model.UpdateRecordRequest;
@@ -66,7 +66,7 @@ public List<Record> getRecords(String datasheetId, int page, int itemsPerPage) t
         Map<String, String> uriVariables = queryParam.toMap();
         GenericTypeReference<HttpResult<PagerInfo<Record>>> reference = new GenericTypeReference<HttpResult<PagerInfo<Record>>>() {};
         String uri = String.format(PATH, datasheetId) + MapUtil.extractKeyToVariables(uriVariables);
-        HttpResult<PagerInfo<Record>> result = getDefaultHttpClient().get(uri, HttpHeader.EMPTY, reference, uriVariables);
+        HttpResult<PagerInfo<Record>> result = getDefaultHttpClient().get(uri, new HttpHeader(), reference, uriVariables);
         return result.getData().getRecords();
     }
 
@@ -98,7 +98,7 @@ public List<Record> addRecords(String datasheetId, CreateRecordRequest record) t
         if (record.getRecords().size() > 10) {
             throw new ApiException("record only can add 10 every request");
         }
-        HttpResult<Records> result = getDefaultHttpClient().post(String.format(PATH, datasheetId), HttpHeader.EMPTY, record, new GenericTypeReference<HttpResult<Records>>() {});
+        HttpResult<Records> result = getDefaultHttpClient().post(String.format(PATH, datasheetId), new HttpHeader(), record, new GenericTypeReference<HttpResult<Records>>() {});
         return result.getData().getRecords();
     }
 
@@ -109,7 +109,7 @@ public List<Record> updateRecords(String datasheetId, UpdateRecordRequest record
         if (record == null) {
             throw new RuntimeException("Record instance cannot be null.");
         }
-        HttpResult<Records> result = getDefaultHttpClient().patch(String.format(PATH, datasheetId), HttpHeader.EMPTY, record, new GenericTypeReference<HttpResult<Records>>() {});
+        HttpResult<Records> result = getDefaultHttpClient().patch(String.format(PATH, datasheetId), new HttpHeader(), record, new GenericTypeReference<HttpResult<Records>>() {});
         return result.getData().getRecords();
     }
 
@@ -129,6 +129,6 @@ public void deleteRecords(String datasheetId, List<String> recordIds) throws Api
         }
         Map<String, String> uriVariables = MapUtil.listToUriVariableMap("recordIds", recordIds);
         String uri = String.format(PATH, datasheetId) + MapUtil.extractKeyToVariables(uriVariables);
-        getDefaultHttpClient().delete(uri, HttpHeader.EMPTY, Void.class, uriVariables);
+        getDefaultHttpClient().delete(uri, new HttpHeader(), Void.class, uriVariables);
     }
 }

client/src/main/java/cn/vika/client/api/http/ApiHttpClient.java

@@ -63,7 +63,7 @@ public ApiHttpClient(ApiVersion apiVersion, String baseUrl, ApiCredential apiCre
     }
 
     private HttpHeader setDefaultHeader(ApiCredential apiCredential) {
-        HttpHeader header = HttpHeader.EMPTY;
+        HttpHeader header = new HttpHeader();
         header.setUserAgent("vika-java-client");
         header.setBearerAuth(apiCredential.getToken());
         return header;

client/src/main/java/cn/vika/client/api/model/Order.java

@@ -32,5 +32,14 @@ public enum Order {
     /**
      * sort records ascending
      */
-    ASC
+    ASC;
+
+    public static Order of(String name) {
+        for (Order value : Order.values()) {
+            if (value.name().toLowerCase().equals(name)) {
+                return value;
+            }
+        }
+        throw new NullPointerException("not support name: " + name);
+    }
 }

client/src/main/java/cn/vika/client/api/model/Pager.java

@@ -76,7 +76,7 @@ public Pager(AbstractApi api, String url, int itemsPerPage, Class<T> type) throw
         Map<String, String> uriVariables = this.queryParam.toMap();
         GenericTypeReference<HttpResult<PagerInfo<T>>> reference = new GenericTypeReference<HttpResult<PagerInfo<T>>>() {};
         String uri = url + MapUtil.extractKeyToVariables(uriVariables);
-        HttpResult<PagerInfo<T>> result = api.getDefaultHttpClient().get(uri, HttpHeader.EMPTY, reference, uriVariables);
+        HttpResult<PagerInfo<T>> result = api.getDefaultHttpClient().get(uri, new HttpHeader(), reference, uriVariables);
         if (result.getData().getRecords() != null) {
             this.currentItems = JacksonConverter.toGenericBean(result.getData().getRecords(), javaType);
             if (this.currentItems == null) {
@@ -99,7 +99,7 @@ public Pager(AbstractApi api, String url, ApiQueryParam queryParam, Class<T> typ
         GenericTypeReference<HttpResult<PagerInfo<T>>> reference = new GenericTypeReference<HttpResult<PagerInfo<T>>>() {};
         Map<String, String> uriVariables = this.queryParam.toMap();
         String uri = url + MapUtil.extractKeyToVariables(uriVariables);
-        HttpResult<PagerInfo<T>> result = api.getDefaultHttpClient().get(uri, HttpHeader.EMPTY, reference, uriVariables);
+        HttpResult<PagerInfo<T>> result = api.getDefaultHttpClient().get(uri, new HttpHeader(), reference, uriVariables);
         if (result.getData().getRecords() != null) {
             this.currentItems = JacksonConverter.toGenericBean(result.getData().getRecords(), javaType);
             if (this.currentItems == null) {
@@ -180,7 +180,7 @@ else if (pageNumber < 1) {
             // do Nothing
         }
         String uri = url + MapUtil.extractKeyToVariables(uriVariables);
-        HttpResult<PagerInfo<T>> result = api.getDefaultHttpClient().get(uri, HttpHeader.EMPTY, reference, uriVariables);
+        HttpResult<PagerInfo<T>> result = api.getDefaultHttpClient().get(uri, new HttpHeader(), reference, uriVariables);
         if (result.getData().getRecords() != null) {
             this.currentItems = JacksonConverter.toGenericBean(result.getData().getRecords(), javaType);
         }

client/src/test/java/cn/vika/client/api/AttachmentTest.java

@@ -19,70 +19,83 @@
 package cn.vika.client.api;
 
 import java.io.File;
+import java.net.URL;
 
+import cn.vika.client.api.http.ApiCredential;
 import cn.vika.client.api.model.Attachment;
 import cn.vika.core.http.ClassPathResourceLoader;
 import cn.vika.core.http.FileResourceLoader;
 import cn.vika.core.http.UrlResourceLoader;
 import cn.vika.core.utils.UrlUtil;
 import com.fasterxml.jackson.core.JsonProcessingException;
-import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestMethodOrder;
 
+import static cn.vika.client.api.ConstantKey.TEST_API_KEY;
 import static cn.vika.client.api.ConstantKey.TEST_DATASHEET_ID;
+import static cn.vika.client.api.ConstantKey.TEST_HOST_URL;
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * attachment test
- *
- * @author Zoe Zheng
- * @date 2020-12-17 18:49:24
+ * Attachment Api Test
+ * @author Shawn Deng
+ * @date 2021-02-24 16:33:58
  */
 @TestMethodOrder(OrderAnnotation.class)
-public class AttachmentTest extends BaseTest {
+public class AttachmentTest {
 
-    private static VikaApiClient vikaApiClient;
+    private final String DATASHEET_ID = TEST_DATASHEET_ID.get();
 
-    @BeforeAll
-    public static void setup() {
-        vikaApiClient = testInitApiClient();
-    }
+    private final String HOST_URL = TEST_HOST_URL.get();
+
+    private final String API_KEY = TEST_API_KEY.get();
+
+    private final VikaApiClient vikaApiClient = new VikaApiClient(HOST_URL, new ApiCredential(API_KEY));
 
     @Test
     @Order(1)
-    public void testUploadWithClassPathResource() throws JsonProcessingException {
-        Attachment attachment = vikaApiClient.getAttachmentApi().upload(TEST_DATASHEET_ID.get(), new ClassPathResourceLoader("test.txt"));
+    void testUploadWithClassPathResource() throws JsonProcessingException, InterruptedException {
+        Attachment attachment = vikaApiClient.getAttachmentApi().upload(DATASHEET_ID, new ClassPathResourceLoader("test.txt"));
         assertThat(attachment).isNotNull();
         System.out.println(JacksonJsonUtil.toJson(attachment, true));
+        Thread.sleep(1000);
     }
 
     @Test
     @Order(2)
-    public void testUploadWithUrlResource() throws JsonProcessingException {
-        Attachment attachment = vikaApiClient.getAttachmentApi().upload(TEST_DATASHEET_ID.get(), new UrlResourceLoader(UrlUtil.url("https://ss1.bdstatic.com/70cFuXSh_Q1YnxGkpoWK1HF6hhy/it/u=3483500324,2196746779&fm=26&gp=0.jpg")));
+    void testUploadWithUrlResource() throws JsonProcessingException, InterruptedException {
+        Attachment attachment = vikaApiClient.getAttachmentApi().upload(DATASHEET_ID, new UrlResourceLoader(UrlUtil.url("https://ss1.bdstatic.com/70cFuXSh_Q1YnxGkpoWK1HF6hhy/it/u=3483500324,2196746779&fm=26&gp=0.jpg")));
         assertThat(attachment).isNotNull();
         System.out.println(JacksonJsonUtil.toJson(attachment, true));
+        Thread.sleep(1000);
     }
 
     @Test
     @Order(3)
-    public void testUploadWithFileResource() throws JsonProcessingException {
-        File file = new File("/Users/shawndeng/Documents/Project/vika.java/client/src/test/resources/test.docx");
-        Attachment attachment = vikaApiClient.getAttachmentApi().upload(TEST_DATASHEET_ID.get(), new FileResourceLoader(file));
+    void testUploadWithFileResource() throws JsonProcessingException, InterruptedException {
+        ClassLoader classLoader = getClass().getClassLoader();
+        URL url = classLoader.getResource("test.txt");
+        assertThat(url).isNotNull();
+        File file = new File(url.getFile());
+        assertThat(file).isNotNull();
+        Attachment attachment = vikaApiClient.getAttachmentApi().upload(DATASHEET_ID, new FileResourceLoader(file));
         assertThat(attachment).isNotNull();
         System.out.println(JacksonJsonUtil.toJson(attachment, true));
+        Thread.sleep(1000);
     }
 
     @Test
     @Order(4)
-    public void testUploadWithFile() throws JsonProcessingException {
-        File file = new File("/Users/shawndeng/Documents/Project/vika.java/client/src/test/resources/test.docx");
-        Attachment attachment = vikaApiClient.getAttachmentApi().upload(TEST_DATASHEET_ID.get(), file);
+    void testUploadWithFile() throws JsonProcessingException {
+        ClassLoader classLoader = getClass().getClassLoader();
+        URL url = classLoader.getResource("test.xlsx");
+        assertThat(url).isNotNull();
+        File file = new File(url.getFile());
+        assertThat(file).isNotNull();
+        Attachment attachment = vikaApiClient.getAttachmentApi().upload(DATASHEET_ID, file);
         assertThat(attachment).isNotNull();
         System.out.println(JacksonJsonUtil.toJson(attachment, true));
     }
-
 }

client/src/test/java/cn/vika/client/api/ConstantKey.java

@@ -35,7 +35,6 @@ public enum ConstantKey {
     TEST_VIEW_ID("TEST_VIEW_ID"),
     TEST_SORT("TEST_SORT"),
     TEST_FIELDS("TEST_FIELDS"),
-    TEST_RECORD_IDS("TEST_RECORD_IDS"),
     TEST_FILTER_FORMULA("TEST_FILTER_FORMULA"),
     TEST_FIELD_KEY("TEST_FIELD_KEY"),
     TEST_MAX_RECORDS("TEST_MAX_RECORDS");
@@ -47,7 +46,7 @@ public enum ConstantKey {
     }
 
     public String get() {
-        String value =  PropertiesUtil.getProperty(this.key);
+        String value =  PropertiesUtil.getProperty(key);
         assertThat(value).isNotNull();
         return value;
     }