@foxtware/mineral 0.1.8 → 0.1.10

package/api/workable/workableJobsGet.js

@@ -0,0 +1,78 @@
+// https://workable.readme.io/reference/jobs
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { workableGet } = require('../workable/workableGet');
+const { MAX_PER_PAGE } = require('../workable/workable.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const workableJobsGet = async (
+  credsPayload,
+  {
+    state,
+    sinceId,
+    maxId,
+    createdAfter,
+    updatedAfter,
+    includeFields,
+    perPage,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const normalisedIncludeFields = Array.isArray(includeFields)
+    ? includeFields.join(',')
+    : includeFields;
+
+  const params = {
+    ...state !== undefined && { state },
+    ...sinceId !== undefined && { since_id: sinceId },
+    ...maxId !== undefined && { max_id: maxId },
+    ...createdAfter !== undefined && { created_after: createdAfter },
+    ...updatedAfter !== undefined && { updated_after: updatedAfter },
+    ...normalisedIncludeFields !== undefined && { include_fields: normalisedIncludeFields },
+  };
+
+  return workableGet(credsPayload, '/jobs', {
+    params,
+    perPage: perPage ?? MAX_PER_PAGE,
+    resultsKey: 'jobs',
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  workableJobsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/workableJobsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "workable" }
+  }'
+
+curl -X POST "http://localhost:8000/workableJobsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "workable" },
+    "options": {
+      "state": "published",
+      "perPage": 10,
+      "includeFields": ["description", "requirements"]
+    }
+  }'
+*/

package/api/yotpo/yotpo.utils.js

@@ -1,17 +1,17 @@
-const { 
-  BASE_URL, 
-  DEFAULT_API_VERSION, 
+const {
+  BASE_URL,
+  DEFAULT_API_VERSION,
 } = require('../yotpo/yotpo.constants');
-const { 
-  FetchClient, 
-  Chain, 
-  appendUrlToBase, 
-  fetchClientCommonSteps, 
+const { resolveCreds } = require('../pipelineSteps');
+const {
+  FetchClient,
+  appendUrlToBase,
+  fetchClientCommonSteps,
 } = require('../utils');
 
-const addUrlAndAuthHeaders = async (state) => {
+const useUrlAndAuthHeaders = async (state) => {
   const { requestPayload, context } = state;
-  const { creds, apiVersion = DEFAULT_API_VERSION } = context;
+  const { apiVersion = DEFAULT_API_VERSION, creds } = context;
   const { API_KEY, GUID } = creds;
 
   return {
@@ -19,7 +19,6 @@ const addUrlAndAuthHeaders = async (state) => {
       ...requestPayload,
       url: appendUrlToBase(`${ BASE_URL }/${ apiVersion }`, requestPayload.url),
       headers: {
-        'Content-Type': 'application/json',
         'x-api-key': API_KEY,
         'x-guid': GUID,
         ...requestPayload.headers,
@@ -28,18 +27,14 @@ const addUrlAndAuthHeaders = async (state) => {
   };
 };
 
-const yotpoClientRequestPreparer = new Chain([
-  addUrlAndAuthHeaders,
-]);
-
-const yotpoClientResponseInterpreter = new Chain([
-  fetchClientCommonSteps.exitEarlyOnNotOk,
-  fetchClientCommonSteps.digToPath,
-]);
-
 const yotpoClient = new FetchClient({
-  requestPreparer: yotpoClientRequestPreparer,
-  responseInterpreter: yotpoClientResponseInterpreter,
+  pipeline: [
+    resolveCreds,
+    useUrlAndAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+    fetchClientCommonSteps.digToPath,
+  ],
 });
 
 module.exports = {

package/api/yotpo/yotpoCampaignsGet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/get-active-campaigns
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -22,8 +22,6 @@ const yotpoCampaignsGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -36,10 +34,12 @@ const yotpoCampaignsGet = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/campaigns',
-    params,
+    requestPayload: {
+      url: '/campaigns',
+      params,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerActionRecord.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/record-a-customer-action
 
-const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -43,8 +43,6 @@ const yotpoCustomerActionRecord = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -63,11 +61,13 @@ const yotpoCustomerActionRecord = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/actions',
-    method: 'post',
-    body,
+    requestPayload: {
+      url: '/actions',
+      method: 'post',
+      body,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerAnniversaryGet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/get-customer-anniversary
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -25,15 +25,15 @@ const yotpoCustomerAnniversaryGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await yotpoClient.fetch({
-    url: '/customer_anniversary',
-    params: {
-      customer_email: customerEmail,
+    requestPayload: {
+      url: '/customer_anniversary',
+      params: {
+        customer_email: customerEmail,
+      },
     },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerAnniversarySet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/createupdate-customer-anniversary
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -35,8 +35,6 @@ const yotpoCustomerAnniversarySet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const body = {
     customer_email: customerEmail,
     day: Number(day),
@@ -45,11 +43,13 @@ const yotpoCustomerAnniversarySet = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/customer_anniversary',
-    method: 'post',
-    body,
+    requestPayload: {
+      url: '/customer_anniversary',
+      method: 'post',
+      body,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerBirthdaySet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/set-customer-birthday
 
-const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -42,8 +42,6 @@ const yotpoCustomerBirthdaySet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -58,11 +56,13 @@ const yotpoCustomerBirthdaySet = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/customer_birthdays',
-    method: 'post',
-    body,
+    requestPayload: {
+      url: '/customer_birthdays',
+      method: 'post',
+      body,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerGet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/fetch-customer-details
 
-const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -37,8 +37,6 @@ const yotpoCustomerGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -57,10 +55,12 @@ const yotpoCustomerGet = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/customers',
-    params,
+    requestPayload: {
+      url: '/customers',
+      params,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerPointsAdjust.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/adjust-a-customers-point-balance
 
-const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -40,8 +40,6 @@ const yotpoCustomerPointsAdjust = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -57,11 +55,13 @@ const yotpoCustomerPointsAdjust = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/points/adjust',
-    method: 'post',
-    body,
+    requestPayload: {
+      url: '/points/adjust',
+      method: 'post',
+      body,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomerUpsert.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/createupdate-customer-records
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -37,8 +37,6 @@ const yotpoCustomerUpsert = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const body = {
     email,
     ...(id && { id }),
@@ -55,11 +53,13 @@ const yotpoCustomerUpsert = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/customers',
-    method: 'post',
-    body,
+    requestPayload: {
+      url: '/customers',
+      method: 'post',
+      body,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoCustomersRecentGet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/fetch-all-recently-updated-customers
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -22,18 +22,18 @@ const yotpoCustomersRecentGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const params = {
     ...(pageInfo && { page_info: pageInfo }),
     ...(perPage !== undefined && { per_page: perPage }),
   };
 
   const response = await yotpoClient.fetch({
-    url: '/customers/recent',
-    params,
+    requestPayload: {
+      url: '/customers/recent',
+      params,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoRedemptionCreate.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/create-redemption
 
-const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { objHasAny, ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -43,8 +43,6 @@ const yotpoRedemptionCreate = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -64,11 +62,13 @@ const yotpoRedemptionCreate = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/redemptions',
-    method: 'post',
-    body,
+    requestPayload: {
+      url: '/redemptions',
+      method: 'post',
+      body,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoRedemptionOptionsGet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/fetch-active-redemption-options
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -23,8 +23,6 @@ const yotpoRedemptionOptionsGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const {
     customerId,
     customerEmail,
@@ -40,10 +38,12 @@ const yotpoRedemptionOptionsGet = async (
   };
 
   const response = await yotpoClient.fetch({
-    url: '/redemption_options',
-    params,
+    requestPayload: {
+      url: '/redemption_options',
+      params,
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/yotpo/yotpoVipTiersGet.js

@@ -1,6 +1,6 @@
 // https://loyaltyapi.yotpo.com/reference/fetch-vip-tiers
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { yotpoClient } = require('../yotpo/yotpo.utils');
 
@@ -20,12 +20,12 @@ const yotpoVipTiersGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await yotpoClient.fetch({
-    url: '/vip_tiers',
+    requestPayload: {
+      url: '/vip_tiers',
+    },
     context: {
-      creds,
+      credsPayload,
       apiVersion,
     },
   });

package/api/youtube/youtube.constants.js

@@ -0,0 +1,5 @@
+const YOUTUBE_API_BASE = 'https://www.googleapis.com/youtube/v3';
+
+module.exports = {
+  YOUTUBE_API_BASE,
+};

package/api/youtube/youtube.utils.js

@@ -0,0 +1,77 @@
+const { YOUTUBE_API_BASE } = require('../youtube/youtube.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+} = require('../utils');
+
+const useApiKeyParam = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const { API_KEY } = creds;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      params: {
+        key: API_KEY,
+        ...requestPayload.params,
+      },
+    },
+  };
+};
+
+const interpretYoutubeResponse = async (state) => {
+  const { response } = state;
+
+  if (!response.ok) {
+    const youtubeError = response.error?.details?.error;
+
+    if (youtubeError) {
+      return {
+        response: {
+          ok: false,
+          error: {
+            code: youtubeError.code,
+            message: youtubeError.message,
+            details: youtubeError,
+          },
+        },
+        breakChain: true,
+      };
+    }
+
+    return { breakChain: true };
+  }
+
+  const { data } = response;
+
+  if (data?.error) {
+    return {
+      response: {
+        ok: false,
+        error: {
+          code: data.error.code,
+          message: data.error.message,
+          details: data.error,
+        },
+      },
+      breakChain: true,
+    };
+  }
+
+  return {};
+};
+
+const youtubeClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(YOUTUBE_API_BASE),
+    useApiKeyParam,
+    'fetch',
+    interpretYoutubeResponse,
+  ],
+});
+
+module.exports = {
+  youtubeClient,
+};