afrikpaysas/symfony-thirdparty-adapter

Symfony Third Party Adapter

1.0 2023-02-13 09:50 UTC

Requires

• php: >=8.1
• ext-ctype: *
• ext-iconv: *
• beberlei/doctrineextensions: ^1.3
• doctrine/doctrine-bundle: ^2.7
• doctrine/doctrine-fixtures-bundle: ^3.4
• doctrine/doctrine-migrations-bundle: ^3.2
• doctrine/orm: ^2.13
• friendsofsymfony/rest-bundle: ^3.4
• jms/serializer-bundle: ^4.2
• nelmio/api-doc-bundle: ^4.10
• sensio/framework-extra-bundle: ^6.2
• symfony/amqp-messenger: 5.4.*
• symfony/asset: 5.4.*
• symfony/console: 5.4.*
• symfony/dotenv: 5.4.*
• symfony/flex: ^1.17|^2
• symfony/framework-bundle: 5.4.*
• symfony/messenger: 5.4.*
• symfony/monolog-bundle: ^3.8
• symfony/proxy-manager-bridge: 5.4.*
• symfony/runtime: 5.4.*
• symfony/security-bundle: 5.4.*
• symfony/twig-bundle: 5.4.*
• symfony/validator: ^5.4
• symfony/yaml: 5.4.*
• twig/extra-bundle: ^2.12|^3.0
• twig/twig: ^2.12|^3.0

Requires (Dev)

• nunomaduro/phpinsights: ^2.6
• phpmd/phpmd: ^2.13
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.7
• symfony/browser-kit: 5.4.*
• symfony/css-selector: 5.4.*
• symfony/phpunit-bridge: ^6.2
• vimeo/psalm: ^5.4

Conflicts

• symfony/symfony: *

proprietary

• Willy DAMTCHOU

README

This Bundle is used for implement a symfony third party adapter. For better understanding use of this bundle, you can download sample project. see

https://github.com/afrikpaysas/symfony-thirdparty-adapter-console

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require afrikpaysas/symfony-thirdparty-adapter

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require afrikpaysas/symfony-thirdparty-adapter

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    Afrikpaysas\SymfonyThirdpartyAdapter\AfrikpaysasSymfonyThirdpartyAdapterBundle::class => ['all' => true],
];

Step 3: Configure error page

Then, configure the error url by adding it in the config/packages/framework.yaml file of your project:

# config/packages/framework.yaml

framework:
  error_controller: Afrikpaysas\SymfonyThirdpartyAdapter\Controller\ErrorController::error

#......

Step 4: Configure the routes

Then, configure the routes by adding it in the config/routes.yaml file of your project:

# config/routes_app.yaml

#......

afrikpaysas_thirdparty_adapter:
  resource: '@AfrikpaysasSymfonyThirdpartyAdapterBundle/Resources/config/routes.yaml'

#afrikpaysas_thirdparty_adapter_app:
#  resource: '@AfrikpaysasSymfonyThirdpartyAdapterBundle/Resources/config/routes_app.yaml'

#......

Step 5: Configure the documentation

Then, configure the documentation by adding it in the config/packages/nelmio_api_doc.yaml file of your project:

# config/packages/nelmio_api_doc.yaml

nelmio_api_doc:
  documentation:
    info:
      title: Third Party Adapter
      description: This is the documentation of third party adapter!
      version: 1.0.0

#......

Step 6: Configure the .env files

Then, configure the .env files by adding it in the .env file of your project:

# In all environments, the following files are loaded if they exist,
# the latter taking precedence over the former:
#
#  * .env                contains default values for the environment variables needed by the app
#  * .env.local          uncommitted file with local overrides
#  * .env.$APP_ENV       committed environment-specific defaults
#  * .env.$APP_ENV.local uncommitted environment-specific overrides
#
# Real environment variables win over .env files.
#
# DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
# https://symfony.com/doc/current/configuration/secrets.html
#
# Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
# https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration

###> symfony/framework-bundle ###
APP_ENV=dev
APP_DEBUG=1
APP_SECRET=""
SHOW_CONFIG=true
###< symfony/framework-bundle ###

###> symfony/security-bundle ###
HTTP_BASIC_AUTH_USERNAME=user
HTTP_BASIC_AUTH_PASSWORD=password
###< symfony/security-bundle ###

###> doctrine/doctrine-bundle ###
# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
#
# DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
DATABASE_URL="mysql://user:pssword@127.0.0.1:3306/db?serverVersion=5&charset=utf8mb4"
#DATABASE_URL="postgresql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=14&charset=utf8"
###< doctrine/doctrine-bundle ###

APP_CODE=00
APP_NAME=NAME

APP_DB_ID_LENGTH=16
TIME_ZONE=UTC
TIME_ZONE_PROVIDER=UTC
DEFAULT_DATE_TIME=now

MANUAL_MODE=false
ASYNC_MODE=false
SET_BALANCE_AFTER_PAYMENT=false

REFERENCE_REGEX="/^[0-9]{6,20}$/"

AMOUNT_ENABLED=false
AMOUNT_MIN=0
AMOUNT_MAX=0

PHONE_ENABLED=false
PHONE_REGEX="/^[0-9]{6,20}$/"

EMAIL_ENABLED=false

OPTION_ENABLED=false
OPTION_API_ENABLED=false
SEARCH_OPTION_WITH_REFERENCE=false
API_OPTION=""
OPTIONS_FILE="/config/options.yaml"
OPTION_PAY_ENABLED=false

REFERENCE_API_ENABLED=true
PAY_UNIQUE_REFERENCE=false
API_REFERENCE=""

API_PAYMENT=""
API_TOKEN=""
API_USERNAME_TOKEN=""
API_PASSWORD_TOKEN=""
API_DATE_FORMAT="Y-m-d H:i:s"

CURL_TIMEOUT=60
CURL_MAXREDIRS=10

ADMIN_PHONES=""
ADMIN_EMAILS=""
NOTIF_ADMIN_PHONES=false
NOTIF_ADMIN_EMAILS=false
NOTIF_SMS_MESSAGE=""
NOTIF_SMS_ADMIN_MESSAGE=""

SMS_ENABLED=false
SMS_SENDER=""
SMS_COUNTRY=""
SMS_SEPARATOR=";"
API_SMS=""

EMAIL_API_ENABLED=false
EMAIL_ADMIN_OBJECT=""
EMAIL_CLIENT_OBJECT=""
EMAIL_SENDER=""
EMAIL_SEPARATOR=";"
API_EMAIL=""
EMAIL_TEMPLATING_INLINE="<hr>"
EMAIL_TEMPLATING_OBJECT="List"

API_CALLBACK_TOKEN=""
API_CALLBACK_SIGNATURE_VARS=""
API_CALLBACK_SIGNATURE_SEPARATOR="+"
API_CALLBACK_SIGNATURE_SECRET=""
CALLBACK_URL_REGEX="/\b(?:(?:https?|ftp):\/\/|www\.)[-a-z0-9+&@#\/%?=~_|!:,.;]*[-a-z0-9+&@#\/%=~_|]/i"

###> symfony/messenger ###
# Choose one of the transports below
#MESSENGER_TRANSPORT_DSN=doctrine://default
MESSENGER_TRANSPORT_DSN=amqp://guest:guest@localhost:5672/%2f/messages
# MESSENGER_TRANSPORT_DSN=redis://localhost:6379/messages
###< symfony/messenger ###

Step 7: Configure messenger

Then, configure messenger by adding it in the config/packages/messenger.yaml file of your project:

# config/packages/messenger.yaml

framework:
  messenger:
    # reset services after consuming messages
    reset_on_message: true

    # Uncomment this (and the failed transport below) to send failed messages to this transport for later handling.
    # failure_transport: failed

    transports:
      # https://symfony.com/doc/current/messenger.html#transport-configuration
      set_balance:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 10
          max_delay: 0
      upload_provider_data:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 10
          max_delay: 0
      upload_provider_id:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 5
          delay: 1000
          multiplier: 5
          max_delay: 0
      update_reference_status:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 10
          max_delay: 0
      send_admin_email:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 60
          max_delay: 0
      send_admin_sms:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 60
          max_delay: 0
      send_client_email:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 60
          max_delay: 0
      send_client_sms:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 60
          max_delay: 0
      callback_message:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 60
          max_delay: 0
      update_status_message:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 10
          max_delay: 0
      log_message:
        dsn: '%env(MESSENGER_TRANSPORT_DSN)%'
        serializer: Afrikpaysas\SymfonyThirdpartyAdapter\Lib\Serializer\ExternalJsonMessageSerializer
        retry_strategy:
          max_retries: 3
          delay: 1000
          multiplier: 10
          max_delay: 0
    routing:
      # Route your messages to the transports
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\SetBalanceMessage': set_balance
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\UpdateProviderDataMessage': upload_provider_data
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\UpdateProviderIdMessage': upload_provider_id
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\UpdateReferenceStatusMessage': update_reference_status
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\SendAdminEmailMessage': send_admin_email
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\SendAdminSMSMessage': send_admin_sms
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\SendClientEmailMessage': send_client_sms
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\SendClientSMSMessage': send_client_email
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\CallbackMessage': callback_message
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\UpdateStatusMessage': update_status_message
      'Afrikpaysas\SymfonyThirdpartyAdapter\Messenger\Message\LogMessage': log_message
#......

Step 8: Run the application

Then, run the application:

composer install && php bin/console cache:clear && symfony console doctrine:schema:update -f && symfony server:start

Step 9: Run messenger consumer

Then, run messenger:

symfony console messenger:consume set_balance upload_provider_data upload_provider_id update_reference_status send_admin_email send_admin_sms send_client_sms send_client_email callback_message update_status_message log_message -vv