@pipedream/zendesk 0.3.3

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/common/constants.mjs

@@ -0,0 +1,29 @@
+const SUBDOMAIN_PLACEHOLDER = "{subdomain}";
+const BASE_URL = `https://${SUBDOMAIN_PLACEHOLDER}.zendesk.com`;
+const VERSION_PATH = "/api/v2";
+const WEBHOOK_ID = "webhookId";
+const TRIGGER_ID = "triggerId";
+const PAGE_SIZE_PARAM = "page[size]";
+const PAGE_AFTER_PARAM = "page[after]";
+const SORT_BY_POSITION_ASC = "position";
+const X_ZENDESK_WEBHOOK_SIGNATURE_HEADER = "x-zendesk-webhook-signature";
+const X_ZENDESK_WEBHOOK_SIGNATURE_TIMESTAMP_HEADER = "x-zendesk-webhook-signature-timestamp";
+const SIGNING_SECRET = "signingSecret";
+const SIGNING_SECRET_ALGORITHM = "sha256";
+const BASE_64 = "base64";
+
+export default {
+  SUBDOMAIN_PLACEHOLDER,
+  BASE_URL,
+  VERSION_PATH,
+  WEBHOOK_ID,
+  TRIGGER_ID,
+  PAGE_SIZE_PARAM,
+  PAGE_AFTER_PARAM,
+  SORT_BY_POSITION_ASC,
+  X_ZENDESK_WEBHOOK_SIGNATURE_HEADER,
+  X_ZENDESK_WEBHOOK_SIGNATURE_TIMESTAMP_HEADER,
+  SIGNING_SECRET,
+  SIGNING_SECRET_ALGORITHM,
+  BASE_64,
+};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@pipedream/zendesk",
+  "version": "0.3.3",
+  "description": "Pipedream Zendesk Components",
+  "main": "zendesk.app.mjs",
+  "keywords": [
+    "pipedream",
+    "zendesk"
+  ],
+  "homepage": "https://pipedream.com/apps/zendesk",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "license": "MIT",
+  "gitHead": "e12480b94cc03bed4808ebc6b13e7fdb3a1ba535",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^0.9.0",
+    "crypto": "^1.0.1"
+  }
+}

package/sources/common/base.mjs

@@ -0,0 +1,182 @@
+import crypto from "crypto";
+import zendesk from "../../zendesk.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  props: {
+    zendesk,
+    db: "$.service.db",
+    http: "$.interface.http",
+    categoryId: {
+      propDefinition: [
+        zendesk,
+        "categoryId",
+      ],
+    },
+  },
+  hooks: {
+    async activate() {
+      const { categoryId } = this;
+
+      const { webhook } = await this.zendesk.createWebhook({
+        data: this.setupWebhookData(),
+      });
+
+      const { id: webhookId } = webhook;
+      this.setWebhookId(webhookId);
+
+      const { signing_secret: signingSecret } = await this.zendesk.showWebhookSigningSecret({
+        webhookId,
+      });
+
+      const { secret } = signingSecret;
+      this.setSigningSecret(secret);
+
+      const { trigger } = await this.zendesk.createTrigger({
+        data: this.setupTriggerData({
+          webhookId,
+          categoryId,
+        }),
+      });
+
+      const { id: triggerId } = trigger;
+      this.setTriggerId(String(triggerId));
+    },
+    async deactivate() {
+      await Promise.all([
+        this.zendesk.deleteTrigger({
+          triggerId: this.getTriggerId(),
+        }),
+        this.zendesk.deleteWebhook({
+          webhookId: this.getWebhookId(),
+        }),
+      ]);
+    },
+  },
+  methods: {
+    setWebhookId(webhookId) {
+      this.db.set(constants.WEBHOOK_ID, webhookId);
+    },
+    getWebhookId() {
+      return this.db.get(constants.WEBHOOK_ID);
+    },
+    setTriggerId(triggerId) {
+      this.db.set(constants.TRIGGER_ID, triggerId);
+    },
+    getTriggerId() {
+      return this.db.get(constants.TRIGGER_ID);
+    },
+    setSigningSecret(secret) {
+      return this.db.set(constants.SIGNING_SECRET, secret);
+    },
+    getSigningSecret() {
+      return this.db.get(constants.SIGNING_SECRET);
+    },
+    getWebhookName() {
+      throw new Error("getWebhookName is not implemented");
+    },
+    getTriggerTitle() {
+      throw new Error("getTriggerTitle is not implemented");
+    },
+    /**
+     * If you want to use this function, you need to implement it in your component.
+     * setupTriggerData depends on this function.
+     * https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/
+     */
+    getTriggerConditions() {
+      throw new Error("getTriggerConditions is not implemented");
+    },
+    /**
+     * If you want to use this function, you need to implement it in your component.
+     * setupTriggerData depends on this function.
+     * https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/
+     */
+    getTriggerPayload() {
+      throw new Error("getTriggerPayload is not implemented");
+    },
+    setupWebhookData() {
+      return {
+        webhook: {
+          endpoint: this.http.endpoint,
+          http_method: "POST",
+          name: this.getWebhookName(),
+          status: "active",
+          request_format: "json",
+          subscriptions: [
+            "conditional_ticket_events",
+          ],
+        },
+      };
+    },
+    setupTriggerData({
+      webhookId, categoryId,
+    }) {
+      return {
+        trigger: {
+          title: this.getTriggerTitle(),
+          category_id: categoryId,
+          conditions: this.getTriggerConditions(),
+          actions: [
+            {
+              field: "notification_webhook",
+              value: [
+                webhookId,
+                JSON.stringify(this.getTriggerPayload()),
+              ],
+            },
+          ],
+        },
+      };
+    },
+    isValidSource({
+      signature, bodyRaw, timestamp,
+    }) {
+      const secret = this.getSigningSecret();
+
+      const sig =
+        crypto
+          .createHmac(constants.SIGNING_SECRET_ALGORITHM, secret)
+          .update(timestamp + bodyRaw)
+          .digest(constants.BASE_64);
+
+      return (
+        Buffer.compare(
+          Buffer.from(signature),
+          Buffer.from(sig.toString(constants.BASE_64)),
+        ) === 0
+      );
+    },
+  },
+  async run(event) {
+    const {
+      body: payload,
+      headers,
+      bodyRaw,
+    } = event;
+
+    const {
+      [constants.X_ZENDESK_WEBHOOK_SIGNATURE_HEADER]: signature,
+      [constants.X_ZENDESK_WEBHOOK_SIGNATURE_TIMESTAMP_HEADER]: timestamp,
+    } = headers;
+
+    const isValid = this.isValidSource({
+      signature,
+      bodyRaw,
+      timestamp,
+    });
+
+    if (!isValid) {
+      console.log("Skipping event due to invalid signature");
+      return;
+    }
+
+    const ts = Date.parse(payload.updatedAt);
+    const id = `${payload.ticketId}-${ts}`;
+
+    this.$emit(payload, {
+      id,
+      summary: payload.title,
+      ts,
+    });
+  },
+};

package/sources/common/ticket.mjs

@@ -0,0 +1,21 @@
+import common from "./base.mjs";
+
+export default {
+  ...common,
+  methods: {
+    ...common.methods,
+    getTriggerPayload() {
+      return {
+        ticketId: "{{ticket.id}}",
+        title: "{{ticket.title}}",
+        description: "{{ticket.description}}",
+        url: "{{ticket.url}}",
+        requester: "{{ticket.requester.first_name}} {{ticket.requester.last_name}} <{{ticket.requester.email}}>",
+        assignee: "{{ticket.assignee.first_name}} {{ticket.assignee.last_name}} <{{ticket.assignee.email}}>",
+        status: "{{ticket.status}}",
+        createdAt: "{{ticket.created_at_with_timestamp}}",
+        updatedAt: "{{ticket.updated_at_with_timestamp}}",
+      };
+    },
+  },
+};

package/sources/new-ticket/new-ticket.mjs

@@ -0,0 +1,30 @@
+import common from "../common/ticket.mjs";
+
+export default {
+  ...common,
+  name: "New Ticket (Instant)",
+  key: "zendesk-new-ticket",
+  type: "source",
+  description: "Emit new event when a ticket is created",
+  version: "0.0.2",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getWebhookName() {
+      return "New Ticket Webhook";
+    },
+    getTriggerTitle() {
+      return "New Ticket Trigger";
+    },
+    getTriggerConditions() {
+      return {
+        all: [
+          {
+            field: "update_type",
+            value: "Create",
+          },
+        ],
+      };
+    },
+  },
+};

package/sources/ticket-closed/ticket-closed.mjs

@@ -0,0 +1,35 @@
+import common from "../common/ticket.mjs";
+
+export default {
+  ...common,
+  name: "Ticket Closed (Instant)",
+  key: "zendesk-ticket-closed",
+  type: "source",
+  description: "Emit new event when a ticket has changed to closed status",
+  version: "0.0.2",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getWebhookName() {
+      return "Ticket Closed Webhook";
+    },
+    getTriggerTitle() {
+      return "Ticket Closed Trigger";
+    },
+    getTriggerConditions() {
+      return {
+        all: [
+          {
+            field: "update_type",
+            value: "Change",
+          },
+          {
+            field: "status",
+            operator: "value",
+            value: "closed",
+          },
+        ],
+      };
+    },
+  },
+};

package/sources/ticket-pended/ticket-pended.mjs

@@ -0,0 +1,35 @@
+import common from "../common/ticket.mjs";
+
+export default {
+  ...common,
+  name: "Ticket Pended (Instant)",
+  key: "zendesk-ticket-pended",
+  type: "source",
+  description: "Emit new event when a ticket has changed to pending status",
+  version: "0.0.2",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getWebhookName() {
+      return "Ticket Pended Webhook";
+    },
+    getTriggerTitle() {
+      return "Ticket Pended Trigger";
+    },
+    getTriggerConditions() {
+      return {
+        all: [
+          {
+            field: "update_type",
+            value: "Change",
+          },
+          {
+            field: "status",
+            operator: "value",
+            value: "pending",
+          },
+        ],
+      };
+    },
+  },
+};

package/sources/ticket-solved/ticket-solved.mjs

@@ -0,0 +1,35 @@
+import common from "../common/ticket.mjs";
+
+export default {
+  ...common,
+  name: "Ticket Solved (Instant)",
+  key: "zendesk-ticket-solved",
+  type: "source",
+  description: "Emit new event when a ticket has changed to solved status",
+  version: "0.0.2",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getWebhookName() {
+      return "Ticket Solved Webhook";
+    },
+    getTriggerTitle() {
+      return "Ticket Solved Trigger";
+    },
+    getTriggerConditions() {
+      return {
+        all: [
+          {
+            field: "update_type",
+            value: "Change",
+          },
+          {
+            field: "status",
+            operator: "value",
+            value: "solved",
+          },
+        ],
+      };
+    },
+  },
+};

package/zendesk.app.mjs

@@ -0,0 +1,139 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
+export default {
+  type: "app",
+  app: "zendesk",
+  propDefinitions: {
+    categoryId: {
+      type: "string",
+      label: "Trigger category ID",
+      description: "The ID of the trigger category. [See the docs here](https://developer.zendesk.com/api-reference/ticketing/business-rules/trigger_categories/#list-trigger-categories)",
+      async options({ prevContext }) {
+        const { afterCursor } = prevContext;
+
+        const {
+          trigger_categories: categories,
+          meta,
+        } =
+          await this.listTriggerCategories({
+            params: {
+              [constants.PAGE_SIZE_PARAM]: 20,
+              sort: constants.SORT_BY_POSITION_ASC,
+              [constants.PAGE_AFTER_PARAM]: afterCursor,
+            },
+          });
+
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: categories.map(({
+            id, name,
+          }) => ({
+            label: name,
+            value: id,
+          })),
+        };
+      },
+    },
+  },
+  methods: {
+    getApiUrl({
+      path, subdomain,
+    }) {
+      const {
+        SUBDOMAIN_PLACEHOLDER,
+        BASE_URL,
+        VERSION_PATH,
+      } = constants;
+      return `${BASE_URL.replace(SUBDOMAIN_PLACEHOLDER, subdomain)}${VERSION_PATH}${path}`;
+    },
+    async makeRequest(customConfig) {
+      const {
+        $,
+        url,
+        path,
+        ...configProps
+      } = customConfig;
+
+      const {
+        oauth_access_token: oauthAccessToken,
+        subdomain,
+      } = this.$auth;
+
+      const headers = {
+        ...configProps?.headers,
+        authorization: `Bearer ${oauthAccessToken}`,
+      };
+
+      const config = {
+        ...configProps,
+        headers,
+        url: url ?? this.getApiUrl({
+          subdomain,
+          path,
+        }),
+        timeout: 10000,
+      };
+
+      return axios($ ?? this, config);
+    },
+    async createTrigger({
+      $, data,
+    }) {
+      return this.makeRequest({
+        $,
+        method: "post",
+        path: "/triggers",
+        data,
+      });
+    },
+    async deleteTrigger({
+      $, triggerId,
+    }) {
+      return this.makeRequest({
+        $,
+        method: "delete",
+        path: `/triggers/${triggerId}`,
+      });
+    },
+    async listTriggerCategories({
+      $, url, params,
+    }) {
+      return this.makeRequest({
+        $,
+        url,
+        path: "/trigger_categories",
+        params,
+      });
+    },
+    async createWebhook({
+      $, data,
+    }) {
+      return this.makeRequest({
+        $,
+        method: "post",
+        path: "/webhooks",
+        data,
+      });
+    },
+    async deleteWebhook({
+      $, webhookId,
+    }) {
+      return this.makeRequest({
+        $,
+        method: "delete",
+        path: `/webhooks/${webhookId}`,
+      });
+    },
+    async showWebhookSigningSecret({
+      $, webhookId,
+    }) {
+      return this.makeRequest({
+        $,
+        path: `/webhooks/${webhookId}/signing_secret`,
+      });
+    },
+  },
+};