trailpack-proxy-generics - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

api/services/PaymentGenericService.js

@@ -21,3 +21,3 @@ 'use strict'
    *
-   * @param data
+   * @param transaction
    * @param adapter
@@ -27,7 +27,7 @@ * @returns {Promise}
   // authorization is the reserving of money that the customer has agreed to pay.
-  authorize(data, adapter){
-    return lib.Validator.paymentProvider.authorize(data)
+  authorize(transaction, adapter){
+    return lib.Validator.paymentProvider.authorize(transaction)
       .then(values => {
         adapter = this._init(adapter)
-        return adapter.authorize(data)
+        return adapter.authorize(transaction)
       })
@@ -37,3 +37,3 @@ }
    *
-   * @param data
+   * @param transaction
    * @param adapter
@@ -43,7 +43,7 @@ * @returns {Promise}
   // capture is the transfer of the money that was reserved during the authorization stage.
-  capture(data, adapter){
-    return lib.Validator.paymentProvider.capture(data)
+  capture(transaction, adapter){
+    return lib.Validator.paymentProvider.capture(transaction)
       .then(values => {
         adapter = this._init(adapter)
-        return adapter.capture(data)
+        return adapter.capture(transaction)
       })
@@ -54,3 +54,3 @@ }
    *
-   * @param data
+   * @param transaction
    * @param adapter
@@ -60,7 +60,7 @@ * @returns {Promise}
   // sale is a combination of authorization and capture, performed in one step.
-  sale(data, adapter){
-    return lib.Validator.paymentProvider.sale(data)
+  sale(transaction, adapter){
+    return lib.Validator.paymentProvider.sale(transaction)
       .then(values => {
         adapter = this._init(adapter)
-        return adapter.sale(data)
+        return adapter.sale(transaction)
       })
@@ -70,3 +70,3 @@ }
    *
-   * @param data
+   * @param transaction
    * @param adapter
@@ -76,7 +76,7 @@ * @returns {Promise}
   // void is the cancellation of a pending authorization or capture.
-  void(data, adapter){
-    return lib.Validator.paymentProvider.void(data)
+  void(transaction, adapter){
+    return lib.Validator.paymentProvider.void(transaction)
       .then(values => {
         adapter = this._init(adapter)
-        return adapter.void(data)
+        return adapter.void(transaction)
       })
@@ -86,3 +86,3 @@ }
    *
-   * @param data
+   * @param transaction
    * @param adapter
@@ -92,7 +92,7 @@ * @returns {Promise}
   // refund is the partial or full refund of the captured money to the sale.
-  refund(data, adapter){
-    return lib.Validator.paymentProvider.refund(data)
+  refund(transaction, adapter){
+    return lib.Validator.paymentProvider.refund(transaction)
       .then(values => {
         adapter = this._init(adapter)
-        return adapter.refund(data)
+        return adapter.refund(transaction)
       })
@@ -99,0 +99,0 @@ }

lib/schemas/proxyGenericsConfig.js

@@ -6,25 +6,25 @@ 'use strict'
   email_provider: joi.object().keys({
-    adapter: joi.string(),
+    adapter: joi.any(),
     options: joi.object()
   }),
   payment_processor: joi.object().keys({
-    adapter: joi.string(),
+    adapter: joi.any(),
     options: joi.object()
   }),
   tax_provider: joi.object().keys({
-    adapter: joi.string(),
+    adapter: joi.any(),
     options: joi.object()
   }),
   shipping_provider: joi.object().keys({
-    adapter: joi.string(),
+    adapter: joi.any(),
     options: joi.object()
   }),
   fulfillment_provider: joi.object().keys({
-    adapter: joi.string(),
+    adapter: joi.any(),
     options: joi.object()
   }),
   data_store_provider: joi.object().keys({
-    adapter: joi.string(),
+    adapter: joi.any(),
     options: joi.object()
   })
 })

package.json

 {
   "name": "trailpack-proxy-generics",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Generics - Trailpack for Proxy Engine",
@@ -5,0 +5,0 @@ "homepage": "https://cali-style.com",

README.md

@@ -10,3 +10,3 @@ # trailpack-proxy-generics
 
-Generics are common features that every web application needs but implements differently.
+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.
@@ -34,12 +34,40 @@
 ### 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
 
@@ -46,0 +74,0 @@

No alert changes

Improved metrics

Total package byte prevSize

21902

increased by8.33%

Number of lines in readme file

82

increased by51.85%

No dependency changes