@foxtware/mineral 0.1.8 → 0.1.10

package/api/starshipit/starshipitTrackingGet.js

@@ -0,0 +1,69 @@
+// https://api-docs.starshipit.com/#05a846b9-0128-4dd3-80e4-e6008aef9b94
+
+const { objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { starshipitClient } = require('../starshipit/starshipit.utils');
+
+const trackingIdentifierValidator = (trackingIdentifier) => {
+  return objHasAny(trackingIdentifier, [
+    'trackingNumber',
+    'orderNumber',
+  ]);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['trackingIdentifier', trackingIdentifierValidator],
+]);
+
+const starshipitTrackingGet = async (
+  credsPayload,
+  trackingIdentifier,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    trackingIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const {
+    trackingNumber,
+    orderNumber,
+  } = trackingIdentifier;
+
+  const response = await starshipitClient.fetch({
+    requestPayload: {
+      url: '/track',
+      params: {
+        ...trackingNumber && { tracking_number: trackingNumber },
+        ...orderNumber && { order_number: orderNumber },
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  starshipitTrackingGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/starshipitTrackingGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "starshipit.wf" },
+    "trackingIdentifier": { "orderNumber": "7726760919112" }
+  }'
+*/

package/api/stripe/_example.js

@@ -0,0 +1,48 @@
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeClient } = require('../stripe/stripe.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['arg'],
+]);
+
+const FUNC = async (
+  credsPayload,
+  arg,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, arg });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await stripeClient.fetch({
+    requestPayload: {
+      url: '/things',
+      method: 'post',
+      body: { arg },
+    },
+    context: { credsPayload },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  FUNC,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/FUNC" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "arg": "1234"
+  }'
+*/

package/api/stripe/stripe.constants.js

@@ -0,0 +1,5 @@
+const BASE_URL = 'https://api.stripe.com/v1';
+
+module.exports = {
+  BASE_URL,
+};

package/api/stripe/stripe.utils.js

@@ -0,0 +1,42 @@
+const { BASE_URL } = require('../stripe/stripe.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const { API_KEY } = creds;
+
+  const body = requestPayload.body
+    ? new URLSearchParams(requestPayload.body).toString()
+    : undefined;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded',
+        Authorization: `Bearer ${ API_KEY }`,
+        ...requestPayload.headers,
+      },
+      ...(body && { body }),
+    },
+  };
+};
+
+const stripeClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
+});
+
+module.exports = {
+  stripeClient,
+};

package/api/stripe/stripeCardCharge.js

@@ -0,0 +1,98 @@
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeCardTokenCreate } = require('../stripe/stripeCardTokenCreate');
+const { stripeChargeCreate } = require('../stripe/stripeChargeCreate');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cardNumber'],
+  ['expiryMonth'],
+  ['expiryYear'],
+  ['cvc'],
+  ['amountCents'],
+  ['currency'],
+  ['description'],
+]);
+
+const stripeCardCharge = async (
+  credsPayload,
+  cardNumber,
+  expiryMonth,
+  expiryYear,
+  cvc,
+  amountCents,
+  currency,
+  description,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cardNumber,
+    expiryMonth,
+    expiryYear,
+    cvc,
+    amountCents,
+    currency,
+    description,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const cardTokenResponse = await stripeCardTokenCreate(
+    credsPayload,
+    cardNumber,
+    expiryMonth,
+    expiryYear,
+    cvc,
+  );
+
+  if (!cardTokenResponse?.ok) {
+    return cardTokenResponse;
+  }
+
+  const cardToken = cardTokenResponse?.data?.id;
+
+  if (!cardToken) {
+    return {
+      ok: false,
+      error: {
+        message: 'Failed to create card token',
+      },
+    };
+  }
+
+  const chargeResponse = await stripeChargeCreate(
+    credsPayload,
+    amountCents,
+    currency,
+    cardToken,
+    description,
+  );
+
+  return chargeResponse;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stripeCardCharge,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stripeCardCharge" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "cardNumber": "4242424242424242",
+    "expiryMonth": "01",
+    "expiryYear": "2026",
+    "cvc": "123",
+    "currency": "AUD",
+    "description": "Transaction helper",
+    "amountCents": "50"
+  }'
+*/

package/api/stripe/stripeCardTokenCreate.js

@@ -0,0 +1,70 @@
+// https://docs.stripe.com/api/tokens/create_card
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeClient } = require('../stripe/stripe.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['cardNumber'],
+  ['expiryMonth'],
+  ['expiryYear'],
+  ['cvc'],
+]);
+
+const stripeCardTokenCreate = async (
+  credsPayload,
+  cardNumber,
+  expiryMonth,
+  expiryYear,
+  cvc,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    cardNumber,
+    expiryMonth,
+    expiryYear,
+    cvc,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await stripeClient.fetch({
+    requestPayload: {
+      url: '/tokens',
+      method: 'post',
+      body: {
+        'card[number]': cardNumber,
+        'card[exp_month]': expiryMonth,
+        'card[exp_year]': expiryYear,
+        'card[cvc]': cvc,
+      },
+    },
+    context: { credsPayload },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stripeCardTokenCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stripeCardTokenCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "cardNumber": "4242424242424242",
+    "expiryMonth": "01",
+    "expiryYear": "2030",
+    "cvc": "123"
+  }'
+*/

package/api/stripe/stripeChargeCapture.js

@@ -0,0 +1,63 @@
+// https://docs.stripe.com/api/charges/capture
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeClient } = require('../stripe/stripe.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['chargeId'],
+]);
+
+const stripeChargeCapture = async (
+  credsPayload,
+  chargeId,
+  {
+    amountCents,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    chargeId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await stripeClient.fetch({
+    requestPayload: {
+      url: `/charges/${ chargeId }/capture`,
+      method: 'post',
+      ...(amountCents && {
+        body: {
+          amount: amountCents,
+        },
+      }),
+    },
+    context: { credsPayload },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stripeChargeCapture,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stripeChargeCapture" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "chargeId": "ch_123",
+    "options": {
+      "amountCents": "100"
+    }
+  }'
+*/

package/api/stripe/stripeChargeCreate.js

@@ -0,0 +1,70 @@
+// https://docs.stripe.com/api/charges/create
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeClient } = require('../stripe/stripe.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['amountCents'],
+  ['currency'],
+  ['source'],
+  ['description'],
+]);
+
+const stripeChargeCreate = async (
+  credsPayload,
+  amountCents,
+  currency,
+  source,
+  description,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    amountCents,
+    currency,
+    source,
+    description,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await stripeClient.fetch({
+    requestPayload: {
+      url: '/charges',
+      method: 'post',
+      body: {
+        amount: amountCents,
+        currency,
+        source,
+        description,
+      },
+    },
+    context: { credsPayload },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stripeChargeCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stripeChargeCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "amountCents": "100",
+    "currency": "AUD",
+    "source": "tok_visa",
+    "description": "small charge"
+  }'
+*/

package/api/stripe/stripeChargeGet.js

@@ -0,0 +1,51 @@
+// https://docs.stripe.com/api/charges/retrieve
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeClient } = require('../stripe/stripe.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['chargeId'],
+]);
+
+const stripeChargeGet = async (
+  credsPayload,
+  chargeId,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    chargeId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await stripeClient.fetch({
+    requestPayload: {
+      url: `/charges/${ chargeId }`,
+    },
+    context: { credsPayload },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stripeChargeGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stripeChargeGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "chargeId": "ch_123"
+  }'
+*/

package/api/stripe/stripeChargesGet.js

@@ -0,0 +1,52 @@
+// https://docs.stripe.com/api/charges/list
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeClient } = require('../stripe/stripe.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const stripeChargesGet = async (
+  credsPayload,
+  {
+    params,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await stripeClient.fetch({
+    requestPayload: {
+      url: '/charges',
+      params,
+    },
+    context: { credsPayload },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stripeChargesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stripeChargesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "options": {
+      "params": { "limit": 10 }
+    }
+  }'
+*/

package/api/stripe/stripeRefundCreate.js

@@ -0,0 +1,64 @@
+// https://docs.stripe.com/api/refunds/create
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeClient } = require('../stripe/stripe.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['chargeId'],
+]);
+
+const stripeRefundCreate = async (
+  credsPayload,
+  chargeId,
+  {
+    amountCents,
+    reason,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    chargeId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await stripeClient.fetch({
+    requestPayload: {
+      url: '/refunds',
+      method: 'post',
+      body: {
+        charge: chargeId,
+        ...amountCents && { amount: amountCents },
+        ...reason && { reason },
+      },
+    },
+    context: { credsPayload },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stripeRefundCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stripeRefundCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "chargeId": "ch_123",
+    "options": {
+      "amountCents": "100"
+    }
+  }'
+*/

package/api/stripe/stripeRefundGet.js

@@ -0,0 +1,51 @@
+// https://docs.stripe.com/api/refunds/retrieve
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stripeClient } = require('../stripe/stripe.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['refundId'],
+]);
+
+const stripeRefundGet = async (
+  credsPayload,
+  refundId,
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    refundId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await stripeClient.fetch({
+    requestPayload: {
+      url: `/refunds/${ refundId }`,
+    },
+    context: { credsPayload },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stripeRefundGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stripeRefundGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stripe" },
+    "refundId": "re_123"
+  }'
+*/