Revise and improve

Author: irazasyed

README.md

@@ -103,7 +103,7 @@ public function toTelegram($notifiable)
         ->content('Awesome *bold* text and [inline URL](http://www.example.com/)')
         ->file('/storage/archive/6029014.jpg', 'photo'); // local photo
 
-        // OR using a helper method with remote file.
+        // OR using a helper method with or without a remote file.
         // ->photo('https://file-examples.com/wp-content/uploads/2017/10/file_example_JPG_1MB.jpg');
 }
 ```
@@ -220,13 +220,13 @@ public function routeNotificationForTelegram()
 - `to($chatId)`: (integer) Recipient's chat id.
 - `content('')`: (string) File caption, supports markdown. For more information on supported markdown styles, check out these [docs](https://telegram-bot-sdk.readme.io/reference#section-formatting-options).
 - `file($file, $type, $filename = null)`: Local file path or remote URL, `$type` of the file (Ex:`photo`, `audio`, `document`, `video`, `animation`, `voice`, `video_note_`) and optionally filename with extension. Ex: `sample.pdf`. You can use helper methods instead of using this to make it easier to work with file attachment.
-- `photo($file, $filename = null)`: Helper method to attach a photo.
-- `audio($file, $filename = null)`: Helper method to attach an audio file (MP3 file).
+- `photo($file)`: Helper method to attach a photo.
+- `audio($file)`: Helper method to attach an audio file (MP3 file).
 - `document($file, $filename = null)`: Helper method to attach a document or any file as document.
-- `video($file, $filename = null)`: Helper method to attach a video file.
-- `animation($file, $filename = null)`: Helper method to attach an animated gif file.
-- `voice($file, $filename = null)`: Helper method to attach a voice note (`.ogg` file with OPUS encoded).
-- `videoNote($file, $filename = null)`: Helper method to attach a video note file (Upto 1 min long, rounded square video).
+- `video($file)`: Helper method to attach a video file.
+- `animation($file)`: Helper method to attach an animated gif file.
+- `voice($file)`: Helper method to attach a voice note (`.ogg` file with OPUS encoded).
+- `videoNote($file)`: Helper method to attach a video note file (Upto 1 min long, rounded square video).
 - `button($text, $url)`: (string) Adds an inline "Call to Action" button. You can add as many as you want and they'll be placed 2 in a row.
 - `disableNotification()`: Send the message silently. Users will receive a notification with no sound.
 - `options([])`: (array) Allows you to add additional or override the payload.

src/TelegramChannel.php

@@ -56,7 +56,7 @@ public function send($notifiable, Notification $notification): void
         } elseif ($message instanceof TelegramLocation) {
             $this->telegram->sendLocation($params);
         } elseif ($message instanceof TelegramFile) {
-            $this->telegram->sendFile($message->toMultipart(), $message->type, true);
+            $this->telegram->sendFile($params, $message->type, $message->hasFile());
         }
     }
 }

src/TelegramFile.php

@@ -65,13 +65,16 @@ public function file($file, string $type, string $filename = null): self
     {
         $this->type = $type;
 
-        $this->payload['file'] = [
-            'name'     => $type,
-            'contents' => (is_file($file) && is_readable($file)) ? fopen($file, 'rb') : $file,
-        ];
-
-        if ($filename !== null) {
-            $this->payload['file']['filename'] = $filename;
+        $isLocalFile = $this->isReadableFile($file);
+
+        if($filename !== null || $isLocalFile) {
+            $this->payload['file'] = [
+                'filename'  => $filename,
+                'name'     => $type,
+                'contents' => $isLocalFile ? fopen($file, 'rb') : $file,
+            ];
+        } else {
+            $this->payload[$type] = $file;
         }
 
         return $this;
@@ -82,14 +85,13 @@ public function file($file, string $type, string $filename = null): self
      *
      * Use this method to send photos.
      *
-     * @param string      $file
-     * @param string|null $filename
+     * @param string $file
      *
      * @return $this
      */
-    public function photo(string $file, string $filename = null): self
+    public function photo(string $file): self
     {
-        return $this->file($file, 'photo', $filename);
+        return $this->file($file, 'photo');
     }
 
     /**
@@ -98,14 +100,13 @@ public function photo(string $file, string $filename = null): self
      * Use this method to send audio files, if you want Telegram clients to display them in the music player.
      * Your audio must be in the .mp3 format.
      *
-     * @param string      $file
-     * @param string|null $filename
+     * @param string $file
      *
      * @return $this
      */
-    public function audio(string $file, string $filename = null): self
+    public function audio(string $file): self
     {
-        return $this->file($file, 'audio', $filename);
+        return $this->file($file, 'audio');
     }
 
     /**
@@ -128,29 +129,27 @@ public function document(string $file, string $filename = null): self
      *
      * Use this method to send video files, Telegram clients support mp4 videos.
      *
-     * @param string      $file
-     * @param string|null $filename
+     * @param string $file
      *
      * @return $this
      */
-    public function video(string $file, string $filename = null): self
+    public function video(string $file): self
     {
-        return $this->file($file, 'video', $filename);
+        return $this->file($file, 'video');
     }
 
     /**
      * Attach an animation file.
      *
      * Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).
      *
-     * @param string      $file
-     * @param string|null $filename
+     * @param string $file
      *
      * @return $this
      */
-    public function animation(string $file, string $filename = null): self
+    public function animation(string $file): self
     {
-        return $this->file($file, 'animation', $filename);
+        return $this->file($file, 'animation');
     }
 
     /**
@@ -159,14 +158,13 @@ public function animation(string $file, string $filename = null): self
      * Use this method to send audio files, if you want Telegram clients to display the file as a playable voice
      * message. For this to work, your audio must be in an .ogg file encoded with OPUS.
      *
-     * @param string      $file
-     * @param string|null $filename
+     * @param string $file
      *
      * @return $this
      */
-    public function voice(string $file, string $filename = null): self
+    public function voice(string $file): self
     {
-        return $this->file($file, 'voice', $filename);
+        return $this->file($file, 'voice');
     }
 
     /**
@@ -175,14 +173,33 @@ public function voice(string $file, string $filename = null): self
      * Telegram clients support rounded square mp4 videos of up to 1 minute long.
      * Use this method to send video messages.
      *
-     * @param string      $file
-     * @param string|null $filename
+     * @param string $file
      *
      * @return $this
      */
-    public function videoNote(string $file, string $filename = null): self
+    public function videoNote(string $file): self
     {
-        return $this->file($file, 'video_note', $filename);
+        return $this->file($file, 'video_note');
+    }
+
+    /**
+     * Determine there is a file.
+     *
+     * @return bool
+     */
+    public function hasFile(): bool
+    {
+        return isset($this->payload['file']);
+    }
+
+    /**
+     * Returns params payload.
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+        return $this->hasFile() ? $this->toMultipart() : $this->payload;
     }
 
     /**
@@ -199,4 +216,16 @@ public function toMultipart(): array
 
         return $data;
     }
+
+    /**
+     * Determine if it's a regular and readable file.
+     *
+     * @param string $file
+     *
+     * @return bool
+     */
+    protected function isReadableFile(string $file): bool
+    {
+        return is_file($file) && is_readable($file);
+    }
 }