Merge pull request #22 from y-t99/master

add interface: create, delete field and create datasheet

Author: shawndenggh

README.md

@@ -267,7 +267,96 @@ File file = new File("/Users/Document/test.txt");
 Attachment attachment = vikaApiClient.getAttachmentApi().upload("datasheet_id", file);
 ```
 
+#### **Add Field**
+
+You can create field by sdk. Firstly, we need to build the property required by the field. Secondly, Using `CreateFieldRequestBuilder` to creating a `CreateFieldRequest` object. Finally, submitting the request to the specified space and the specified datasheet. If creating the field successfully, we can get the new field's `id` and `name`.
+
+> more detail about field type and property of field see official [API manual#create-field](https://vika.cn/developers/api/reference/#operation/create-fields)
+
+create single text field example:
+
+```java
+// build the SingleText field's property
+SingleTextFieldProperty singleTextFieldProperty = new SingleTextFieldProperty();
+singleTextFieldProperty.setDefaultValue("defaultValue");
+// create a CreateFieldRequest Object
+CreateFieldRequest<SingleTextFieldProperty> createFieldRequest = CreateFieldRequestBuilder
+                .create()
+                .ofType(FieldTypeEnum.SingleText)
+                .withName("singleText")
+                .withProperty(singleTextFieldProperty)
+                .build();
+// request to create a field
+CreateFieldResponse response = vikaApiClient.getFieldApi().addField("space_id", "datasheet_id", createFieldRequest);
+```
+
+ create text field example:
+
+```java
+// if field don't require property, we can skip the process that build the property
+CreateFieldRequest<EmptyProperty> createFieldRequest = CreateFieldRequestBuilder
+                .create()
+                .ofType(FieldTypeEnum.Text)
+                .withName("text")
+                .withoutProperty()
+                .build();
+// request to create a field
+CreateFieldResponse createFieldRequest = vikaApiClient.getFieldApi().addField("space_id", "datasheet_id", createFieldRequest);
+```
+
+#### **Detele Field**
+
+```java
+// we can use field_id to detele field
+vikaApiClient.getFieldApi().deleteField("space_id", "datasheet_id", "field_id");
+```
+
+#### **Add Datasheet**
+
+You can create a datasheet with the help of a `CreateDatasheetRequest` Object.  If creating the datasheet successfully, we can get the new datasheet's `id`, `name` and the fields' `id`, `name`. 
+
+> more detail see official [API munual#create-datasheet](https://vika.cn/developers/api/reference/#operation/create-datasheets)
+
+```java
+// create a CreateDatasheetRequest Object
+CreateDatasheetRequest createDatasheetRequest = new CreateDatasheetRequest();
+// datasheet's name is required.
+request.setName("datasheet");
+// add description to datasheet
+request.setDescription("description");
+// specify the folder where the datasheet is stored
+request.setFolderId("fold_id");
+// specify the datasheet's previous node
+request.setPreNodeId("pre_node_id");
+
+// datasheet's initial fields
+SingleTextFieldProperty property = new SingleTextFieldProperty();
+property.setDefaultValue("defaultValue");
+// a SingleText field
+CreateFieldRequest<SingleTextFieldProperty> singleSelectField = CreateFieldRequestBuilder
+                .create()
+                .ofType(FieldTypeEnum.SingleText)
+                .withName("singleSelect")
+                .withProperty(property)
+                .build();
+// a Text field
+CreateFieldRequest<EmptyProperty> textField = CreateFieldRequestBuilder
+                .create()
+                .ofType(FieldTypeEnum.Text)
+                .withName("text")
+                .withoutProperty()
+                .build();
+List<CreateFieldRequest<?>> fields = new ArrayList<>();
+fields.add(singleSelectField);
+fields.add(textField);
+request.setFields(fields);
+
+// request to create a datasheet
+CreateDatasheetResponse response = vikaApiClient.getDatasheetApi().addDatasheet("space_id", createDatasheetRequest);
+```
+
 ## Reporting Issues
+
 Vika java sdk project uses GitHub's integrated issue tracking system to record bugs and feature requests.
 If you want to raise an issue, please follow the recommendations below:
 
@@ -279,4 +368,3 @@ If you want to raise an issue, please follow the recommendations below:
 ## License
 Open Source software released under the [MIT License](https://vikadata.mit-license.org).
 
-

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

@@ -0,0 +1,45 @@
+package cn.vika.client.api;
+
+import cn.vika.client.api.exception.ApiException;
+import cn.vika.client.api.http.AbstractApi;
+import cn.vika.client.api.http.ApiHttpClient;
+import cn.vika.client.api.model.CreateDatasheetRequest;
+import cn.vika.client.api.model.CreateDatasheetResponse;
+import cn.vika.client.api.model.HttpResult;
+import cn.vika.core.http.GenericTypeReference;
+import cn.vika.core.http.HttpHeader;
+import cn.vika.core.utils.StringUtil;
+
+/**
+ * @author tao
+ */
+public class DatasheetApi extends AbstractApi {
+
+    private static final String POST_DATASHEET_PATH = "/spaces/%s/datasheets";
+
+    public DatasheetApi(ApiHttpClient apiHttpClient) {
+        super(apiHttpClient);
+    }
+
+    public CreateDatasheetResponse addDatasheet(String spaceId,
+            CreateDatasheetRequest datasheet) {
+
+        checkPostDatasheetPathArgs(spaceId);
+
+        final String path = String.format(POST_DATASHEET_PATH, spaceId);
+
+        HttpResult<CreateDatasheetResponse> result = getDefaultHttpClient().post(
+                path, new HttpHeader(), datasheet,
+                new GenericTypeReference<HttpResult<CreateDatasheetResponse>>() {});
+        return result.getData();
+    }
+
+    private void checkPostDatasheetPathArgs(String spaceId) {
+
+        if (!StringUtil.hasText(spaceId)) {
+            throw new ApiException("space id must be not null");
+        }
+
+    }
+
+}

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

@@ -0,0 +1,75 @@
+package cn.vika.client.api;
+
+import cn.vika.client.api.exception.ApiException;
+import cn.vika.client.api.http.AbstractApi;
+import cn.vika.client.api.http.ApiHttpClient;
+import cn.vika.client.api.model.CreateFieldRequest;
+import cn.vika.client.api.model.CreateFieldResponse;
+import cn.vika.client.api.model.HttpResult;
+import cn.vika.client.api.model.field.property.BaseFieldProperty;
+import cn.vika.core.http.GenericTypeReference;
+import cn.vika.core.http.HttpHeader;
+import cn.vika.core.utils.StringUtil;
+
+/**
+ * @author wuyitao
+ */
+public class FieldApi extends AbstractApi {
+
+    private static final String POST_FIELD_PATH = "/spaces/%s/datasheets/%s/fields";
+
+    private static final String DELETE_FIELD_PATH = "/spaces/%s/datasheets/%s/fields/%s";
+
+
+    public FieldApi(ApiHttpClient apiHttpClient) {
+        super(apiHttpClient);
+    }
+
+    public CreateFieldResponse addField(String spaceId, String datasheetId,
+            CreateFieldRequest<? extends BaseFieldProperty> field) throws ApiException {
+
+        checkPostFieldPathArgs(spaceId, datasheetId);
+
+        final String path = String.format(POST_FIELD_PATH, spaceId, datasheetId);
+        HttpResult<CreateFieldResponse> result = getDefaultHttpClient().post(
+                        path, new HttpHeader(), field,
+                        new GenericTypeReference<HttpResult<CreateFieldResponse>>() {});
+        return result.getData();
+    }
+
+    private void checkPostFieldPathArgs(String spaceId, String datasheetId) {
+
+        if (!StringUtil.hasText(spaceId)) {
+            throw new ApiException("space id must be not null");
+        }
+
+        if (!StringUtil.hasText(datasheetId)) {
+            throw new ApiException("datasheet id must be not null");
+        }
+
+    }
+
+    public void deleteField(String spaceId, String datasheetId, String fieldId) {
+
+        checkDeleteFieldPathArgs(spaceId, datasheetId, fieldId);
+
+        final String path = String.format(DELETE_FIELD_PATH, spaceId, datasheetId, fieldId);
+
+        getDefaultHttpClient().delete(path, new HttpHeader(), Void.class);
+
+    }
+
+    private void checkDeleteFieldPathArgs(String spaceId, String datasheetId, String fieldId) {
+        if (!StringUtil.hasText(spaceId)) {
+            throw new ApiException("space id must not be null");
+        }
+
+        if (!StringUtil.hasText(datasheetId)) {
+            throw new ApiException("datasheet id must not be null");
+        }
+
+        if (!StringUtil.hasText(fieldId)) {
+            throw new ApiException("fieldId id must not be null");
+        }
+    }
+}

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

@@ -43,11 +43,15 @@ public class VikaApiClient {
 
     private final ApiHttpClient apiHttpClient;
 
-    private RecordApi recordApi;
+    private volatile RecordApi recordApi;
 
-    private AttachmentApi attachmentApi;
+    private volatile AttachmentApi attachmentApi;
 
-    private NodeApi nodeApi;
+    private volatile NodeApi nodeApi;
+
+    private volatile FieldApi fieldApi;
+
+    private volatile DatasheetApi datasheetApi;
 
     public VikaApiClient(ApiCredential credential) {
         this(ApiVersion.V1, DEFAULT_HOST, credential);
@@ -159,4 +163,26 @@ public NodeApi getNodeApi() {
         }
         return this.nodeApi;
     }
+
+    public FieldApi getFieldApi() {
+        if (this.fieldApi == null) {
+            synchronized (this) {
+                if (this.fieldApi == null) {
+                    this.fieldApi = new FieldApi(this.apiHttpClient);
+                }
+            }
+        }
+        return fieldApi;
+    }
+
+    public DatasheetApi getDatasheetApi() {
+        if (this.datasheetApi == null) {
+            synchronized (this) {
+                if (this.datasheetApi == null) {
+                    this.datasheetApi = new DatasheetApi(this.apiHttpClient);
+                }
+            }
+        }
+        return datasheetApi;
+    }
 }

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

@@ -0,0 +1,59 @@
+package cn.vika.client.api.model;
+
+import java.util.List;
+
+/**
+ * @author tao
+ */
+public class CreateDatasheetRequest {
+
+    private String name;
+
+    private String description;
+
+    private String folderId;
+
+    private String preNodeId;
+
+    private List<CreateFieldRequest<?>> fields;
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    public String getFolderId() {
+        return folderId;
+    }
+
+    public void setFolderId(String folderId) {
+        this.folderId = folderId;
+    }
+
+    public String getPreNodeId() {
+        return preNodeId;
+    }
+
+    public void setPreNodeId(String preNodeId) {
+        this.preNodeId = preNodeId;
+    }
+
+    public List<CreateFieldRequest<?>> getFields() {
+        return fields;
+    }
+
+    public void setFields(List<CreateFieldRequest<?>> fields) {
+        this.fields = fields;
+    }
+}

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

@@ -0,0 +1,40 @@
+package cn.vika.client.api.model;
+
+import java.util.List;
+
+/**
+ * @author tao
+ */
+public class CreateDatasheetResponse {
+
+    private String id;
+
+    private long createdAt;
+
+    private List<CreateFieldResponse> fields;
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public long getCreatedAt() {
+        return createdAt;
+    }
+
+    public void setCreatedAt(long createdAt) {
+        this.createdAt = createdAt;
+    }
+
+    public List<CreateFieldResponse> getFields() {
+        return fields;
+    }
+
+    public void setFields(List<CreateFieldResponse> fields) {
+        this.fields = fields;
+    }
+
+}