Add api base uri support for web bridge.

- Revise README with instructions for Proxy or Bridge support.
- Remove redundant test.
- Fix test typo.

Author: irazasyed

README.md

@@ -51,13 +51,17 @@ Then, configure your Telegram Bot API Token:
 
 ```php
 // config/services.php
-...
 'telegram-bot-api' => [
     'token' => env('TELEGRAM_BOT_TOKEN', 'YOUR BOT TOKEN HERE')
 ],
-...
 ```
 
+#### (Optional) Proxy or Bridge Support
+
+You may not be able to send notifications if Telegram Bot API is not accessible in your country, 
+you can either set a proxy by following the instructions [here](http://docs.guzzlephp.org/en/stable/quickstart.html#environment-variables) or 
+use a web bridge by setting the `base_uri` config above with the bridge uri.
+
 ## Usage
 
 You can now use the channel in your `via()` method inside the Notification class.

composer.json

@@ -19,7 +19,8 @@
         }
     ],
     "require": {
-        "php": "^7.1",
+        "php": ">=7.1",
+        "ext-json": "*",
         "guzzlehttp/guzzle": "^6.2",
         "illuminate/notifications": "^5.5 || ^6.0 || ^7.0",
         "illuminate/support": "^5.5 || ^6.0 || ^7.0"

src/Exceptions/CouldNotSendNotification.php

@@ -54,14 +54,4 @@ public static function couldNotCommunicateWithTelegram($message): self
     {
         return new static("The communication with Telegram failed. `{$message}`");
     }
-
-    /**
-     * Thrown when there is no chat id provided.
-     *
-     * @return static
-     */
-    public static function chatIdNotProvided(): self
-    {
-        return new static('Telegram notification chat ID was not provided. Please refer usage docs.');
-    }
 }

src/Telegram.php

@@ -17,17 +17,22 @@ class Telegram
     /** @var HttpClient HTTP Client */
     protected $http;
 
-    /** @var null|string Telegram Bot API Token. */
+    /** @var string|null Telegram Bot API Token. */
     protected $token;
 
+    /** @var string Telegram Bot API Base URI */
+    protected $apiBaseUri;
+
     /**
-     * @param null            $token
+     * @param string|null     $token
      * @param HttpClient|null $httpClient
+     * @param string|null     $apiBaseUri
      */
-    public function __construct($token = null, HttpClient $httpClient = null)
+    public function __construct($token = null, HttpClient $httpClient = null, $apiBaseUri = null)
     {
         $this->token = $token;
-        $this->http = $httpClient;
+        $this->http = $httpClient ?? new HttpClient();
+        $this->setApiBaseUri($apiBaseUri ?? 'https://api.telegram.org');
     }
 
     /**
@@ -43,11 +48,39 @@ public function getToken(): string
     /**
      * Token setter.
      *
-     * @param  string
+     * @param string $token
+     *
+     * @return $this
      */
-    public function setToken($token): void
+    public function setToken(string $token): self
     {
         $this->token = $token;
+
+        return $this;
+    }
+
+    /**
+     * API Base URI getter.
+     *
+     * @return string
+     */
+    public function getApiBaseUri(): string
+    {
+        return $this->apiBaseUri;
+    }
+
+    /**
+     * API Base URI setter.
+     *
+     * @param string $apiBaseUri
+     *
+     * @return $this
+     */
+    public function setApiBaseUri(string $apiBaseUri): self
+    {
+        $this->apiBaseUri = rtrim($apiBaseUri, '/');
+
+        return $this;
     }
 
     /**
@@ -57,7 +90,7 @@ public function setToken($token): void
      */
     protected function httpClient(): HttpClient
     {
-        return $this->http ?? new HttpClient();
+        return $this->http;
     }
 
     /**
@@ -101,7 +134,7 @@ public function sendMessage(array $params): ?ResponseInterface
      */
     public function sendFile(array $params, string $type, bool $multipart = false): ?ResponseInterface
     {
-        return $this->sendRequest('send'.Str::studly($type), $params, $multipart);
+        return $this->sendRequest('send' . Str::studly($type), $params, $multipart);
     }
 
     /**
@@ -135,10 +168,10 @@ protected function sendRequest(string $endpoint, array $params, bool $multipart
             throw CouldNotSendNotification::telegramBotTokenNotProvided('You must provide your telegram bot token to make any API requests.');
         }
 
-        $endPointUrl = 'https://api.telegram.org/bot'.$this->token.'/'.$endpoint;
+        $apiUri = sprintf('%s/bot%s/%s', $this->apiBaseUri, $this->token, $endpoint);
 
         try {
-            return $this->httpClient()->post($endPointUrl, [
+            return $this->httpClient()->post($apiUri, [
                 $multipart ? 'multipart' : 'form_params' => $params,
             ]);
         } catch (ClientException $exception) {

src/TelegramServiceProvider.php

@@ -20,7 +20,8 @@ public function boot(): void
             ->give(static function () {
                 return new Telegram(
                     config('services.telegram-bot-api.token'),
-                    new HttpClient()
+                    app(HttpClient::class),
+                    config('services.telegram-bot-api.base_uri')
                 );
             });
     }

tests/TelegramChannelTest.php

@@ -52,13 +52,6 @@ public function it_can_send_a_message(): void
 
         self::assertSame($expectedResponse, $actualResponse);
     }
-
-    /** @test */
-    public function it_throws_an_exception_when_it_could_not_send_the_notification_because_no_chat_id_provided(): void
-    {
-        $this->expectException(CouldNotSendNotification::class);
-        $this->channel->send(new TestNotifiable(), new TestNotificationNoChatId());
-    }
 }
 
 /**

tests/TelegramMessageTest.php

@@ -41,7 +41,7 @@ public function the_notification_message_can_be_set(): void
     }
 
     /** @test */
-    public function an_inline_button_can_be_added_to_the_messsage(): void
+    public function an_inline_button_can_be_added_to_the_message(): void
     {
         $message = new TelegramMessage();
         $message->button('Laravel', 'https://laravel.com');