@pipedream/toggl 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Pipedream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/actions/get-current-time-entry/get-current-time-entry.mjs

@@ -0,0 +1,21 @@
+import toggl from "../../toggl.app.mjs";
+
+export default {
+  name: "Get Current Time Entry",
+  version: "0.0.1",
+  key: "toggl-get-current-time-entry",
+  description: "Get the time entry that is running now. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#get-running-time-entry)",
+  type: "action",
+  props: {
+    toggl,
+  },
+  async run({ $ }) {
+    const response = await this.toggl.getCurrentTimeEntry({
+      $,
+    });
+
+    response && $.export("summary", "Successfully retrieved current time entry");
+
+    return response;
+  },
+};

package/actions/get-time-entries/get-time-entries.mjs

@@ -0,0 +1,21 @@
+import toggl from "../../toggl.app.mjs";
+
+export default {
+  name: "Get Time Entries",
+  version: "0.0.1",
+  key: "toggl-get-time-entries",
+  description: "Get the last thousand time entries. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#get-time-entries-started-in-a-specific-time-range)",
+  type: "action",
+  props: {
+    toggl,
+  },
+  async run({ $ }) {
+    const response = await this.toggl.getTimeEntries({
+      $,
+    });
+
+    response && $.export("summary", "Successfully retrieved time entries");
+
+    return response;
+  },
+};

package/actions/get-time-entry/get-time-entry.mjs

@@ -0,0 +1,28 @@
+import toggl from "../../toggl.app.mjs";
+
+export default {
+  name: "Get Time Entry",
+  version: "0.0.1",
+  key: "toggl-get-time-entry",
+  description: "Get details about a specific time entry. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/chapters/time_entries.md#get-time-entry-details)",
+  type: "action",
+  props: {
+    toggl,
+    timeEntryId: {
+      propDefinition: [
+        toggl,
+        "timeEntryId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.toggl.getTimeEntry({
+      $,
+      timeEntryId: this.timeEntryId,
+    });
+
+    response && $.export("summary", "Successfully retrieved time entry");
+
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,6 @@
+export default {
+  API_BASE_URL_VERSIONS: {
+    "v1": "https://track.toggl.com/webhooks/api/v1",
+    "v8": "https://api.track.toggl.com/api/v8",
+  },
+};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@pipedream/toggl",
+  "version": "0.0.1",
+  "description": "Pipedream Toggl Components",
+  "main": "toggl.app.js",
+  "keywords": [
+    "pipedream",
+    "toggl"
+  ],
+  "homepage": "https://pipedream.com/apps/toggl",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "license": "MIT",
+  "gitHead": "e12480b94cc03bed4808ebc6b13e7fdb3a1ba535",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^0.10.0",
+    "toggl-api": "^1.0.2"
+  }
+}

package/sources/common/base.mjs

@@ -0,0 +1,79 @@
+import toggl from "../../toggl.app.mjs";
+
+export default {
+  props: {
+    toggl,
+    workspaceId: {
+      propDefinition: [
+        toggl,
+        "workspaceId",
+      ],
+    },
+    db: "$.service.db",
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+  },
+  methods: {
+    async _respond(event) {
+      const { body } = event;
+
+      await this.http.respond({
+        status: 200,
+        body: {
+          validation_code: body.validation_code,
+        },
+      });
+    },
+    _getWebhookId() {
+      return this.db.get("webhookId");
+    },
+    _setWebhookId(webhookId) {
+      this.db.set("webhookId", webhookId);
+    },
+    _getAction() {
+      throw new Error("_getAction not implemented");
+    },
+    _getEntity() {
+      throw new Error("_getEntity not implemented");
+    },
+  },
+  hooks: {
+    async activate() {
+      const response = await this.toggl.createWebhook({
+        workspaceId: this.workspaceId,
+        data: {
+          url_callback: this.http.endpoint,
+          event_filters: [
+            {
+              entity: this._getEntity(),
+              action: this._getAction(),
+            },
+          ],
+        },
+      });
+
+      this._setWebhookId(response.subscription_id);
+    },
+    async deactivate() {
+      const webhookId = this._getWebhookId();
+      await this.toggl.removeWebhook({
+        workspaceId: this.workspaceId,
+        webhookId,
+      });
+    },
+  },
+  async run(event) {
+    const { body } = event;
+
+    await this._respond(event);
+    if (body.payload === "ping") return;
+
+    this.$emit(body, {
+      id: body.event_id,
+      summary: `New ${body.metadata.model} ${body.metadata.action} with id ${body.payload.id}`,
+      ts: Date.parse(body.created_at),
+    });
+  },
+};

package/sources/common/constants.mjs

@@ -0,0 +1,62 @@
+export default {
+  WEBHOOK_ENTITIES: [
+    {
+      label: "All",
+      value: "*",
+    },
+    {
+      label: "Client",
+      value: "client",
+    },
+    {
+      label: "Project",
+      value: "project",
+    },
+    {
+      label: "Project Group",
+      value: "project_group",
+    },
+    {
+      label: "Project User",
+      value: "project_user",
+    },
+    {
+      label: "Tag",
+      value: "tag",
+    },
+    {
+      label: "Task",
+      value: "task",
+    },
+    {
+      label: "Time Entry",
+      value: "time_entry",
+    },
+    {
+      label: "Workspace",
+      value: "workspace",
+    },
+    {
+      label: "Workspace User",
+      value: "workspace_user",
+    },
+  ],
+  WEBHOOK_ACTIONS: [
+    {
+      label: "All",
+      value: "*",
+    },
+    {
+      label: "Created",
+      value: "created",
+    },
+    {
+      label: "Updated",
+      value: "updated",
+    },
+    {
+      label: "Deleted",
+      value: "deleted",
+    },
+  ],
+};

package/sources/new-start-time-entry/new-start-time-entry.mjs

@@ -0,0 +1,34 @@
+import base from "../common/base.mjs";
+
+export default {
+  ...base,
+  name: "New Start Time Entry (Instant)",
+  version: "0.0.1",
+  key: "toggl-new-start-time-entry",
+  description: "Emit new event when a time entry is started. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/webhooks.md)",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...base.methods,
+    _getAction() {
+      return "created";
+    },
+    _getEntity() {
+      return "time_entry";
+    },
+  },
+  async run(event) {
+    const { body } = event;
+
+    await this._respond(event);
+    if (body.payload === "ping") return;
+
+    if (!body.payload.stop) {
+      this.$emit(body, {
+        id: body.event_id,
+        summary: `New time_entry started with id ${body.payload.id}`,
+        ts: Date.parse(body.created_at),
+      });
+    }
+  },
+};

package/sources/new-time-entry/new-time-entry.mjs

@@ -0,0 +1,34 @@
+import base from "../common/base.mjs";
+
+export default {
+  ...base,
+  name: "New Time Entry (Instant)",
+  version: "0.0.1",
+  key: "toggl-new-time-entry",
+  description: "Emit new event when a time entry is created. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/webhooks.md)",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...base.methods,
+    _getAction() {
+      return "updated";
+    },
+    _getEntity() {
+      return "time_entry";
+    },
+  },
+  async run(event) {
+    const { body } = event;
+
+    await this._respond(event);
+    if (body.payload === "ping") return;
+
+    if (body.payload.stop) {
+      this.$emit(body, {
+        id: body.event_id,
+        summary: `New time_entry created with id ${body.payload.id}`,
+        ts: Date.parse(body.created_at),
+      });
+    }
+  },
+};

package/sources/new-update-time-entry/new-update-time-entry.mjs

@@ -0,0 +1,20 @@
+import base from "../common/base.mjs";
+
+export default {
+  ...base,
+  name: "New Update Time Entry (Instant)",
+  version: "0.0.1",
+  key: "toggl-new-update-time-entry",
+  description: "Emit new event when a time entry is updated. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/webhooks.md)",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...base.methods,
+    _getAction() {
+      return "updated";
+    },
+    _getEntity() {
+      return "time_entry";
+    },
+  },
+};

package/sources/new-webhook-event/new-webhook-event.mjs

@@ -0,0 +1,36 @@
+import base from "../common/base.mjs";
+import constants from "../common/constants.mjs";
+
+export default {
+  ...base,
+  name: "New Webhook Event (Instant)",
+  version: "0.0.1",
+  key: "toggl-new-webhook-event",
+  description: "Emit new event on receive a webhook event. [See docs here](https://github.com/toggl/toggl_api_docs/blob/master/webhooks.md)",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...base.props,
+    entity: {
+      label: "Entity",
+      description: "The entity you want to listen the events",
+      type: "string",
+      options: constants.WEBHOOK_ENTITIES,
+    },
+    action: {
+      label: "Action",
+      description: "The action you want to listen the events",
+      type: "string",
+      options: constants.WEBHOOK_ACTIONS,
+    },
+  },
+  methods: {
+    ...base.methods,
+    _getAction() {
+      return this.action;
+    },
+    _getEntity() {
+      return this.entity;
+    },
+  },
+};

package/toggl.app.mjs

@@ -0,0 +1,103 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
+export default {
+  type: "app",
+  app: "toggl",
+  propDefinitions: {
+    timeEntryId: {
+      label: "Time Entry ID",
+      description: "The time entry ID",
+      type: "integer",
+      async options({ page }) {
+        const timeEntries = await this.getTimeEntries({
+          params: {
+            page: page + 1,
+          },
+        });
+
+        return timeEntries.map((timeEntry) => ({
+          label: timeEntry.description ?? `Duration: ${timeEntry.duration}`,
+          value: timeEntry.id,
+        }));
+      },
+    },
+    workspaceId: {
+      label: "Workspace Id",
+      description: "The workspace ID",
+      type: "integer",
+      async options({ page }) {
+        const workspaces = await this.getWorkspaces({
+          params: {
+            page: page + 1,
+          },
+        });
+
+        return workspaces.map((workspace) => ({
+          label: workspace.name,
+          value: workspace.id,
+        }));
+      },
+    },
+  },
+  methods: {
+    _apiToken() {
+      return this.$auth.api_token;
+    },
+    _apiUrl(apiVersion) {
+      return constants.API_BASE_URL_VERSIONS[apiVersion];
+    },
+    async _makeRequest(apiVersion, path, options = {}, $ = this) {
+      return axios($, {
+        url: `${this._apiUrl(apiVersion)}/${path}`,
+        auth: {
+          username: this._apiToken(),
+          password: "api_token",
+        },
+        ...options,
+      });
+    },
+    async createWebhook({
+      workspaceId, data,
+    }) {
+      return this._makeRequest("v1", `subscriptions/${workspaceId}`, {
+        method: "post",
+        data: {
+          ...data,
+          enabled: true,
+          description: `Pipedream webhook created at ${new Date().toISOString()}`,
+        },
+      });
+    },
+    async removeWebhook({
+      workspaceId, webhookId,
+    }) {
+      return this._makeRequest("v1", `subscriptions/${workspaceId}/${webhookId}`, {
+        method: "delete",
+      });
+    },
+    async getWorkspaces({ $ } = {}) {
+      return this._makeRequest("v8", "workspaces", {}, $);
+    },
+    async getCurrentTimeEntry({ $ } = {}) {
+      return this._makeRequest("v8", "time_entries/current", {}, $);
+    },
+    async getTimeEntries({
+      params, $,
+    } = {}) {
+      return this._makeRequest("v8", "time_entries", {
+        params: {
+          ...params,
+          per_page: 1000,
+        },
+      }, $);
+    },
+    async getTimeEntry({
+      timeEntryId, $,
+    } = {}) {
+      const { data } = await this._makeRequest("v8", `time_entries/${timeEntryId}`, {}, $);
+
+      return data;
+    },
+  },
+};