Add endpoint to get realm emojis.

Author: Anupam-dagar

Diff for: README.md

@@ -110,6 +110,7 @@ zulip.callEndpoint('/messages', 'POST', params);
 | `zulip.users.create()` | POST `/users` | create a new user. |
 | `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.realm.retrieve()` | GET `realm/emoji` | returns a dictionary of all the emojis in a realm |
 
 # Testing
 

Diff for: examples/realm.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.realm.retrieve().then(console.log);
+}).catch(err => console.log(err.message));

Diff for: src/index.js

@@ -13,6 +13,7 @@ const users = require('./resources/users');
 const emojis = require('./resources/emojis');
 const typing = require('./resources/typing');
 const reactions = require('./resources/reactions');
+const realm = require('./resources/realm');
 
 function callEndpoint(endpoint, method = 'GET', params) {
   let finalendpoint = endpoint;
@@ -36,6 +37,7 @@ function resources(config) {
     emojis: emojis(config),
     typing: typing(config),
     reactions: reactions(config),
+    realm: realm(config),
   };
 }
 

Diff for: src/resources/realm.js

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

Diff for: test/resources/realm.js

@@ -0,0 +1,36 @@
+const realm = require('../../lib/resources/realm');
+const common = require('../common');
+const chai = require('chai');
+chai.use(require('chai-as-promised'));
+
+chai.should();
+
+describe('Realm', () => {
+  it('should fetch realm emojis', (done) => {
+    const validator = (url, options) => {
+      url.should.equal(`${common.config.apiURL}/realm/emoji`);
+      options.should.not.have.property('body');
+      options.method.should.be.equal('GET');
+    };
+    const output = {
+      emoji: {
+        3: {
+          author: null,
+          deactivated: false,
+          name: 'jenkins',
+          id: '3',
+          source_url: '/user_avatars/2/emoji/images/3.png',
+        },
+      },
+      msg: '',
+      result: 'success',
+    };
+    const stubs = common.getStubs(validator, output);
+    realm(common.config).retrieve()
+      .then((data) => {
+        data.should.have.property('result', 'success');
+        common.restoreStubs(stubs);
+        done();
+      }).catch(done);
+  });
+});