[Date/Time] Compare Dates with Formatting API on New Article Published from New York Times API

Pipedream makes it easy to connect APIs for Formatting, New York Times and 2,400+ other apps remarkably fast.

Trigger workflow on

New Article Published from the New York Times API

Next, do this

[Date/Time] Compare Dates with the Formatting 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 New York Times trigger and Formatting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Article Published trigger
1. Connect your New York Times account
2. Configure timer
3. Optional- Configure Facet
4. Optional- Select one or more Facet Fields
5. Optional- Configure Facet Filter
6. Optional- Configure Field List
7. Optional- Configure Filtered Query
8. Optional- Configure Query
9. Configure alert
Configure the [Date/Time] Compare Dates action
1. Connect your Formatting account
2. Configure Start Date
3. Optional- Select a Input Format
4. Configure End Date
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 Article Published on New York Times

Description:Emit new event when an article is published.

Version:0.0.1

Key:new_york_times-new-article

View on GitHub

New York Times Overview#

The New York Times API offers a variety of endpoints to access different types of news and information. With Pipedream, you can tap into this wealth of data to automate tasks, enrich applications with the latest news, or even analyze trends. Workflows on Pipedream triggered by NYT's API can range from sending daily news briefings to your communication platform, to analyzing article metadata for SEO research, or even keeping track of the most popular stories for content curation.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import app from "../../new_york_times.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "new_york_times-new-article",
  name: "New Article Published",
  description: "Emit new event when an article is published.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    facet: {
      type: "boolean",
      label: "Facet",
      description: "Whether to show facet counts.",
      optional: true,
    },
    facetFields: {
      type: "string[]",
      label: "Facet Fields",
      description: "Use facets to view the relative importance of certain fields to a search term, and gain insight about how to best refine your queries and filter your search results.",
      options: [
        "day_of_week",
        "document_type",
        "ingredients",
        "news_desk",
        "pub_month",
        "pub_year",
        "section_name",
        "source",
        "subsection_name",
        "type_of_material",
      ],
      optional: true,
    },
    facetFilter: {
      type: "boolean",
      label: "Facet Filter",
      description: "Have facet counts use filters.",
      optional: true,
    },
    fl: {
      type: "string[]",
      label: "Field List",
      description: "The list of fields to return in the result set.",
      optional: true,
    },
    fq: {
      type: "string",
      label: "Filtered Query",
      description: "A query to filter the search results.",
      optional: true,
    },
    q: {
      type: "string",
      label: "Query",
      description: "Search query term. Search is performed on the article body, headline, and byline.",
      optional: true,
    },
    alert: {
      type: "alert",
      alertType: "info",
      content: "To learn more about filters you can download the [New York Times specification here](https://developer.nytimes.com/portals/api/sites/nyt-devportal/liveportal/apis/articlesearch-product/download_spec).",
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || moment().subtract(1, "day");
    },
    _setLastDate(created) {
      this.db.set("lastDate", created);
    },
    generateMeta(item) {
      return {
        id: item._id,
        summary: `A new article was just published with Id: ${item._id}.`,
        ts: item.pub_date,
      };
    },
    async startEvent(maxResults = 0) {
      const lastDate = this._getLastDate();

      const data = this.app.paginate({
        fn: this.app.searchArticles,
        maxResults,
        params: {
          begin_date: moment(lastDate).format("YYYYMMDD"),
          facet: this.facet,
          facet_fields: this.facetFields && this.facetFields.join(),
          facet_filter: this.facetFilter,
          fl: this.fl && this.fl.join(),
          fq: this.fq,
          q: this.q,
          sort: "newest",
        },
      });

      const responseArray = [];
      for await (const item of data) {
        if (Date.parse(item.pub_date) <= Date.parse(lastDate)) break;
        responseArray.push(item);
      }

      if (responseArray.length) this._setLastDate(responseArray[0].pub_date);

      for (const item of responseArray.reverse()) {
        this.$emit(item, this.generateMeta(item));
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  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
New York Times	`app`	`app`	This component uses the New York Times app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Facet	`facet`	`boolean`	Whether to show facet counts.
Facet Fields	`facetFields`	`string[]`	Select a value from the drop down menu:`day_of_weekdocument_typeingredientsnews_deskpub_monthpub_yearsection_namesourcesubsection_nametype_of_material`
Facet Filter	`facetFilter`	`boolean`	Have facet counts use filters.
Field List	`fl`	`string[]`	The list of fields to return in the result set.
Filtered Query	`fq`	`string`	A query to filter the search results.
Query	`q`	`string`	Search query term. Search is performed on the article body, headline, and byline.

Trigger Authentication#

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

About New York Times#

The New York Times is an American daily newspaper which features top articles across many sections, including politics, technology, and opinion.

Action#

[Date/Time] Compare Dates on Formatting

Description:Get the duration between two dates in days, hours, minutes, and seconds along with checking if they are the same.

Version:0.0.5

Key:formatting-compare-dates

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import commonDateTime from "../../common/date-time/commonDateTime.mjs";
import app from "../../app/formatting.app.mjs";
import { DATE_TIME_UNITS } from "../../common/date-time/dateTimeUnits.mjs";
export default defineAction({
    ...commonDateTime,
    name: "[Date/Time] Compare Dates",
    description: "Get the duration between two dates in days, hours, minutes, and seconds along with checking if they are the same.",
    key: "formatting-compare-dates",
    version: "0.0.5",
    type: "action",
    props: {
        ...commonDateTime.props,
        inputDate: {
            propDefinition: [
                app,
                "inputDate",
            ],
            label: "Start Date",
            description: "Enter start date string, in the format defined in `Input Format`. If the start date is after the end date, these dates will be swapped and in the output `datesSwapped` will be set to `true`.",
        },
        endDate: {
            propDefinition: [
                app,
                "inputDate",
            ],
            label: "End Date",
            description: "Enter end date string, in the format defined in `Input Format`. Timezone is assumed the same for both dates if not explicitly set.",
        },
    },
    async run({ $ }) {
        const startDateObj = this.getDateFromInput(this.inputDate);
        const endDateObj = this.getDateFromInput(this.endDate);
        const startValue = startDateObj.valueOf();
        const endValue = endDateObj.valueOf();
        const datesSwapped = startValue > endValue;
        let result = "equal";
        let remainingValue = Math.abs(endValue - startValue);
        if (remainingValue) {
            const arrResults = [];
            const arrUnits = Object.entries(DATE_TIME_UNITS).sort((a, b) => b[1] - a[1]);
            for (const [word, unit,] of arrUnits) {
                const amount = Math.floor(remainingValue / unit);
                if (amount) {
                    arrResults.push(`${amount} ${amount === 1
                        ? word
                        : `${word}s`}`);
                    remainingValue %= unit;
                    if (!remainingValue)
                        break;
                }
            }
            result = arrResults.join(", ");
        }
        $.export("$summary", "Successfully compared dates");
        return {
            datesSwapped,
            result,
        };
    },
});

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
Formatting	`app`	`app`	This component uses the Formatting app.
Start Date	`inputDate`	`string`	Enter start date string, in the format defined in `Input Format`. If the start date is after the end date, these dates will be swapped and in the output `datesSwapped` will be set to `true`.
Input Format	`inputFormat`	`string`	Select a value from the drop down menu:`Sun Jan 22 23:04:05 +0000 2006January 22 2006 23:04:05January 22 2006Jan 22 20062006-01-22T23:04:052006-01-22T23:04:05+00002006-01-22 23:04:05 +00002006-01-22 23:042006-01-2201-22-200601/22/200601/22/0622-01-200622/01/200622/01/06Unix time (seconds) Eg. 1137971045Unix time (milliseconds) Eg. 1137971045000`
End Date	`endDate`	`string`	Enter end date string, in the format defined in `Input Format`. Timezone is assumed the same for both dates if not explicitly set.