Share File or Folder with Google Drive API on New or Removed Documents in a Collection from Fauna API

Pipedream makes it easy to connect APIs for Google Drive, Fauna and 2,700+ other apps remarkably fast.

Trigger workflow on

New or Removed Documents in a Collection from the Fauna API

Next, do this

Share File or Folder with the Google Drive 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 Fauna trigger and Google Drive action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New or Removed Documents in a Collection trigger
1. Configure timer
2. Connect your Fauna account
3. Select a Collection
4. Optional- Configure Emit changes as a single event
Configure the Share File or Folder action
1. Connect your Google Drive account
2. Optional- Select a Drive
3. Select a Use File or Folder
4. Select a File
5. Select a Folder
6. Select a Type
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 or Removed Documents in a Collection on Fauna

Description:Emit new event each time you add or remove a document from a specific collection, with the details of the document.

Version:0.0.8

Key:faunadb-changes-to-collection

View on GitHub

Fauna Overview#

Fauna API offers a powerful serverless database solution for modern applications. Its unique capabilities allow for highly scalable, secure, and flexible data management. With Pipedream, you can harness the power of Fauna to create intricate serverless workflows that react to various triggers, manage data efficiently, and connect seamlessly with other services and APIs to automate complex tasks.

Trigger Code#

import fauna from "../../faunadb.app.mjs";
import _ from "lodash";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  type: "source",
  key: "faunadb-changes-to-collection",
  name: "New or Removed Documents in a Collection",
  description: "Emit new event each time you add or remove a document from a specific collection, with the details of the document.",
  version: "0.0.8",
  dedupe: "unique", // Dedupe events based on the concatenation of event + document ref id
  props: {
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
    fauna,
    collection: {
      propDefinition: [
        fauna,
        "collections",
      ],
    },
    emitEventsInBatch: {
      type: "boolean",
      label: "Emit changes as a single event",
      description:
        "If `true`, all events are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each event in Fauna as its own event in Pipedream",
      optional: true,
      default: false,
    },
  },
  async run() {
    // As soon as the script runs, mark the start time so we can fetch changes
    // since this time on the next run. Fauna expects epoch ms as its cursor.
    const ts = +new Date() * 1000;
    const cursor = this.db.get("cursor") || ts;

    const events = await this.fauna.getEventsInCollectionAfterTs(
      this.collection,
      cursor,
    );

    if (!events.length) {
      console.log(`No new events in collection ${this.collection}`);
      this.db.set("cursor", ts);
      return;
    }

    console.log(`${events.length} new events in collection ${this.collection}`);

    // Batched emits do not take advantage of the built-in deduper
    if (this.emitEventsInBatch) {
      this.$emit({
        events,
      }, {
        summary: `${events.length} new event${events.length > 1
          ? "s"
          : ""}`,
        id: cursor,
      });
    } else {
      for (const event of events) {
        this.$emit(event, {
          summary: `${event.action.toUpperCase()} - ${event.document.id}`,
          id: `${event.action}-${event.document.id}`, // dedupes events based on this ID
        });
      }
    }

    // Finally, set cursor for the next run to the max timestamp of the changed events, ensuring we
    // get all events after that on the next run. We need to add 1 since the timestamp filter in
    // Fauna is inclusive: https://docs.fauna.com/fauna/current/api/fql/functions/paginate
    const maxEventTs = _.maxBy(events, (event) => event.ts).ts + 1;

    this.db.set("cursor", maxEventTs);
  },
};

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
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Fauna	`fauna`	`app`	This component uses the Fauna app.
Collection	`collection`	`string`	Select a value from the drop down menu.
Emit changes as a single event	`emitEventsInBatch`	`boolean`	If `true`, all events are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each event in Fauna as its own event in Pipedream

Trigger Authentication#

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

Create a key in the Security section of your FaunaDB dashboard, then enter the Secret below.

About Fauna#

The distributed serverless database combining the flexibility of NoSQL with the relational querying capabilities of SQL systems.

Action#

Share File or Folder on Google Drive

Description:Add a [sharing permission](https://support.google.com/drive/answer/7166529) to the sharing preferences of a file or folder and provide a sharing URL. [See the documentation](https://developers.google.com/drive/api/v3/reference/permissions/create)

Version:0.2.2

Key:google_drive-add-file-sharing-preference

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  GOOGLE_DRIVE_GRANTEE_DOMAIN,
  GOOGLE_DRIVE_GRANTEE_GROUP,
  GOOGLE_DRIVE_GRANTEE_USER,
  GOOGLE_DRIVE_ROLE_OPTIONS,
  GOOGLE_DRIVE_ROLE_OPTION_FILEORGANIZER,
  GOOGLE_DRIVE_ROLE_WRITER,
} from "../../common/constants.mjs";
import googleDrive from "../../google_drive.app.mjs";

/**
 * Uses Google Drive API to create a permission for a file. The role granted by
 * the permission is one of `owner`,`organizer`,`fileOrganizer`,
 * `writer`,`commenter`, `reader`. See the [Google Drive API Reference for
 * Permissions](https://bit.ly/2XKKG1X) for more information.
 */
export default {
  key: "google_drive-add-file-sharing-preference",
  name: "Share File or Folder",
  description:
    "Add a [sharing permission](https://support.google.com/drive/answer/7166529) to the sharing preferences of a file or folder and provide a sharing URL. [See the documentation](https://developers.google.com/drive/api/v3/reference/permissions/create)",
  version: "0.2.2",
  type: "action",
  props: {
    googleDrive,
    drive: {
      propDefinition: [
        googleDrive,
        "watchedDrive",
      ],
      optional: true,
    },
    useFileOrFolder: {
      type: "string",
      label: "Use File or Folder",
      description: "Whether to use a file or a folder for this action",
      reloadProps: true,
      options: [
        "File",
        "Folder",
      ],
    },
    fileId: {
      propDefinition: [
        googleDrive,
        "fileId",
        (c) => ({
          drive: c.drive,
        }),
      ],
      hidden: true,
      description: "The file to share. You must specify either a file or a folder.",
    },
    folderId: {
      propDefinition: [
        googleDrive,
        "folderId",
        (c) => ({
          drive: c.drive,
        }),
      ],
      hidden: true,
      description: "The folder to share. You must specify either a file or a folder.",
    },
    type: {
      propDefinition: [
        googleDrive,
        "type",
      ],
      reloadProps: true,
    },
  },
  async additionalProps(previousProps) {
    const {
      fileId, folderId, type, useFileOrFolder,
    } = this;

    if (useFileOrFolder === "File") {
      previousProps.fileId.hidden = false;
      previousProps.folderId.hidden = true;
    } else if (useFileOrFolder === "Folder") {
      previousProps.fileId.hidden = true;
      previousProps.folderId.hidden = false;
    }

    const obj = {};
    if (!(fileId || folderId) || !type) return obj;

    const emailAddress = {
      type: "string",
      label: "Email Address",
      description:
        "Enter the email address of the user that you'd like to share the file or folder with (e.g. `alex@altostrat.com`).",
    };

    switch (type) {
    case GOOGLE_DRIVE_GRANTEE_DOMAIN:
      obj.domain = {
        type: "string",
        label: "Domain",
        description:
            "Enter the domain of the G Suite organization that you'd like to share the file or folder with (e.g. `altostrat.com`). All G Suite organization users under this domain will have access to the file you share.",
      };
      break;
    case GOOGLE_DRIVE_GRANTEE_GROUP:
      obj.emailAddress = {
        ...emailAddress,
        description:
            "Enter the email address of the group that you'd like to share the file or folder with (e.g. `hiking-club@altostrat.com`)",
      };
      break;
    case GOOGLE_DRIVE_GRANTEE_USER:
      obj.emailAddress = emailAddress;
      break;

    default:
      break;
    }

    const isFolder = !!folderId;
    const options = GOOGLE_DRIVE_ROLE_OPTIONS;

    if (isFolder) {
      const writerOpt = options.find(({ value }) => value === GOOGLE_DRIVE_ROLE_WRITER);
      writerOpt.label = writerOpt.label.replace(/Writer/, "Contributor");
      options.push(GOOGLE_DRIVE_ROLE_OPTION_FILEORGANIZER);
    }

    return {
      ...obj,
      role: {
        type: "string",
        label: "Role",
        description: "The role granted by this permission",
        options,
      },
    };
  },
  async run({ $ }) {
    const {
      fileId, folderId, role, type, domain, emailAddress,
    } = this;
    if (!(fileId || folderId)) {
      throw new ConfigurationError("You must specify either a file or a folder");
    }
    // Create the permission for the file
    await this.googleDrive.createPermission(folderId ?? fileId, {
      role,
      type,
      domain,
      emailAddress,
    });

    // Get the file to get the `webViewLink` sharing URL
    const resp = await this.googleDrive.getFile(folderId ?? fileId);
    const webViewLink = resp.webViewLink;
    $.export(
      "$summary",
      `Successfully shared ${folderId
        ? "folder"
        : "file"} "${resp.name}" with ${type} "${
        emailAddress ?? domain ?? ""
      }" with role '${role}'`,
    );
    return webViewLink;
  },
};

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
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
Drive	`drive`	`string`	Select a value from the drop down menu.
Use File or Folder	`useFileOrFolder`	`string`	Select a value from the drop down menu:`FileFolder`
Type	`type`	`string`	Select a value from the drop down menu:`usergroupdomainanyone`

Action Authentication#

Google Drive uses OAuth authentication. When you connect your Google Drive account, Pipedream will open a popup window where you can sign into Google Drive 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 Drive API.

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

https://www.googleapis.com/auth/drive

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

More Ways to Connect Google Drive + Fauna#

Other Popular Integrations#

Read From FaunaDB Collection with Fauna API on Changes to Specific Files from Google Drive API

Google Drive + Fauna

Share File or Folder with Google Drive API on New or Removed Documents in a Collection from Fauna API

Pipedream makes it easy to connect APIs for Google Drive, Fauna and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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