WIP

Author: stevebauman

src/Commands/ConfigureIdleQuery.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace DirectoryTree\ImapEngine\Laravel\Commands;
+
+use DirectoryTree\ImapEngine\MessageQueryInterface;
+
+class ConfigureIdleQuery
+{
+    /**
+     * Constructor.
+     */
+    public function __construct(
+        protected array $with = []
+    ) {}
+
+    /**
+     * Configure the query.
+     */
+    public function __invoke(MessageQueryInterface $query): MessageQueryInterface
+    {
+        if (in_array('flags', $this->with)) {
+            $query->withFlags();
+        }
+
+        if (in_array('body', $this->with)) {
+            $query->withBody();
+        }
+
+        if (in_array('headers', $this->with)) {
+            $query->withHeaders();
+        }
+
+        return $query;
+    }
+}

src/Commands/HandleMessageReceived.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace DirectoryTree\ImapEngine\Laravel\Commands;
+
+use DirectoryTree\ImapEngine\Laravel\Events\MessageReceived;
+use DirectoryTree\ImapEngine\MessageInterface;
+use Illuminate\Support\Facades\Event;
+
+class HandleMessageReceived
+{
+    /**
+     * Constructor.
+     */
+    public function __construct(
+        protected WatchMailbox $command
+    ) {}
+
+    /**
+     * Handle the message received event.
+     */
+    public function __invoke(MessageInterface $message): void
+    {
+        $this->command->info(
+            "Message received: [{$message->uid()}]"
+        );
+
+        Event::dispatch(new MessageReceived($message));
+    }
+}

src/Commands/WatchMailbox.php

@@ -2,13 +2,13 @@
 
 namespace DirectoryTree\ImapEngine\Laravel\Commands;
 
-use DirectoryTree\ImapEngine\Laravel\Events\MessageReceived;
+use DirectoryTree\ImapEngine\FolderInterface;
 use DirectoryTree\ImapEngine\Laravel\Facades\Imap;
+use DirectoryTree\ImapEngine\Laravel\Support\LoopInterface;
+use DirectoryTree\ImapEngine\MailboxInterface;
 use DirectoryTree\ImapEngine\Message;
-use DirectoryTree\ImapEngine\MessageQuery;
 use Exception;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Str;
 
 class WatchMailbox extends Command
@@ -18,7 +18,7 @@ class WatchMailbox extends Command
      *
      * @var string
      */
-    protected $signature = 'imap:watch {mailbox} {folder?} {--with=} {--timeout=30} {--debug=false}';
+    protected $signature = 'imap:watch {mailbox} {folder?} {--with=} {--timeout=30} {--attempts=5} {--debug=false}';
 
     /**
      * The console command description.
@@ -30,63 +30,57 @@ class WatchMailbox extends Command
     /**
      * Execute the console command.
      */
-    public function handle(): void
+    public function handle(LoopInterface $loop): void
     {
         $mailbox = Imap::mailbox($name = $this->argument('mailbox'));
 
         $with = explode(',', $this->option('with'));
 
-        $this->info("Watching mailbox $name...");
+        $this->info("Watching mailbox [$name]...");
 
         $attempts = 0;
 
-        while (true) {
+        $loop->run(function () use ($mailbox, $with, &$attempts) {
             try {
-                $inbox = ($folder = $this->argument('folder'))
-                    ? $mailbox->folders()->findOrFail($folder)
-                    : $mailbox->inbox();
+                $folder = $this->folder($mailbox);
 
                 $attempts = 0;
 
-                $inbox->idle(function (Message $message) {
-                    $this->info("Message received: [{$message->uid()}]");
-
-                    Event::dispatch(new MessageReceived($message));
-                }, function (MessageQuery $query) use ($with) {
-                    if (in_array('flags', $with)) {
-                        $query->withFlags();
-                    }
-
-                    if (in_array('body', $with)) {
-                        $query->withBody();
-                    }
-
-                    if (in_array('headers', $with)) {
-                        $query->withHeaders();
-                    }
-
-                    return $query;
-                }, $this->option('timeout'));
+                $folder->idle(
+                    new HandleMessageReceived($this),
+                    new ConfigureIdleQuery($with),
+                    $this->option('timeout')
+                );
             } catch (Exception $e) {
                 if ($this->isMessageMissing($e)) {
-                    continue;
+                    return;
                 }
 
                 if ($this->isDisconnection($e)) {
                     sleep(2);
 
-                    continue;
+                    return;
                 }
 
-                if ($attempts >= 5) {
+                if ($attempts >= $this->option('attempts')) {
                     $this->info("Exception: {$e->getMessage()}");
 
                     throw $e;
                 }
 
                 $attempts++;
             }
-        }
+        });
+    }
+
+    /**
+     * Get the mailbox folder to idle.
+     */
+    protected function folder(MailboxInterface $mailbox): FolderInterface
+    {
+        return ($folder = $this->argument('folder'))
+             ? $mailbox->folders()->findOrFail($folder)
+             : $mailbox->inbox();
     }
 
     /**

src/Events/MessageReceived.php

@@ -2,14 +2,14 @@
 
 namespace DirectoryTree\ImapEngine\Laravel\Events;
 
-use DirectoryTree\ImapEngine\Message;
+use DirectoryTree\ImapEngine\MessageInterface;
 
 class MessageReceived
 {
     /**
      * Create a new event instance.
      */
     public function __construct(
-        public Message $message
+        public MessageInterface $message
     ) {}
 }

src/ImapManager.php

@@ -35,13 +35,31 @@ public function mailbox(string $name): MailboxInterface
             return $this->mailboxes[$name];
         }
 
-        if (! array_key_exists($name, $this->config['mailboxes'])) {
+        if (! array_key_exists($name, $this->config['mailboxes'] ?? [])) {
             throw new InvalidArgumentException(
                 "Mailbox [{$name}] is not defined. Please check your IMAP configuration."
             );
         }
 
-        return $this->mailboxes[$name] = new Mailbox($this->config['mailboxes'][$name]);
+        return $this->mailboxes[$name] = $this->build($this->config['mailboxes'][$name]);
+    }
+
+    /**
+     * Register a mailbox instance.
+     */
+    public function register(string $name, array $config): static
+    {
+        $this->mailboxes[$name] = $this->build($config);
+
+        return $this;
+    }
+
+    /**
+     * Build an on-demand mailbox instance.
+     */
+    public function build(array $config): MailboxInterface
+    {
+        return new Mailbox($config);
     }
 
     /**

src/ImapServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace DirectoryTree\ImapEngine\Laravel;
 
+use DirectoryTree\ImapEngine\Laravel\Support\Loop;
+use DirectoryTree\ImapEngine\Laravel\Support\LoopInterface;
 use Illuminate\Support\ServiceProvider;
 
 class ImapServiceProvider extends ServiceProvider
@@ -12,8 +14,10 @@ class ImapServiceProvider extends ServiceProvider
     public function register(): void
     {
         $this->app->singleton(ImapManager::class, function () {
-            return new ImapManager(config('imap'));
+            return new ImapManager(config('imap', []));
         });
+
+        $this->app->bind(LoopInterface::class, Loop::class);
     }
 
     /**

src/Support/Loop.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DirectoryTree\ImapEngine\Laravel\Support;
+
+class Loop implements LoopInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function run(callable $tick): void
+    {
+        while (true) {
+            $tick();
+        }
+    }
+}

src/Support/LoopFake.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace DirectoryTree\ImapEngine\Laravel\Support;
+
+class LoopFake implements LoopInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function run(callable $tick): void
+    {
+        $tick();
+    }
+}

src/Support/LoopInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace DirectoryTree\ImapEngine\Laravel\Support;
+
+interface LoopInterface
+{
+    /**
+     * Execute the loop.
+     */
+    public function run(callable $tick): void;
+}

tests/Commands/ConfigureIdleQueryTest.php

@@ -0,0 +1,29 @@
+<?php
+
+use DirectoryTree\ImapEngine\Laravel\Commands\ConfigureIdleQuery;
+use DirectoryTree\ImapEngine\MessageQueryInterface;
+use DirectoryTree\ImapEngine\Testing\FakeFolder;
+
+test('it does nothing when "with" is empty', function () {
+    $folder = new FakeFolder;
+
+    $configure = new ConfigureIdleQuery;
+
+    $query = $configure($folder->messages());
+
+    expect($query)->toBeInstanceOf(MessageQueryInterface::class);
+});
+
+test('it configures query when "with" is present', function () {
+    $folder = new FakeFolder;
+
+    $configure = new ConfigureIdleQuery([
+        'flags', 'body', 'headers',
+    ]);
+
+    $query = $configure($folder->messages());
+
+    expect($query->isFetchingBody())->toBeTrue();
+    expect($query->isFetchingFlags())->toBeTrue();
+    expect($query->isFetchingHeaders())->toBeTrue();
+});

tests/Commands/HandleMessageReceivedTest.php

@@ -0,0 +1,17 @@
+<?php
+
+use DirectoryTree\ImapEngine\Laravel\Commands\HandleMessageReceived;
+use DirectoryTree\ImapEngine\Laravel\Commands\WatchMailbox;
+use DirectoryTree\ImapEngine\Testing\FakeMessage;
+
+test('it dispatches event', function () {
+    $command = mock(WatchMailbox::class);
+
+    $command->shouldReceive('info')->once()->with(
+        'Message received: [123]'
+    );
+
+    $handle = new HandleMessageReceived($command);
+
+    $handle(new FakeMessage(123));
+});

tests/Commands/WatchMailboxTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace DirectoryTree\ImapEngine\Laravel\Tests;
+
+use DirectoryTree\ImapEngine\Laravel\Commands\WatchMailbox;
+use DirectoryTree\ImapEngine\Laravel\Facades\Imap;
+use DirectoryTree\ImapEngine\Laravel\Support\LoopFake;
+use DirectoryTree\ImapEngine\Laravel\Support\LoopInterface;
+use DirectoryTree\ImapEngine\Testing\FakeFolder;
+use Illuminate\Support\Facades\App;
+use Illuminate\Support\Facades\Config;
+use InvalidArgumentException;
+
+use function Pest\Laravel\artisan;
+
+test('it throws exception when mailbox is not configured', function () {
+    artisan(WatchMailbox::class, ['mailbox' => 'invalid']);
+})->throws(
+    InvalidArgumentException::class,
+    'Mailbox [invalid] is not defined. Please check your IMAP configuration.'
+);
+
+test('it can watch mailbox', function () {
+    Config::set('imap.mailboxes.test', [
+        'host' => 'localhost',
+        'port' => 993,
+        'encryption' => 'ssl',
+        'username' => '',
+        'password' => '',
+    ]);
+
+    Imap::fake('test', folders: [
+        new FakeFolder('inbox'),
+    ]);
+
+    App::bind(LoopInterface::class, LoopFake::class);
+
+    artisan(WatchMailbox::class, ['mailbox' => 'test'])->assertSuccessful();
+});