Merging pull request #18768

Author: jcortes

components/aftership/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/aftership",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Pipedream AfterShip Components",
   "main": "aftership.app.mjs",
   "keywords": [
@@ -13,7 +13,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1"
+    "@pipedream/platform": "^3.1.0",
+    "crypto": "^1.0.1"
   }
 }
-

components/aftership/sources/common/webhook.mjs

@@ -0,0 +1,85 @@
+import { createHmac } from "crypto";
+import { ConfigurationError } from "@pipedream/platform";
+import app from "../../aftership.app.mjs";
+
+export default {
+  props: {
+    app,
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    webhookSecret: {
+      type: "string",
+      label: "Secret",
+      description: "The secret for the webhook. You can find it in `Tracking -> Settings -> Webhooks -> Webhook secret`",
+    },
+  },
+  hooks: {
+    async deploy() {
+      if (!this.webhookSecret) {
+        console.log("No webhook secret was provided, skipping deployment");
+        throw new ConfigurationError("No webhook secret was provided, skipping deployment");
+      }
+
+      const { data: { trackings } } = await this.app.listTrackings({
+        params: {
+          page: 1,
+          limit: 25,
+        },
+      });
+
+      trackings
+        .slice(0, 25)
+        .reverse()
+        .forEach((tracking) => {
+          this.processResource({
+            event: this.getEventName(),
+            event_id: tracking.id,
+            msg: tracking,
+            ts: Date.parse(tracking.updated_at) / 1000,
+          });
+        });
+    },
+  },
+  methods: {
+    generateMeta() {
+      throw new ConfigurationError("generateMeta is not implemented");
+    },
+    getEventName() {
+      throw new ConfigurationError("getEventName is not implemented");
+    },
+    isSignatureValid(bodyRaw, signature) {
+      const { webhookSecret } = this;
+      if (!webhookSecret) {
+        console.log("No webhook secret found, skipping signature verification");
+        return true;
+      }
+      const hash = createHmac("sha256", webhookSecret)
+        .update(bodyRaw)
+        .digest("base64");
+      return hash === signature;
+    },
+    processResource(resource) {
+      this.$emit(resource, this.generateMeta(resource));
+    },
+  },
+  async run({
+    body, bodyRaw, headers,
+  }) {
+    const signature = headers["aftership-hmac-sha256"];
+
+    if (!this.isSignatureValid(bodyRaw, signature)) {
+      console.log("Could not verify incoming webhook signature");
+      return this.http.respond({
+        status: 401,
+      });
+    }
+
+    this.http.respond({
+      status: 200,
+    });
+
+    this.processResource(body);
+  },
+};

components/aftership/sources/shipment-status-updated/shipment-status-updated.mjs

@@ -0,0 +1,29 @@
+import common from "../common/webhook.mjs";
+
+export default {
+  ...common,
+  key: "aftership-shipment-status-updated",
+  name: "Shipment Status Updated",
+  description: "Emit new event when a shipment tracking status is updated. [See the documentation](https://www.aftership.com/docs/shipping/webhook/webhook-overview)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventName() {
+      return "tracking_update";
+    },
+    generateMeta(resource) {
+      const {
+        event_id: eventId,
+        msg: tracking,
+      } = resource;
+
+      return {
+        id: eventId || tracking.id,
+        summary: `Tracking Updated: ${tracking.tracking_number || tracking.title}`,
+        ts: Date.parse(tracking.updated_at) || Date.now(),
+      };
+    },
+  },
+};