api: Add support for GET /realm/filters.

Author: Anupam-dagar

Diff for: README.md

@@ -125,6 +125,7 @@ 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 |
 
 # Testing
 

Diff for: examples/filters.js

@@ -0,0 +1,11 @@
+const zulip = require('../lib/');
+
+const config = {
+  username: process.env.ZULIP_USERNAME,
+  apiKey: process.env.ZULIP_API_KEY,
+  realm: process.env.ZULIP_REALM,
+};
+
+zulip(config).then((z) => {
+  z.filters.retrieve().then(console.log);
+}).catch(err => console.log(err.message));

Diff for: src/index.js

@@ -12,6 +12,7 @@ const emojis = require('./resources/emojis');
 const typing = require('./resources/typing');
 const reactions = require('./resources/reactions');
 const server = require('./resources/server');
+const filters = require('./resources/filters');
 
 function getCallEndpoint(config) {
   return function callEndpoint(endpoint, method = 'GET', params) {
@@ -40,6 +41,7 @@ function resources(config) {
     typing: typing(config),
     reactions: reactions(config),
     server: server(config),
+    filters: filters(config),
   };
 }
 

Diff for: src/resources/filters.js

@@ -0,0 +1,12 @@
+const api = require('../api');
+
+function filters(config) {
+  return {
+    retrieve: (params) => {
+      const url = `${config.apiURL}/realm/filters`;
+      return api(url, config, 'GET', params);
+    },
+  };
+}
+
+module.exports = filters;

Diff for: test/resources/filters.js

@@ -0,0 +1,32 @@
+const filters = require('../../lib/resources/filters');
+const common = require('../common');
+const chai = require('chai');
+chai.use(require('chai-as-promised'));
+
+chai.should();
+
+describe('Filters', () => {
+  it('should fetch realm filters', (done) => {
+    const validator = (url, options) => {
+      url.should.equal(`${common.config.apiURL}/realm/filters`);
+      options.should.not.have.property('body');
+      options.method.should.be.equal('GET');
+    };
+    const output = {
+      filters: [
+        ['#(?P<id>[0-9]{2,8})',
+          'https://github.com/zulip/zulip/pull/%(id)s',
+          1],
+      ],
+      msg: '',
+      result: 'success',
+    };
+    const stubs = common.getStubs(validator, output);
+    filters(common.config).retrieve()
+      .then((data) => {
+        data.should.have.property('result', 'success');
+        common.restoreStubs(stubs);
+        done();
+      }).catch(done);
+  });
+});