Mercado Pago Payment Gateway Plugin (Woocommerce)

Welcome to the readme for Mercado Pago Payment Gateway Plugin. This guide is intended to provide users with the necessary information to understandand extend the functionality of the plugin.

Table of Contents

1. Introduction

2. Plugin Overview

3. WordPress and WooCommerce Basics

4. Installation

5. Plugin Configuration

6. Hooks and Filters

7. Customization

8. Contributing

9. Running Tests

10. Support and Issues

Introduction

Mercado Pago Payment Gateway Plugin is a WooCommerce payment gateway extension designed to facilitate secure online transactions. This guide will help you understand the inner workings of the plugin and provide information on how to extend its functionality.

Plugin Overview

Mercado Pago Payment Gateway Plugin integrates seamlessly with WooCommerce, enabling users to make payments using Mercado Pago. The plugin is built with flexibility and extensibility in mind, allowing developers to customize and extend its features.

WordPress and WooCommerce Basics

To work effectively with our plugin, it's essential to have a basic understanding of WordPress and WooCommerce. If you are new to these platforms, consider familiarizing yourself with the following resources:

• WordPress Documentation

• WooCommerce Documentation

Installation

Follow these steps to manual installation :

1. Download the plugin from ths GitHub repository.
2. Run npm install and composer install
3. Run sh bin/create-release-zip.sh to generate the final zip used to install it in the store.
4. Upload the plugin files generated by zip to the /wp-content/plugins/ directory or install it via the WordPress admin interface.
5. Activate the plugin through the 'Plugins' menu in WordPress.

you can also get the plugin directly from the wordpress page at https://wordpress.org/plugins/woocommerce-mercadopago/

Plugin Configuration

After installation, navigate to the Mercado Pago developer site to view integration documentation and configure the plugin.

Customization

The WooCommerce payment plugin provides flexibility for customization and extensions. You can extend existing functionalities or add new ones according to your specific needs.

Example Payment Gateway Extension

You can also extend the payment gateway class to add new custom gateways. See an example:

namespace MercadoPago\Woocommerce\Templates\Gateways;

use MercadoPago\Woocommerce\Gateways\AbstractGateway;
use MercadoPago\Woocommerce\Templates\Transactions\ExamplePaymentTransaction;
use MercadoPago\Woocommerce\Templates\WoocommerceMercadopagoTemplate;

class ExamplePaymentGateway extends AbstractGateway {
    // ... (your code here)
}

In this example, the ExamplePaymentGateway class extends the payment gateway functionality and can be customized to add new payment options.

Example Payment Transaction Extension

To extend the payment transaction class, you can create a custom class that inherits from AbstractPaymentTransaction. See the example below:

namespace MercadoPago\Woocommerce\Templates\Transactions;

use MercadoPago\Woocommerce\Gateways\AbstractGateway;
use MercadoPago\Woocommerce\Transactions\AbstractPaymentTransaction;

class ExamplePaymentTransaction extends AbstractPaymentTransaction {
    // ... (your code here)
}

In this example, the ExamplePaymentTransaction class extends the payment transaction functionality and can be customized as needed.

You can see more on the github wiki page.

Running Tests

This project uses PHPUnit for automated testing and generating code coverage reports. Follow the instructions below to run tests and generate coverage reports.

Requirements

Ensure that all dependencies are installed by running:

composer install 

Test Commands

To run all project tests and generate HTML code coverage reports, you can use the pre-configured commands in composer.json.

• Run all tests:

  composer phpunit

  This command will execute all tests in the project and display results in the terminal.

• Run a specific test file:

  composer phpunit-file path/to/your/testfile.php

  This command allows you to focus on a single test file, which is useful for development and debugging.

Code Coverage Reports

After running the tests, a coverage directory will be generated in the project root, containing the reports in HTML format. You can view the reports by opening coverage/index.html in a browser.

How to mock Wordpress

To mock WordPress functions and classes in your unit tests, you can use the WP_Mock library. It simplifies the creation of mocks and stubs for WordPress functions, allowing you to test your code in isolation.

For more information, refer to the WP_Mock documentation.

Support and Issues

For any issues or questions, please reach out to our support team.

Thank you for using our plugin!

---