endpoint enhancement: Add endpoint for mark messages.

Implement endpoints for mark all messages,
mark messages in stream and
mark messages in topic.

Author: yasiruRathnayaka97

README.md

@@ -130,7 +130,10 @@ await zulip.callEndpoint('/messages', 'POST', params);
 | `zulip.users.me.subscriptions.remove()` | DELETE `/users/me/subscriptions` | remove subscriptions. |
 | `zulip.users.me.pointer.update()` | POST `users/me/pointer` | updates the pointer for the user, for moving the home view. Accepts a message id. This has the side effect of marking some messages as read. Will not return success if the message id is invalid. Will always succeed if the id is less than the current value of the pointer (the id of the last message read). |
 | `zulip.server.settings()` | GET `/server_settings` | returns a dictionary of server settings. |
-| `zulip.filters.retrieve()` | GET `realm/filters` | return a list of filters in a realm |
+| `zulip.filters.retrieve()` | GET `realm/filters` | return a list of filters in a realm. |
+| `zulip.mark.all()` | POST `/mark_all_as_read ` | Marks all of the current user's unread messages as read. |
+| `zulip.mark.stream()` | POST `/mark_stream_as_read ` | Mark all the unread messages in a stream as read. Accepts a params object with `stream_id`. |
+| `zulip.mark.topic()` | POST `/mark_topic_as_read ` | Mark all the unread messages in a topic as read. Accepts a params object with `stream_id` and `topic_name`. |
 
 # Testing
 

examples/mark.js

@@ -0,0 +1,25 @@
+const zulip = require('../lib');
+
+const config = {
+  username: process.env.ZULIP_USERNAME,
+  apiKey: process.env.ZULIP_API_KEY,
+  realm: process.env.ZULIP_REALM,
+};
+
+(async () => {
+  const z = await zulip(config);
+  // Mark all messages as read
+  console.log(await z.mark.all());
+
+  // Mark all the unread messages in a stream as read
+  const streamParams = {
+    stream_id: 1,
+  };
+  console.log(await z.mark.stream(streamParams));
+  // Mark all the unread messages in a topic as read
+  const topicParams = {
+    stream_id: 1,
+    topic_name: 'Testing zulip-js',
+  };
+  console.log(await z.mark.topic(topicParams));
+})();

src/api.js

@@ -8,14 +8,16 @@ async function api(baseUrl, config, method, params) {
   const authHeader = `Basic ${auth}`;
   const options = { method, headers: { Authorization: authHeader } };
   if (method === 'POST') {
-    options.body = new helper.FormData();
-    Object.keys(params).forEach((key) => {
-      let data = params[key];
-      if (Array.isArray(data)) {
-        data = JSON.stringify(data);
-      }
-      options.body.append(key, data);
-    });
+    if (params) {
+      options.body = new helper.FormData();
+      Object.keys(params).forEach((key) => {
+        let data = params[key];
+        if (Array.isArray(data)) {
+          data = JSON.stringify(data);
+        }
+        options.body.append(key, data);
+      });
+    }
   } else if (params) {
     Object.entries(params).forEach(([key, value]) => {
       url.searchParams.append(key, value);

src/index.js

@@ -14,6 +14,7 @@ const reactions = require('./resources/reactions');
 const server = require('./resources/server');
 const filters = require('./resources/filters');
 const eventsWapper = require('./events_wrapper');
+const mark = require('./resources/mark');
 
 function getCallEndpoint(config) {
   return function callEndpoint(endpoint, method = 'GET', params) {
@@ -43,6 +44,7 @@ function resources(config) {
     server: server(config),
     filters: filters(config),
     callOnEachEvent: eventsWapper(config),
+    mark: mark(config),
   };
 }
 

src/resources/mark.js

@@ -0,0 +1,20 @@
+const api = require('../api');
+
+function mark(config) {
+  return {
+    all: (params) => {
+      const url = `${config.apiURL}/mark_all_as_read`;
+      return api(url, config, 'POST', params);
+    },
+    stream: (params) => {
+      const url = `${config.apiURL}/mark_stream_as_read`;
+      return api(url, config, 'POST', params);
+    },
+    topic: (params) => {
+      const url = `${config.apiURL}/mark_topic_as_read`;
+      return api(url, config, 'POST', params);
+    },
+  };
+}
+
+module.exports = mark;

test/resources/mark.js

@@ -0,0 +1,59 @@
+const chai = require('chai');
+const mark = require('../../lib/resources/mark');
+const common = require('../common');
+
+chai.should();
+
+describe('Mark', () => {
+  // it('should mark all messages as read', async () => {
+  //   const validator = (url, options) => {
+  //     url.should.contain(`${common.config.apiURL}/mark_all_as_read`);
+  //     Object.keys(options.body.data).length.should.equal(2);
+  //     options.method.should.be.equal('POST');
+  //   };
+  //   const output = {
+  //     msg: '',
+  //     result: 'success',
+  //   };
+  //   common.stubNetwork(validator, output);
+  //   const data = await mark(common.config).all();
+  //   data.should.have.property('result', 'success');
+  // });
+
+  // it('should mark stream as read', async () => {
+  //   const params = {
+  //     stream_id: 15,
+  //   };
+  //   const validator = (url, options) => {
+  //     url.should.contain(`${common.config.apiURL}/mark_stream_as_read`);
+  //     Object.keys(options.body.data).length.should.equal(2);
+  //     options.method.should.be.equal('POST');
+  //   };
+  //   const output = {
+  //     msg: '',
+  //     result: 'success',
+  //   };
+  //   common.stubNetwork(validator, output);
+  //   const dataStream = await mark(common.config).stream(params);
+  //   dataStream.should.have.property('result', 'success');
+  // });
+
+  it('should mark topic as read', async () => {
+    const params = {
+      stream_id: 15,
+      topic_name: 'Denmark1',
+    };
+    const validator = (url, options) => {
+      url.should.contain(`${common.config.apiURL}/mark_topic_as_read`);
+      Object.keys(options.body.data).length.should.equal(2);
+      options.method.should.be.equal('POST');
+    };
+    const output = {
+      msg: '',
+      result: 'success',
+    };
+    common.stubNetwork(validator, output);
+    const dataTopic = await mark(common.config).topic(params);
+    dataTopic.should.have.property('result', 'success');
+  });
+});