@foxtware/mineral 0.1.9 → 0.1.11

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

@@ -1,4 +1,4 @@
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -17,13 +17,13 @@ const FUNC = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/things',
-    method: 'post',
-    body: { arg },
-    context: { creds },
+    requestPayload: {
+      url: '/things',
+      method: 'post',
+      body: { arg },
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripe.utils.js

@@ -1,12 +1,11 @@
 const { BASE_URL } = require('../stripe/stripe.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
 const {
   FetchClient,
-  Chain,
-  appendUrlToBase,
   fetchClientCommonSteps,
 } = require('../utils');
 
-const addUrlAndAuthHeaders = async (state) => {
+const useAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
   const { creds } = context;
   const { API_KEY } = creds;
@@ -18,7 +17,6 @@ const addUrlAndAuthHeaders = async (state) => {
   return {
     requestPayload: {
       ...requestPayload,
-      url: appendUrlToBase(BASE_URL, requestPayload.url),
       headers: {
         'Content-Type': 'application/x-www-form-urlencoded',
         Authorization: `Bearer ${ API_KEY }`,
@@ -29,17 +27,14 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-const stripeClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const stripeClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-]);
-
 const stripeClient = new FetchClient({
-  requestPreparer: stripeClientRequestPreparer,
-  responseInterpreter: stripeClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
 });
 
 module.exports = {

package/api/stripe/stripeCardTokenCreate.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/tokens/create_card
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -31,18 +31,18 @@ const stripeCardTokenCreate = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/tokens',
-    method: 'post',
-    body: {
-      'card[number]': cardNumber,
-      'card[exp_month]': expiryMonth,
-      'card[exp_year]': expiryYear,
-      'card[cvc]': cvc,
+    requestPayload: {
+      url: '/tokens',
+      method: 'post',
+      body: {
+        'card[number]': cardNumber,
+        'card[exp_month]': expiryMonth,
+        'card[exp_year]': expiryYear,
+        'card[cvc]': cvc,
+      },
     },
-    context: { creds },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeChargeCapture.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/charges/capture
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -25,17 +25,17 @@ const stripeChargeCapture = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: `/charges/${ chargeId }/capture`,
-    method: 'post',
-    ...(amountCents && {
-      body: {
-        amount: amountCents,
-      },
-    }),
-    context: { creds },
+    requestPayload: {
+      url: `/charges/${ chargeId }/capture`,
+      method: 'post',
+      ...(amountCents && {
+        body: {
+          amount: amountCents,
+        },
+      }),
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeChargeCreate.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/charges/create
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -31,18 +31,18 @@ const stripeChargeCreate = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/charges',
-    method: 'post',
-    body: {
-      amount: amountCents,
-      currency,
-      source,
-      description,
+    requestPayload: {
+      url: '/charges',
+      method: 'post',
+      body: {
+        amount: amountCents,
+        currency,
+        source,
+        description,
+      },
     },
-    context: { creds },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeChargeGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/charges/retrieve
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -22,11 +22,11 @@ const stripeChargeGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: `/charges/${ chargeId }`,
-    context: { creds },
+    requestPayload: {
+      url: `/charges/${ chargeId }`,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeChargesGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/charges/list
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -20,12 +20,12 @@ const stripeChargesGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/charges',
-    params,
-    context: { creds },
+    requestPayload: {
+      url: '/charges',
+      params,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeRefundCreate.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/refunds/create
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -26,17 +26,17 @@ const stripeRefundCreate = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/refunds',
-    method: 'post',
-    body: {
-      charge: chargeId,
-      ...amountCents && { amount: amountCents },
-      ...reason && { reason },
+    requestPayload: {
+      url: '/refunds',
+      method: 'post',
+      body: {
+        charge: chargeId,
+        ...amountCents && { amount: amountCents },
+        ...reason && { reason },
+      },
     },
-    context: { creds },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeRefundGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/refunds/retrieve
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -22,11 +22,11 @@ const stripeRefundGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: `/refunds/${ refundId }`,
-    context: { creds },
+    requestPayload: {
+      url: `/refunds/${ refundId }`,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeRefundsGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/refunds/list
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -20,12 +20,12 @@ const stripeRefundsGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/refunds',
-    params,
-    context: { creds },
+    requestPayload: {
+      url: '/refunds',
+      params,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeTokenGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/tokens/retrieve
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -22,11 +22,11 @@ const stripeTokenGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: `/tokens/${ tokenId }`,
-    context: { creds },
+    requestPayload: {
+      url: `/tokens/${ tokenId }`,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stylearcade/stylearcade.constants.js

@@ -0,0 +1,5 @@
+const MAX_PER_PAGE = 100;
+
+module.exports = {
+  MAX_PER_PAGE,
+};

package/api/stylearcade/stylearcade.utils.js

@@ -0,0 +1,40 @@
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const useStylearcadeBaseUrl = async (state) => {
+  const { creds } = state.context;
+  return useBaseUrl(creds.BASE_URL)(state);
+};
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const { API_KEY } = creds;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        'Api-Key': API_KEY,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const stylearcadeClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useStylearcadeBaseUrl,
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
+});
+
+module.exports = {
+  stylearcadeClient,
+};

package/api/stylearcade/stylearcadeDataGet.js

@@ -0,0 +1,62 @@
+// https://stylearcade.gitlab.io/api-docs/range-plan
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stylearcadeGet, stylearcadeGetter } = require('../stylearcade/stylearcadeGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const stylearcadeDataGet = async (
+  credsPayload,
+  options = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return stylearcadeGet(credsPayload, {
+    nodeName: 'records',
+    ...options,
+  });
+};
+
+const stylearcadeDataGetter = async (
+  credsPayload,
+  options = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return stylearcadeGetter(credsPayload, {
+    nodeName: 'records',
+    ...options,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stylearcadeDataGet,
+  stylearcadeDataGetter,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stylearcadeDataGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stylearcade" },
+    "options": {
+      "limit": 2000
+    }
+  }'
+*/

package/api/stylearcade/stylearcadeGet.js

@@ -0,0 +1,133 @@
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stylearcadeClient } = require('../stylearcade/stylearcade.utils');
+const { MAX_PER_PAGE } = require('../stylearcade/stylearcade.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const stylearcadeGetPacket = async (
+  credsPayload,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    url = '/export',
+  } = {},
+) => {
+  return stylearcadeClient.fetch({
+    requestPayload: {
+      url,
+      params: {
+        limit: perPage,
+        ...params,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const stylearcadeGetPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const { nextCursor } = response.data || {};
+
+  if (!nextCursor) {
+    return [true];
+  }
+
+  const { args, options } = currentParams;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      params: {
+        ...options.params,
+        cursor: nextCursor,
+      },
+    },
+  }];
+};
+
+const stylearcadeGetDigester = (response, nodeName) => {
+  if (!response?.ok) {
+    return [];
+  }
+
+  return response?.data?.[nodeName] ?? [];
+};
+
+const stylearcadeGet = async (
+  returnGetter,
+
+  credsPayload,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    nodeName = 'records',
+    url = '/export',
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload],
+      options: {
+        params,
+        perPage,
+        url,
+      },
+    },
+    {
+      func: stylearcadeGetPacket,
+      digester: (response) => stylearcadeGetDigester(response, nodeName),
+      paginator: stylearcadeGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stylearcadeGet: (...args) => stylearcadeGet(false, ...args),
+  stylearcadeGetter: (...args) => stylearcadeGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stylearcadeGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stylearcade" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/