@pipedream/recreation_gov 0.0.1 → 0.0.2

package/actions/get-recreation-area/get-recreation-area.mjs

@@ -0,0 +1,29 @@
+import app from "../../recreation_gov.app.mjs";
+
+export default {
+  key: "recreation_gov-get-recreation-area",
+  version: "0.0.1",
+  type: "action",
+  name: "Get Recreation Area",
+  description: "Retrieves details of a specific campsite. [See the documentation](https://ridb.recreation.gov/docs#/Campsites/getCampsites)",
+  props: {
+    app,
+    recAreaId: {
+      propDefinition: [
+        app,
+        "recAreaId",
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const resp = this.app.getRecArea({
+      $,
+      recAreaId: this.recAreaId,
+      params: {
+        full: "true",
+      },
+    });
+    $.export("$summary", `Recreation Area - ${resp.RecAreaName} has been retrieved.`);
+    return resp;
+  },
+};

package/actions/search-campsites/search-campsites.mjs

@@ -0,0 +1,46 @@
+import app from "../../recreation_gov.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "recreation_gov-search-campsites",
+  version: "0.0.1",
+  type: "action",
+  name: "Search Campsites",
+  description: "Searchs campsites with the given query. If no query given, returns campsites from the beginning. Returning campsite number is limited to `1000`. [See the documentation](https://ridb.recreation.gov/docs#/Campsites/getCampsites)",
+  props: {
+    app,
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Query filter criteria. Searches on campsite name, type, loop, type of use (Overnight/Day), campsite accessible (Yes/No)",
+      optional: true,
+    },
+    offset: {
+      type: "integer",
+      label: "Offset",
+      description: "Used when all results could not be retrieved due to limit of `1000`. Set this offset to fetch next resources.",
+      optional: true,
+    },
+  },
+  async run ({ $ }) {
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getCampsites,
+      resourceKey: "RECDATA",
+      resourceLimit: 1000,
+      offset: this.offset,
+      resourceFnArgs: {
+        $,
+        params: {
+          query: this.query,
+        },
+      },
+    });
+    const items = [];
+    for await (const item of resourcesStream) {
+      items.push(item);
+    }
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${items.length} campsite${items.length == 1 ? "" : "s"} found.`);
+    return items;
+  },
+};

package/actions/search-recreation-areas/search-recreation-areas.mjs

@@ -0,0 +1,72 @@
+import app from "../../recreation_gov.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "recreation_gov-search-recreation-areas",
+  version: "0.0.1",
+  type: "action",
+  name: "Search Recreation Areas",
+  description: "Searchs recreation areas with the given properties. If no parameters given, returns all. [See the documentation](https://ridb.recreation.gov/docs#/Recreation%20Areas/getRecAreas)",
+  props: {
+    app,
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Query filter criteria. Searches on RecArea name, description, keywords, and stay limit",
+      optional: true,
+    },
+    states: {
+      propDefinition: [
+        app,
+        "states",
+      ],
+    },
+    activities: {
+      propDefinition: [
+        app,
+        "activities",
+      ],
+    },
+    latitude: {
+      type: "string",
+      label: "Latitude",
+      description: "Latitude of the point in decimal degrees",
+      optional: true,
+    },
+    longitude: {
+      type: "string",
+      label: "Longitude",
+      description: "Longitude of the point in decimal degrees",
+      optional: true,
+    },
+    radius: {
+      type: "string",
+      label: "Radius",
+      description: "Distance (in miles) by which to include search results",
+      optional: true,
+    },
+  },
+  async run ({ $ }) {
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getRecAreas,
+      resourceKey: "RECDATA",
+      resourceFnArgs: {
+        $,
+        params: {
+          query: this.query,
+          state: this.states?.join(","),
+          activity: this.activities?.join(","),
+          latitude: this.latitude,
+          longitude: this.longitude,
+          radius: this.radius,
+        },
+      },
+    });
+    const items = [];
+    for await (const item of resourcesStream)
+      items.push(item);
+      // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `${items.length} recreation area${items.length == 1 ? "" : "s"} found.`);
+    return items;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,230 @@
+const states = [
+  {
+    "label": "ALABAMA",
+    "value": "AL",
+  },
+  {
+    "label": "ALASKA",
+    "value": "AK",
+  },
+  {
+    "label": "AMERICAN SAMOA",
+    "value": "AS",
+  },
+  {
+    "label": "ARIZONA",
+    "value": "AZ",
+  },
+  {
+    "label": "ARKANSAS",
+    "value": "AR",
+  },
+  {
+    "label": "CALIFORNIA",
+    "value": "CA",
+  },
+  {
+    "label": "COLORADO",
+    "value": "CO",
+  },
+  {
+    "label": "CONNECTICUT",
+    "value": "CT",
+  },
+  {
+    "label": "DELAWARE",
+    "value": "DE",
+  },
+  {
+    "label": "DISTRICT OF COLUMBIA",
+    "value": "DC",
+  },
+  {
+    "label": "FLORIDA",
+    "value": "FL",
+  },
+  {
+    "label": "GEORGIA",
+    "value": "GA",
+  },
+  {
+    "label": "GUAM",
+    "value": "GU",
+  },
+  {
+    "label": "HAWAII",
+    "value": "HI",
+  },
+  {
+    "label": "IDAHO",
+    "value": "ID",
+  },
+  {
+    "label": "ILLINOIS",
+    "value": "IL",
+  },
+  {
+    "label": "INDIANA",
+    "value": "IN",
+  },
+  {
+    "label": "IOWA",
+    "value": "IA",
+  },
+  {
+    "label": "KANSAS",
+    "value": "KS",
+  },
+  {
+    "label": "KENTUCKY",
+    "value": "KY",
+  },
+  {
+    "label": "LOUISIANA",
+    "value": "LA",
+  },
+  {
+    "label": "MAINE",
+    "value": "ME",
+  },
+  {
+    "label": "MARYLAND",
+    "value": "MD",
+  },
+  {
+    "label": "MASSACHUSETTS",
+    "value": "MA",
+  },
+  {
+    "label": "MICHIGAN",
+    "value": "MI",
+  },
+  {
+    "label": "MINNESOTA",
+    "value": "MN",
+  },
+  {
+    "label": "MISSISSIPPI",
+    "value": "MS",
+  },
+  {
+    "label": "MISSOURI",
+    "value": "MO",
+  },
+  {
+    "label": "MONTANA",
+    "value": "MT",
+  },
+  {
+    "label": "NEBRASKA",
+    "value": "NE",
+  },
+  {
+    "label": "NEVADA",
+    "value": "NV",
+  },
+  {
+    "label": "NEW HAMPSHIRE",
+    "value": "NH",
+  },
+  {
+    "label": "NEW JERSEY",
+    "value": "NJ",
+  },
+  {
+    "label": "NEW MEXICO",
+    "value": "NM",
+  },
+  {
+    "label": "NEW YORK",
+    "value": "NY",
+  },
+  {
+    "label": "NORTH CAROLINA",
+    "value": "NC",
+  },
+  {
+    "label": "NORTH DAKOTA",
+    "value": "ND",
+  },
+  {
+    "label": "NORTHERN MARIANA IS",
+    "value": "MP",
+  },
+  {
+    "label": "OHIO",
+    "value": "OH",
+  },
+  {
+    "label": "OKLAHOMA",
+    "value": "OK",
+  },
+  {
+    "label": "OREGON",
+    "value": "OR",
+  },
+  {
+    "label": "PENNSYLVANIA",
+    "value": "PA",
+  },
+  {
+    "label": "PUERTO RICO",
+    "value": "PR",
+  },
+  {
+    "label": "RHODE ISLAND",
+    "value": "RI",
+  },
+  {
+    "label": "SOUTH CAROLINA",
+    "value": "SC",
+  },
+  {
+    "label": "SOUTH DAKOTA",
+    "value": "SD",
+  },
+  {
+    "label": "TENNESSEE",
+    "value": "TN",
+  },
+  {
+    "label": "TEXAS",
+    "value": "TX",
+  },
+  {
+    "label": "UTAH",
+    "value": "UT",
+  },
+  {
+    "label": "VERMONT",
+    "value": "VT",
+  },
+  {
+    "label": "VIRGINIA",
+    "value": "VA",
+  },
+  {
+    "label": "VIRGIN ISLANDS",
+    "value": "VI",
+  },
+  {
+    "label": "WASHINGTON",
+    "value": "WA",
+  },
+  {
+    "label": "WEST VIRGINIA",
+    "value": "WV",
+  },
+  {
+    "label": "WISCONSIN",
+    "value": "WI",
+  },
+  {
+    "label": "WYOMING",
+    "value": "WY",
+  },
+];
+
+export {
+  states,
+};

package/common/utils.mjs

@@ -0,0 +1,67 @@
+const PAGE_SIZE = 50;
+
+export default {
+  async asyncPropHandler({
+    resourceFn, resourceKey, page, labelVal, params,
+  } = {}) {
+    let resp = await resourceFn({
+      ...params,
+      params: {
+        ...params?.params,
+        ...(typeof page != "undefined" && {
+          offset: page * PAGE_SIZE,
+          limit: PAGE_SIZE,
+        }),
+      },
+    });
+    const items = resourceKey.split(".").reduce((acc, curr) => acc?.[curr], resp);
+    const label = labelVal?.label ?? "name";
+    const value = labelVal?.value ?? "id";
+    const options = items.map((item) => ({
+      label: typeof label == "string" ?
+        label.split(".").reduce((acc, curr) => acc?.[curr], item) :
+        label(item),
+      value: typeof value == "string" ?
+        value.split(".").reduce((acc, curr) => acc?.[curr], item) :
+        value(item),
+    }));
+    return typeof page != "undefined"
+      ? {
+        options,
+        context: {
+          page: page + 1,
+        },
+      } :
+      options;
+  },
+  async *getResourcesStream({
+    resourceFn, resourceFnArgs, resourceLimit, resourceKey, offset,
+  }) {
+    let page = 0, resourceCount = 0, startOffset = offset ?? 0;
+    while (true) {
+      const nextResources = await resourceFn({
+        ...resourceFnArgs,
+        params: {
+          ...resourceFnArgs?.params,
+          limit: PAGE_SIZE,
+          offset: startOffset + PAGE_SIZE * page++,
+        },
+      });
+      const resources = resourceKey
+        ? resourceKey.split(".").reduce((acc, curr) => acc?.[curr], nextResources)
+        : nextResources;
+      if (!resources?.length)
+        return;
+      for (const resource of resources) {
+        if (resourceLimit && resourceLimit < ++resourceCount) {
+          return;
+        } else {
+          yield resource;
+        }
+      }
+      if (resources?.length < PAGE_SIZE) {
+        return;
+      }
+    }
+  },
+};

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@pipedream/recreation_gov",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Pipedream Recreation.gov Components",
   "main": "dist/app/recreation_gov.app.mjs",
   "keywords": [
     "pipedream",
     "recreation_gov"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/recreation_gov",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "license": "MIT",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.5.1"
   }
 }

package/recreation_gov.app.mjs

@@ -0,0 +1,130 @@
+import { axios } from "@pipedream/platform";
+import utils from "./common/utils.mjs";
+import { states } from "./common/constants.mjs";
+
+export default {
+  type: "app",
+  app: "recreation_gov",
+  propDefinitions: {
+    recAreaId: {
+      type: "string",
+      label: "Recreation Area Id",
+      description: "Recreation Area Id",
+      async options({ page }) {
+        return utils.asyncPropHandler({
+          resourceFn: this.getRecAreas,
+          page,
+          resourceKey: "RECDATA",
+          labelVal: {
+            label: "RecAreaName",
+            value: "RecAreaID",
+          },
+        });
+      },
+    },
+    campsiteId: {
+      type: "string",
+      label: "Campsite Id",
+      description: "Campsite Id",
+      async options({ page }) {
+        return utils.asyncPropHandler({
+          resourceFn: this.getCampsites,
+          page,
+          resourceKey: "RECDATA",
+          labelVal: {
+            label: "CampsiteName",
+            value: "CampsiteID",
+          },
+        });
+      },
+    },
+    activities: {
+      type: "integer[]",
+      label: "Activities",
+      description: "Activity Ids",
+      optional: true,
+      async options({ page }) {
+        return utils.asyncPropHandler({
+          resourceFn: this.getActivities,
+          page,
+          resourceKey: "RECDATA",
+          labelVal: {
+            label: "ActivityName",
+            value: "ActivityID",
+          },
+        });
+      },
+    },
+    states: {
+      type: "string[]",
+      label: "States",
+      description: "Two-letter state abbreviations",
+      optional: true,
+      options: states,
+    },
+  },
+  methods: {
+    _getUrl(path) {
+      return `https://ridb.recreation.gov/api/v1${path}`;
+    },
+    _getHeaders(headers = {}) {
+      return {
+        "Content-Type": "application/json",
+        "Accept": "application/json",
+        "User-Agent": "@PipedreamHQ/pipedream v0.1",
+        ...headers,
+      };
+    },
+    async _makeRequest({
+      $, path, params, headers, ...otherConfig
+    } = {}) {
+      const config = {
+        url: this._getUrl(path),
+        headers: this._getHeaders(headers),
+        params: {
+          apikey: this.$auth.api_key,
+          ...params,
+        },
+        ...otherConfig,
+      };
+      console.log("axios config", config);
+      return axios($ ?? this, config);
+    },
+    async getCampsites(args = {}) {
+      return this._makeRequest({
+        path: "/campsites",
+        ...args,
+      });
+    },
+    async getCampsite({
+      campsiteId,
+      ...args
+    } = {}) {
+      return this._makeRequest({
+        path: `/campsites/${campsiteId}`,
+        ...args,
+      });
+    },
+    async getRecAreas(args = {}) {
+      return this._makeRequest({
+        path: "/recareas",
+        ...args,
+      });
+    },
+    async getRecArea({
+      recAreaId,
+      ...args
+    } = {}) {
+      return this._makeRequest({
+        path: `/recareas/${recAreaId}`,
+        ...args,
+      });
+    },
+    async getActivities(args = {}) {
+      return this._makeRequest({
+        path: "/activities",
+        ...args,
+      });
+    },
+  },
+};

package/sources/campsite-availability-changed/campsite-availability-changed.mjs

@@ -0,0 +1,46 @@
+import common from "../common/attribute-based.mjs";
+
+export default {
+  ...common,
+  key: "recreation_gov-campsite-availability-changed",
+  name: "New Campsite Availability Changed Event",
+  description: "Emit new events when selected campsite's availability is changed. [See the documentation](https://ridb.recreation.gov/docs#/Campsites/getCampsite)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    campsiteId: {
+      propDefinition: [
+        common.props.app,
+        "campsiteId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceFnConfig() {
+      return {
+        resourceFn: this.app.getCampsite,
+        resourceKey: "RECDATA",
+        params: {
+          campsiteId: this.campsiteId,
+        },
+      };
+    },
+    getMeta(item) {
+      return {
+        ts: new Date().getTime(),
+        id: new Date().getTime(),
+        // eslint-disable-next-line multiline-ternary
+        summary: `Campsite(${item.CampsiteName}) availability was changed to ${item.CampsiteAccessible ? "available" : "not available"}`,
+      };
+    },
+    compareFn(item) {
+      return item.CampsiteAccessible !== this.getAttribute();
+    },
+    getAttributeKey() {
+      return "CampsiteAccessible";
+    },
+  },
+};

package/sources/common/attribute-based.mjs

@@ -0,0 +1,29 @@
+import base from "./base.mjs";
+
+export default {
+  ...base,
+  methods: {
+    ...base.methods,
+    setAttribute(attribute) {
+      this.db.set("attribute", attribute);
+    },
+    getAttribute() {
+      return this.db.get("attribute");
+    },
+    getAttributeKey() {
+      throw new Error("getAttributeKey() is not implemented!");
+    },
+    compareFn() {
+      throw new Error("compareFn() is not implemented!");
+    },
+  },
+  async run() {
+    const item = await this.getResourceFnConfig().resourceFn({
+      ...this.getResourceFnConfig().params,
+    });
+    if (this.compareFn(item[0])) { //the API always returns an array with a single element
+      this.$emit(item[0], this.getMeta(item[0]));
+      this.setAttribute(item[0][this.getAttributeKey()]);
+    }
+  },
+};

package/sources/common/base.mjs

@@ -0,0 +1,23 @@
+import app from "../../recreation_gov.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  props: {
+    app,
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    db: "$.service.db",
+  },
+  methods: {
+    getResourceFnConfig() {
+      throw new Error("getResourceFnConfig() is not implemented!");
+    },
+    getMeta() {
+      throw new Error("getMeta() is not implemented!");
+    },
+  },
+};

package/sources/common/count-based.mjs

@@ -0,0 +1,42 @@
+import base from "./base.mjs";
+import utils from "../../common/utils.mjs";
+
+const EVENT_COUNT = 25; // Historical event count
+
+export default {
+  ...base,
+  methods: {
+    ...base.methods,
+    setCount(count) {
+      this.db.set("count", count);
+    },
+    getCount() {
+      return this.db.get("count") || 0;
+    },
+    getItem(item) {
+      return item;
+    },
+  },
+  hooks: {
+    async deploy() {
+      const config = this.getResourceFnConfig();
+      const firstResponse = await config.resourceFn(config.resourceFnArgs);
+      const recordCount = firstResponse?.METADATA?.RESULTS?.TOTAL_COUNT;
+      // eslint-disable-next-line multiline-ternary
+      this.setCount(recordCount > EVENT_COUNT ? recordCount - EVENT_COUNT : 0);
+    },
+  },
+  async run() {
+    let offset = this.getCount();
+    const resourcesStream = utils.getResourcesStream({
+      ...this.getResourceFnConfig(),
+      offset,
+    });
+    for await (const resource of resourcesStream) {
+      const item = await this.getItem(resource);
+      this.$emit(item, this.getMeta(item));
+      offset++;
+    }
+    this.setCount(offset);
+  },
+};

package/sources/new-recreation-area-added/new-recreation-area-added.mjs

@@ -0,0 +1,32 @@
+import common from "../common/count-based.mjs";
+
+export default {
+  ...common,
+  key: "recreation_gov-new-recreation-area-added",
+  name: "New Recreation Area Added Event",
+  description: "Emit new events when a new recreation area is added to the Recreation.gov database. [See the documentation](https://ridb.recreation.gov/docs#/Recreation%20Areas/getRecAreas)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFnConfig() {
+      return {
+        resourceFn: this.app.getRecAreas,
+        resourceKey: "RECDATA",
+      };
+    },
+    getMeta(item) {
+      return {
+        ts: new Date().getTime(),
+        id: parseInt(item.RecAreaID),
+        summary: `New recreation area(${item.RecAreaName}) was added to RDIB`,
+      };
+    },
+    async getItem(item) {
+      return this.app.getRecArea({
+        recAreaId: parseInt(item.RecAreaID),
+      });
+    },
+  },
+};