Merge pull request #59 from amcintosh/webhook-verify-resend

✨ Handle webhook callback verification, resend

README.md

@@ -472,6 +472,12 @@ To run all tests:
 make test
 ```
 
+Run a specific test:
+
+```shell
+ ./vendor/bin/phpunit --filter testCreateValidationError
+```
+
 ### Documentations
 
 You can generate the documentation via:

src/FreshBooksClient.php

@@ -307,7 +307,7 @@ public function taxes(): AccountingResource
 
     /**
      * FreshBooks callbacks (webhook callbacks) resource with calls to
-     * get, list, create, update, delete, resend_verification, verify
+     * get, list, create, update, delete, verify, resendVerification
      *
      * @return EventsResource
      */

src/Resource/AccountingResource.php

@@ -62,7 +62,7 @@ protected function getUrl(string $accountId, int $resourceId = null): string
      * @param  array $data
      * @return array
      */
-    private function makeRequest(string $method, string $url, array $data = null): array
+    protected function makeRequest(string $method, string $url, array $data = null): array
     {
         if (!is_null($data)) {
             $data = json_encode($data);

src/Resource/EventsResource.php

@@ -64,4 +64,36 @@ protected function handleError(int $statusCode, array $responseData, string $raw
         var_dump($details);
         throw new FreshBooksException($message, $statusCode, null, $rawRespone, $errorCode, $details);
     }
+
+    /**
+     * Tell FreshBooks to resend the verification webhook for the callback
+     *
+     * @param  string $accountId The alpha-numeric account id
+     * @param  int $resourceId Id of the resource to update
+     * @return DataTransferObject Model of the updated resource's response data.
+     */
+    public function resendVerification(string $accountId, int $resourceId): DataTransferObject
+    {
+        $data = array($this->singleModel::RESPONSE_FIELD => array("resend" => true));
+        $result = $this->makeRequest(self::PUT, $this->getUrl($accountId, $resourceId), $data);
+        return new $this->singleModel($result[$this->singleModel::RESPONSE_FIELD]);
+    }
+
+    /**
+     * Verify webhook callback by making a put request
+     *
+     * @param  string $accountId The alpha-numeric account id
+     * @param  int $resourceId Id of the resource to update
+     * @param  string The string verifier received by the webhook callback URI
+     * @return DataTransferObject Model of the updated resource's response data.
+     */
+    public function verify(
+        string $accountId,
+        int $resourceId,
+        string $verifier,
+    ): DataTransferObject {
+        $data = array($this->singleModel::RESPONSE_FIELD => array("verifier" => $verifier));
+        $result = $this->makeRequest(self::PUT, $this->getUrl($accountId, $resourceId), $data);
+        return new $this->singleModel($result[$this->singleModel::RESPONSE_FIELD]);
+    }
 }

tests/Resource/EventsResourceTest.php

@@ -117,4 +117,46 @@ public function testCreateValidationError(): void
             ]], $e->getErrorDetails());
         }
     }
+
+    public function testVerify(): void
+    {
+        $callbackId = 12345;
+        $mockHttpClient = $this->getMockHttpClient(
+            200,
+            ['response' => ['result' => ['callback' => [
+                'callbackid' => $callbackId,
+                'verified' => true
+            ]]]]
+        );
+
+        $resource = new EventsResource($mockHttpClient, 'events/callbacks', Callback::class, CallbackList::class);
+        $callback = $resource->verify($this->accountId, $callbackId, 'some_verifier');
+
+        $this->assertSame($callbackId, $callback->callbackId);
+
+        $request = $mockHttpClient->getLastRequest();
+        $this->assertSame('PUT', $request->getMethod());
+        $this->assertSame('/events/account/ACM123/events/callbacks/12345', $request->getRequestTarget());
+    }
+
+    public function testResend(): void
+    {
+        $callbackId = 12345;
+        $mockHttpClient = $this->getMockHttpClient(
+            200,
+            ['response' => ['result' => ['callback' => [
+                'callbackid' => $callbackId,
+                'verified' => true
+            ]]]]
+        );
+
+        $resource = new EventsResource($mockHttpClient, 'events/callbacks', Callback::class, CallbackList::class);
+        $callback = $resource->resendVerification($this->accountId, $callbackId);
+
+        $this->assertSame($callbackId, $callback->callbackId);
+
+        $request = $mockHttpClient->getLastRequest();
+        $this->assertSame('PUT', $request->getMethod());
+        $this->assertSame('/events/account/ACM123/events/callbacks/12345', $request->getRequestTarget());
+    }
 }