Merge pull request #4 from getsolaris/feat/webhook

webhook

Author: getsolaris

README.md

@@ -76,6 +76,29 @@ Basic 인증 방식은 `{SECRET_KEY}:` 를 Base64 인코딩 한 값을 사용합
 
 [예제 보기](examples/PROMOTION.md)
 
+## [웹훅 (Webhook) 연동하기](https://docs.tosspayments.com/guides/webhook#%EC%9B%B9%ED%9B%85webhook-%EC%97%B0%EB%8F%99%ED%95%98%EA%B8%B0)
+
+웹훅을 사용하기 전에 토스페이먼츠 개발자센터 웹훅 페이지에서 웹훅을 등록해주세요.
+
+웹훅을 이용하기 전에 `config/tosspayments.php` 파일에서 `webhook` 설정을 확인해주세요.
+
+```
+'webhook' => [
+    'handler' => [
+        'controller' => \App\Http\Controllers\WebhookController::class,
+        'method' => '__invoke',
+    ],
+],
+```
+
+`handler` 설정을 변경하여 웹훅을 처리할 컨트롤러와 메소드를 지정할 수 있습니다.
+
+또한 아래의 명령어를 실행하여 기본 라우트 설정값인 `url/webhooks/tosspayments` 를 변경할 수 있습니다.
+
+```bash
+php artisan vendor:publish --provider="Getsolaris\LaravelTossPayments\TossPaymentsServiceProvider" --tag="webhook"
+```
+
 
 ## [테스트 코드 사용하기](https://docs.tosspayments.com/reference/error-codes#%EC%97%90%EB%9F%AC-%EC%BD%94%EB%93%9C)
 

config/toss-payments.php renamed to config/tosspayments.php

@@ -7,4 +7,11 @@
     'secret_key' => env('TOSS_PAYMENTS_SECRET_KEY'),
     'content_type' => 'application/json',
     'accept' => 'application/json',
+
+    'webhook' => [
+        'handler' => [
+            'controller' => \App\Http\Controllers\WebhookController::class,
+            'method' => '__invoke',
+        ],
+    ],
 ];

routes/tosspayments.php

@@ -0,0 +1,5 @@
+<?php
+
+use Getsolaris\LaravelTossPayments\Handlers\TossPaymentsWebhookHandler;
+
+Route::post('webhooks/tosspayments', [TossPaymentsWebhookHandler::class, '__invoke']);

src/Exceptions/WebhookPayloadException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Getsolaris\LaravelTossPayments\Exceptions;
+
+class WebhookPayloadException extends \Exception
+{
+    protected $message = 'Webhook 의 Payload 정보가 올바르지 않습니다.';
+}

src/Handlers/TossPaymentsWebhookHandler.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Getsolaris\LaravelTossPayments\Handlers;
+
+use Getsolaris\LaravelTossPayments\Exceptions\WebhookPayloadException;
+
+class TossPaymentsWebhookHandler
+{
+    /**
+     * @throws WebhookPayloadException
+     * @throws \ReflectionException
+     */
+    public function __invoke()
+    {
+        $payload = json_decode(request()->getContent(), true);
+
+        if (! $payload) {
+            throw new WebhookPayloadException();
+        }
+
+        $target = new \ReflectionClass(config('tosspayments.webhook.handler.controller'));
+        $method = config('tosspayments.webhook.handler.method');
+
+        return $target->newInstance()->$method($payload);
+    }
+}

src/TossPayments.php

@@ -91,8 +91,8 @@ public function __call($name, $arguments)
      */
     protected function initializeApiUrl(): static
     {
-        $this->endpoint = config('toss-payments.endpoint');
-        $this->version = config('toss-payments.version');
+        $this->endpoint = config('tosspayments.endpoint');
+        $this->version = config('tosspayments.version');
         $this->url = $this->endpoint.'/'.$this->version;
 
         return $this;
@@ -103,8 +103,8 @@ protected function initializeApiUrl(): static
      */
     protected function initializeKeys(): static
     {
-        $this->clientKey = config('toss-payments.client_key');
-        $this->secretKey = config('toss-payments.secret_key');
+        $this->clientKey = config('tosspayments.client_key');
+        $this->secretKey = config('tosspayments.secret_key');
 
         return $this;
     }

src/TossPaymentsServiceProvider.php

@@ -9,7 +9,7 @@ class TossPaymentsServiceProvider extends ServiceProvider
     /**
      * @var string
      */
-    private string $name = 'toss-payments';
+    private string $name = 'tosspayments';
 
     /**
      * @return void
@@ -31,5 +31,11 @@ public function boot(): void
         $this->publishes([
             __DIR__."/../config/{$this->name}.php" => config_path($this->name.'.php'),
         ], 'config');
+
+        $this->publishes([
+            __DIR__."/../routes/{$this->name}.php" => base_path('routes/'.$this->name.'.php'),
+        ], 'webhook');
+
+        $this->loadRoutesFrom(__DIR__."/../routes/{$this->name}.php");
     }
 }

tests/WebhookTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Getsolaris\LaravelTossPayments\tests;
+
+use PHPUnit\Framework\TestCase;
+
+class WebhookTest extends TestCase
+{
+    public function testWebhook(): void
+    {
+        $payload = $this->getData();
+
+        $this->assertIsArray($payload);
+        $this->assertArrayHasKey('eventType', $payload);
+        $this->assertArrayHasKey('createdAt', $payload);
+        $this->assertArrayHasKey('data', $payload);
+        $this->assertIsArray($payload['data']);
+    }
+
+    /**
+     * @return array
+     */
+    private function getData(): array
+    {
+        $payload = '{
+          "eventType": "PAYMENT_STATUS_CHANGED",
+          "createdAt": "2022-01-01T00:00:00.000000",
+          "data": {}
+        }';
+
+        return json_decode($payload, true);
+    }
+}