trailpack-proxy-generics

trailpack-proxy-generics

Generic features that require adapters built with love from Cali-Style

Generics are common features that every web application needs but implements differently. The result of a Generic is a normalized way of handeling these different services. For example: Email, Payment Processors, Tax Provider, Shipping Provider, and Fulfillment.

Install

$ npm install --save trailpack-proxy-generics

Configure

// config/main.js
module.exports = {
  packs: [
    // ... other trailpacks
    require('trailpack-proxy-generics')
  ]
}

Currently Supported Generics

Email Provider (TODO)

The Email Provider handles sending emails from different email providers eg. Mandrill, MailGun

EmailGenericService.send

EmailGenericService.sendTemplate

Creating an Email Provider Plugin

Payment Processor (TODO)

The Payment Processor handles payments from different merchant processors/terminals eg. Stripe, Authorize.net.

PaymentGenericService.authorize

PaymentGenericService.capture

PaymentGenericService.sale

PaymentGenericService.void

PaymentGenericService.refund

Creating a Payment Processor Plugin

Tax Provider (TODO)

The Tax Provider handles sales tax for items sold from different tax providers eg. TaxBundle

TaxGenericService.getRate

Creating a Tax Provider Plugin

Shipping Provider (TODO)

The Shipping Provider handles shipping rates from a location to a destination from different shipping providers eg. Shipstation, USPS, FedEx, UPS

ShippingGenericService.getRates

Creating a Shipping Provider Plugin

Fulfillment Provider (TODO)

The Fulfillment Provider handles fulfillment events from a location to a destination from different fulfillment providers eg. Shipstation

FulfillmentGenericService.createOrders

FulfillmentGenericService.updateOrders

FulfillmentGenericService.destroyOrders

FulfillmentGenericService.getOrders

FulfillmentGenericService.holdOrders

Creating a Fulfillment Provider Plugin

Data Store Provider (TODO)

The Data Store provider handles uploads and downloads to a remote data store eg. AWS, Gcloud

DataStoreGenericService.upload

Creating a Data Store Provider Plugin