Add symlink api (#673)

* FEAT: add symlink api or test cases

* FIX: opt symlink code

* OPT: test case decode

Author: Ari1c

README.md

@@ -106,6 +106,8 @@ All operation use es7 async/await to implement. All api is async function.
   - [.putACL(name, acl[, options])](#putaclname-acl-options)
   - [.getACL(name[, options])](#getaclname-options)
   - [.restore(name[, options])](#restorename-options)
+  - [.putSymlink(name, targetName[, options])](#putsymlinkname-targetname-options)
+  - [.getSymlink(name[, options])](#getsymlinkname-options)
   - [.initMultipartUpload(name[, options])](#initmultipartuploadname-options)
   - [.uploadPart(name, uploadId, partNo, file, start, end[, options])](#uploadpartname-uploadid-partno-file-start-end-options)
   - [.uploadPartCopy(name, uploadId, partNo, range, sourceData[, options])](#uploadpartcopyname-uploadid-partno-range-sourcedata-options)
@@ -1761,6 +1763,63 @@ const result = await store.restore('ossdemo.txt');
 console.log(result.status);
 ```
 
+### .putSymlink(name, targetName[, options])
+
+PutSymlink
+
+parameters:
+
+- name {String} object name
+- targetName {String} target name
+- [options] {Object} optional parameters
+  - [headers] {Object} extra headers
+    - [x-oss-storsge-calss] {String} set the header x-oss-storage-class 
+
+Success will return
+
+- res {Object} response info, including
+  - status {Number} response status
+  - headers {Object} response headers
+  - size {Number} response size
+  - rt {Number} request total use time (ms)
+
+example:
+
+```js
+const options = {
+  headers: {
+    'x-oss-storage-class': 'IA'
+  }
+}
+const result = await store.putSymlink('ossdemo.txt', 'targetName', options)
+console.log(result.status)
+```
+
+### .getSymlink(name[, options])
+
+GetSymlink
+
+parameters:
+
+- name {String} object name
+- [options] {Object} optional parameters
+
+Success will return
+
+- targetName {String} symlink info
+- res {Object} response info, including
+  - status {Number} response status
+  - headers {Object} response headers
+  - size {Number} response size
+  - rt {Number} request total use time (ms)
+
+example:
+
+```js
+const result = await store.getSymlink('ossdemo.txt')
+console.log(result.status)
+```
+
 ### .initMultipartUpload(name[, options])
 Before transmitting data in the Multipart Upload mode,
 you must call the Initiate Multipart Upload interface to notify the OSS to initiate a Multipart Upload event.

lib/browser/object.js

@@ -430,6 +430,56 @@ proto.restore = async function restore(name, options) {
   };
 };
 
+/**
+ * putSymlink
+ * @param {Sting} name - object name
+ * @param {String} targetName - target name
+ * @param {Object} options
+ * @param {{res}}
+ */
+
+proto.putSymlink = async function putSymlink(name, targetName, options) {
+  options = options || {};
+  options.headers = options.headers || {};
+  this._convertMetaToHeaders(options.meta, options.headers);
+  options.headers['x-oss-symlink-target'] = targetName;
+  options.subres = 'symlink';
+
+  if (options.storageClass) {
+    options.headers['x-oss-storage-class'] = options.storageClass;
+  }
+
+  name = this._objectName(name);
+  const params = this._objectRequestParams('PUT', name, options);
+
+  params.successStatuses = [200];
+  const result = await this.request(params);
+  return {
+    res: result.res
+  };
+};
+
+/**
+ * getSymlink
+ * @param {String} -object name
+ * @param {Object} options
+ * @param {{res}}
+ */
+
+proto.getSymlink = async function getSymlink(name, options) {
+  options = options || {};
+  options.subres = 'symlink';
+  name = this._objectName(name);
+  const params = this._objectRequestParams('GET', name, options);
+  params.successStatuses = [200];
+  const result = await this.request(params);
+  const target = result.res.headers['x-oss-symlink-target'];
+  return {
+    targetName: target,
+    res: result.res
+  };
+};
+
 proto.signatureUrl = function signatureUrl(name, options) {
   options = options || {};
   name = this._objectName(name);

lib/object.js

@@ -447,6 +447,56 @@ proto.restore = async function restore(name, options) {
   };
 };
 
+/**
+ * putSymlink
+ * @param {Sting} name - object name
+ * @param {String} targetName - target name
+ * @param {Object} options
+ * @param {{res}}
+ */
+
+proto.putSymlink = async function putSymlink(name, targetName, options) {
+  options = options || {};
+  options.headers = options.headers || {};
+  this._convertMetaToHeaders(options.meta, options.headers);
+  options.headers['x-oss-symlink-target'] = targetName;
+  options.subres = 'symlink';
+
+  if (options.storageClass) {
+    options.headers['x-oss-storage-class'] = options.storageClass;
+  }
+
+  name = this._objectName(name);
+  const params = this._objectRequestParams('PUT', name, options);
+
+  params.successStatuses = [200];
+  const result = await this.request(params);
+  return {
+    res: result.res
+  };
+};
+
+/**
+ * getSymlink
+ * @param {String} -object name
+ * @param {Object} options
+ * @param {{res}}
+ */
+
+proto.getSymlink = async function getSymlink(name, options) {
+  options = options || {};
+  options.subres = 'symlink';
+  name = this._objectName(name);
+  const params = this._objectRequestParams('GET', name, options);
+  params.successStatuses = [200];
+  const result = await this.request(params);
+  const target = result.res.headers['x-oss-symlink-target'];
+  return {
+    targetName: target,
+    res: result.res
+  };
+};
+
 proto.signatureUrl = function signatureUrl(name, options) {
   options = options || {};
   name = this._objectName(name);

test/node/object.test.js

@@ -1639,4 +1639,24 @@ describe('test/object.test.js', () => {
       }
     });
   });
+  describe('symlink()', () => {
+    it('Should put and get Symlink', async () => {
+      const name = '/oss/symlink.js';
+      const test = 'test-symlink.js';
+      let result = await store.put(name, __filename);
+
+      const options = {
+        headers: {
+          'x-oss-storsge-calss': 'IA'
+        }
+      }
+      result = await store.putSymlink(test, name, options);
+      assert.equal(result.res.status, 200);
+
+      result = await store.getSymlink(test);
+      assert.equal(typeof result.res.headers['x-oss-storage-class'], 'string');
+      assert.equal(decodeURIComponent(result.targetName), name);
+      assert.equal(result.res.status, 200);
+    });
+  });
 });