Merge pull request #104 from tanhongit/main

tanhongit · web-flow · commit cfb0366517f7 · 2023-11-08T10:28:30.000+07:00
fix: update webhook request with exceptions
diff --git a/.docker/conf.d/site.conf b/.docker/conf.d/site.conf
@@ -1,9 +1,9 @@
 server {
     listen 80;
-    server_name telegram-nofity-bot.com;
+    server_name telegram-git-notifier.com;
 
-    error_log  /var/log/nginx/telegram-nofity-bot-error.log;
-    access_log /var/log/nginx/telegram-nofity-bot-access.log;
+    error_log  /var/log/nginx/telegram-git-notifier-error.log;
+    access_log /var/log/nginx/telegram-git-notifier-access.log;
 
     root /var/www/html/;
     index index.php index.html index.htm;
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -3,6 +3,7 @@
 $finder = Symfony\Component\Finder\Finder::create()
     ->in([
         __DIR__ . '/src',
+        __DIR__ . '/webhooks',
     ])
     ->name('*.php')
     ->ignoreDotFiles(true)
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Tan Nguyen
+Copyright (c) 2023 CSlant
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -11,6 +11,8 @@ and manage customization through messages and buttons on Telegram.
 
 ![License](https://img.shields.io/github/license/cslant/telegram-git-notifier-app.svg?style=flat-square)
 [![Latest Version](https://img.shields.io/github/release/cslant/telegram-git-notifier-app.svg?style=flat-square)](https://github.com/cslant/telegram-git-notifier-app/releases)
+![Test Status](https://img.shields.io/github/actions/workflow/status/cslant/telegram-git-notifier-app/setup_test.yml?label=tests&branch=main)
+![Code Style Status](https://img.shields.io/github/actions/workflow/status/cslant/telegram-git-notifier-app/php-cs-fixer.yml?label=code%20style&branch=main)
 [![StyleCI](https://styleci.io/repos/656960426/shield)](https://styleci.io/repos/656960426)
 [![Quality Score](https://img.shields.io/scrutinizer/g/cslant/telegram-git-notifier-app.svg?style=flat-square)](https://scrutinizer-ci.com/g/cslant/telegram-git-notifier-app)
 [![Maintainability](https://api.codeclimate.com/v1/badges/7ccaccebe9cd58ff3df5/maintainability)](https://codeclimate.com/github/cslant/telegram-git-notifier-app/maintainability)
@@ -131,7 +133,7 @@ TGN_APP_URL=https://123456789.ngrok.io
 
 1. Open a chat with your bot.
 2. Send any message to your bot. (This handle needs to get your chat ID)
-3. Go to the following URL: `<TGN_APP_URL>/webhook/getUpdate.php`
+3. Go to the following URL: `<TGN_APP_URL>/webhooks/getUpdate.php`
 4. Look for the `"chat":{"id":` field and copy the number after it. This is your Chat ID.
 5. Paste the Chat ID in your `.env` file.
 
@@ -240,7 +242,7 @@ TGN_APP_URL=https://123456789.ngrok-free.app
 
 1. Open a chat with your bot.
 2. Send any message to your bot. (This handle needs to get your chat ID)
-3. Go to the following URL: `<TGN_APP_URL>/webhook/getUpdate.php`
+3. Go to the following URL: `<TGN_APP_URL>/webhooks/getUpdate.php`
 4. Look for the `"chat":{"id":` field and copy the number after it. This is your Chat ID.
 5. Paste the Chat ID in your `.env` file.
 
@@ -261,7 +263,7 @@ After setting up your domain and SSL certificate, you need to set up the webhook
 **Go to:**
 
 ```text
-<APP_URL>/webhook/set.php
+<APP_URL>/webhooks/set.php
 ```
 
 > **Note:** Replace `<APP_URL>` with your app URL in .env file.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -2,5 +2,6 @@ parameters:
     level: 8
     paths:
         - src
+        - webhooks
     tmpDir: build/phpstan
     checkMissingIterableValueType: false
diff --git a/src/Http/Actions/IndexAction.php b/src/Http/Actions/IndexAction.php
@@ -3,6 +3,9 @@
 namespace CSlant\TelegramGitNotifierApp\Http\Actions;
 
 use CSlant\TelegramGitNotifier\Bot;
+use CSlant\TelegramGitNotifier\Exceptions\BotException;
+use CSlant\TelegramGitNotifier\Exceptions\CallbackException;
+use CSlant\TelegramGitNotifier\Exceptions\ConfigFileException;
 use CSlant\TelegramGitNotifier\Exceptions\EntryNotFoundException;
 use CSlant\TelegramGitNotifier\Exceptions\InvalidViewTemplateException;
 use CSlant\TelegramGitNotifier\Exceptions\MessageIsEmptyException;
@@ -25,6 +28,9 @@ class IndexAction
 
     protected Request $request;
 
+    /**
+     * @throws ConfigFileException
+     */
     public function __construct()
     {
         $this->client = new Client();
@@ -38,10 +44,12 @@ public function __construct()
      * Handle telegram git notifier app
      *
      * @return void
-     * @throws InvalidViewTemplateException
-     * @throws SendNotificationException
      * @throws EntryNotFoundException
+     * @throws InvalidViewTemplateException
      * @throws MessageIsEmptyException
+     * @throws SendNotificationException
+     * @throws BotException
+     * @throws CallbackException
      */
     public function __invoke(): void
     {
diff --git a/src/Http/Actions/WebhookAction.php b/src/Http/Actions/WebhookAction.php
@@ -2,6 +2,7 @@
 
 namespace CSlant\TelegramGitNotifierApp\Http\Actions;
 
+use CSlant\TelegramGitNotifier\Exceptions\WebhookException;
 use CSlant\TelegramGitNotifier\Webhook;
 
 class WebhookAction
@@ -20,29 +21,32 @@ public function __construct()
     /**
      * Set webhook for telegram bot
      *
-     * @return false|string
+     * @return string
+     * @throws WebhookException
      */
-    public function set(): false|string
+    public function set(): string
     {
         return $this->webhook->setWebhook();
     }
 
     /**
      * Delete webhook for telegram bot
      *
-     * @return false|string
+     * @return string
+     * @throws WebhookException
      */
-    public function delete(): false|string
+    public function delete(): string
     {
         return $this->webhook->deleteWebHook();
     }
 
     /**
      * Get webhook update
      *
-     * @return false|string
+     * @return string
+     * @throws WebhookException
      */
-    public function getUpdates(): false|string
+    public function getUpdates(): string
     {
         return $this->webhook->getUpdates();
     }
diff --git a/src/Services/CallbackService.php b/src/Services/CallbackService.php
@@ -4,6 +4,8 @@
 
 use CSlant\TelegramGitNotifier\Bot;
 use CSlant\TelegramGitNotifier\Constants\SettingConstant;
+use CSlant\TelegramGitNotifier\Exceptions\BotException;
+use CSlant\TelegramGitNotifier\Exceptions\CallbackException;
 use CSlant\TelegramGitNotifier\Exceptions\InvalidViewTemplateException;
 use CSlant\TelegramGitNotifier\Exceptions\MessageIsEmptyException;
 use CSlant\TelegramGitNotifierApp\Traits\Markup;
@@ -26,6 +28,8 @@ public function __construct(Bot $bot)
      *
      * @return void
      * @throws MessageIsEmptyException
+     * @throws BotException
+     * @throws CallbackException
      */
     public function answerBackButton(string $callback): void
     {
@@ -67,6 +71,7 @@ public function answerBackButton(string $callback): void
      * @return void
      * @throws MessageIsEmptyException
      * @throws InvalidViewTemplateException
+     * @throws BotException|CallbackException
      */
     public function handle(): void
     {
diff --git a/webhook/delete.php b/webhook/delete.php
diff --git a/webhook/getUpdate.php b/webhook/getUpdate.php
diff --git a/webhook/set.php b/webhook/set.php
diff --git a/webhooks/delete.php b/webhooks/delete.php
@@ -0,0 +1,14 @@
+<?php
+
+use CSlant\TelegramGitNotifier\Exceptions\WebhookException;
+use CSlant\TelegramGitNotifierApp\Http\Actions\WebhookAction;
+
+require __DIR__ . '/../init.php';
+
+$webhookAction = new WebhookAction();
+
+try {
+    echo $webhookAction->delete();
+} catch (WebhookException $e) {
+    echo $e->getMessage();
+}
diff --git a/webhooks/getUpdate.php b/webhooks/getUpdate.php
@@ -0,0 +1,14 @@
+<?php
+
+use CSlant\TelegramGitNotifier\Exceptions\WebhookException;
+use CSlant\TelegramGitNotifierApp\Http\Actions\WebhookAction;
+
+require __DIR__ . '/../init.php';
+
+$webhookAction = new WebhookAction();
+
+try {
+    echo $webhookAction->getUpdates();
+} catch (WebhookException $e) {
+    echo $e->getMessage();
+}
diff --git a/webhooks/set.php b/webhooks/set.php
@@ -0,0 +1,14 @@
+<?php
+
+use CSlant\TelegramGitNotifier\Exceptions\WebhookException;
+use CSlant\TelegramGitNotifierApp\Http\Actions\WebhookAction;
+
+require __DIR__ . '/../init.php';
+
+$webhookAction = new WebhookAction();
+
+try {
+    echo $webhookAction->set();
+} catch (WebhookException $e) {
+    echo $e->getMessage();
+}

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace CSlant\TelegramGitNotifierApp\Http\Actions;`
`4`	`4`
	`5`	`+use CSlant\TelegramGitNotifier\Exceptions\WebhookException;`
`5`	`6`	`use CSlant\TelegramGitNotifier\Webhook;`
`6`	`7`
`7`	`8`	`class WebhookAction`
`@@ -20,29 +21,32 @@ public function __construct()`
`20`	`21`	`/**`
`21`	`22`	`* Set webhook for telegram bot`
`22`	`23`	`*`
`23`		`- * @return false\|string`
	`24`	`+ * @return string`
	`25`	`+ * @throws WebhookException`
`24`	`26`	`*/`
`25`		`- public function set(): false\|string`
	`27`	`+ public function set(): string`
`26`	`28`	`{`
`27`	`29`	`return $this->webhook->setWebhook();`
`28`	`30`	`}`
`29`	`31`
`30`	`32`	`/**`
`31`	`33`	`* Delete webhook for telegram bot`
`32`	`34`	`*`
`33`		`- * @return false\|string`
	`35`	`+ * @return string`
	`36`	`+ * @throws WebhookException`
`34`	`37`	`*/`
`35`		`- public function delete(): false\|string`
	`38`	`+ public function delete(): string`
`36`	`39`	`{`
`37`	`40`	`return $this->webhook->deleteWebHook();`
`38`	`41`	`}`
`39`	`42`
`40`	`43`	`/**`
`41`	`44`	`* Get webhook update`
`42`	`45`	`*`
`43`		`- * @return false\|string`
	`46`	`+ * @return string`
	`47`	`+ * @throws WebhookException`
`44`	`48`	`*/`
`45`		`- public function getUpdates(): false\|string`
	`49`	`+ public function getUpdates(): string`
`46`	`50`	`{`
`47`	`51`	`return $this->webhook->getUpdates();`
`48`	`52`	`}`