symfony omnipay bundle commit

Author: janwebdev

.gitignore

@@ -1,52 +1,4 @@
-# Cache and logs (Symfony2)
-/app/cache/*
-/app/logs/*
-!app/cache/.gitkeep
-!app/logs/.gitkeep
-
-# Email spool folder
-/app/spool/*
-
-# Cache, session files and logs (Symfony3)
-/var/cache/*
-/var/logs/*
-/var/sessions/*
-!var/cache/.gitkeep
-!var/logs/.gitkeep
-!var/sessions/.gitkeep
-
-# Logs (Symfony4)
-/var/log/*
-!var/log/.gitkeep
-
-# Parameters
-/app/config/parameters.yml
-/app/config/parameters.ini
-
-# Managed by Composer
-/app/bootstrap.php.cache
-/var/bootstrap.php.cache
-/bin/*
-!bin/console
-!bin/symfony_requirements
+/.idea
 /vendor/
-
-# Assets and user uploads
-/web/bundles/
-/web/uploads/
-
-# PHPUnit
-/app/phpunit.xml
-/phpunit.xml
-
-# Build data
-/build/
-
-# Composer PHAR
 /composer.phar
-
-# Backup entities generated with doctrine:generate:entities command
-**/Entity/*~
-
-# Embedded web-server pid file
-/.web-server-pid
+.phpunit.result.cache

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2022-06-06
+
+### Added
+- 1st release

DependencyInjection/Compiler/GatewayTagCompilerPass.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Janwebdev\OmnipayBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class GatewayTagCompilerPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasDefinition('omnipay')) {
+            return;
+        }
+
+        $definition = $container->findDefinition('omnipay');
+
+        $taggedGateways = $container->findTaggedServiceIds('omnipay.gateway');
+        foreach ($taggedGateways as $id => $tags) {
+            foreach ($tags as $tag) {
+                $args = [new Reference($id)];
+
+                // Reference the gateway by the alias if provided
+                if (isset($tag['alias'])) {
+                    $args[] = $tag['alias'];
+                }
+
+                $definition->addMethodCall('registerGateway', $args);
+            }
+        }
+    }
+}

DependencyInjection/Configuration.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Janwebdev\OmnipayBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder('omnipay');
+        $rootNode = $treeBuilder->getRootNode();
+
+        $rootNode
+            ->children()
+                ->arrayNode('gateways')
+                    ->useAttributeAsKey('name')
+                        ->prototype('variable')
+                    ->end()
+                ->end()
+                ->scalarNode('default')
+                    ->defaultNull()
+                ->end()
+                ->booleanNode('init_on_boot')
+                    ->defaultFalse()
+                ->end()
+                ->arrayNode('disabled')
+                    ->prototype('scalar')
+                ->end()
+            ->end();
+
+        return $treeBuilder;
+    }
+}

DependencyInjection/OmnipayExtension.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Janwebdev\OmnipayBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\DependencyInjection\Loader;
+
+class OmnipayExtension extends Extension
+{
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $configuration = new Configuration();
+        $config = $this->processConfiguration($configuration, $configs);
+
+        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
+        $loader->load('services.yaml');
+
+        $gateways = $config['gateways'];
+        $gatewayNames = array_keys($gateways);
+
+        // Add configuration to the Omnipay service
+        $omnipay = $container->getDefinition('omnipay');
+        $omnipay->setPublic(true);
+        $omnipay->addArgument($gateways);
+
+        if ($disabledGateways = $config['disabled']) {
+            $omnipay->addMethodCall('setDisabledGateways', [$disabledGateways]);
+        }
+
+        if ($defaultGateway = $config['default']) {
+            $allowedValues = array_diff($gatewayNames, $disabledGateways);
+
+            if (!in_array($defaultGateway, $gatewayNames, true)) {
+                throw new InvalidConfigurationException(sprintf(
+                    'You cannot specify non-existing gateway (%s) as default. Allowed values: %s',
+                    $defaultGateway,
+                    implode(', ', $allowedValues)
+                ));
+            }
+
+            if (in_array($defaultGateway, $disabledGateways, true)) {
+                throw new InvalidConfigurationException(sprintf(
+                    'You cannot specify disabled gateway (%s) as default. Allowed values: %s',
+                    $defaultGateway,
+                    implode(', ', $allowedValues)
+                ));
+            }
+
+            $omnipay->addMethodCall('setDefaultGatewayName', [$defaultGateway]);
+        }
+
+        if ($initOnBoot = $config['init_on_boot']) {
+            $omnipay->addMethodCall('initOnBoot', [$initOnBoot]);
+        }
+    }
+}

Manager/OmnipayManager.php

@@ -0,0 +1,119 @@
+<?php
+
+namespace Janwebdev\OmnipayBundle\Manager;
+
+use Omnipay\Common\Http\Client;
+use Omnipay\Common\GatewayFactory;
+use Omnipay\Common\GatewayInterface;
+use Omnipay\Common\Helper;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
+
+class OmnipayManager
+{
+    /**
+     * @var GatewayFactory
+     */
+    protected GatewayFactory $gatewayFactory;
+
+    /**
+     * @var array
+     */
+    protected array $config;
+
+    /**
+     * @var GatewayInterface[]
+     */
+    protected array $storage;
+
+    /**
+     * @var GatewayInterface[]
+     */
+    protected array $registeredGateways = [];
+
+    /**
+     * @var string[]
+     */
+    protected array $disabledGateways = [];
+
+    /**
+     * @var string|null
+     */
+    protected ?string $defaultGatewayName = null;
+
+    /**
+     * @var bool
+     */
+    protected bool $initOnBoot = false;
+
+    public function __construct(GatewayFactory $gatewayFactory, array $config = [])
+    {
+        $this->gatewayFactory = $gatewayFactory;
+        $this->config = $config;
+    }
+
+    public function get(string $gatewayName): GatewayInterface
+    {
+        if (!isset($this->storage[$gatewayName])) {
+            $gateway = $this->createGateway($gatewayName);
+            $this->storage[$gatewayName] = $gateway;
+        }
+
+        return $this->storage[$gatewayName];
+    }
+
+    protected function createGateway(string $gatewayName): GatewayInterface
+    {
+        if (isset($this->registeredGateways[$gatewayName])) {
+            $gateway = $this->registeredGateways[$gatewayName];
+        } else {
+            $gateway = $this->gatewayFactory->create($gatewayName, new Client());
+        }
+
+        return $gateway->initialize($this->getGatewayConfig($gatewayName));
+    }
+
+    protected function getGatewayConfig(string $gatewayName): array
+    {
+        return $this->config[$gatewayName] ?? [];
+    }
+
+    public function registerGateway(GatewayInterface $gatewayInstance, ?string $alias = null): void
+    {
+        $name = $alias ?? Helper::getGatewayClassName(get_class($gatewayInstance));
+
+        if (in_array($name, $this->disabledGateways, true)) {
+            return;
+        }
+
+        $this->registeredGateways[$name] = $gatewayInstance;
+
+        if ($this->initOnBoot) {
+            $gatewayInstance->initialize($this->getGatewayConfig($name));
+            $this->storage[$name] = $gatewayInstance;
+        }
+    }
+
+    public function setDisabledGateways(array $disabledGateways): void
+    {
+        $this->disabledGateways = $disabledGateways;
+    }
+
+    public function getDefaultGateway(): GatewayInterface
+    {
+        if (null === $this->defaultGatewayName) {
+            throw new InvalidConfigurationException('Default gateway is not configured');
+        }
+
+        return $this->get($this->defaultGatewayName);
+    }
+
+    public function setDefaultGatewayName(string $defaultGatewayName): void
+    {
+        $this->defaultGatewayName = $defaultGatewayName;
+    }
+
+    public function initOnBoot(bool $initOnBoot): void
+    {
+        $this->initOnBoot = $initOnBoot;
+    }
+}

OmnipayBundle.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Janwebdev\OmnipayBundle;
+
+use Janwebdev\OmnipayBundle\DependencyInjection\Compiler\GatewayTagCompilerPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class OmnipayBundle extends Bundle
+{
+    public function build(ContainerBuilder $container): void
+    {
+        parent::build($container);
+
+        $container->addCompilerPass(new GatewayTagCompilerPass());
+    }
+}