Merge pull request #416 from SockDrawer/feat-lock-topics

feat(topic): Added lock and unlock
SockDrawer · Apr 11, 2017 · 2dcf223 · 2dcf223
2 parents d0373a9 + b2bb573
commit 2dcf223
Show file tree

Hide file tree

Showing 2 changed files with 90 additions and 0 deletions.
diff --git a/providers/nodebb/topic.js b/providers/nodebb/topic.js
@@ -347,6 +347,44 @@ exports.bindTopic = function bindTopic(forum) {
         unmute() {
             return Promise.resolve(this);
         }
+
+        /**
+         * Locks the topic. Will reject if you're not a moderator.
+         *
+         * @public
+         *
+         * @returns {Promise<Topic>} Resolves to self on completion
+         *
+         * @promise
+         * @fulfill {Topic} Source Topic
+         * @reject {Error} An Error that occured while posting
+         */
+        lock() {
+            return forum._emit('topics.lock', {
+                tids: [this.id],
+                cid: this.categoryId
+            })
+            .then(() => this);
+        }
+
+        /**
+         * Unlocks the topic. Will reject if you're not a moderator.
+         *
+         * @public
+         *
+         * @returns {Promise<Topic>} Resolves to self on completion
+         *
+         * @promise
+         * @fulfill {Topic} Source Topic
+         * @reject {Error} An Error that occured while posting
+         */
+        unlock() {
+            return forum._emit('topics.unlock', {
+                tids: [this.id],
+                cid: this.categoryId
+            })
+            .then(() => this);
+        }
 
         /**
          * Retrieve a topic by topic id

diff --git a/test/providers/nodebb/topicTest.js b/test/providers/nodebb/topicTest.js
@@ -369,6 +369,58 @@ describe('providers/nodebb/topic', () => {
                 return topic.unmute().should.become(topic);
             });
         });
+        describe('lock()', () => {
+            let topic, data;
+            beforeEach(() => {
+                topic = new Topic({});
+                data = utils.mapGet(topic);
+            });
+            it('should emit `topics.lock` via websocket', () => {
+                const id = Math.random();
+                const cid = Math.random();
+                data.id = id;
+                data.categoryId = cid;
+                return topic.lock().then(() => {
+                    forum._emit.calledWith('topics.lock', {
+                        tids: [id],
+                        cid: cid
+                    }).should.be.true;
+                });
+            });
+            it('should resolve to locked topic', () => {
+                return topic.lock().should.become(topic);
+            });
+            it('should reject if websocket rejects', () => {
+                forum._emit.rejects('bad');
+                return topic.lock().should.be.rejected;
+            });
+        });
+        describe('unlock()', () => {
+            let topic, data;
+            beforeEach(() => {
+                topic = new Topic({});
+                data = utils.mapGet(topic);
+            });
+            it('should emit `topics.unlock` via websocket', () => {
+                const id = Math.random();
+                const cid = Math.random();
+                data.id = id;
+                data.categoryId = cid;
+                return topic.unlock().then(() => {
+                    forum._emit.calledWith('topics.unlock', {
+                        tids: [id],
+                        cid: cid
+                    }).should.be.true;
+                });
+            });
+            it('should resolve to locked topic', () => {
+                return topic.unlock().should.become(topic);
+            });
+            it('should reject if websocket rejects', () => {
+                forum._emit.rejects('bad');
+                return topic.unlock().should.be.rejected;
+            });
+        });
         describe('static functions', () => {
             describe('static getRecentTopics()', () => {
                 let spy = () => 0;