freshcells/soap-client-bundle

SoapClientBundle for symfony

3.0.0 2024-06-05 15:33 UTC

Requires

• php: ^8.1
• ext-soap: *
• psr/log: ^1.1 || ^2 || ^3
• ramsey/uuid: ^3.7 || ^4
• symfony/config: ^5.4 || ^6.4 || ^7.0
• symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
• symfony/event-dispatcher: ^5.4 || ^6.4 || ^7.0
• symfony/http-kernel: ^5.4 || ^6.4 || ^7.0

Requires (Dev)

• colinodell/psr-testlogger: ^1.3
• phpunit/phpunit: ^9
• squizlabs/php_codesniffer: ^3.10
• symfony/browser-kit: ^5.4 || ^6.4 || ^7.0
• symfony/debug-bundle: ^5.4 || ^6.4 || ^7.0
• symfony/framework-bundle: ^5.4 || ^6.4 || ^7.0
• symfony/phpunit-bridge: ^5.4 || ^6.4 || ^7.0
• symfony/web-profiler-bundle: ^5.4 || ^6.4 || ^7.0
• symfony/yaml: ^5.4 || ^6.4 || ^7.0

MIT

• Freshcells engineering
• Ivo Bathke

• soap
• soap-client
• symfony-bundle
• freshcells

README

Symfony integration for an advanced SoapClient.

Features

• Logging of requests, responses and faults
• XML can be anonymized before logging
• DataCollector and symfony profiler integration
• Events are dispatched before, after requests and in case of SoapFault
• Provide mock requests and responses while testing and developing

Install

Via Composer

$ composer require freshcells/soap-client-bundle

Usage

Initalize the bundle:

freshcells_soap_client:
  logger: monolog.logger.soap
  anonymize_logs: # in case you need to anonymize certain elements in the xml logs
    elements:
      - 'GivenName'
      - 'ns1:GivenName'
    attributes: [ 'PhoneNumber' ]
    namespaces:
      dummy: 'http://gcomputer.net/webservices/'
  truncate_element_logs: # in case you need to truncate some elements because values are too long for logging
    elements:
      - 'DailyDilbertResult'
    namespaces:
      dummy: 'http://gcomputer.net/webservices/'
    max_length: 2
  truncate_logs: # in case you need to truncate request/response logs
    max_length: 350

Create a Soap Client service and tag it with freshcells_soap_client.client

parameters:
    mock_requests:
        'http://gcomputer.net/webservices/DailyDilbert': './tests/Fixtures/MockRequest.xml'
    mock_responses:
        'http://gcomputer.net/webservices/DailyDilbert': './tests/Fixtures/MockResponse.xml'
    soap_options:
        mock_requests: '%mock_requests%'
        mock_responses: '%mock_responses%'
services:
    _instanceof:
        Freshcells\SoapClientBundle\SoapClient\SoapClient:
            tags: [ 'freshcells_soap_client.client' ]

    Freshcells\SoapClientBundle\SoapClient\SoapClient:
        arguments: ['%soap_wsdl%', '%soap_options%']
        public: true

SoapClients are created outside of the bundle to give more flexibility, f.e when using generators like https://github.com/wsdl2phpgenerator/wsdl2phpgenerator.
The bundle provides an advanced SoapClient that takes care of dispatching events, mocking and error handling.
Make sure that you use this client or extend from it.

$response = $this->container->get('Freshcells\SoapClientBundle\SoapClient\SoapClient')->DailyDilbert();

Note:
Mock requests can also be detected by a callable in case if Action and Location are not different by request, which is the case with some Soap servers. See tests for implementation.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Todo

• add to timeline in profiler
• mock indicator
• make middlewares
• error / soap fault indicator in accordion header
• use options-resolver

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Freshcells engineering
• All Contributors

License

The MIT License (MIT). Please see License File for more information.