@pipedream/pumble 0.0.1 → 0.2.0

package/actions/create-channel/create-channel.mjs

@@ -0,0 +1,51 @@
+import pumble from "../../pumble.app.mjs";
+
+export default {
+  key: "pumble-create-channel",
+  name: "Create Channel",
+  description: "Create a new channel in Pumble. [See the documentation](https://pumble.com/help/integrations/add-pumble-apps/api-keys-integration/#create-channel)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    pumble,
+    name: {
+      type: "string",
+      label: "Channel Name",
+      description: "Name of the new channel",
+    },
+    type: {
+      type: "string",
+      label: "Type",
+      description: "Whether the new channel is public or private. Defaults to `public`",
+      options: [
+        "PUBLIC",
+        "PRIVATE",
+      ],
+      default: "PUBLIC",
+      optional: true,
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "Description of the new channel",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.pumble.createChannel({
+      $,
+      data: {
+        name: this.name,
+        type: this.type,
+        description: this.description,
+      },
+    });
+    $.export("$summary", `Successfully created channel with ID ${response.id}`);
+    return response;
+  },
+};

package/actions/list-channel-options/list-channel-options.mjs

@@ -0,0 +1,26 @@
+import pumble from "../../pumble.app.mjs";
+
+export default {
+  key: "pumble-list-channel-options",
+  name: "List Channel Options",
+  description: "Retrieves available options for the Channel field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    pumble,
+  },
+  async run({ $ }) {
+    const options = await pumble.propDefinitions.channel.options.call(this.pumble, {});
+    $.export("$summary", `Successfully retrieved ${options.length} option${
+      options.length === 1
+        ? ""
+        : "s"
+    }`);
+    return options;
+  },
+};

package/actions/list-messages/list-messages.mjs

@@ -0,0 +1,35 @@
+import pumble from "../../pumble.app.mjs";
+
+export default {
+  key: "pumble-list-messages",
+  name: "List Messages",
+  description: "List messages in a channel. [See the documentation](https://pumble.com/help/integrations/add-pumble-apps/api-keys-integration/#list-messages-in-a-channel)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    pumble,
+    channel: {
+      propDefinition: [
+        pumble,
+        "channel",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { messages } = await this.pumble.listMessages({
+      $,
+      params: {
+        channel: this.channel,
+      },
+    });
+    $.export("$summary", `Successfully retrieved ${messages.length} message${messages.length === 1
+      ? ""
+      : "s"}`);
+    return messages;
+  },
+};

package/actions/send-message/send-message.mjs

@@ -0,0 +1,47 @@
+import pumble from "../../pumble.app.mjs";
+
+export default {
+  key: "pumble-send-message",
+  name: "Send Message",
+  description: "Send a message to a channel in Pumble. [See the documentation](https://pumble.com/help/integrations/add-pumble-apps/api-keys-integration/#send-messages)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    pumble,
+    channel: {
+      propDefinition: [
+        pumble,
+        "channel",
+      ],
+    },
+    text: {
+      type: "string",
+      label: "Text",
+      description: "The message to send",
+    },
+    asBot: {
+      type: "boolean",
+      label: "As Bot",
+      description: "Whether to send the message from your personal account or as a bot. Defaults to `false`",
+      default: false,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.pumble.sendMessage({
+      $,
+      data: {
+        channel: this.channel,
+        text: this.text,
+        asBot: this.asBot,
+      },
+    });
+    $.export("$summary", `Successfully sent message with ID ${response.id}`);
+    return response;
+  },
+};

package/package.json

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

package/pumble.app.mjs

@@ -1,11 +1,66 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "pumble",
-  propDefinitions: {},
+  propDefinitions: {
+    channel: {
+      type: "string",
+      label: "Channel",
+      description: "The name of the channel",
+      async options() {
+        const channels = await this.listChannels();
+        return channels
+          ?.filter(({ channel }) => channel.name)
+          ?.map(({ channel }) => channel.name) || [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://pumble-api-keys.addons.marketplace.cake.com";
+    },
+    _headers() {
+      return {
+        "Api-Key": `${this.$auth.api_key}`,
+      };
+    },
+    _makeRequest({
+      $ = this,
+      path,
+      ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: this._headers(),
+        ...opts,
+      });
+    },
+    listChannels(opts = {}) {
+      return this._makeRequest({
+        path: "/listChannels",
+        ...opts,
+      });
+    },
+    listMessages(opts = {}) {
+      return this._makeRequest({
+        path: "/listMessages",
+        ...opts,
+      });
+    },
+    createChannel(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/createChannel",
+        ...opts,
+      });
+    },
+    sendMessage(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/sendMessage",
+        ...opts,
+      });
     },
   },
-};
+};

package/sources/common/base.mjs

@@ -0,0 +1,24 @@
+import pumble from "../../pumble.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  props: {
+    pumble,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    emitEvent(item) {
+      const meta = this.generateMeta(item);
+      this.$emit(item, meta);
+    },
+    generateMeta() {
+      throw new Error("generateMeta is not implemented");
+    },
+  },
+};

package/sources/new-channel-created/new-channel-created.mjs

@@ -0,0 +1,29 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "pumble-new-channel-created",
+  name: "New Channel Created",
+  description: "Emit new event when a new channel is created in Pumble",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    generateMeta(channel) {
+      return {
+        id: channel.id,
+        summary: `New Channel: ${channel.name}`,
+        ts: Date.now(),
+      };
+    },
+  },
+  async run() {
+    const channels = await this.pumble.listChannels();
+    channels
+      .filter(({ channel }) => channel.name)
+      .forEach(({ channel }) => this.emitEvent(channel));
+  },
+  sampleEmit,
+};

package/sources/new-channel-created/test-event.mjs

@@ -0,0 +1,28 @@
+export default {
+  "id": "66575d32d3c8847e4c85e00f",
+  "workspaceId": "66575d31d3c8847e4c85e009",
+  "channelType": "PUBLIC",
+  "name": "general",
+  "description": "",
+  "isMember": true,
+  "isMuted": false,
+  "isHidden": false,
+  "isArchived": false,
+  "isPumbleBot": false,
+  "isAddonBot": false,
+  "lastMarkTimestamp": "2024-05-29T17:25:50.805Z",
+  "lastMarkTimestampMilli": 1717003550805,
+  "isMain": true,
+  "isInitial": true,
+  "sectionId": "",
+  "postingPermissions": {
+    "allowThreads": true,
+    "allowMentions": true,
+    "postingPermissionsGroup": "EVERYONE",
+    "workspaceUserIds": []
+  },
+  "desktopNotificationPreferences": null,
+  "mobileNotificationPreferences": null,
+  "notifyAboutRepliesInThreads": false,
+  "addedById": "66575d31d3c8847e4c85e00a"
+}

package/sources/new-message-in-channel/new-message-in-channel.mjs

@@ -0,0 +1,57 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "pumble-new-message-in-channel",
+  name: "New Message in Channel",
+  description: "Emit new event when a message is posted in the specified channel in Pumble",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    channel: {
+      propDefinition: [
+        common.props.pumble,
+        "channel",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    _getLastTs() {
+      return this.db.get("lastTs") || 0;
+    },
+    _setLastTs(lastTs) {
+      this.db.set("lastTs", lastTs);
+    },
+    generateMeta(message) {
+      return {
+        id: message.id,
+        summary: `New Message: ${message.text}`,
+        ts: Date.parse(message.timestamp),
+      };
+    },
+  },
+  async run() {
+    const lastTs = this._getLastTs();
+    let maxTs = lastTs;
+
+    const { messages } = await this.pumble.listMessages({
+      params: {
+        channel: this.channel,
+      },
+    });
+    for (const message of messages) {
+      const ts = Date.parse(message.timestamp);
+      if (ts >= lastTs) {
+        this.emitEvent(message);
+        maxTs = Math.max(ts, maxTs);
+      }
+    }
+
+    this._setLastTs(maxTs);
+  },
+  sampleEmit,
+};

package/sources/new-message-in-channel/test-event.mjs

@@ -0,0 +1,40 @@
+export default {
+  "id": "6657650a3ca2f542afff7151",
+  "workspaceId": "66575d31d3c8847e4c85e009",
+  "channelId": "66575d32d3c8847e4c85e00f",
+  "author": "66575d31d3c8847e4c85e00a",
+  "text": "hello world",
+  "timestamp": "2024-05-29T17:25:30Z",
+  "timestampMilli": 1717003530000,
+  "subtype": "",
+  "reactions": [],
+  "linkPreviews": [],
+  "isFollowing": true,
+  "threadRootInfo": null,
+  "threadReplyInfo": null,
+  "files": [],
+  "deleted": false,
+  "edited": false,
+  "localId": "665765820b689728fcc64b52",
+  "attachments": [],
+  "sharedMessage": null,
+  "savedTimestampMilli": 0,
+  "blocks": [
+    {
+      "type": "rich_text",
+      "elements": [
+        {
+          "type": "rich_text_section",
+          "elements": [
+            {
+              "type": "text",
+              "text": "hello world"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "meta": null,
+  "authorAppId": null
+}