Add stream marker support

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.10.0
+
+- Stream marker support
+
 ## 0.9.0
 
 - Add "Missed Conversations" stream

lib/pnut.js

@@ -10,6 +10,7 @@ const users = require("./users");
 const posts = require("./posts");
 const explore = require("./explore");
 const channels = require("./channels");
+const streamMarkers = require("./stream_markers");
 const messages = require("./messages");
 const system = require("./system");
 const appStreams = require("./app_streams");
@@ -120,6 +121,7 @@ const pnut = () => {
     posts(api),
     explore(api),
     channels(api),
+    streamMarkers(api),
     messages(api),
     system(api),
     appStreams(api)

lib/stream_markers.js

@@ -0,0 +1,55 @@
+"use strict";
+
+/**
+ * Stream markers
+ * @module stream_markers
+ */
+module.exports = api => {
+  return {
+    /**
+     * Set a single stream marker.
+     *
+     * Valid values for the "name" argument are:
+     * - global
+     * - personal
+     * - mentions
+     * - channel:id
+     * @example
+     * pnut.marker("channel:18", 15100).then(res => {
+     *  console.log(res);
+     * });
+     * @param {string} name - Name of the markable stream
+     * @param {string|number} id - ID of the post / message
+     * @returns {Promise}
+     */
+    marker(name, id) {
+      return api.request(`/markers`, {
+        httpMethod: "POST",
+        data: [
+          {
+            name: name,
+            id: id
+          }
+        ]
+      });
+    },
+
+    /**
+     * Set up to 10 markers at once, like described in the pnut docs.
+     *
+     * @example
+     * pnut.markers([
+     *     { name: "channel:18", id: 15100 },
+     *     { name: "channel:19", id: 15101 }
+     * ]).then(res => console.log(res));
+     * @param {array} markerObjects - An array of marker objects
+     * @returns {Promise}
+     */
+    markers(markerObjects = []) {
+      return api.request(`/markers`, {
+        httpMethod: "POST",
+        data: markerObjects
+      });
+    }
+  };
+};

test/stream_markers_test.js

@@ -0,0 +1,52 @@
+const chai = require("chai");
+const chaiAsPromised = require("chai-as-promised");
+const nock = require("nock");
+chai.use(chaiAsPromised);
+chai.should();
+
+const pnut = require("../lib/pnut");
+
+before(function() {
+  let base = "https://api.pnut.io/v0";
+
+  nock(base)
+    .post("/markers", [
+      {
+        name: "channel:18",
+        id: 15100
+      }
+    ])
+    .reply(200, {});
+
+  nock(base)
+    .post("/markers", [
+      {
+        name: "channel:18",
+        id: 15100
+      },
+      {
+        name: "channel:19",
+        id: 15101
+      }
+    ])
+    .reply(200, {});
+});
+
+after(function() {
+  nock.cleanAll();
+});
+
+describe("Stream markers", () => {
+  it("should be able to update a single stream marker", () => {
+    return pnut.marker("channel:18", 15100).should.become({});
+  });
+
+  it("should be able to update a multiple stream markers", () => {
+    return pnut
+      .markers([
+        { name: "channel:18", id: 15100 },
+        { name: "channel:19", id: 15101 }
+      ])
+      .should.become({});
+  });
+});