Merge branch 'issue-11579' into 9395-action-zoom-app-zoom-phones-get-call-logs-action

Author: luancazarine

components/foursquare/actions/create-check-in/create-check-in.mjs

@@ -0,0 +1,36 @@
+import foursquare from "../../foursquare.app.mjs";
+
+export default {
+  key: "foursquare-create-check-in",
+  name: "Create Check In",
+  description: "Allows the user to generate a new check-in at a specific location on Foursquare. [See the documentation](https://docs.foursquare.com/developer/reference/create-a-checkin)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    foursquare,
+    venueId: {
+      propDefinition: [
+        foursquare,
+        "venueId",
+      ],
+    },
+    shout: {
+      type: "string",
+      label: "Shout",
+      description: "A message about your check-in.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.foursquare.createCheckIn({
+      $,
+      params: {
+        venueId: this.venueId,
+        shout: this.shout,
+      },
+    });
+
+    $.export("$summary", `Successfully created check-in at venue ${this.venueId}`);
+    return response;
+  },
+};

components/foursquare/actions/create-tip/create-tip.mjs

@@ -0,0 +1,34 @@
+import foursquare from "../../foursquare.app.mjs";
+
+export default {
+  key: "foursquare-create-tip",
+  name: "Create Tip",
+  description: "Allows the user to create a new tip for a venue on Foursquare. [See the documentation](https://docs.foursquare.com/developer/reference/add-a-tip)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    foursquare,
+    venueId: {
+      propDefinition: [
+        foursquare,
+        "venueId",
+      ],
+    },
+    tipText: {
+      type: "string",
+      label: "Tip Text",
+      description: "The text of the tip.",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.foursquare.addTip({
+      $,
+      params: {
+        venueId: this.venueId,
+        text: this.tipText,
+      },
+    });
+    $.export("$summary", `Successfully created tip for venue ${this.venueId}`);
+    return response;
+  },
+};

components/foursquare/common/constants.mjs

@@ -0,0 +1 @@
+export const LIMIT = 1;

components/foursquare/foursquare.app.mjs

@@ -1,11 +1,94 @@
+import { axios } from "@pipedream/platform";
+import { LIMIT } from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "foursquare",
-  propDefinitions: {},
+  propDefinitions: {
+    venueId: {
+      type: "string",
+      label: "Venue ID",
+      description: "The ID of the venue where you want to interact.",
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.foursquare.com/v2";
+    },
+    _headers() {
+      return {
+        "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, params = {}, ...opts
+    }) {
+      return axios($, {
+        url: this._baseUrl() + path,
+        headers: this._headers(),
+        params: {
+          ...params,
+          v: "20240430",
+        },
+        ...opts,
+      });
+    },
+    createCheckIn(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/checkins/add",
+        ...opts,
+      });
+    },
+    addTip(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/tips/add",
+        ...opts,
+      });
+    },
+    getUserTips(opts = {}) {
+      return this._makeRequest({
+        path: "/users/self/tips",
+        ...opts,
+      });
+    },
+    getUserCheckins(opts = {}) {
+      return this._makeRequest({
+        path: "/users/self/checkins",
+        ...opts,
+      });
+    },
+    async *paginate({
+      fn, params = {}, dataField, maxResults = null, ...opts
+    }) {
+      let hasMore = false;
+      let count = 0;
+      let page = 0;
+
+      do {
+        params.limit = LIMIT;
+        params.offset = LIMIT * page;
+        page++;
+
+        const { response } = await fn({
+          params,
+          ...opts,
+        });
+
+        const items = response[dataField].items;
+
+        for (const d of items) {
+          yield d;
+
+          if (maxResults && ++count === maxResults) {
+            return count;
+          }
+        }
+
+        hasMore = items.length;
+
+      } while (hasMore);
     },
   },
 };

components/foursquare/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@pipedream/foursquare",
+  "version": "0.1.0",
+  "description": "Pipedream Foursquare Components",
+  "main": "foursquare.app.mjs",
+  "keywords": [
+    "pipedream",
+    "foursquare"
+  ],
+  "homepage": "https://pipedream.com/apps/foursquare",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.6.2"
+  }
+}

components/foursquare/sources/common/base.mjs

@@ -0,0 +1,58 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import foursquare from "../../foursquare.app.mjs";
+
+export default {
+  props: {
+    foursquare,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastDate() {
+      return this.db.get("lastDate") || 0;
+    },
+    _setLastDate(created) {
+      this.db.set("lastDate", created);
+    },
+    generateMeta(item) {
+      return {
+        id: item.id,
+        summary: this.getSummary(item),
+        ts: item.createdAt,
+      };
+    },
+    async startEvent(maxResults = 0) {
+      const lastDate = this._getLastDate();
+      const response = this.foursquare.paginate({
+        fn: this.getFn(),
+        dataField: this.getDataField(),
+        maxResults,
+      });
+
+      const responseArray = [];
+      for await (const item of response) {
+        if (item.createdAt <= lastDate) break;
+        responseArray.push(item);
+      }
+
+      if (responseArray.length) this._setLastDate(responseArray[0].createdAt);
+
+      for (const item of responseArray.reverse()) {
+        this.$emit(item, this.generateMeta(item));
+      }
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.startEvent(25);
+    },
+  },
+  async run() {
+    await this.startEvent();
+  },
+};

components/foursquare/sources/new-check-in/new-check-in.mjs

@@ -0,0 +1,25 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "foursquare-new-check-in",
+  name: "New Check-In",
+  description: "Emit new event when a user checks in.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getSummary(item) {
+      return `New Check-In with Id: ${item.id}`;
+    },
+    getDataField() {
+      return "checkins";
+    },
+    getFn() {
+      return this.foursquare.getUserCheckins;
+    },
+  },
+  sampleEmit,
+};

components/foursquare/sources/new-check-in/test-event.mjs

@@ -0,0 +1,69 @@
+export default {
+  "id": "59b97e6cf79faa0d5e23abeb",
+  "createdAt": 1505328748,
+  "type": "checkin",
+  "private": true,
+  "visibility": "private",
+  "entities": [],
+  "shout": "Monday monday!",
+  "timeZoneOffset": -240,
+  "venue": {
+    "id": "4f0de7267bebfc146005dcc0",
+    "name": "Mattlantis 🐳"
+  },
+  "likes": {
+    "count": 0,
+    "groups": []
+  },
+  "like": false,
+  "isMayor": false,
+  "photos": {
+    "count": 1,
+    "items": [
+      {
+        "id": "59b97e6d270ee77dbf2b8aa0",
+        "createdAt": 1505328749,
+        "source": {
+          "name": "Swarm for iOS",
+          "url": "https://www.swarmapp.com"
+        },
+        "prefix": "https://fastly.4sqi.net/img/general/",
+        "suffix": "/7294631_KK8FbnS6sqgrlXgZeCwkYbSn2efiAQBoT7x4p_hteis.jpg",
+        "width": 1440,
+        "height": 1920,
+        "user": {
+          "id": "123456",
+          "firstName": "John",
+          "lastName": "Smith",
+          "handle": "johnsmith",
+          "privateProfile": false,
+          "gender": "male",
+          "countryCode": "US",
+          "relationship": "self",
+          "photo": {
+            "prefix": "https://fastly.4sqi.net/img/user/",
+            "suffix": "/blank_boy.png",
+            "default": true
+          },
+          "birthday": 19700101,
+          "isAnonymous": false
+        },
+        "visibility": "private"
+      }
+    ],
+    "layout": {
+      "name": "single"
+    }
+  },
+  "posts": {
+    "count": 0,
+    "textCount": 0
+  },
+  "comments": {
+    "count": 0
+  },
+  "source": {
+    "name": "Swarm for iOS",
+    "url": "https://www.swarmapp.com"
+  }
+}

components/foursquare/sources/new-tip/new-tip.mjs

@@ -0,0 +1,25 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "foursquare-new-tip",
+  name: "New Tip",
+  description: "Emit new event when a user adds a new tip.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getSummary(item) {
+      return `New tip with Id: ${item.id}`;
+    },
+    getDataField() {
+      return "tips";
+    },
+    getFn() {
+      return this.foursquare.getUserTips;
+    },
+  },
+  sampleEmit,
+};