WooCommerce

Smart Send module for WooCommerce

Setup

WP CLI and WooCommerce CLI can be used to setup a fresh WooCommerce installation for testing.

Install WP CLI

Either as a global composer package:

composer global require "wp-cli/wp-cli-bundle:*"

or by Downloading the Phar file (recommended in eg CI/CD pipelines):

curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
php wp-cli.phar --info

Note there is also a Github Actio for installing WP CLI.

Install WordPress

# Download wordpress
wp core download --path=wordpress

# Go to new installation
cd wordpress

# Generate a config file
wp config create --dbhost="127.0.0.1" --dbname=wordpress --dbuser=root --dbpass=""

# Remove any previous database if needed
# wp db drop --yes

# Create the database
wp db create

# Reset DB if ever needed
# wp db reset --yes

# Install WordPress
wp core install --url=wordpress.test --title="WordPress Demo" --admin_user=wp --admin_password=wp [email protected]

# Install admin command
wp package install wp-cli/admin-command

# Update all plugins
wp plugin update --all

Install WooCommerce

WooCommerce CLI is part of WooCommerce since version 3, so simply install WooCommerce using WP Cli:

wp plugin install woocommerce --activate

Install Storefront theme

The official storefront theme should be used for development and testing:

wp theme install storefront --activate

Import Sample data

Installing the WooCommerce Sample Data serves as a good starting point:

# Install the required plugin for importing
wp plugin install wordpress-importer --activate

# Import the WooCommerce sample data
wp import "wp-content/plugins/woocommerce/sample-data/sample_products.xml" --authors=create

Install plugin

During development then it makes sense symlinking the working plugin folder ./smart-send-logistics into the wordpress pluigns folder wp-content/plugins:

# Assuming that the repo is stored locally inside the folder ~/github.com/smartsendio/woocommerce
ln -s ~/github.com/smartsendio/woocommerce/smart-send-logistics "wp-content/plugins/smart-send-logistics" 

After which the plugin can be activated

wp plugin activate smart-send-logistics

Setup WooCommerce

A few modifications must be made to the default WooCommerce setup

Finishing Setup Wizard

We have not found a way to finish the Setup Wizard through CLI yet. This Wizard sets a few settings like vat settings.

Add shipping zones

wp wc shipping_zone create --user=wp --name="Denmark"
wp wc shipping_zone create --user=wp --name="Nordics"
wp wc shipping_zone create --user=wp --name="EU"

configuring the countries for each shipping zone cannot be done via CLI, so doing via DB Query:

wp db query "INSERT INTO wp_woocommerce_shipping_zone_locations (zone_id, location_code, location_type) VALUES (1, 'DK', 'country')"
wp db query "INSERT INTO wp_woocommerce_shipping_zone_locations (zone_id, location_code, location_type) VALUES (2, 'SE', 'country')"
wp db query "INSERT INTO wp_woocommerce_shipping_zone_locations (zone_id, location_code, location_type) VALUES (3, 'EU', 'continent')"

Adding Smart Send shipping methods

wp wc shipping_zone_method create 1 --enabled=true --settings='{"title":"Smart Send Demo"}' --method_id=smart_send_shipping --user=wp

Enable payments

wp wc payment_gateway update bacs --user=wp --enabled=true
wp wc payment_gateway update cod --user=wp --enabled=true

Go to admin

wp admin --user=wp

Wordpress Plugin releases are managed by SVN and to sync the plugin to a local folder run:

svn co https://plugins.svn.wordpress.org/smart-send-logistics smart-send-logistics

To release a new version of the plugin:

1. Update all mentions of the Version:

• smart-send-logistics/smart-send-logistics.php: Header
• smart-send-logistics/smart-send-logistics.php: private property $version
• smart-send-logistics/readme.txt: Stable tag-tag

2. Add changelog entry in smart-send-logistics/readme.txt
3. Copy folder smart-send-logistics to the trunk svn folder
4. Copy the trunk folder content to a new tagged release using the command svn cp trunk tags/8.0.0 (replace 8.0.0 with the new version number)
5. Commit the work using the command svn ci -m "tagging version 8.0.0"

Note that the following command can be used to check which files are modified/added/deleted:

svn stat

Zip

To create a plugin zip file of a given branch/tag use:

git archive v8.1.0b4 --output="smart-send-shipping-woocommerce-v810b4.zip" "smart-send-logistics"

Development

When developing then it can sometimes be relevant to use Smart Send's development environment. This is done by implementing the following filter:

function smart_send_api_endpoint_callback( $endpoint ) {
  	if ($endpoint == 'https://app.smartsend.io/api/v1/') {
	  $endpoint = 'https://app.smartsend.dev/api/v1/';
	}
    return $endpoint;
}
add_filter( 'smart_send_api_endpoint', 'smart_send_api_endpoint_callback' );

An easy way to implement this is using the Code Snippets plugin and select Run snippet everywhere