List Gists for a User with GitHub API on New Scraping Completed from WebScraper.IO API

Pipedream makes it easy to connect APIs for GitHub, WebScraper.IO and 2,500+ other apps remarkably fast.

Trigger workflow on

New Scraping Completed from the WebScraper.IO API

Next, do this

List Gists for a User with the GitHub 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 WebScraper.IO trigger and GitHub action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scraping Completed trigger
1. Connect your WebScraper.IO account
2. Configure timer
Configure the List Gists for a User action
1. Connect your GitHub account
2. Optional- Configure Filter by Timestamp
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 Scraping Completed on WebScraper.IO

Description:Emit new event when a page scraping job has completed. [See the docs here](https://webscraper.io/documentation/web-scraper-cloud/api)

Version:0.0.1

Key:webscraper_io-new-scraping-completed

View on GitHub

WebScraper.IO Overview#

The WebScraper.IO API allows you to programmatically perform web scraping tasks, extracting structured data from websites. With the API, you can automate the gathering of web content for analysis, monitoring, and integration with other data sources. In Pipedream, you can leverage this API to build workflows that process, analyze, and act on the data you scrape without writing code for backend infrastructure.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "webscraper_io-new-scraping-completed",
  name: "New Scraping Completed",
  description: "Emit new event when a page scraping job has completed. [See the docs here](https://webscraper.io/documentation/web-scraper-cloud/api)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async emitHistoricalEvents({ limit }) {
      const jobs = await this.getScrapingJobs();
      if (!(jobs?.length > 0)) {
        return;
      }
      jobs.reverse().slice(0, limit)
        .forEach((job) => this.emitEvent(job));
    },
    isRelevant(job, previousIds) {
      return job.status === "finished" && !previousIds[job.id];
    },
    emitEvent(job) {
      const meta = this.generateMeta(job);
      this.$emit(job, meta);
    },
    generateMeta(job) {
      return {
        id: job.id,
        summary: job.sitemap_name,
        ts: job.time_created,
      };
    },
    async getScrapingJobs() {
      const jobs = [];
      const previousIds = this._getPreviousIds();

      const results = await this.webscraper.paginate(this.webscraper.getScrapingJobs);
      for (const job of results) {
        if (this.isRelevant(job, previousIds)) {
          previousIds[job.id] = true;
          jobs.push(job);
        }
      }

      this._setPreviousIds(previousIds);

      return jobs;
    },
  },
  async run() {
    const jobs = await this.getScrapingJobs();
    jobs.forEach((job) => this.emitEvent(job));
  },
};

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
WebScraper.IO	`webscraper`	`app`	This component uses the WebScraper.IO app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

" To retrieve your API token,

Navigate to your Web Scraper account and sign in
Go to “Account Info” > “API settings”"

About WebScraper.IO#

Making web data extraction easy and accessible for everyone.

Action#

List Gists for a User on GitHub

Description:Lists public gists for the specified user. [See the documentation](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28#list-gists-for-a-user)

Version:0.1.3

Key:github-list-gists-for-a-user

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import github from "../../github.app.mjs";

export default {
  key: "github-list-gists-for-a-user",
  name: "List Gists for a User",
  description: "Lists public gists for the specified user. [See the documentation](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28#list-gists-for-a-user)",
  version: "0.1.3",
  type: "action",
  props: {
    github: {
      ...github,
      reloadProps: true,
    },
    since: {
      label: "Filter by Timestamp",
      description: "Only show notifications updated since the given time. This should be a timestamp in ISO 8601 format, e.g. `2018-05-16T09:30:10Z` or [another standard date/time format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format).",
      type: "string",
      optional: true,
    },
  },
  async additionalProps() {
    const { login } = await this.github.getAuthenticatedUser();
    return {
      username: {
        label: "Username",
        description: "The username of the user whose gists you want to list",
        type: "string",
        default: login,
      },
    };
  },
  async run({ $ }) {
    const PER_PAGE = 100;
    const MAX_PAGES = 50;
    let page = 1;
    const data = [];

    const date = this.since && new Date(this.since);
    if (date && isNaN(date.valueOf())) {
      throw new ConfigurationError("Invalid date string provided");
    }

    const since = date?.toISOString();

    while (true) {
      const res = await this.github.listGistsFromUser(this.username, {
        since,
        per_page: PER_PAGE,
        page,
      });

      if (!res || res.length === 0) {
        break;
      }
      data.push(...res);

      page++;
      if (page > MAX_PAGES) {
        break;
      }
    }

    if (data.length === 0) {
      $.export("$summary", `No gists found for user "${this.username}"`);
      return;
    }

    $.export("$summary", `Successfully fetched ${data.length} gist(s)`);
    return data;
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Filter by Timestamp	`since`	`string`	Only show notifications updated since the given time. This should be a timestamp in ISO 8601 format, e.g. `2018-05-16T09:30:10Z` or another standard date/time format

Action Authentication#

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

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

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

List Gists for a User with GitHub API on New Scraping Completed from WebScraper.IO API

Pipedream makes it easy to connect APIs for GitHub, WebScraper.IO and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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