feat(lune-integration): Add Lune integration custom shipping code and…

config.js

@@ -13,56 +13,64 @@ function env(envVar) {
 const config = {
   datastore: {
     error: {
-      insufficientInventory: env('FOXY_ERROR_INSUFFICIENT_INVENTORY') || env('FX_ERROR_INSUFFICIENT_INVENTORY'),
-      priceMismatch: env('FOXY_ERROR_PRICE_MISMATCH') || env('FX_ERROR_PRICE_MISMATCH')
+      insufficientInventory:
+        env("FOXY_ERROR_INSUFFICIENT_INVENTORY") ||
+        env("FX_ERROR_INSUFFICIENT_INVENTORY"),
+      priceMismatch:
+        env("FOXY_ERROR_PRICE_MISMATCH") || env("FX_ERROR_PRICE_MISMATCH"),
     },
     field: {
-      code: env('FOXY_FIELD_CODE') || env('FX_FIELD_CODE'),
-      inventory: env('FOXY_FIELD_INVENTORY') || env('FX_FIELD_INVENTORY'),
-      price: env('FOXY_FIELD_PRICE') || env('FX_FIELD_PRICE')
+      code: env("FOXY_FIELD_CODE") || env("FX_FIELD_CODE"),
+      inventory: env("FOXY_FIELD_INVENTORY") || env("FX_FIELD_INVENTORY"),
+      price: env("FOXY_FIELD_PRICE") || env("FX_FIELD_PRICE"),
     },
     provider: {
       orderDesk: {
         apiKey: env("FOXY_ORDERDESK_API_KEY"),
         storeId: env("FOXY_ORDERDESK_STORE_ID"),
       },
       webflow: {
-        collection: env('FOXY_WEBFLOW_COLLECTION'),
-        token: env('FOXY_WEBFLOW_TOKEN') || env('WEBFLOW_TOKEN'),
-      }
+        collection: env("FOXY_WEBFLOW_COLLECTION"),
+        token: env("FOXY_WEBFLOW_TOKEN") || env("WEBFLOW_TOKEN"),
+      },
     },
     skipUpdate: {
-      inventory: env('FOXY_SKIP_INVENTORY_UPDATE_CODES')
+      inventory: env("FOXY_SKIP_INVENTORY_UPDATE_CODES"),
     },
     skipValidation: {
-      inventory: env('FOXY_SKIP_INVENTORY_CODES') || env('FX_SKIP_INVENTORY_CODES'),
-      price: env('FOXY_SKIP_PRICE_CODES') || env('FX_SKIP_PRICE_CODES'),
-      updateinfo: env('FOXY_SKIP_UPDATEINFO_NAME')
+      inventory:
+        env("FOXY_SKIP_INVENTORY_CODES") || env("FX_SKIP_INVENTORY_CODES"),
+      price: env("FOXY_SKIP_PRICE_CODES") || env("FX_SKIP_PRICE_CODES"),
+      updateinfo: env("FOXY_SKIP_UPDATEINFO_NAME"),
     },
   },
   default: {
-    autoshipFrequency: env('FOXY_DEFAULT_AUTOSHIP_FREQUENCY') || env('DEFAULT_AUTOSHIP_FREQUENCY')
+    autoshipFrequency:
+      env("FOXY_DEFAULT_AUTOSHIP_FREQUENCY") ||
+      env("DEFAULT_AUTOSHIP_FREQUENCY"),
   },
   foxy: {
     api: {
-      clientId: env('FOXY_API_CLIENT_ID'),
-      clientSecret: env('FOXY_API_CLIENT_SECRET'),
-      refreshToken: env('FOXY_API_REFRESH_TOKEN')
+      clientId: env("FOXY_API_CLIENT_ID"),
+      clientSecret: env("FOXY_API_CLIENT_SECRET"),
+      refreshToken: env("FOXY_API_REFRESH_TOKEN"),
     },
     webhook: {
-      encryptionKey: env('FOXY_WEBHOOK_ENCRYPTION_KEY'),
-    }
+      encryptionKey: env("FOXY_WEBHOOK_ENCRYPTION_KEY"),
+    },
   },
   idevAffiliate: {
-    apiUrl: env('FOXY_IDEV_API_URL') || env('IDEV_API_URL'),
-    secretKey: env('FOXY_IDEV_SECRET_KEY') || env('IDEV_SECRET_KEY'),
+    apiUrl: env("FOXY_IDEV_API_URL") || env("IDEV_API_URL"),
+    secretKey: env("FOXY_IDEV_SECRET_KEY") || env("IDEV_SECRET_KEY"),
+  },
+  lune: {
+    apiKey: env("LUNE_API_KEY"),
   },
   vatlayer: {
-    accessKey: env('VATLAYER_ACCESS_KEY'),
-  }
-}
-
+    accessKey: env("VATLAYER_ACCESS_KEY"),
+  },
+};
 
 module.exports = {
-  config
-}
+  config,
+};

src/functions/lune-integration/README.md

@@ -0,0 +1,59 @@
+# Lune Integration for CO2 Offset Order creation
+
+This Foxy.io-Lune integration provides you with:
+
+- a **custom shipping code** to add to the Custom Shipping Code feature on your Foxy Store Admin [Shipping Page](https://admin.foxycart.com/admin.php?ThisAction=ShippingSetup), for getting live shipping rates with CO2 offset estimates. The code is on the `custom-shipping-code.js` file under this folder.
+- a **transaction webhook** to create an CO2 offset Order in Lune when a transaction is created.
+
+## Usage
+
+### Overview
+
+- Sign up with Lune, and get an API key.
+- Create Foxy OAuth Client Integration on the [Foxy Admin Integrations page](https://admin.foxycart.com/admin.php?ThisAction=AddIntegration), and save the credentials.
+- Add the custom shipping code on your Foxy Store Admin [Shipping Page](https://admin.foxycart.com/admin.php?ThisAction=ShippingSetup), using the code on the `custom-shipping-code.js` file, filling in the data needed on the code from the OAuth client and Lune. There are other configuration variables that need data for the shipping code to work correctly, like the originAddress.
+- Deploy this repository to your Netlify account.
+- Set the environment variables
+- Deploy the site
+
+Notes:
+
+- You will also need to configure your Lune account default project bundles, and billing info.
+- Note that this integration doesn't handle multi ship transactions. It will only calculate shipping rates with CO2 offset for one shipping, and it will grab the information from the first shipment to create a CO2 offset order in lune.
+
+### Deploy this repository to Netlify
+
+1. Click the **Fork** button at the top right corner of this page
+2. Log in your Netlify account
+3. Add a new site and select the **Import an existing project** option
+4. Connect your GitHub account and choose your repository (the repository name should be something like `your-github-username/foxy-node-netlify-functions`)
+5. In the site settings, click the **Show advanced** button
+6. Under the Advanced build settings section, click the **New variable** button, you will add two environment variables.
+7. In the Key field, enter `LUNE_API_KEY`
+8. In the Value field, enter your Lune API key
+9. Deploy the site
+
+### Create a new Foxy Webhook
+
+After the deploy is complete, click the "functions" tab, look for the `lune-integration` function and copy the **Endpoint URL**.
+
+Configure your webhook using your endpoint URL.
+
+Specify a query string value within the `API filter query string` with the following parameters:
+
+```
+zoom=applied_taxes,billing_addresses,custom_fields,customer,discounts,items,items:item_category,items:item_options,payments,shipments,attributes
+```
+
+Then click on `Update Webhooks Next`
+
+## Upgrade your webhook
+
+When new upgrades to this webhook are published, you can use the GitHub Action available in the "Actions" tab in your repository to upgrade your Webhook.
+
+- Click the "Actions" tab. Agree to use GitHub Actions.
+- Click the SyncFork workflow and then "run workflow"
+
+This will upgrade your repository.
+
+If you've made customizations, there may be conflicts. In this case you can pull the changes and resolve the conflicts manually.