Get Current Weather Forecast by Location with OpenWeather API API on New Pub/Sub Messages from Google Cloud API

Pipedream makes it easy to connect APIs for OpenWeather API, Google Cloud and 2,400+ other apps remarkably fast.

Trigger workflow on

New Pub/Sub Messages from the Google Cloud API

Next, do this

Get Current Weather Forecast by Location with the OpenWeather API 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 Cloud trigger and OpenWeather API action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Pub/Sub Messages trigger
1. Connect your Google Cloud account
2. Select a Type
Configure the Get Current Weather Forecast by Location action
1. Connect your OpenWeather API account
2. Configure City
3. Optional- Configure State code
4. Optional- Configure Country Code
5. Optional- Configure Days Count
6. Optional- Select a Units of Measurement
7. Optional- Select a Language
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 Pub/Sub Messages on Google Cloud

Description:Emit new Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.

Version:0.1.6

Key:google_cloud-new-pubsub-messages

View on GitHub

Google Cloud Overview#

The Google Cloud API opens a world of possibilities for enhancing cloud operations and automating tasks. It empowers you to manage, scale, and fine-tune various services within the Google Cloud Platform (GCP) programmatically. With Pipedream, you can harness this power to create intricate workflows, trigger cloud functions based on events from other apps, manage resources, and analyze data, all in a serverless environment. The ability to interconnect GCP services with numerous other apps enriches automation, making it easier to synchronize data, streamline development workflows, and deploy applications efficiently.

Trigger Code#

import { PubSub } from "@google-cloud/pubsub";
import googleCloud from "../../google_cloud.app.mjs";

export default {
  key: "google_cloud-new-pubsub-messages",
  name: "New Pub/Sub Messages",
  description: "Emit new Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.",
  version: "0.1.6",
  type: "source",
  dedupe: "unique", // Dedupe on Pub/Sub message ID
  props: {
    googleCloud,
    http: "$.interface.http",
    db: "$.service.db",
    topicType: {
      type: "string",
      label: "Type",
      description: "Do you have an existing Pub/Sub topic, or would you like to create a new one?",
      options: [
        "existing",
        "new",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const topic = {
      type: "string",
      label: "Pub/Sub Topic Name",
      description: "Select a Pub/Sub topic from your GCP account to watch",
      options: async () => {
        return this.getTopics();
      },
    };
    if (this.topicType === "new") {
      topic.description = "**Pipedream will create a Pub/Sub topic with this name in your account**, converting it to a [valid Pub/Sub topic name](https://cloud.google.com/pubsub/docs/admin#resource_names).";
      delete topic.options;
    }
    return {
      topic,
    };
  },
  methods: {
    _getTopicName() {
      return this.db.get("topicName");
    },
    _setTopicName(topicName) {
      this.db.set("topicName", topicName);
    },
    _getSubscriptionName() {
      return this.db.get("subscriptionName");
    },
    _setSubscriptionName(subscriptionName) {
      this.db.set("subscriptionName", subscriptionName);
    },
    async getTopics() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);
      const topics = (await pubSubClient.getTopics())[0];
      if (topics.length > 0) {
        return topics.map((topic) => topic.name);
      }
      return [];
    },
    convertNameToValidPubSubTopicName(name) {
      // For valid names, see https://cloud.google.com/pubsub/docs/admin#resource_names
      return name
        // Must not start with `goog`. We add a `pd-` at the beginning if that's the case.
        .replace(/(^goog.*)/g, "pd-$1")
        // Must start with a letter, otherwise we add `pd-` at the beginning.
        .replace(/^(?![a-zA-Z]+)/, "pd-")
        // Only certain characters are allowed, the rest will be replaced with a `-`.
        .replace(/[^a-zA-Z0-9_\-.~+%]+/g, "-");
    },
  },
  hooks: {
    async activate() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const currentTopic = {
        name: this.topic,
      };
      if (this.topicType === "new") {
        const topicName = this.convertNameToValidPubSubTopicName(this.topic);
        console.log(`Creating Pub/Sub topic ${topicName}`);
        const [
          topic,
        ] = await pubSubClient.createTopic(topicName);
        currentTopic.name = topic.name;
      }
      this._setTopicName(currentTopic.name);

      const pushEndpoint = this.http.endpoint;
      const subscriptionName = this.convertNameToValidPubSubTopicName(pushEndpoint);
      const subscriptionOptions = {
        pushConfig: {
          pushEndpoint,
        },
      };
      console.log(
        `Subscribing this source's URL to the Pub/Sub topic: ${pushEndpoint}
        (under name ${subscriptionName}).`,
      );
      const [
        subscriptionResult,
      ] = await pubSubClient
        .topic(currentTopic.name)
        .createSubscription(subscriptionName, subscriptionOptions);
      this._setSubscriptionName(subscriptionResult.name);
    },
    async deactivate() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const subscriptionName = this._getSubscriptionName();
      if (subscriptionName) {
        await pubSubClient.subscription(subscriptionName).delete();
      }

      if (this.topicType === "new") {
        const topicName = this._getTopicName();
        if (topicName) {
          await pubSubClient.topic(topicName).delete();
        }
      }
    },
  },
  async run(event) {
    const {
      data,
      messageId,
      publishTime,
    } = event.body.message;

    if (!data) {
      console.warn("No message present, exiting");
      return;
    }
    const dataString = Buffer.from(data, "base64").toString("utf-8");
    const metadata = {
      id: messageId,
      summary: dataString,
      ts: +new Date(publishTime),
    };

    let dataObj;
    try {
      dataObj = JSON.parse(dataString);
    } catch (err) {
      console.error(
        `Couldn't parse message as JSON. Emitting raw message. Error: ${err}`,
      );
      dataObj = {
        rawMessage: dataString,
      };
    }
    this.$emit(dataObj, metadata);
  },
};

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 Cloud	`googleCloud`	`app`	This component uses the Google Cloud app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Type	`topicType`	`string`	Select a value from the drop down menu:`existingnew`

Trigger Authentication#

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

Create a service account in GCP and set the permissions you need for Pipedream workflows.
Generate a service account key
Download the key details in JSON format
Upload the key below.

About Google Cloud#

The Google Cloud Platform, including BigQuery

Action#

Get Current Weather Forecast by Location on OpenWeather API

Description:Retrieves 1-16 days weather forecast for a specified location. [See the docs here](https://openweathermap.org/forecast16#geo16). For more accurate reading, you are advised to fill in the country and/or state code

Version:0.0.1

Key:openweather_api-get-weather-forecast-by-location

View on GitHub

OpenWeather API Overview#

The OpenWeather API offers real-time weather data, forecasts, and historical information, enabling you to integrate weather conditions into your applications or workflows. With Pipedream, you can harness this data to automate tasks like sending weather updates, triggering actions based on specific weather conditions, or combining it with other data sources to inform decision-making processes.

Action Code#

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

export default {
  key: "openweather_api-get-weather-forecast-by-location",
  name: "Get Current Weather Forecast by Location",
  description: `Retrieves 1-16 days weather forecast for a specified location. 
  [See the docs here](https://openweathermap.org/forecast16#geo16). For more accurate reading, you are advised to fill in the country and/or state code`,
  version: "0.0.1",
  type: "action",
  props: {
    openweatherApi,
    city: {
      propDefinition: [
        openweatherApi,
        "city",
      ],
    },
    stateCode: {
      propDefinition: [
        openweatherApi,
        "stateCode",
      ],
    },
    countryCode: {
      propDefinition: [
        openweatherApi,
        "countryCode",
      ],
    },
    cnt: {
      type: "integer",
      label: "Days Count",
      description: "Number of days, which will be returned in the API response",
      min: 1,
      max: 16,
      default: 1,
      optional: true,
    },
    units: {
      type: "string",
      label: "Units of Measurement",
      description: "Standard, metric and imperial units are available. Standard units will be applied by default",
      options: [
        "standard",
        "metric",
        "imperial",
      ],
      optional: true,
    },
    lang: {
      propDefinition: [
        openweatherApi,
        "lang",
      ],
    },
  },
  async run({ $ }) {
    const appid = this.openweatherApi.$auth.api_key;
    const limit = 1;
    const {
      city,
      stateCode,
      countryCode,
      cnt,
      units,
      lang,
    } = this;
    let location;
    try {
      const qParam = [
        city,
        stateCode,
      ];
      countryCode && qParam.push(countryCode);
      location = await this.openweatherApi.getLocationCordinate({
        q: qParam.join(","),
        limit,
        appid,
      }, $);
      if (!location?.length) {
        throw new Error();
      }
      const locationDetail = location?.length &&
        Object
          .entries(location[0])
          .map((x) => (x.join("=")))
          .join();
      locationDetail && $.export("$summary", `Location retrieved: ${locationDetail}. Getting weather report...`);
    } catch (error) {
      throw new ConfigurationError("Error getting location coordinates");
    }

    const weatherForecast = await this.openweatherApi.getDailyWeatherForcast({
      lat: location[0].lat,
      lon: location[0].lon,
      appid,
      cnt,
      units,
      lang,
    }, $);
    weatherForecast && $.export("$summary", `${location[0].name},${location[0]?.state} weather forecast loaded.`);
    return weatherForecast;
  },
};

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
OpenWeather API	`openweatherApi`	`app`	This component uses the OpenWeather API app.
City	`city`	`string`	City location. For example "Houston" in the United States.
State code	`stateCode`	`string`	State code. For example "TX" for Texas.
Country Code	`countryCode`	`string`	The 2 or 3-letter country code, for example "US" for the United States.
Days Count	`cnt`	`integer`	Number of days, which will be returned in the API response
Units of Measurement	`units`	`string`	Select a value from the drop down menu:`standardmetricimperial`
Language	`lang`	`string`	Select a value from the drop down menu.

Action Authentication#

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