import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import googlePostmasterToolsApi from "../../google_postmaster_tools_api.app.mjs";
import sampleEmit from "./test-event.mjs";
export default {
key: "google_postmaster_tools_api-new-matched-traffic-stats",
name: "New Matched Traffic Stats",
description:
"Emits a new event when traffic stats match certain criteria. [See the documentation](https://developers.google.com/gmail/postmaster/reference/rest)",
version: "0.1.0",
type: "source",
dedupe: "unique",
sampleEmit,
props: {
googlePostmasterToolsApi,
db: "$.service.db",
timer: {
type: "$.interface.timer",
default: {
intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
},
},
domain: {
propDefinition: [
googlePostmasterToolsApi,
"domain",
],
},
filterInfo: {
type: "alert",
alertType: "info",
content: "By default, events will be emitted when matching **any** of the configured filters. If you want **all** configured filters to be required instead, you can use the `Match All Filters` prop below.",
},
matchAllFilters: {
propDefinition: [
googlePostmasterToolsApi,
"matchAllFilters",
],
},
ipReputation: {
propDefinition: [
googlePostmasterToolsApi,
"ipReputation",
],
},
domainReputation: {
propDefinition: [
googlePostmasterToolsApi,
"domainReputation",
],
},
userReportedSpamRatio: {
propDefinition: [
googlePostmasterToolsApi,
"userReportedSpamRatio",
],
},
spfSuccessRatio: {
propDefinition: [
googlePostmasterToolsApi,
"spfSuccessRatio",
],
},
dkimSuccessRatio: {
propDefinition: [
googlePostmasterToolsApi,
"dkimSuccessRatio",
],
},
dmarcSuccessRatio: {
propDefinition: [
googlePostmasterToolsApi,
"dmarcSuccessRatio",
],
},
outboundEncryptionRatio: {
propDefinition: [
googlePostmasterToolsApi,
"outboundEncryptionRatio",
],
},
inboundEncryptionRatio: {
propDefinition: [
googlePostmasterToolsApi,
"inboundEncryptionRatio",
],
},
errorRatio: {
propDefinition: [
googlePostmasterToolsApi,
"errorRatio",
],
},
errorCategories: {
propDefinition: [
googlePostmasterToolsApi,
"errorCategories",
],
},
},
methods: {
_getSavedItems() {
return this.db.get("savedItems") ?? [];
},
_setSavedItems(value) {
this.db.set("savedItems", value);
},
getDateValues(date) {
const [
year,
month,
day,
] = date.toISOString().split("T")[0].split("-").map((i) => Number(i));
return {
year,
month,
day,
};
},
async getTrafficStats() {
const today = new Date();
const oneDayAgo = new Date(today);
oneDayAgo.setDate(oneDayAgo.getDate() - 7);
const endDate = this.getDateValues(today);
const startDate = this.getDateValues(oneDayAgo);
return this.googlePostmasterToolsApi.getDomainTrafficStats({
domainName: this.domain,
params: {
"startDate.day": startDate.day,
"startDate.month": startDate.month,
"startDate.year": startDate.year,
"endDate.day": endDate.day,
"endDate.month": endDate.month,
"endDate.year": endDate.year,
},
});
},
filterIpReputation(item) {
let { ipReputation } = this;
if (typeof ipReputation === "string")
ipReputation = ipReputation.split(",");
if (!ipReputation?.length) return undefined;
return item.ipReputations.some(
({
reputation, ipCount,
}) =>
ipReputation.includes(reputation) && ipCount > 0,
);
},
filterDomainReputation(item) {
let { domainReputation } = this;
if (typeof domainReputation === "string")
domainReputation = domainReputation.split(",");
if (!domainReputation?.length) return undefined;
return domainReputation.includes(item.domainReputation);
},
filterRatio(prop, value, greaterOrEqual = false) {
if (prop?.endsWith("%")) prop = Number(prop.slice(0, -1)) / 100;
const ratio = Number(prop);
if (isNaN(ratio) || value === undefined) return undefined;
return greaterOrEqual
? value >= ratio
: value < ratio;
},
filterSpamRatio(item) {
return this.filterRatio(
this.userReportedSpamRatio,
item.userReportedSpamRatio,
true,
);
},
filterSpfSuccessRatio(item) {
return this.filterRatio(this.spfSuccessRatio, item.spfSuccessRatio);
},
filterDkimSuccessRatio(item) {
return this.filterRatio(this.dkimSuccessRatio, item.dkimSuccessRatio);
},
filterDmarcSuccessRatio(item) {
return this.filterRatio(this.dmarcSuccessRatio, item.dmarcSuccessRatio);
},
filterOutboundEncryptionRatio(item) {
return this.filterRatio(
this.outboundEncryptionRatio,
item.outboundEncryptionRatio,
);
},
filterInboundEncryptionRatio(item) {
return this.filterRatio(
this.inboundEncryptionRatio,
item.inboundEncryptionRatio,
);
},
filterErrorRatio(item) {
const ratio = Number(this.errorRatio);
if (isNaN(ratio)) return undefined;
let { errorCategories } = this;
if (typeof errorCategories === "string")
errorCategories = errorCategories.split(",");
return item.deliveryErrors.some(
({
errorType, errorRatio,
}) =>
(!errorCategories || errorCategories.includes(errorType)) && errorRatio > ratio,
);
},
matchesCriteria(item) {
const filters = [
this.filterIpReputation,
this.filterDomainReputation,
this.filterSpamRatio,
this.filterSpfSuccessRatio,
this.filterDkimSuccessRatio,
this.filterDmarcSuccessRatio,
this.filterOutboundEncryptionRatio,
this.filterInboundEncryptionRatio,
this.filterErrorRatio,
];
let hasMatch = false;
for (let filter of filters) {
const result = filter(item);
if (result === true) {
if (!this.matchAllFilters) return true;
hasMatch = true;
} else if (result === false && this.matchAllFilters) {
return false;
}
}
return hasMatch;
},
},
async run() {
const savedItems = this._getSavedItems();
const ts = Date.now();
const stats = await this.getTrafficStats();
stats?.trafficStats?.filter(({ name }) => !savedItems.includes(name)).forEach((item) => {
const id = item.name;
if (this.matchesCriteria(item)) {
this.$emit(item, {
id,
summary: `Matched Traffic Stats: ${id}`,
ts,
});
savedItems.push(id);
}
});
this._setSavedItems(savedItems);
},
};
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.
