Create Requirement with PractiTest API on New Created or Updated Event (Instant) from Google Calendar API

Pipedream makes it easy to connect APIs for PractiTest, Google Calendar and 2,400+ other apps remarkably fast.

Trigger workflow on

New Created or Updated Event (Instant) from the Google Calendar API

Next, do this

Create Requirement with the PractiTest API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Google Calendar trigger and PractiTest action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Created or Updated Event (Instant) trigger
1. Connect your Google Calendar account
2. Optional- Select one or more Calendars
3. Optional- Configure Emit only for new events
4. Configure Push notification renewal schedule
Configure the Create Requirement action
1. Connect your PractiTest account
2. Select a Project
3. Configure Name
4. Select a Author
5. Optional- Configure Description
6. Optional- Select a Assigned To
7. Optional- Configure Version
8. Optional- Configure Priority
9. Optional- Configure Custom Fields
10. Optional- Configure Parent ID
11. Optional- Configure Test IDs
12. Optional- Configure Tags
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Created or Updated Event (Instant) on Google Calendar

Description:Emit new event when a Google Calendar events is created or updated (does not emit cancelled events)

Version:0.1.13

Key:google_calendar-new-or-updated-event-instant

View on GitHub

Google Calendar Overview#

The Google Calendar API lets you dip into the powerhouse of scheduling, allowing for the reading, creation, and manipulation of events and calendars directly from your applications. Through Pipedream, you can seamlessly integrate Google Calendar into a myriad of workflows, automating event management, syncing with other services, setting up custom reminders, or even collating data for reporting. The key here is to streamline your calendar-related processes, ensuring that your time management is as efficient and automated as possible.

Trigger Code#

import { v4 as uuid } from "uuid";
import sampleEmit from "./test-event.mjs";
import googleCalendar from "../../google_calendar.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "google_calendar-new-or-updated-event-instant",
  type: "source",
  name: "New Created or Updated Event (Instant)",
  description: "Emit new event when a Google Calendar events is created or updated (does not emit cancelled events)",
  version: "0.1.13",
  dedupe: "unique",
  props: {
    googleCalendar,
    db: "$.service.db",
    calendarIds: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
      type: "string[]",
      default: [
        "primary",
      ],
      label: "Calendars",
      description: "Select one or more calendars to watch (defaults to the primary calendar)",
    },
    newOnly: {
      label: "Emit only for new events",
      type: "boolean",
      description: "Emit new events only, and not updates to existing events (defaults to `false`)",
      optional: true,
      default: false,
    },
    http: "$.interface.http",
    timer: {
      label: "Push notification renewal schedule",
      description: "The Google Calendar API requires occasional renewal of push notification subscriptions. **This runs in the background, so you should not need to modify this schedule**.",
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      const events = [];
      const params = {
        maxResults: 25,
        orderBy: "updated",
      };
      for (const calendarId of this.calendarIds) {
        params.calendarId = calendarId;
        const { items } = await this.googleCalendar.listEvents(params);
        events.push(...items);
      }
      events.sort((a, b) => (Date.parse(a.updated) > Date.parse(b.updated))
        ? 1
        : -1);
      for (const event of events.slice(-25)) {
        const meta = this.generateMeta(event);
        this.$emit(event, meta);
      }
    },
    async activate() {
      await this.makeWatchRequest();
    },
    async deactivate() {
      await this.stopWatchRequest();
    },
  },
  methods: {
    setNextSyncToken(calendarId, nextSyncToken) {
      this.db.set(`${calendarId}.nextSyncToken`, nextSyncToken);
    },
    getNextSyncToken(calendarId) {
      return this.db.get(`${calendarId}.nextSyncToken`);
    },
    setChannelId(calendarId, channelId) {
      this.db.set(`${calendarId}.channelId`, channelId);
    },
    getChannelId(calendarId) {
      return this.db.get(`${calendarId}.channelId`);
    },
    setResourceId(calendarId, resourceId) {
      this.db.set(`${calendarId}.resourceId`, resourceId);
    },
    getResourceId(calendarId) {
      return this.db.get(`${calendarId}.resourceId`);
    },
    setExpiration(calendarId, expiration) {
      this.db.set(`${calendarId}.expiration`, expiration);
    },
    getExpiration(calendarId) {
      return this.db.get(`${calendarId}.expiration`);
    },
    /**
     * A utility method to compute whether the provided event is newly created
     * or not. Since the Google Calendar API does not provide a specific way to
     * determine this, this method estimates the result based on the `created`
     * and `updated` timestamps: if they are more than 2 seconds apart, then we
     * assume that the event is not new.
     *
     * @param {Object} event - The calendar event being processed
     * @returns {Boolean} True if the input event is a newly created event, or
     * false otherwise
     */
    _isNewEvent(event) {
      const {
        created,
        updated,
      } = event;
      const createdTimestampMilliseconds = Date.parse(created);
      const updatedTimestampMilliseconds = Date.parse(updated);
      const diffMilliseconds = Math.abs(
        updatedTimestampMilliseconds - createdTimestampMilliseconds,
      );
      const maxDiffMilliseconds = 2000;
      return diffMilliseconds <= maxDiffMilliseconds;
    },
    /**
     * A utility method to compute whether the provided event is relevant to the
     * event source (and as a consequence must be processed) or not.
     *
     * @param {Object} event - The calendar event being processed
     * @returns {Boolean} True if the input event must be processed, or false
     * otherwise (i.e. if the event must be skipped)
     */
    isEventRelevant(event) {
      return !this.newOnly || this._isNewEvent(event);
    },
    generateMeta(event) {
      const {
        id,
        summary,
        updated: tsString,
      } = event;
      const ts = Date.parse(tsString);
      return {
        id: `${id}-${ts}`,
        summary,
        ts,
      };
    },
    async makeWatchRequest() {
      // Make watch request for this HTTP endpoint
      for (const calendarId of this.calendarIds) {
        const watchResp =
          await this.googleCalendar.watchEvents({
            calendarId,
            requestBody: {
              id: uuid(),
              type: "web_hook",
              address: this.http.endpoint,
            },
          });

        // Initial full sync. Get next sync token
        const nextSyncToken = await this.googleCalendar.fullSync(calendarId);

        this.setNextSyncToken(calendarId, nextSyncToken);
        this.setChannelId(calendarId, watchResp.id);
        this.setResourceId(calendarId, watchResp.resourceId);
        this.setExpiration(calendarId, watchResp.expiration);
      }
    },
    async stopWatchRequest() {
      for (const calendarId of this.calendarIds) {
        const id = this.getChannelId(calendarId);
        const resourceId = this.getResourceId(calendarId);
        if (id && resourceId) {
          const { status } =
            await this.googleCalendar.stopChannel({
              returnOnlyData: false,
              requestBody: {
                id,
                resourceId,
              },
            });
          if (status === 204) {
            console.log("webhook deactivated");
            this.setNextSyncToken(calendarId, null);
            this.setChannelId(calendarId, null);
            this.setResourceId(calendarId, null);
            this.setExpiration(calendarId, null);
          } else {
            console.log("There was a problem deactivating the webhook");
          }
        }
      }
    },
    getSoonestExpirationDate() {
      let min;
      for (const calendarId of this.calendarIds) {
        const expiration = parseInt(this.db.get(`${calendarId}.expiration`));
        if (!min || expiration < min) {
          min = expiration;
        }
      }
      return new Date(min);
    },
    getChannelIds() {
      const channelIds = [];
      for (const calendarId of this.calendarIds) {
        const channelId = this.db.get(`${calendarId}.channelId`);
        channelIds.push(channelId);
      }
      return channelIds;
    },
  },
  async run(event) {
    // refresh watch
    if (event.interval_seconds) {
      // get time
      const now = new Date();
      const intervalMs = event.interval_seconds * 1000;
      // get expiration
      const expireDate = this.getSoonestExpirationDate();

      // if now + interval > expiration, refresh watch
      if (now.getTime() + intervalMs > expireDate.getTime()) {
        await this.stopWatchRequest();
        await this.makeWatchRequest();
      }
    } else {
      // Verify channel ID
      const channelIds = this.getChannelIds();
      const incomingChannelId = event?.headers?.["x-goog-channel-id"];
      if (!channelIds.includes(incomingChannelId)) {
        console.log(
          `Unexpected channel ID ${incomingChannelId}. This likely means there are multiple, older subscriptions active.`,
        );
        return;
      }

      // Check that resource state === exists
      const state = event?.headers?.["x-goog-resource-state"];
      switch (state) {
      case "exists":
        // there's something to emit, so keep going
        break;
      case "not_exists":
        console.log("Resource does not exist. Exiting.");
        return;
      case "sync":
        console.log("New channel created");
        return;
      default:
        console.log(`Unknown state: ${state}`);
        return;
      }
    }

    // Fetch and emit events
    for (const calendarId of this.calendarIds) {
      const syncToken = this.getNextSyncToken(calendarId);
      let nextSyncToken = null;
      let nextPageToken = null;
      while (!nextSyncToken) {
        const {
          data: syncData = {},
          status: syncStatus,
        } = await this.googleCalendar.listEvents({
          returnOnlyData: false,
          calendarId,
          syncToken,
          pageToken: nextPageToken,
          maxResults: 2500,
        });
        if (syncStatus === 410) {
          console.log("Sync token invalid, resyncing");
          nextSyncToken = await this.googleCalendar.fullSync(this.calendarId);
          break;
        }
        nextPageToken = syncData.nextPageToken;
        nextSyncToken = syncData.nextSyncToken;

        const { items: events = [] } = syncData;
        events
          .filter(this.isEventRelevant, this)
          .forEach((event) => {
            const { status } = event;
            if (status === "cancelled") {
              console.log("Event cancelled. Exiting.");
              return;
            }
            const meta = this.generateMeta(event);
            this.$emit(event, meta);
          });
      }

      this.setNextSyncToken(calendarId, nextSyncToken);
    }
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Calendars	`calendarIds`	`string[]`	Select a value from the drop down menu.
Emit only for new events	`newOnly`	`boolean`	Emit new events only, and not updates to existing events (defaults to `false`)
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Push notification renewal schedule	`timer`	`$.interface.timer`	The Google Calendar API requires occasional renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.

Trigger Authentication#

Google Calendar uses OAuth authentication. When you connect your Google Calendar account, Pipedream will open a popup window where you can sign into Google Calendar and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Calendar API.

Pipedream requests the following authorization scopes when you connect your account:

https://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/calendar.settings.readonly

About Google Calendar#

With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.

Action#

Create Requirement on PractiTest

Description:Create a requirement [See docs here](https://www.practitest.com/api-v2/#create-a-requirement)

Version:0.0.1

Key:practitest-create-requirement

View on GitHub

PractiTest Overview#

PractiTest is a test management tool that facilitates the organization, tracking, and planning of software testing processes by integrating with Pipedream's automation capabilities. With the PractiTest API, you're able to manipulate test cases, sets, runs, and report on results programmatically. This powerful combination opens the door to automated workflows that enhance testing processes, improve bug tracking, and provide real-time feedback to your team.

Action Code#

import practitest from "../../app/practitest.app.mjs";
import { defineAction } from "@pipedream/types";
import { DOCS } from "../../common/constants.mjs";
export default defineAction({
    name: "Create Requirement",
    description: `Create a requirement [See docs here](${DOCS.createRequirement})`,
    key: "practitest-create-requirement",
    version: "0.0.1",
    type: "action",
    props: {
        practitest,
        projectId: {
            propDefinition: [
                practitest,
                "project",
            ],
        },
        name: {
            type: "string",
            label: "Name",
            description: "Name of the requirement",
        },
        authorId: {
            propDefinition: [
                practitest,
                "user",
            ],
            label: "Author",
        },
        description: {
            type: "string",
            label: "Description",
            description: "Description of the requirement",
            optional: true,
        },
        assignedToId: {
            propDefinition: [
                practitest,
                "user",
            ],
            label: "Assigned To",
            optional: true,
        },
        version: {
            propDefinition: [
                practitest,
                "version",
            ],
            description: "String of the requirement's version",
        },
        priority: {
            type: "string",
            label: "Priority",
            description: "String of the requirement's priority",
            optional: true,
        },
        customFields: {
            propDefinition: [
                practitest,
                "customFields",
            ],
        },
        parentId: {
            type: "string",
            label: "Parent ID",
            description: "A parent's requirement ID",
            optional: true,
        },
        testIds: {
            type: "integer[]",
            label: "Test IDs",
            description: "An array of test-ids to add to the traceability of the new requirement",
            optional: true,
        },
        tags: {
            type: "string[]",
            label: "Tags",
            description: "An array of tags for the requirement",
            optional: true,
        },
    },
    async run({ $ }) {
        const { projectId, name, authorId, description, assignedToId, version, priority, customFields, parentId, testIds, tags, } = this;
        const params = {
            $,
            projectId,
            attributes: {
                name,
                "author-id": authorId,
                description,
                "assigned-to-id": assignedToId,
                version,
                priority,
                "custom-fields": customFields,
                "parent-id": parentId,
                tags,
            },
        };
        if (testIds) {
            params.traceability = {
                "test-ids": testIds,
            };
        }
        const response = await this.practitest.createRequirement(params);
        $.export("$summary", `Successfully created requirement (id ${response.data.id})`);
        return response;
    },
});

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
PractiTest	`practitest`	`app`	This component uses the PractiTest app.
Project	`projectId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the requirement
Author	`authorId`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	Description of the requirement
Assigned To	`assignedToId`	`string`	Select a value from the drop down menu.
Version	`version`	`string`	String of the requirement's version
Priority	`priority`	`string`	String of the requirement's priority
Custom Fields	`customFields`	`object`	A hash of custom-fields with their value
Parent ID	`parentId`	`string`	A parent's requirement ID
Test IDs	`testIds`	`integer[]`	An array of test-ids to add to the traceability of the new requirement
Tags	`tags`	`string[]`	An array of tags for the requirement

Action Authentication#

PractiTest uses API keys for authentication. When you connect your PractiTest account, Pipedream securely stores the keys so you can easily authenticate to PractiTest APIs in both code and no-code steps.

PractiTest uses API tokens for authentication. You can create a new API token by going to the Account Settings - “API Tokens”, or going to your personal settings for Personal Tokens. Please visit API tokens for more information.

About PractiTest#

Empower organizations to create, deploy and run software with confidence.

More Ways to Connect PractiTest + Google Calendar#

Other Popular Integrations#

Create Requirement with PractiTest API on Event Cancelled from Google Calendar API

Google Calendar + PractiTest

Create Requirement with PractiTest API on New Created or Updated Event (Instant) from Google Calendar API

Pipedream makes it easy to connect APIs for PractiTest, Google Calendar and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular