Payment Setting: properly display payment methods based on a given Omise Account (for admin) #151

guzzilar · 2020-01-19T23:21:29Z

1. Objective

Previously all the payment methods that have been implemented to the plugin will be shown at WooCommerce Payment Setting page, regardless on a given Omise account.

For instance, using Omise Japan account at Omise-WooCommerce plugin, you will see all the payment methods, including those that can be used only for Omise Thailand.

This, is believed to cause a bad user-experience and a confusion for all the merchants outside Thailand.

Related information:
Related issue(s): T18705

2. Description of change

Before saving given credential keys to WooCommerce's DB, the plugin will be making a request to Omise API to retrieve Omise Account detail, then pack and save it to WooCommerce's DB along with those credentials.

At WordPress's wp_options table, option_name: woocommerce_omise_settings, there will be 3 new parameters: account_id, account_email, and account_country.

Before

a:5:{s:7:"sandbox";s:3:"yes";s:15:"test_public_key";s:29:"pkey_test_***";s:16:"test_private_key";s:29:"skey_test_***";s:15:"live_public_key";s:0:"";s:16:"live_private_key";s:0:"";}

After

a:8:{s:10:"account_id";s:24:"acct_***";s:13:"account_email";s:22:"***@***";s:15:"account_country";s:2:"JP";s:7:"sandbox";s:3:"yes";s:15:"test_public_key";s:29:"pkey_test_***";s:16:"test_private_key";s:29:"skey_test_***";s:15:"live_public_key";s:0:"";s:16:"live_private_key";s:0:"";}

.
2. At the Admin Payment Setting page, add a condition to display only payment methods that are available for that specific Omise account's country.

Before
The below screenshot: all the payment methods are listed at the payment setting page regardless on a given Omise account.

After
The below screenshot: hide all the payment methods if Omise account's credential hasn't been set.

The below screenshot: Once the Omise account has been set, the payment methods will be shown accordingly to the given account (in this case, Thailand account).

The below screenshot: Once the Omise account has been set, the payment methods will be shown accordingly to the given account (in this case, Japan account).

Also make sure that it won't affect to the current merchants.

3. Quality assurance

🔧 Environments:

WooCommerce: v3.8.1
WordPress: v5.3.2
PHP version: 7.3.3

✏️ Details:

There are 2 possible cases.

Current users upgrading from the previous plugin version to this one.
The following code should detect and auto-update its database to meet with the condition of displaying payment methods by a given Omise account.
https://github.com/omise/omise-woocommerce/pull/151/files#diff-9849043e36d1d7b568f325534b722341R77

As for user perspective, they wouldn't need to do any extra step.

New users that download the plugin for the first time.
This group should be no problem as described at the section 2. Description of change, [2].

4. Impact of the change

As described at the section 2. Description of change, [1]. There will be 3 new parameters saved at WordPress's wp_options table, option_name: woocommerce_omise_settings.

5. Priority of change

Normal

6. Additional Notes

No

…keys.

…ble.

…count_country' parameter has been set properly.

guzzilar · 2020-01-20T00:51:43Z

includes/admin/views/omise-page-settings.php

-											'status'  => __( 'Enabled', 'omise' ),
-											'setting' => ''
-										);
+		<?php if ($settings['account_country']) : ?>


Note; this seems to be a lot of changes but it only is because of this line and another following line.
The rest is about the changing of its indent.

guzzilar · 2020-01-20T00:52:47Z

includes/admin/views/omise-page-settings.php

+										new Omise_Payment_Truemoney
+									);
+									foreach ( $available_gateways as $gateway ) :
+										if ( $gateway->is_country_support( $settings['account_country'] ) ) :


Note; continue from https://github.com/omise/omise-woocommerce/pull/151/files#r368338668
Here is another line that has been added. The rest is code indentation.

jonrandy · 2020-01-20T04:38:23Z

Would this not be better achieved using the Capability API? This would make it more future proof by preventing the need to change the code should the country availability of a payment method change.

Admittedly, the downside to this is that some payment methods still do not appear in the capability API, so we'd need to wait for that to be done before release (but I believe it should be done soon).

Arguably, the best solution would be a combination of using the Capability API, and what you have done. We could show all the payment methods available for the merchant country overall, and grey out the ones that are not currently available to that particular merchant

guzzilar · 2020-01-20T05:31:02Z

@jonrandy Thanks for the input 👍
The use case of this approach is slightly different from using Capability API.

The Capability API is to list out available payment methods of that particular Omise account "at the moment". But what this pull request is trying to achieve here is to list all the payment methods that is available for that "country" regardless of if it can be used on that particular account or not.

However, I would love to implement the Capability API once it done, to maximize this feature so the output can be:

TH Account:
- Available payment methods
  - Alipay
  - Bill Payment [disabled] (please contact Omise support to enable this payment)
  - Credit Card
  - Internet Banking
  - Installment
  - TrueMoney Wallet

JP Account:  
- Available payment methods
  - Credit Card
  - Konbini [disabled] (please contact Omise support to enable this payment)

"Here are 5 payment methods that you may use with the account that is registered under Thailand, currently 3 enabled and 2 disabled. To enable these 2 payment methods, please contact our support team".

jonrandy · 2020-01-20T05:32:45Z

Yup, that was my arguable 'best solution' above that is the best of both worlds

guzzilar · 2020-01-20T05:39:40Z

@jonrandy ah sorry I miss-read the whole sentence of and grey out the ones that are not currently available to that particular merchant. You've already mentioned what I've explained in a shorter and better sentence. Yeah, exactly like that, in my opinion.

jonrandy · 2020-01-20T05:49:32Z

includes/admin/views/omise-page-settings.php

+										new Omise_Payment_Creditcard,
+										new Omise_Payment_Installment,
+										new Omise_Payment_Internetbanking,
+										new Omise_Payment_Truemoney


Wow - they're even alphabetised! :)

I do have the feeling this list of available gateways really belongs at a higher level as it feels like something that may be used again elsewhere. It's ok here for now though I guess

Thanks for the input 👍
Now you have mentioned and it got me to think that probably the main Omise class (omise-woocommerce.php) would also likely to be a place where this can also be implemented if not too complex.

Note for idea (but not in anytime soon)

foreach ( Omise::available_payment_methods() as $methods ) { // ... }

also note for myself. I think gateways is a not so good name. methods would be more accurate

Yep. I mentioned it because I'm doing something similar in my Prestashop refactoring

jonrandy

LGTM. Some comments there with thoughts for the future though

jacstn · 2020-01-21T11:07:21Z

works great..

guzzilar · 2020-01-21T13:29:26Z

@jacstn @jonrandy Thanks for the review! 👍

Retrieve & record Omise Account to WC's DB by using given credential …

23f8f60

…keys.

guzzilar added Status: In progress Type: Enhancement labels Jan 19, 2020

guzzilar added 2 commits January 20, 2020 06:29

Adding a functionality to assign & check for a restrict-country varia…

2de363b

…ble.

class Omise_Page_Settings, adding extra condition to check if the 'ac…

9c34e9c

…count_country' parameter has been set properly.

guzzilar changed the title ~~[WIP] Payment Setting: properly display payment methods based on a given Omise Account (for admin)~~ Payment Setting: properly display payment methods based on a given Omise Account (for admin) Jan 20, 2020

guzzilar added Status: Review needed and removed Status: In progress labels Jan 20, 2020

guzzilar commented Jan 20, 2020

View reviewed changes

jonrandy reviewed Jan 20, 2020

View reviewed changes

jonrandy approved these changes Jan 20, 2020

View reviewed changes

guzzilar mentioned this pull request Jan 20, 2020

Introducing Konbini payment method #149

Merged

jacstn self-requested a review January 21, 2020 11:07

jacstn approved these changes Jan 21, 2020

View reviewed changes

guzzilar added Status: Ready and removed Status: Review needed labels Jan 21, 2020

guzzilar merged commit c004b6c into master Jan 21, 2020

guzzilar deleted the detect-account-capability branch January 21, 2020 13:30

guzzilar mentioned this pull request Mar 11, 2020

✨ Releasing Omise-WooCommerce v3.11 #154

Merged

guzzilar added Status: Released and removed Status: Ready labels Mar 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Payment Setting: properly display payment methods based on a given Omise Account (for admin) #151

Payment Setting: properly display payment methods based on a given Omise Account (for admin) #151

guzzilar commented Jan 19, 2020 •

edited

Loading

guzzilar Jan 20, 2020

guzzilar Jan 20, 2020

jonrandy commented Jan 20, 2020

guzzilar commented Jan 20, 2020 •

edited

Loading

jonrandy commented Jan 20, 2020

guzzilar commented Jan 20, 2020

jonrandy Jan 20, 2020

jonrandy Jan 20, 2020

guzzilar Jan 20, 2020

guzzilar Jan 20, 2020 •

edited

Loading

jonrandy Jan 21, 2020

jonrandy left a comment

jacstn commented Jan 21, 2020

guzzilar commented Jan 21, 2020

Payment Setting: properly display payment methods based on a given Omise Account (for admin) #151

Payment Setting: properly display payment methods based on a given Omise Account (for admin) #151

Conversation

guzzilar commented Jan 19, 2020 • edited Loading

1. Objective

2. Description of change

3. Quality assurance

4. Impact of the change

5. Priority of change

6. Additional Notes

guzzilar Jan 20, 2020

Choose a reason for hiding this comment

guzzilar Jan 20, 2020

Choose a reason for hiding this comment

jonrandy commented Jan 20, 2020

guzzilar commented Jan 20, 2020 • edited Loading

jonrandy commented Jan 20, 2020

guzzilar commented Jan 20, 2020

jonrandy Jan 20, 2020

Choose a reason for hiding this comment

jonrandy Jan 20, 2020

Choose a reason for hiding this comment

guzzilar Jan 20, 2020

Choose a reason for hiding this comment

guzzilar Jan 20, 2020 • edited Loading

Choose a reason for hiding this comment

jonrandy Jan 21, 2020

Choose a reason for hiding this comment

jonrandy left a comment

Choose a reason for hiding this comment

jacstn commented Jan 21, 2020

guzzilar commented Jan 21, 2020

guzzilar commented Jan 19, 2020 •

edited

Loading

guzzilar commented Jan 20, 2020 •

edited

Loading

guzzilar Jan 20, 2020 •

edited

Loading