[Components] tinyurl #15135

Sources
 - New Survey Completion
 - New Segment Entry

Actions
 - Identify User
 - Track Event

Author: luancazarine

components/refiner/actions/identify-user/identify-user.mjs

@@ -1,11 +1,11 @@
+import { ConfigurationError } from "@pipedream/platform";
 import refiner from "../../refiner.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "refiner-identify-user",
   name: "Identify User",
-  description: "Creates or updates a user profile in Refiner. [See the documentation]()",
-  version: "0.0.{{ts}}",
+  description: "Creates or updates a user profile in Refiner. [See the documentation](https://refiner.io/docs/api/#identify-user)",
+  version: "0.0.1",
   type: "action",
   props: {
     refiner,
@@ -14,18 +14,27 @@ export default {
         refiner,
         "userId",
       ],
+      optional: true,
     },
     email: {
       propDefinition: [
         refiner,
         "email",
       ],
+      optional: true,
     },
   },
   async run({ $ }) {
+    if (!this.userId && !this.email) {
+      throw new ConfigurationError("Either User Id or E mail must be provided to identify the user.");
+    }
+
     const response = await this.refiner.identifyUser({
-      userId: this.userId,
-      email: this.email,
+      $,
+      data: {
+        id: this.userId,
+        email: this.email,
+      },
     });
 
     $.export("$summary", `User identified successfully. Contact UUID: ${response.contact_uuid}`);

components/refiner/actions/track-event/track-event.mjs

@@ -1,19 +1,17 @@
 import refiner from "../../refiner.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "refiner-track-event",
   name: "Track Event",
-  description: "Tracks a user event in Refiner. [See the documentation](https://refiner.io/docs/api/)",
-  version: "0.0.{{ts}}",
+  description: "Tracks a user event in Refiner. [See the documentation](https://refiner.io/docs/api/#track-event)",
+  version: "0.0.1",
   type: "action",
   props: {
     refiner,
     eventName: {
-      propDefinition: [
-        refiner,
-        "eventName",
-      ],
+      type: "string",
+      label: "Event Name",
+      description: "The name of the event or signal being tracked.",
     },
     userId: {
       propDefinition: [
@@ -36,9 +34,12 @@ export default {
     }
 
     const response = await this.refiner.trackEvent({
-      eventName: this.eventName,
-      userId: this.userId,
-      email: this.email,
+      $,
+      data: {
+        event: this.eventName,
+        id: this.userId,
+        email: this.email,
+      },
     });
 
     $.export("$summary", `Tracked event "${this.eventName}" successfully.`);

components/refiner/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/refiner",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Refiner Components",
   "main": "refiner.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }

components/refiner/refiner.app.mjs

@@ -3,108 +3,131 @@ import { axios } from "@pipedream/platform";
 export default {
   type: "app",
   app: "refiner",
-  version: "0.0.{{ts}}",
   propDefinitions: {
     userId: {
       type: "string",
       label: "User ID",
       description: "The ID of the user to identify or track events for.",
-      optional: true,
+      async options({ page }) {
+        const { items } = await this.listContacts({
+          params: {
+            page: page + 1,
+          },
+        });
+
+        return items.map(({
+          uuid: value, email: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
     },
     email: {
       type: "string",
       label: "Email",
       description: "The email address of the user to identify or track events for.",
       optional: true,
     },
-    eventName: {
+    segmentId: {
       type: "string",
-      label: "Event Name",
-      description: "The name of the event or signal being tracked.",
+      label: "Segment ID",
+      description: "The ID of the segment to emit events for.",
+      async options({ page }) {
+        const { items } = await this.listSegments({
+          params: {
+            page: page + 1,
+          },
+        });
+
+        return items.map(({
+          uuid: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
     },
   },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
-    },
     _baseUrl() {
       return "https://api.refiner.io/v1";
     },
-    async _makeRequest(opts = {}) {
-      const {
-        $ = this, method = "GET", path = "/", headers, ...otherOpts
-      } = opts;
+    _headers() {
+      return {
+        "Authorization": `Bearer ${this.$auth.api_key}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
       return axios($, {
-        method,
         url: this._baseUrl() + path,
-        headers: {
-          ...headers,
-          "Authorization": `Bearer ${this.$auth.api_key}`,
-          "user-agent": "@PipedreamHQ/pipedream v0.1",
-          "Content-Type": "application/json",
-        },
-        ...otherOpts,
+        headers: this._headers(),
+        ...opts,
       });
     },
-    async identifyUser(opts = {}) {
-      const {
-        userId, email, ...attributes
-      } = opts;
-      if (!userId && !email) {
-        throw new Error("Either userId or email must be provided to identify the user.");
-      }
-      const data = {
-        ...(userId && {
-          id: userId,
-        }),
-        ...(email && {
-          email,
-        }),
-        ...attributes,
-      };
+    listContacts(opts = {}) {
       return this._makeRequest({
-        method: "POST",
-        path: "/identify-user",
-        data,
+        path: "/contacts",
+        ...opts,
       });
     },
-    async trackEvent(opts = {}) {
-      const {
-        eventName, userId, email,
-      } = opts;
-      if (!eventName) {
-        throw new Error("eventName is required to track an event.");
-      }
-      if (!userId && !email) {
-        throw new Error("Either userId or email must be provided to track the event.");
-      }
-      const data = {
-        event: eventName,
-        ...(userId && {
-          id: userId,
-        }),
-        ...(email && {
-          email,
-        }),
-      };
+    listResponses(opts = {}) {
       return this._makeRequest({
-        method: "POST",
-        path: "/track-event",
-        data,
+        path: "/responses",
+        ...opts,
+      });
+    },
+    listSegments(opts = {}) {
+      return this._makeRequest({
+        path: "/segments",
+        ...opts,
       });
     },
-    async emitSurveyCompleted() {
+    identifyUser(opts = {}) {
       return this._makeRequest({
         method: "POST",
-        path: "/emit-survey-completed",
+        path: "/identify-user",
+        ...opts,
       });
     },
-    async emitSegmentEntered() {
+    trackEvent(opts = {}) {
       return this._makeRequest({
         method: "POST",
-        path: "/emit-segment-entered",
+        path: "/track-event",
+        ...opts,
       });
     },
+    async *paginate({
+      fn, params = {}, maxResults = null, ...opts
+    }) {
+      let hasMore = false;
+      let count = 0;
+      let page = 0;
+
+      do {
+        params.page = ++page;
+        const {
+          items,
+          pagination: {
+            current_page, last_page,
+          },
+        } = await fn({
+          params,
+          ...opts,
+        });
+        for (const d of items) {
+          yield d;
+
+          if (maxResults && ++count === maxResults) {
+            return count;
+          }
+        }
+
+        hasMore = current_page < last_page;
+
+      } while (hasMore);
+    },
   },
 };

components/refiner/sources/common/base.mjs

@@ -0,0 +1,66 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import refiner from "../../refiner.app.mjs";
+
+export default {
+  props: {
+    refiner,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastDate() {
+      return this.db.get("lastDate") || 0;
+    },
+    _setLastDate(lastDate) {
+      this.db.set("lastDate", lastDate);
+    },
+    async emitEvent(maxResults = false) {
+      const lastDate = this._getLastDate();
+
+      const response = this.refiner.paginate({
+        fn: this.getFunction(),
+        params: this.getParams(),
+      });
+
+      let responseArray = [];
+      for await (const item of response) {
+        const itemDate = this.getItemDate(item);
+
+        if (!itemDate.length) continue;
+        if (Date.parse(itemDate) <= lastDate) break;
+        responseArray.push(item);
+      }
+
+      if (responseArray.length) {
+        if (maxResults && (responseArray.length > maxResults)) {
+          responseArray.length = maxResults;
+        }
+        const itemDate = this.getItemDate(responseArray[0]);
+        this._setLastDate(itemDate);
+      }
+
+      for (const item of responseArray.reverse()) {
+        const itemDate = this.getItemDate(item);
+
+        this.$emit(item, {
+          id: item.uuid,
+          summary: this.getSummary(item),
+          ts: Date.parse(itemDate),
+        });
+      }
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.emitEvent(25);
+    },
+  },
+  async run() {
+    await this.emitEvent();
+  },
+};