spree_emerchantpay_genesis 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3f946f18fcb121abeb5227927b4d8480f73aedfd549cca1eae4a069a322b34b
-  data.tar.gz: 675f4efd4755f39eca482ef49dcb4c75555eb98e8cd89217cd2b713f90074d59
+  metadata.gz: d2dbd23a908a23677fb4ee2bea0a49cc739052aa5d882e57b7c532d57c480602
+  data.tar.gz: d6b2c2fbbe86dcc820946edda7c79d7ff34b83ba702e0b678226ad5c87667306
 SHA512:
-  metadata.gz: eda4500c230e18a04b44eb67613c7911666e27730dd8f9eafc19fe6e43d636673479b3f47c9762465ee839ccbff026acb2e4b6dad5cde36f0b7fd07c2fff216f
-  data.tar.gz: 958cdcf91ac6ce0cd617e14d17c8cc09bde302fb829197e1b74c77ff9829f8e961b5847c419710b2372149baf1b1e72eb4956b0ce7ffaaa7e94121304af46895
+  metadata.gz: '0487117b7c98132dd864200b76d52c9b9c2b678244726bb6386a3c4c2c3220de2b729dc3c6f8d767abc46bf460c6655e158c301664777b10cf71d6a22f9268a9'
+  data.tar.gz: 861e78025ac386920634ddacb4c130d2d6285067fb693ddad00da2b9fc897a3e0011999d567795cd385931aada42d280e0e105225c07652bd618d786e282cfbf

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+0.1.5
+-----
+**Features**:
+
+* Added `emerchantpay Checkout` Description field handling
+* Updated Genesis Ruby SDK to version 0.1.6
+* Updated project dependencies
+* Added `emerchantpay Checkout` Custom Attributes handling
+* Added `emerchantpay Checkout` Language support
+
+0.1.4
+-----
+**Features**:
+
+* Added `EmerchantpayCheckout` payment method
+* Updated Genesis Ruby SDK to version 0.1.5
+* Update Card JS to the latest version
+
+**Fixes**:
+
+* Fixed project's URLs listed on RubyGems
+
 0.1.3
 -----
 **Features**

data/README.md

@@ -7,7 +7,7 @@ This is a Payment Module for Spree eCommerce that gives you the ability to proce
 * Spree FrontEnd - Optional (Tested up to 4.4.0)
 * Ruby >= 2.7
 * Ruby on Rails >= 6.1.4
-* [GenesisRuby v0.1.3](https://github.com/GenesisGateway/genesis_ruby/releases/tag/0.1.3)
+* [GenesisRuby v0.1.6](https://github.com/GenesisGateway/genesis_ruby/releases/tag/0.1.6)
 * PCI-certified server in order to use emerchantpay Direct
 
 ## Installation
@@ -37,14 +37,14 @@ Restart your server
 ## Create Payment Method
 * Sign in to Spree Admin BackEnd
 * Navigate to Configurations -> Payment Methods -> New Payment Method
-* For Provider `Choose Spree::Gateway::Emerchantpay*`
+* For Provider choose `Spree::Gateway::EmerchantpayDirect` or `Spree:Gateway::EmerchantpayCheckout`
 * Fill in Name, Description and Stores
 * Click Create
 
 # Usage
 
 ## Configuration
-* Navigate to the `Spree::Gateway::Emerchantpay*` payment method in the Configurations
+* Navigate to the `Spree::Gateway::EmerchantpayDirect` or `Spree:Gateway::EmerchantpayCheckout` payment method in the Configurations
 * Fill in Username, Password and Token
 * Fill in `hostname` used for the generation of the notification webhook. In most cases, the hostname should be the hostname of the Spree backend.
 * Fill in `return_success_url` and `return_failure_url`. Those endpoints will be returned to the `create_payment` response
@@ -128,6 +128,7 @@ curl --request 'PATCH' \
 ```
 
 4. Update Order
+<a id="payment-point-4"></a>
 ```bash
 curl --request 'PATCH' \
   --header 'Accept: application/vnd.api+json' \
@@ -175,10 +176,15 @@ curl --request 'PATCH' \
   }
 }'
 ```
-5. Create Payment
+
+### Create Payment
+
+#### Create Direct Payment  
+
 **CAUTION** Create Payment endpoint will Complete the order! Call this endpoint in order to finish the order!  
-Accept Header, Java Enabled, Language, Color Depth, Screen height, Screen Width, Time Zone Offset, User Agent parameters must be retrieved from the customer browser. More info [here](https://emerchantpay.github.io/gateway-api-docs/?shell#3ds-v2-request-params).
 
+Accept Header, Java Enabled, Language, Color Depth, Screen height, Screen Width, Time Zone Offset, User Agent parameters must be retrieved from the customer browser. More info [here](https://emerchantpay.github.io/gateway-api-docs/?shell#3ds-v2-request-params).
+    
 ```bash
 curl --request 'POST' \
   --header 'Accept: application/vnd.api+json' \
@@ -206,9 +212,49 @@ curl --request 'POST' \
 }'
 ```
 
-Response:
-**CAUTION** If a redirect URL exists in the response object you MUST redirect the customer for payment completion
+**CAUTION** If a redirect URL exists in the response object you MUST redirect the customer for payment completion. Check [Response](#payment-response).  
+
+#### Create Checkout Payment
+
+The Checkout Gateway doesn't require `source_attributes` by default (see [p.4 Update Order](#payment-point-4)). Upon Order Update or Payment Create the only required parameter is `payment_method_id`.
 
+In some cases, the Gateway Web Payment Form may require Custom Attributes. Those attributes can be passed to the gateway via `api/v2/storefront/checkout/create_payment`.
+public_metadata contains a list with custom attributes where the key is the transaction type chosen on the payment method configuration inside the administration backend.
+
+```bash
+curl --request 'POST' \
+  --header 'Accept: application/vnd.api+json' \
+  --header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
+  --header 'Content-Type: application/vnd.api+json' \
+  --url 'http://localhost:4000/api/v2/storefront/checkout/create_payment' \
+  --data '{
+  "payment_method_id": "8",
+  "source_attributes": {
+    "consumer_id":"123456",
+    "consumer_email": "travis@example.com",
+    "public_metadata": {
+      "sale3d": { "bin": "401200", "tail": "0085"},
+      "trustly_sale": {"return_success_url_target": "top"}
+    }
+  }
+}'
+```
+Full list with the available Custom Attributes for every Transaction Type can be found [here](https://emerchantpay.github.io/gateway-api-docs/#wpf-transaction-types).
+
+The payment can be finished and a request to the Gateway will be sent with one of the Order Next or Complete endpoints.  
+
+* Order complete:
+```bash
+curl --request 'PATCH' \
+  --header 'Accept: application/vnd.api+json' \
+  --header 'X-Spree-Order-Token: EsDjq1oXEgKI6kuujgfvFw1694531383712' \
+  --header 'Content-Type: application/vnd.api+json' \
+  --url 'http://localhost:4000/api/v2/storefront/checkout/complete'
+```
+In the JSON Response document you will find a `redirect_url` where the customer must be redirected for completing the payment. Check [Response](#payment-response).
+
+## Response:
+<a id="payment-response"></a>
 Create Payment response will contain `emerchantpay_payment` object. It will contain the current status of the payment.
 Redirect URL will give you the next step.
 
@@ -216,6 +262,7 @@ States:
 * error or declined - redirect URL will be the Failure URL filled in plugin settings
 * approved - redirect URL will be the Success URL filled in the plugin settings
 * pending_async - redirect URL will be the 3DSecure Method Continue endpoint for the next step of the payment
+* new - redirect URL will be the Web Payment Form URL where the customer must finish the payment 
 
 ```json
 {
@@ -238,8 +285,81 @@ States:
 * Refund
 * Void
 
-## Contributing
-Contribution directions go here.
+## Supported Transactions
+
+* ```emerchantpay Direct``` Payment Method
+  * __Authorize__
+  * __Authorize (3D-Secure)__
+  * __Sale__
+  * __Sale (3D-Secure)__
+
+* ```emerchantpay Checkout``` Payment Method
+  * __Apple Pay__
+  * __Argencard__
+  * __Aura__
+  * __Authorize__
+  * __Authorize (3D-Secure)__
+  * __Baloto__
+  * __Bancomer__
+  * __Bancontact__
+  * __Banco de Occidente__
+  * __Banco do Brasil__
+  * __BitPay__
+  * __Boleto__
+  * __Bradesco__
+  * __Cabal__
+  * __CashU__
+  * __Cencosud__
+  * __Davivienda__
+  * __Efecty__
+  * __Elo__
+  * __eps__
+  * __eZeeWallet__
+  * __Fashioncheque__
+  * __GiroPay__
+  * __Google Pay__
+  * __iDeal__
+  * __iDebit__
+  * __InstaDebit__
+  * __Intersolve__
+  * __Itau__
+  * __Klarna__
+  * __Multibanco__
+  * __MyBank__
+  * __Naranja__
+  * __Nativa__
+  * __Neosurf__
+  * __Neteller__
+  * __Online Banking__
+  * __OXXO__
+  * __P24__
+  * __Pago Facil__
+  * __PayPal__
+  * __PaySafeCard__
+  * __PayU__
+  * __Pix__
+  * __POLi__
+  * __Post Finance__
+  * __PPRO__
+  * __PSE__
+  * __RapiPago__
+  * __Redpagos__
+  * __SafetyPay__
+  * __Sale__
+  * __Sale (3D-Secure)__
+  * __Santander__
+  * __Sepa Direct Debit__
+  * __SOFORT__
+  * __Tarjeta Shopping__
+  * __TCS__
+  * __Trustly__
+  * __TrustPay__
+  * __UPI__
+  * __WebMoney__
+  * __WebPay__
+  * __WeChat__
+
+_Note_: If you have trouble with your credentials or terminal configuration, get in touch with our [support] team
 
 ## Development
 
@@ -266,4 +386,6 @@ Contribution directions go here.
 `bundle exec appraisal install`
 
 ## License
-The gem is available as open source under the terms of the [GPL-2.0 License](https://opensource.org/license/gpl-2-0/).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/license/mit).
+
+[support]: mailto:tech-support@emerchantpay.net