[Components] motive #15221

Sources
 - New Hours Of Service Violation (Instant)
 - New Safety Event (Instant)

Actions
 - Find User Details

Author: luancazarine

components/motive/actions/find-user-details/find-user-details.mjs

@@ -1,26 +1,30 @@
+import { ConfigurationError } from "@pipedream/platform";
+import { clearObj } from "../../common/util.mjs";
 import motive from "../../motive.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "motive-find-user-details",
   name: "Find User Details",
   description: "Retrieve user details based on specific criteria. [See the documentation](https://developer.gomotive.com/reference/users-lookup)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     motive,
+    alert: {
+      type: "alert",
+      alertType: "info",
+      content: "If you provide more than one prop, only one will be considered, the others will be ignored.",
+    },
     username: {
-      propDefinition: [
-        motive,
-        "username",
-      ],
+      type: "string",
+      label: "Username",
+      description: "Username to retrieve user details",
       optional: true,
     },
     email: {
-      propDefinition: [
-        motive,
-        "email",
-      ],
+      type: "string",
+      label: "Email",
+      description: "Email to retrieve user details",
       optional: true,
     },
     driverCompanyId: {
@@ -30,35 +34,41 @@ export default {
       ],
       optional: true,
     },
-    phone: {
-      propDefinition: [
-        motive,
-        "phone",
-      ],
-      optional: true,
-    },
   },
   async run({ $ }) {
+    let response;
+    const criteria = [];
+
     const {
-      username, email, driverCompanyId, phone,
+      username, email, driverCompanyId,
     } = this;
-    if (!username && !email && !driverCompanyId && !phone) {
-      throw new Error("At least one of 'username', 'email', 'driverCompanyId', or 'phone' must be provided.");
+    if (!username && !email && !driverCompanyId) {
+      throw new Error("At least one of 'Username', 'Email', 'Driver Company Id' must be provided.");
     }
 
-    const response = await this.motive.retrieveUserDetails({
-      username,
-      email,
-      driverCompanyId,
-      phone,
-    });
-
-    const criteria = [];
     if (username) criteria.push(`username: ${username}`);
     if (email) criteria.push(`email: ${email}`);
     if (driverCompanyId) criteria.push(`driverCompanyId: ${driverCompanyId}`);
-    if (phone) criteria.push(`phone: ${phone}`);
 
+    try {
+      response = await this.motive.retrieveUserDetails({
+        $,
+        params: clearObj({
+          username,
+          email,
+          driver_company_id: driverCompanyId,
+        }),
+      });
+
+    } catch ({ response: { data } }) {
+      if (data.error_message === "user not found") {
+        response =  {
+          user: null,
+        };
+      } else {
+        throw new ConfigurationError(data.error_message);
+      }
+    }
     $.export("$summary", `Successfully retrieved user details for ${criteria.join(", ")}`);
     return response;
   },

components/motive/common/util.mjs

@@ -0,0 +1,16 @@
+export const clearObj = (obj) => {
+  return Object.entries(obj)
+    .filter(([
+      _,
+      v,
+    ]) => (v != null && v != "" && _ != "$emit"))
+    .reduce((acc, [
+      k,
+      v,
+    ]) => ({
+      ...acc,
+      [k]: (!Array.isArray(v) && v === Object(v))
+        ? clearObj(v)
+        : v,
+    }), {});
+};

components/motive/motive.app.mjs

@@ -3,124 +3,96 @@ import { axios } from "@pipedream/platform";
 export default {
   type: "app",
   app: "motive",
-  version: "0.0.{{ts}}",
   propDefinitions: {
     driverId: {
       type: "string",
       label: "Driver ID",
       description: "Filter to a specific driver",
-      optional: true,
     },
     safetyCategory: {
       type: "string",
       label: "Safety Category",
       description: "Filter to a specific safety category",
-      optional: true,
-    },
-    username: {
-      type: "string",
-      label: "Username",
-      description: "Username to retrieve user details",
-      optional: true,
-    },
-    email: {
-      type: "string",
-      label: "Email",
-      description: "Email to retrieve user details",
-      optional: true,
     },
     driverCompanyId: {
       type: "string",
       label: "Driver Company ID",
       description: "Driver company ID to retrieve user details",
-      optional: true,
-    },
-    phone: {
-      type: "string",
-      label: "Phone",
-      description: "Phone number to retrieve user details",
-      optional: true,
+      async options({ page }) {
+        const { users } = await this.listUsers({
+          params: {
+            page_no: page + 1,
+            role: "driver",
+          },
+        });
+
+        return users.map(({ user }) => ({
+          label: user.email || `${user.first_name} ${user.last_name}`,
+          value: user.driver_company_id,
+        }));
+      },
     },
   },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
-    },
     _baseUrl() {
-      return "https://api.gomotive.com";
+      return "https://api.gomotive.com/v1";
+    },
+    _headers() {
+      return {
+        Authorization: `Bearer ${this.$auth.oauth_access_token}`,
+      };
     },
-    async _makeRequest(opts = {}) {
-      const {
-        $, method = "GET", path = "/", headers, ...otherOpts
-      } = opts;
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
       return axios($, {
-        ...otherOpts,
-        method,
-        url: `${this._baseUrl()}${path}`,
-        headers: {
-          ...headers,
-          "user-agent": "@PipedreamHQ/pipedream v0.1",
-          "Authorization": `Bearer ${this.$auth.api_token}`,
-        },
+        url: this._baseUrl() + path,
+        headers: this._headers(),
+        ...opts,
       });
     },
-    async listHosViolations(opts = {}) {
-      const params = {};
-      if (opts.driverId) params.driver_id = opts.driverId;
+    listHosViolations(opts = {}) {
       return this._makeRequest({
         method: "GET",
         path: "/hos_violations",
-        params,
         ...opts,
       });
     },
-    async listDriverPerformanceEvents(opts = {}) {
-      const params = {};
-      if (opts.safetyCategory) params.safety_category = opts.safetyCategory;
+    listUsers(opts = {}) {
+      return this._makeRequest({
+        path: "/users",
+        ...opts,
+      });
+    },
+    createWebhook(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/company_webhooks",
+        ...opts,
+      });
+    },
+    updateWebhook({
+      webhookId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "PUT",
+        path: `/company_webhooks/${webhookId}`,
+        ...opts,
+      });
+    },
+    listDriverPerformanceEvents(opts = {}) {
       return this._makeRequest({
         method: "GET",
         path: "/driver_performance_events",
-        params,
         ...opts,
       });
     },
-    async retrieveUserDetails(opts = {}) {
-      const {
-        username, email, driverCompanyId, phone, ...otherOpts
-      } = opts;
-      const queryParams = {};
-      if (username) queryParams.username = username;
-      if (email) queryParams.email = email;
-      if (driverCompanyId) queryParams.driver_company_id = driverCompanyId;
-      if (phone) queryParams.phone = phone;
-
+    retrieveUserDetails(opts = {}) {
       return this._makeRequest({
         method: "GET",
         path: "/users/lookup",
-        params: queryParams,
-        ...otherOpts,
+        ...opts,
       });
     },
-    async paginate(fn, ...args) {
-      const results = [];
-      let hasMore = true;
-      let page = 1;
-
-      while (hasMore) {
-        const response = await fn({
-          ...args,
-          page,
-        });
-        if (!Array.isArray(response) || response.length === 0) {
-          hasMore = false;
-        } else {
-          results.push(...response);
-          page += 1;
-        }
-      }
-
-      return results;
-    },
   },
 };

components/motive/package.json

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

components/motive/sources/common/base.mjs

@@ -0,0 +1,61 @@
+import { v4 as uuid } from "uuid";
+import motive from "../../motive.app.mjs";
+
+export default {
+  props: {
+    motive,
+    http: "$.interface.http",
+    db: "$.service.db",
+  },
+  methods: {
+    _getHookId() {
+      return this.db.get("hookId");
+    },
+    _setHookId(hookId) {
+      this.db.set("hookId", hookId);
+    },
+    filterEvent() {
+      return true;
+    },
+  },
+  hooks: {
+    async deploy() {
+      const response = await this.motive.createWebhook({
+        data: {
+          url: this.http.endpoint,
+          secret: uuid(),
+          actions: this.getActions(),
+          format: "json",
+          enabled: true,
+          webhook_type: "POST",
+        },
+      });
+      this._setHookId(response.company_webhook.id);
+    },
+    async activate() {
+      await this.motive.updateWebhook({
+        webhookId: this._getHookId(),
+        data: {
+          enabled: true,
+        },
+      });
+    },
+    async deactivate() {
+      await this.motive.updateWebhook({
+        webhookId: this._getHookId(),
+        data: {
+          enabled: false,
+        },
+      });
+    },
+  },
+  async run({ body }) {
+    if (this.filterEvent(body)) {
+      this.$emit(body, {
+        id: body.id,
+        summary: this.getSummary(body),
+        ts: Date.parse(body.end_time || new Date()),
+      });
+    }
+  },
+};