@pipedream/unirateapi 0.0.1 → 0.2.0

package/actions/convert-currency/convert-currency.mjs

@@ -0,0 +1,57 @@
+import app from "../../unirateapi.app.mjs";
+
+export default {
+  key: "unirateapi-convert-currency",
+  name: "Convert Currency",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  description: "Convert an amount from one currency to another at the latest rate. [See the documentation](https://unirateapi.com/docs).",
+  type: "action",
+  props: {
+    app,
+    from: {
+      propDefinition: [
+        app,
+        "currencyCode",
+      ],
+      label: "From",
+      description: "The source currency code.",
+    },
+    to: {
+      propDefinition: [
+        app,
+        "currencyCode",
+      ],
+      label: "To",
+      description: "The target currency code.",
+    },
+    amount: {
+      type: "string",
+      label: "Amount",
+      description: "The amount to convert.",
+      default: "1",
+    },
+  },
+  async run({ $ }) {
+    const {
+      app, from, to, amount,
+    } = this;
+
+    const response = await app.convert({
+      $,
+      from,
+      to,
+      amount,
+    });
+
+    $.export(
+      "$summary",
+      `Converted ${amount} ${from} → ${response?.result ?? "?"} ${to}`,
+    );
+    return response;
+  },
+};

package/actions/get-exchange-rates/get-exchange-rates.mjs

@@ -0,0 +1,58 @@
+import app from "../../unirateapi.app.mjs";
+
+export default {
+  key: "unirateapi-get-exchange-rates",
+  name: "Get Exchange Rates",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  description: "Get the latest exchange rate(s) for a base currency. Returns a single rate when a target is provided, or all rates keyed by currency code when omitted. [See the documentation](https://unirateapi.com/docs).",
+  type: "action",
+  props: {
+    app,
+    from: {
+      propDefinition: [
+        app,
+        "currencyCode",
+      ],
+      label: "From",
+      description: "The base currency code. Defaults to `USD`.",
+      optional: true,
+    },
+    to: {
+      propDefinition: [
+        app,
+        "currencyCode",
+      ],
+      label: "To",
+      description: "Optional target currency code. If omitted, all rates for the base currency are returned.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      app, from, to,
+    } = this;
+
+    const response = await app.getRates({
+      $,
+      from,
+      to,
+    });
+
+    const base = from || "USD";
+    const rateCount = response?.rates
+      ? Object.keys(response.rates).length
+      : 0;
+    $.export(
+      "$summary",
+      to
+        ? `Fetched ${base}→${to} rate: ${response?.rate ?? "?"}`
+        : `Fetched ${rateCount} rate(s) for ${base}`,
+    );
+    return response;
+  },
+};

package/actions/list-currency-code-options/list-currency-code-options.mjs

@@ -0,0 +1,24 @@
+import unirateapi from "../../unirateapi.app.mjs";
+
+export default {
+  key: "unirateapi-list-currency-code-options",
+  name: "List Currency Code Options",
+  description: "Retrieves available options for the Currency Code field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    unirateapi,
+  },
+  async run({ $ }) {
+    const options = await unirateapi.propDefinitions.currencyCode.options.call(this.unirateapi);
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/unirateapi",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream UniRateAPI Components",
   "main": "unirateapi.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.4.0"
   }
 }

package/sources/new-rate-update/new-rate-update.mjs

@@ -0,0 +1,95 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import app from "../../unirateapi.app.mjs";
+
+export default {
+  key: "unirateapi-new-rate-update",
+  name: "New Rate Update",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  description: "Emit new event when the exchange rate between two currencies changes. [See the documentation](https://unirateapi.com/docs).",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    app,
+    db: "$.service.db",
+    timer: {
+      label: "Polling interval",
+      description: "Pipedream will poll UniRate on this schedule.",
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    from: {
+      propDefinition: [
+        app,
+        "currencyCode",
+      ],
+      label: "From",
+      description: "The base currency code.",
+    },
+    to: {
+      propDefinition: [
+        app,
+        "currencyCode",
+      ],
+      label: "To",
+      description: "The target currency code.",
+    },
+  },
+  methods: {
+    _getLastRate() {
+      return this.db.get("lastRate");
+    },
+    _setLastRate(rate) {
+      this.db.set("lastRate", rate);
+    },
+  },
+  async run({ $ }) {
+    const {
+      app, from, to,
+    } = this;
+
+    const response = await app.getRates({
+      $,
+      from,
+      to,
+    });
+
+    const rate = response?.rate;
+    if (rate === undefined) {
+      return;
+    }
+
+    const lastRate = this._getLastRate();
+    if (lastRate === rate) {
+      return;
+    }
+
+    if (lastRate === undefined) {
+      this._setLastRate(rate);
+      return;
+    }
+
+    const ts = Date.now();
+    this.$emit(
+      {
+        from,
+        to,
+        rate,
+        previousRate: lastRate,
+        ts,
+      },
+      {
+        id: `${from}-${to}-${rate}`,
+        summary: `${from}→${to}: ${lastRate} → ${rate}`,
+        ts,
+      },
+    );
+    this._setLastRate(rate);
+  },
+};

package/unirateapi.app.mjs

@@ -1,11 +1,77 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "unirateapi",
-  propDefinitions: {},
+  propDefinitions: {
+    currencyCode: {
+      type: "string",
+      label: "Currency Code",
+      description: "An ISO 4217 currency code (e.g. `USD`, `EUR`, `GBP`).",
+      async options() {
+        const { currencies = [] } = await this.listCurrencies();
+        return currencies.map((value) => ({
+          label: value,
+          value,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _apiUrl() {
+      return "https://api.unirateapi.com/api";
+    },
+    _getParams(params) {
+      return {
+        api_key: this.$auth.api_key,
+        ...params,
+      };
+    },
+    async _makeRequest({
+      $ = this, path, params = {}, headers = {}, ...opts
+    }) {
+      return axios($, {
+        url: `${this._apiUrl()}/${path}`,
+        params: this._getParams(params),
+        ...opts,
+        headers: {
+          Accept: "application/json",
+          ...headers,
+        },
+      });
+    },
+    listCurrencies(args = {}) {
+      return this._makeRequest({
+        path: "currencies",
+        ...args,
+      });
+    },
+    getRates({
+      from, to, ...args
+    } = {}) {
+      return this._makeRequest({
+        path: "rates",
+        params: {
+          from,
+          ...(to && {
+            to,
+          }),
+        },
+        ...args,
+      });
+    },
+    convert({
+      from, to, amount, ...args
+    }) {
+      return this._makeRequest({
+        path: "convert",
+        params: {
+          from,
+          to,
+          amount,
+        },
+        ...args,
+      });
     },
   },
-};
+};