@pipedream/orca_scan 0.0.1 → 0.1.0

package/actions/add-update-row/add-update-row.mjs

@@ -0,0 +1,71 @@
+import orca_scan from "../../orca_scan.app.mjs";
+
+export default {
+  key: "orca_scan-add-update-row",
+  name: "Add or Update Row",
+  description: "Adds a new row or updates an existing row in a sheet. [See the documentation](https://orcascan.com/guides/add-barcode-tracking-to-your-system-using-a-rest-api-f09a21c3)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    orca_scan,
+    sheetId: {
+      propDefinition: [
+        orca_scan,
+        "sheetId",
+      ],
+    },
+    rowData: {
+      propDefinition: [
+        orca_scan,
+        "rowData",
+      ],
+    },
+    barcode: {
+      propDefinition: [
+        orca_scan,
+        "barcode",
+      ],
+    },
+  },
+  async run({ $ }) {
+    let rowId = null;
+
+    // Check if a row with the given barcode exists
+    if (this.barcode) {
+      const { data } = await this.orca_scan.listRows({
+        sheetId: this.sheetId,
+        params: {
+          barcode: this.barcode || null,
+        },
+      });
+      if (data.length > 0) {
+        const row = data[0];
+        // Assume the first row is the one to update
+        rowId = row._id;
+        for (const [
+          key,
+          value,
+        ] of Object.entries(this.rowData)) {
+          row[key] = value;
+        }
+        this.rowData = row;
+      } else {
+        this.rowData.barcode = this.barcode;
+      }
+    }
+
+    if (!this.rowData.date) this.rowData.date = new Date();
+
+    // Make the request to add or update the row
+    const response = await this.orca_scan.addOrUpdateRow({
+      sheetId: this.sheetId,
+      data: this.rowData,
+      rowId: rowId,
+    });
+
+    $.export("$summary", `Successfully ${rowId
+      ? "updated"
+      : "added"} row with ID: ${response.data?._id}`);
+    return response;
+  },
+};

package/actions/find-row/find-row.mjs

@@ -0,0 +1,36 @@
+import orca_scan from "../../orca_scan.app.mjs";
+
+export default {
+  key: "orca_scan-find-row",
+  name: "Find Row",
+  description: "Locates a row record based on a given barcode. If no barcode is provided, return all rows. [See the documentation](https://orcascan.com/guides/add-barcode-tracking-to-your-system-using-a-rest-api-f09a21c3#rows-1)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    orca_scan,
+    sheetId: {
+      propDefinition: [
+        orca_scan,
+        "sheetId",
+      ],
+    },
+    barcode: {
+      propDefinition: [
+        orca_scan,
+        "barcode",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const rows = await this.orca_scan.listRows({
+      sheetId: this.sheetId,
+      params: {
+        barcode: this.barcode || null,
+      },
+    });
+
+    $.export("$summary", `Successfully found ${rows.data?.length} row(s)`);
+    return rows;
+  },
+};

package/orca_scan.app.mjs

@@ -1,11 +1,113 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "orca_scan",
-  propDefinitions: {},
+  propDefinitions: {
+    sheetId: {
+      type: "string",
+      label: "Sheet ID",
+      description: "The ID of the sheet where the row will be created or updated.",
+      async options({ page }) {
+        const { data } = await this.listSheets({
+          params: {
+            page,
+          },
+        });
+
+        return data.map(({
+          _id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    rowData: {
+      type: "object",
+      label: "Row Data",
+      description: "The data for the new row to be added or updated. To get the fields, use the `Find Row` action to find a row and refer to the JSON output.",
+    },
+    barcode: {
+      type: "string",
+      label: "Barcode",
+      description: "The barcode value to locate a specific row record. If the barcode is not found, a new row will be created. If the barcode is found, the row will be updated with the data in `Row Data`.",
+      optional: true,
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.orcascan.com/v1";
+    },
+    _getHeaders(headers) {
+      return {
+        ...headers,
+        "Authorization": `Bearer ${this.$auth.api_key}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: this._baseUrl() + path,
+        headers: this._getHeaders(),
+        ...opts,
+      });
+    },
+    listSheets() {
+      return this._makeRequest({
+        path: "/sheets",
+      });
+    },
+    getFields(sheetId) {
+      return this._makeRequest({
+        path: `/sheets/${sheetId}/fields`,
+      });
+    },
+    getSettings(sheetId) {
+      return this._makeRequest({
+        path: `/sheets/${sheetId}/settings`,
+      });
+    },
+    clearSheet(sheetId) {
+      return this._makeRequest({
+        method: "PUT",
+        path: `/sheets/${sheetId}/clear`,
+      });
+    },
+    listRows({
+      sheetId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/sheets/${sheetId}/rows`,
+        ...opts,
+      });
+    },
+    getSingleRow(sheetId, rowId) {
+      return this._makeRequest({
+        path: `/sheets/${sheetId}/rows/${rowId}`,
+      });
+    },
+    addOrUpdateRow({
+      sheetId, rowId, ...opts
+    }) {
+      const method = rowId
+        ? "PUT"
+        : "POST";
+      const path = `/sheets/${sheetId}/rows${rowId
+        ? `/${rowId}`
+        : ""}`;
+      return this._makeRequest({
+        method,
+        path,
+        ...opts,
+      });
+    },
+    deleteRow(sheetId, rowId) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/sheets/${sheetId}/rows/${rowId}`,
+      });
     },
   },
-};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/orca_scan",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Orca Scan Components",
   "main": "orca_scan.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.5.1"
   }
 }

package/sources/common/base.mjs

@@ -0,0 +1,35 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import orcaScan from "../../orca_scan.app.mjs";
+
+export default {
+  props: {
+    orcaScan,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    async startEvent(maxResults = false) {
+      const lastInfo = this._getLastInfo();
+      const data = await this.getData(maxResults, lastInfo);
+
+      if (data.length) this._setLastInfo(data[0]);
+
+      for (const item of data.reverse()) {
+        this.$emit(item, this.getEmit(item));
+      }
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.startEvent(25);
+    },
+  },
+  async run() {
+    await this.startEvent();
+  },
+};

package/sources/new-row/new-row.mjs

@@ -0,0 +1,50 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "orca_scan-new-row",
+  name: "New Row in Orca Scan Sheet",
+  description: "Emit new event when a new row is created in an Orca Scan sheet. [See the documentation](https://orcascan.com/guides/add-barcode-tracking-to-your-system-using-a-rest-api-f09a21c3)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    sheetId: {
+      propDefinition: [
+        common.props.orcaScan,
+        "sheetId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    _getLastInfo() {
+      return this.db.get("lastDate") || 0;
+    },
+    _setLastInfo(row) {
+      return this.db.set("lastDate", row.date);
+    },
+    async getData(maxResults = false, lastDate) {
+      const { data: rows } = await this.orcaScan.listRows({
+        sheetId: this.sheetId,
+      });
+
+      const sortedRows = rows
+        .filter((row) => new Date(row.date) > new Date(lastDate))
+        .sort((a, b) => new Date(b.date) - new Date(a.date));
+
+      if (maxResults && sortedRows.length >= maxResults) sortedRows.length = maxResults;
+      return sortedRows;
+    },
+    getEmit(row) {
+      return {
+        id: row._id,
+        summary: `New row with _id: ${row._id}`,
+        ts: row.date,
+      };
+    },
+  },
+  sampleEmit,
+};

package/sources/new-row/test-event.mjs

@@ -0,0 +1,7 @@
+export default {
+	"barcode": "WS2323",
+	"name": "Wooden Socks",
+	"location": "52.2019723, 0.1168256",
+	"date": "2020-03-16T16:02:45.000Z",
+	"_id": "6554e2a74c5cfa00b5e71b3c"
+}

package/sources/new-sheet/new-sheet.mjs

@@ -0,0 +1,42 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "orca_scan-new-sheet",
+  name: "New Sheet Created",
+  description: "Emit new event when a new sheet is created in Orca Scan. [See the documentation](https://orcascan.com/guides/add-barcode-tracking-to-your-system-using-a-rest-api-f09a21c3)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    _getLastInfo() {
+      return this.db.get("lastId") || 0;
+    },
+    _setLastInfo(row) {
+      return this.db.set("lastId", row._id);
+    },
+    async getData(maxResults = false, lastId) {
+      const { data: sheets } = await this.orcaScan.listSheets();
+
+      let pos = -1;
+      let sortedSheets = sheets;
+      if (lastId) {
+        pos = sheets.findIndex((sheet) => sheet._id == lastId);
+        if (pos != -1) sortedSheets = sheets.slice(pos + 1);
+      }
+
+      if (maxResults && sortedSheets.length >= maxResults) sortedSheets.length = maxResults;
+      return sortedSheets.reverse();
+    },
+    getEmit(sheet) {
+      return {
+        id: sheet._id,
+        summary: `New Sheet: ${sheet.name}`,
+        ts: Date.now(),
+      };
+    },
+  },
+  sampleEmit,
+};

package/sources/new-sheet/test-event.mjs

@@ -0,0 +1,9 @@
+export default {
+	"_id": "62a3188f098a6343fe0d9c1b",
+	"name": "My sheet",
+	"isOwner": true,
+	"canAdmin": true,
+	"canUpdate": true,
+	"canDelete": true,
+	"canExport": true
+}