kmatulewicz/sylius-baselinker

Baselinker API plugin for Sylius.

dev-master / 1.12.x-dev 2023-04-21 17:44 UTC

Requires

• php: ^8.0
• sylius/mailer-bundle: ^1.8 || ^2.0@beta
• sylius/sylius: ^1.12
• symfony/http-client: ^6.0
• symfony/webpack-encore-bundle: ^1.15

Requires (Dev)

• behat/behat: ^3.6.1
• behat/mink-selenium2-driver: ^1.4
• dmore/behat-chrome-extension: ^1.3
• dmore/chrome-mink-driver: ^2.7
• friends-of-behat/mink: ^1.8
• friends-of-behat/mink-browserkit-driver: ^1.4
• friends-of-behat/mink-debug-extension: ^2.0.0
• friends-of-behat/mink-extension: ^2.4
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.0
• friends-of-behat/symfony-extension: ^2.1
• friends-of-behat/variadic-extension: ^1.3
• matthiasnoback/symfony-dependency-injection-test: ^4.3
• phpspec/phpspec: ^7.2
• phpstan/extension-installer: ^1.0
• phpstan/phpstan: ^1.8.1
• phpstan/phpstan-doctrine: ^1.3.37
• phpstan/phpstan-strict-rules: ^1.3.0
• phpstan/phpstan-webmozart-assert: ^1.2.0
• phpunit/phpunit: ^9.5
• polishsymfonycommunity/symfony-mocker-container: ^1.0
• sylius-labs/coding-standard: ^4.2
• symfony/browser-kit: ^5.4 || ^6.0
• symfony/debug-bundle: ^5.4 || ^6.0
• symfony/dotenv: ^5.4 || ^6.0
• symfony/flex: ^2.2.2
• symfony/intl: ^5.4 || ^6.0
• symfony/web-profiler-bundle: ^5.4 || ^6.0
• theofidry/alice-data-fixtures: ^1.5
• vimeo/psalm: ^5.8.0

MIT

• sylius
• sylius-plugin
• baselinker
• baselinker-api

README

This plugin is work in progress, do not use this plugin to other purpose then testing, especially do not use this plugin in production environment.

How to test plugin

The fastest method to run dev environment is to use docker:

docker compose up -d
docker compose exec app make init

Change BL_TOKEN in tests/Application/.env. Now you can set plugin in admin panel on your localhost: http://localhost/admin, login is sylius, password is the same as login. You can run sync commands:

docker compose exec app make symfony baselinker:orders:add
docker compose exec app make symfony baselinker:orders:payments
docker compose exec app make symfony baselinker:orders:statuses

or tests:

docker compose exec app make test

Installation

The plugin can be installed in an existing or new sylius-standard application.

1. Run:

   composer require kmatulewicz/sylius-baselinker

2. Check presence of plugin entry in config/bundles.php:

   SyliusBaselinkerPlugin\SyliusBaselinkerPlugin::class => ['all' => true],
   

3. Add to config/packages/_sylius.yaml:

   - { resource: "@SyliusBaselinkerPlugin/Resources/config/config.yml" }

4. Add to config/routes.yaml:

   sylius_baselinker:
       resource: "@SyliusBaselinkerPlugin/Resources/config/routing.yml"

5. Add SyliusBaselinkerPlugin\Entity\OrderInterface and SyliusBaselinkerPlugin\Entity\OrderTrait to src/Entity/Order/Order.php. Final result should be similar to:

   // src/Entity/Order/Order.php
   // [...]
   use SyliusBaselinkerPlugin\Entity\OrderInterface;
   use SyliusBaselinkerPlugin\Entity\OrderTrait;
   // [...]
   class Order extends BaseOrder implements OrderInterface
   {
       use OrderTrait;
   }

6. Add BL_TOKEN to your .env file. Token can be found in Baselinker > My Account > API. If you do not have a token already, create a new one. Final result should be similar to:

   BL_TOKEN=token_copied_from_baselinker
   

7. Execute migrations:

   bin/console doctrine:migrations:migrate

8. Rebuild the cache to display all new translations correctly:

   bin/console cache:clear
   bin/console cache:warmup

9. Go to admin panel and set order source and statuses associations on Baselinker section.

Usage

This plugin provides commands:

1. baselinker:orders:add Adds not synchronized shop orders to Baselinker.
2. baselinker:orders:payments Adds to Baselinker payments done in shop after last synchronization.
3. baselinker:orders:statuses Checks for status changes of synchronized orders. Applies shop order status change to corresponding Baselinker status.