Poll support (#130)

Author: faissaloux

README.md

@@ -17,6 +17,7 @@ This package makes it easy to send Telegram notification using [Telegram Bot API
   - [Proxy or Bridge Support](#proxy-or-bridge-support)
 - [Usage](#usage)
   - [Text Notification](#text-notification)
+  - [Send a poll](#Send-a-poll)
   - [Attach a Photo](#attach-a-photo)
   - [Attach a Document](#attach-a-document)
   - [Attach a Location](#attach-a-location)
@@ -124,6 +125,22 @@ Here's a screenshot preview of the above notification on Telegram Messenger:
 
 ![Laravel Telegram Notification Example](https://user-images.githubusercontent.com/1915268/66616627-39be6180-ebef-11e9-92cc-f2da81da047a.jpg)
 
+### Send a poll
+
+```php
+public function toTelegram($notifiable)
+{
+    return TelegramPoll::create()
+        ->to($notifiable)
+        ->question("Aren't Laravel Notification Channels awesome?")
+        ->choices(['Yes', 'YEs', 'YES']);
+}
+```
+
+Preview:
+
+![Laravel Telegram Poll Example](https://user-images.githubusercontent.com/60013703/143135248-1224a69b-3233-4686-8a59-d41517d8c722.png)
+
 ### Attach a Photo
 
 ```php

src/Telegram.php

@@ -151,6 +151,20 @@ public function sendFile(array $params, string $type, bool $multipart = false):
         return $this->sendRequest('send'.Str::studly($type), $params, $multipart);
     }
 
+    /**
+     * Send a Poll.
+     *
+     * @param array  $params
+     *
+     * @throws CouldNotSendNotification
+     *
+     * @return ResponseInterface|null
+     */
+    public function sendPoll(array $params): ?ResponseInterface
+    {
+        return $this->sendRequest('sendPoll', $params);
+    }
+
     /**
      * Send a Location.
      *

src/TelegramChannel.php

@@ -109,6 +109,8 @@ public function send($notifiable, Notification $notification): ?array
                 $response = $this->telegram->sendLocation($params);
             } elseif ($message instanceof TelegramFile) {
                 $response = $this->telegram->sendFile($params, $message->type, $message->hasFile());
+            } elseif ($message instanceof TelegramPoll) {
+                $response = $this->telegram->sendPoll($params);
             } else {
                 return null;
             }

src/TelegramPoll.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace NotificationChannels\Telegram;
+
+use JsonSerializable;
+use NotificationChannels\Telegram\Traits\HasSharedLogic;
+
+/**
+ * Class TelegramPoll.
+ */
+class TelegramPoll implements JsonSerializable
+{
+    use HasSharedLogic;
+
+    /**
+     * @param  string  $question
+     *
+     * @return self
+     */
+    public static function create(string $question = ''): self
+    {
+        return new self($question);
+    }
+
+    /**
+     * Message constructor.
+     *
+     * @param  string  $question
+     */
+    public function __construct(string $question = '')
+    {
+        $this->question($question);
+    }
+
+    /**
+     * Poll question.
+     *
+     * @param  string  $question
+     *
+     * @return $this
+     */
+    public function question(string $question): self
+    {
+        $this->payload['question'] = $question;
+
+        return $this;
+    }
+
+    /**
+     * Poll choices.
+     *
+     * @param  array  $choices
+     *
+     * @return $this
+     */
+    public function choices(array $choices): self
+    {
+        $this->payload['options'] = json_encode($choices);
+
+        return $this;
+    }
+}

tests/TelegramPollTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace NotificationChannels\Telegram\Test;
+
+use NotificationChannels\Telegram\TelegramPoll;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Class TelegramPollTest.
+ */
+class TelegramPollTest extends TestCase
+{
+    /** @test */
+    public function it_accepts_question_when_constructed(): void
+    {
+        $message = new TelegramPoll("Aren't Laravel Notification Channels awesome?");
+        $this->assertEquals("Aren't Laravel Notification Channels awesome?", $message->getPayloadValue('question'));
+    }
+
+    /** @test */
+    public function the_recipients_chat_id_can_be_set(): void
+    {
+        $message = new TelegramPoll();
+        $message->to(12345);
+        $this->assertEquals(12345, $message->getPayloadValue('chat_id'));
+    }
+
+    /** @test */
+    public function the_question_message_can_be_set(): void
+    {
+        $message = new TelegramPoll();
+        $message->question("Aren't Laravel Notification Channels awesome?");
+        $this->assertEquals("Aren't Laravel Notification Channels awesome?", $message->getPayloadValue('question'));
+    }
+
+    /** @test */
+    public function the_options_can_be_set_for_the_question(): void
+    {
+        $message = new TelegramPoll();
+        $message->choices(['Yes', 'No']);
+        $this->assertEquals('["Yes","No"]', $message->getPayloadValue('options'));
+    }
+
+    /** @test */
+    public function it_can_determine_if_the_recipient_chat_id_has_not_been_set(): void
+    {
+        $message = new TelegramPoll();
+        $this->assertTrue($message->toNotGiven());
+
+        $message->to(12345);
+        $this->assertFalse($message->toNotGiven());
+    }
+
+    /** @test */
+    public function it_can_return_the_payload_as_an_array(): void
+    {
+        $message = new TelegramPoll("Aren't Laravel Notification Channels awesome?");
+        $message->to(12345);
+        $message->choices(['Yes', 'No']);
+        $expected = [
+            'chat_id'   => 12345,
+            'question'  => "Aren't Laravel Notification Channels awesome?",
+            'options'   => '["Yes","No"]',
+        ];
+
+        $this->assertEquals($expected, $message->toArray());
+    }
+}