@pipedream/streak 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Pipedream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@pipedream/streak",
+  "version": "0.0.1",
+  "description": "Pipedream Streak Components",
+  "main": "streak.app.mjs",
+  "keywords": [
+    "pipedream",
+    "streak"
+  ],
+  "homepage": "https://pipedream.com/apps/streak",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "license": "MIT",
+  "dependencies": {
+    "@pipedream/platform": "^1.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/sources/box-changed-pipeline/box-changed-pipeline.mjs

@@ -0,0 +1,33 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-box-changed-pipeline",
+  name: "Box Changed Pipeline (Instant)",
+  description: "Emit new event when a box changes pipelines.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      return this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+    },
+    getEventType() {
+      return "BOX_CHANGE_PIPELINE";
+    },
+    generateMeta(box) {
+      return {
+        id: box.lastUpdatedTimestamp,
+        summary: box.name,
+        ts: box.lastUpdatedTimestamp,
+      };
+    },
+  },
+};

package/sources/box-changed-stage/box-changed-stage.mjs

@@ -0,0 +1,33 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-box-changed-stage",
+  name: "Box Changed Stage (Instant)",
+  description: "Emit new event when a box's stage is updated in a pipeline.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      return this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+    },
+    getEventType() {
+      return "BOX_CHANGE_STAGE";
+    },
+    generateMeta(box) {
+      return {
+        id: box.lastUpdatedTimestamp,
+        summary: box.name,
+        ts: box.lastUpdatedTimestamp,
+      };
+    },
+  },
+};

package/sources/common/base.mjs

@@ -0,0 +1,57 @@
+import streak from "../../streak.app.mjs";
+
+export default {
+  props: {
+    streak,
+    db: "$.service.db",
+    http: "$.interface.http",
+    pipelineId: {
+      propDefinition: [
+        streak,
+        "pipelineId",
+      ],
+    },
+  },
+  hooks: {
+    async deploy() {
+      const events = await this.getHistoricalEvents(25);
+      if (!events || events.length === 0) {
+        return;
+      }
+      for (const item of events) {
+        const meta = this.generateMeta(item);
+        this.$emit(item, meta);
+      }
+    },
+    async deactivate() {
+      const hookId = this._getHookId();
+      await this.streak.deleteWebhook({
+        id: hookId,
+      });
+    },
+  },
+  methods: {
+    _getHookId() {
+      return this.db.get("hookId");
+    },
+    _setHookId(hookId) {
+      this.db.set("hookId", hookId);
+    },
+    shortenKey(key) {
+      return key.slice(-72);
+    },
+    getHistoricalEvents() {
+      throw new Error("getHistoricalEvents is not implemented");
+    },
+    generateMeta() {
+      throw new Error("generateMeta is not implemented");
+    },
+  },
+  async run(event) {
+    const { body } = event;
+    for (const item of body) {
+      const meta = this.generateMeta(item);
+      this.$emit(item, meta);
+    }
+  },
+};

package/sources/common/pipeline-based.mjs

@@ -0,0 +1,20 @@
+import common from "./base.mjs";
+
+export default {
+  ...common,
+  hooks: {
+    ...common.hooks,
+    async activate() {
+      const { key } = await this.streak.createWebhook({
+        params: {
+          pipelineKey: this.pipelineId,
+        },
+        data: {
+          targetUrl: this.http.endpoint,
+          event: this.getEventType(),
+        },
+      });
+      this._setHookId(key);
+    },
+  },
+};

package/sources/common/team-based.mjs

@@ -0,0 +1,63 @@
+import common from "./base.mjs";
+
+export default {
+  ...common,
+  props: {
+    ...common.props,
+    teamId: {
+      propDefinition: [
+        common.props.streak,
+        "teamId",
+      ],
+    },
+  },
+  hooks: {
+    ...common.hooks,
+    async activate() {
+      const { key } = await this.streak.createWebhook({
+        params: {
+          teamKey: this.teamId,
+        },
+        data: {
+          targetUrl: this.http.endpoint,
+          event: this.getEventType(),
+        },
+      });
+      this._setHookId(key);
+    },
+  },
+  methods: {
+    ...common.methods,
+    async getContactsInPipeline(limit) {
+      const boxes = await this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+      const contactIds = [];
+      for (const box of boxes) {
+        if (!box.contacts) {
+          continue;
+        }
+        const contactKeys = box.contacts.map((contact) => contact.key);
+        if (contactKeys?.length > 0) {
+          contactIds.push(...contactKeys);
+        }
+      }
+      const contacts = [];
+      for (const contactId of contactIds) {
+        const contact = await this.streak.getContact({
+          contactId,
+        });
+        contacts.push(contact);
+        if (contacts.length >= limit) {
+          contacts.length = limit;
+          break;
+        }
+      }
+      return contacts;
+    },
+  },
+};

package/sources/new-box/new-box.mjs

@@ -0,0 +1,33 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-new-box",
+  name: "New Box (Instant)",
+  description: "Emit new event when a new box is created in a pipeline.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      return this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "creationTimestamp",
+        },
+      });
+    },
+    getEventType() {
+      return "BOX_CREATE";
+    },
+    generateMeta(box) {
+      return {
+        id: this.shortenKey(box.key),
+        summary: box.name,
+        ts: box.creationTimestamp,
+      };
+    },
+  },
+};

package/sources/new-comment/new-comment.mjs

@@ -0,0 +1,45 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-new-comment",
+  name: "New Comment (Instant)",
+  description: "Emit new event when a new comment is created within a pipeline.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      const boxes = await this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+      const comments = [];
+      for (const box of boxes) {
+        const { results } = await this.streak.listComments({
+          boxId: box.key,
+        });
+        comments.push(...results);
+        if (comments.length >= limit) {
+          comments.length = limit;
+          break;
+        }
+      }
+      return comments;
+    },
+    getEventType() {
+      return "COMMENT_CREATE";
+    },
+    generateMeta(comment) {
+      return {
+        id: this.shortenKey(comment.key),
+        summary: comment.message,
+        ts: comment.timestamp,
+      };
+    },
+  },
+};

package/sources/new-contact/new-contact.mjs

@@ -0,0 +1,27 @@
+import common from "../common/team-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-new-contact",
+  name: "New Contact (Instant)",
+  description: "Emit new event when a new contact is created within a team.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      return this.getContactsInPipeline(limit);
+    },
+    getEventType() {
+      return "CONTACT_CREATE";
+    },
+    generateMeta(contact) {
+      return {
+        id: this.shortenKey(contact.key),
+        summary: contact.emailAddresses[0],
+        ts: contact.creationDate,
+      };
+    },
+  },
+};

package/sources/new-email-on-box/new-email-on-box.mjs

@@ -0,0 +1,34 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-new-email-on-box",
+  name: "New Email on Box (Instant)",
+  description: "Emit new event when an email is added to a box in a pipeline.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      const boxes = await this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+      return boxes.filter((box) => box?.emailAddresses.length > 0);
+    },
+    getEventType() {
+      return "BOX_NEW_EMAIL_ADDRESS";
+    },
+    generateMeta(box) {
+      return {
+        id: box.lastUpdatedTimestamp,
+        summary: box.name,
+        ts: box.lastUpdatedTimestamp,
+      };
+    },
+  },
+};

package/sources/new-task/new-task.mjs

@@ -0,0 +1,45 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-new-task",
+  name: "New Task (Instant)",
+  description: "Emit new event when a new task is created in a pipeline.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      const boxes = await this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+      const tasks = [];
+      for (const box of boxes) {
+        const { results } = await this.streak.listTasks({
+          boxId: box.key,
+        });
+        tasks.push(...results);
+        if (tasks.length >= limit) {
+          tasks.length = limit;
+          break;
+        }
+      }
+      return tasks;
+    },
+    getEventType() {
+      return "TASK_CREATE";
+    },
+    generateMeta(task) {
+      return {
+        id: this.shortenKey(task.key),
+        summary: task.text,
+        ts: task.creationDate,
+      };
+    },
+  },
+};

package/sources/new-task-due/new-task-due.mjs

@@ -0,0 +1,46 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-new-task-due",
+  name: "New Task Due (Instant)",
+  description: "Emit new event when a new task is created in a pipeline.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      const boxes = await this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+      const tasks = [];
+      for (const box of boxes) {
+        const { results } = await this.streak.listTasks({
+          boxId: box.key,
+        });
+        const pastDueTasks = results.filter((task) => task?.reminderStatus === "REMINDED");
+        tasks.push(...pastDueTasks);
+        if (tasks.length >= limit) {
+          tasks.length = limit;
+          break;
+        }
+      }
+      return tasks;
+    },
+    getEventType() {
+      return "TASK_DUE";
+    },
+    generateMeta(task) {
+      return {
+        id: this.shortenKey(task.key),
+        summary: task.text,
+        ts: task.lastStatusChangeDate,
+      };
+    },
+  },
+};

package/sources/task-completed/task-completed.mjs

@@ -0,0 +1,46 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-task-completed",
+  name: "Task Completed (Instant)",
+  description: "Emit new event when a task is completed in a pipeline.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      const boxes = await this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+      const tasks = [];
+      for (const box of boxes) {
+        const { results } = await this.streak.listTasks({
+          boxId: box.key,
+        });
+        const completedTasks = results.filter((task) => task?.status === "DONE");
+        tasks.push(...completedTasks);
+        if (tasks.length >= limit) {
+          tasks.length = limit;
+          break;
+        }
+      }
+      return tasks;
+    },
+    getEventType() {
+      return "TASK_COMPLETE";
+    },
+    generateMeta(task) {
+      return {
+        id: this.shortenKey(task.key),
+        summary: task.text,
+        ts: task.lastStatusChangeDate,
+      };
+    },
+  },
+};

package/sources/updated-box/updated-box.mjs

@@ -0,0 +1,33 @@
+import common from "../common/pipeline-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-updated-box",
+  name: "Updated Box (Instant)",
+  description: "Emit new event when a box is updated in a pipeline.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      return this.streak.listBoxes({
+        pipelineId: this.pipelineId,
+        params: {
+          limit,
+          sortBy: "lastUpdatedTimestamp",
+        },
+      });
+    },
+    getEventType() {
+      return "BOX_EDIT";
+    },
+    generateMeta(box) {
+      return {
+        id: box.lastUpdatedTimestamp,
+        summary: box.name,
+        ts: box.lastUpdatedTimestamp,
+      };
+    },
+  },
+};

package/sources/updated-contact/updated-contact.mjs

@@ -0,0 +1,27 @@
+import common from "../common/team-based.mjs";
+
+export default {
+  ...common,
+  key: "streak-updated-contact",
+  name: "Updated Contact (Instant)",
+  description: "Emit new event when a contact is updated within a team.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async getHistoricalEvents(limit) {
+      return this.getContactsInPipeline(limit);
+    },
+    getEventType() {
+      return "CONTACT_UPDATE";
+    },
+    generateMeta(contact) {
+      return {
+        id: contact.lastSavedTimestamp,
+        summary: contact.emailAddresses[0],
+        ts: contact.lastSavedTimestamp,
+      };
+    },
+  },
+};

package/streak.app.mjs

@@ -0,0 +1,125 @@
+import { axios } from "@pipedream/platform";
+
+export default {
+  type: "app",
+  app: "streak",
+  propDefinitions: {
+    pipelineId: {
+      type: "string",
+      label: "Pipeline",
+      description: "Filter by pipeline",
+      async options() {
+        const pipelines = await this.listPipelines();
+        return pipelines.map((pipeline) => ({
+          label: pipeline.name,
+          value: pipeline.key,
+        }));
+      },
+    },
+    teamId: {
+      type: "string",
+      label: "Team",
+      description: "Filter by team",
+      async options() {
+        const { results } = await this.listTeams();
+        return results.map((team) => ({
+          label: team.name,
+          value: team.key,
+        }));
+      },
+    },
+  },
+  methods: {
+    _getBaseUrl() {
+      return "https://www.streak.com/api/";
+    },
+    _getAuth() {
+      return {
+        username: this.$auth.api_key,
+      };
+    },
+    async _makeRequest(args = {}) {
+      const {
+        method = "GET",
+        path,
+        $ = this,
+        ...otherArgs
+      } = args;
+      const config = {
+        method,
+        url: `${this._getBaseUrl()}${path}`,
+        auth: this._getAuth(),
+        ...otherArgs,
+      };
+      return axios($, config);
+    },
+    async createWebhook(args = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "v2/webhooks",
+        ...args,
+      });
+    },
+    async deleteWebhook({
+      id, ...args
+    }) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `v2/webhooks/${id}`,
+        ...args,
+      });
+    },
+    async getContact({
+      contactId, ...args
+    }) {
+      return this._makeRequest({
+        path: `v2/contacts/${contactId}`,
+        ...args,
+      });
+    },
+    async listPipelines(args = {}) {
+      return this._makeRequest({
+        path: "v1/pipelines",
+        ...args,
+      });
+    },
+    async listTeams(args = {}) {
+      return this._makeRequest({
+        path: "v2/users/me/teams",
+        ...args,
+      });
+    },
+    async listBoxes({
+      pipelineId, ...args
+    }) {
+      return this._makeRequest({
+        path: `v1/pipelines/${pipelineId}/boxes`,
+        ...args,
+      });
+    },
+    async listComments({
+      boxId, ...args
+    }) {
+      return this._makeRequest({
+        path: `v2/boxes/${boxId}/comments`,
+        ...args,
+      });
+    },
+    async listTasks({
+      boxId, ...args
+    }) {
+      return this._makeRequest({
+        path: `v2/boxes/${boxId}/tasks`,
+        ...args,
+      });
+    },
+    async listContacts({
+      boxId, ...args
+    }) {
+      return this._makeRequest({
+        path: `v1/boxes/${boxId}`,
+        ...args,
+      });
+    },
+  },
+};