teamtnt/php-stripe-webhook-tester

A PHP package for testing Stripe Webhooks localy

PHP Stripe Webhook Tester

, _(*1)

The goal of this package is to make testing stripe webhooks easy on a local machine without the use of ngrok or other similar tunneling services. The package will simulate a post request to a specified endpoint with a json containing event data and make sure that your application reacts accordingly., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require TeamTNT/php-stripe-webhook-tester, <sub>(*4)</sub>

## Usage

``` php
$tester = new TeamTNT\Stripe\WebhookTester();
$tester->setVersion('2018-05-21');
$tester->setEndpoint('http://local.dev/stripe/webhooks');

$response = $tester->triggerEvent('charge.succeeded');

For your convenience you can use chained methods, <sub>(*5)</sub>

``` php $tester = new TeamTNT\Stripe\WebhookTester('http://local.dev/stripe/webhooks); $response = $tester->setVersion('2014-09-08')->triggerEvent('charge.succeeded');, <sub>(*6)</sub>

## Laravel Integration 
To implement this package with [Laravel Cashier](http://laravel.com/docs/5.1/billing), you will need to override the `eventExistsOnStripe()` method in `Laravel\Cashier\WebhookController` with something like this:

``` php
protected function eventExistsOnStripe($id)
{
    if(App::environment() == 'testing' or App::environment() == 'local') {
        return true;
    }
    try {
        return ! is_null(StripeEvent::retrieve($id, Config::get('services.stripe.secret')));
    } catch (Exception $e) {
        return false;
    }
}

Without the environment checks Cashier attempts to verify that the dummy event is a valid webhook with Stripe, which will obviously fail., <sub>(*7)</sub>

Available versions and events

Available versions and events can be found in the webhooks directory, <sub>(*8)</sub>

Testing

bash $ phpunit, <sub>(*9)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*10)</sub>

Credits

• Nenad Ticaric
• Sasa Tokic
• Jesse Schutt
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*11)</sub>