Merge 6a6c4a7 into acc1ce8

Author: Norgul

config/mailbox.php

@@ -1,20 +1,37 @@
 <?php
 
+use BeyondCode\Mailbox\Drivers\Log;
+use BeyondCode\Mailbox\Drivers\MailCare;
+use BeyondCode\Mailbox\Drivers\Mailgun;
+use BeyondCode\Mailbox\Drivers\Postmark;
+use BeyondCode\Mailbox\Drivers\SendGrid;
+use BeyondCode\Mailbox\InboundEmail;
+
 return [
 
-    /*
+    /**
      * The driver to use when listening for incoming emails.
      * It defaults to the mail driver that you are using.
-     *
-     * Supported drivers: "log", "mailgun", "sendgrid", "postmark"
      */
     'driver' => env('MAILBOX_DRIVER', 'log'),
 
+    /**
+     * Supported driver keys and what they map to. Can map to a class or a callback.
+     * If class is used, it must implement DriverInterface.
+     */
+    'supported_drivers' => [
+        'log'       => Log::class,
+        'mailgun'   => Mailgun::class,
+        'send_grid' => SendGrid::class,
+        'mail_care' => MailCare::class,
+        'postmark'  => Postmark::class,
+    ],
+
     /*
      * The model class to use when converting an incoming email to a message.
      * It must extend the default model class
      */
-    'model' => \BeyondCode\Mailbox\InboundEmail::class,
+    'model' => InboundEmail::class,
 
     /*
      * The path for driver specific routes. This is where
@@ -23,7 +40,7 @@
      *
      * For example: /laravel-mailbox/sendgrid/
      */
-    'path' => 'laravel-mailbox',
+    'route_prefix' => 'laravel-mailbox',
 
     /*
      * The amount of days that incoming emails should be stored in your

docs/extending/_index.md

@@ -0,0 +1,4 @@
+---
+title: Extending
+order: 4
+---

docs/extending/extending.md

@@ -0,0 +1,41 @@
+# Extending the package
+
+## Drivers
+
+You can add your own drivers to extend the package stock configuration.
+
+1. Publish the configuration with ``php artisan vendor:publish``.
+1. List of currently supported drivers is listed under ``supported_drivers`` config key.
+1. Create a new driver class, making sure it implements ``DriverInterface``
+1. ``register()`` method should provide all the necessary steps to register 
+a driver. For this package, this is usually done to expose routes for callbacks
+dynamically, i.e.: 
+
+    ```
+    public function register()
+    {
+        Route::prefix(config('mailbox.route_prefix'))->group(function () {
+            Route::post('/mailgun/mime', MailgunController::class);
+        });
+    }
+    ```
+
+1. Controller needs to call a mailbox, and provide an ``InboundEmail`` instance
+to it:
+
+    ```
+    public function __invoke(MailgunRequest $request)
+    {
+        Mailbox::callMailboxes($request->email());
+    }
+    ```
+   
+1. Making a form request is optional but recommended. The exposed ``email()``
+method takes in input parameters and converts it to ``InboundEmail`` instance:
+    
+    ```
+    public function email()
+    {
+        return InboundEmail::fromMessage($this->get('email'));
+    }
+    ```

src/Drivers/MailCare.php

@@ -9,7 +9,7 @@ class MailCare implements DriverInterface
 {
     public function register()
     {
-        Route::prefix(config('mailbox.path'))->group(function () {
+        Route::prefix(config('mailbox.route_prefix'))->group(function () {
             Route::post('/mailcare', MailCareController::class);
         });
     }

src/Drivers/Mailgun.php

@@ -9,7 +9,7 @@ class Mailgun implements DriverInterface
 {
     public function register()
     {
-        Route::prefix(config('mailbox.path'))->group(function () {
+        Route::prefix(config('mailbox.route_prefix'))->group(function () {
             Route::post('/mailgun/mime', MailgunController::class);
         });
     }

src/Drivers/Postmark.php

@@ -9,7 +9,7 @@ class Postmark implements DriverInterface
 {
     public function register()
     {
-        Route::prefix(config('mailbox.path'))->group(function () {
+        Route::prefix(config('mailbox.route_prefix'))->group(function () {
             Route::post('/postmark', PostmarkController::class);
         });
     }

src/Drivers/SendGrid.php

@@ -9,7 +9,7 @@ class SendGrid implements DriverInterface
 {
     public function register()
     {
-        Route::prefix(config('mailbox.path'))->group(function () {
+        Route::prefix(config('mailbox.route_prefix'))->group(function () {
             Route::post('/sendgrid', SendGridController::class);
         });
     }

src/Facades/Mailbox.php

@@ -2,8 +2,12 @@
 
 namespace BeyondCode\Mailbox\Facades;
 
+use BeyondCode\Mailbox\Routing\Router;
 use Illuminate\Support\Facades\Facade;
 
+/**
+ * @see Router
+ */
 class Mailbox extends Facade
 {
     protected static function getFacadeAccessor()

src/Http/Controllers/MailCareController.php

@@ -10,7 +10,7 @@ class MailCareController extends Controller
 {
     public function __construct()
     {
-        $this->middleware('laravel-mailbox');
+        $this->middleware('laravel-mailbox-auth');
     }
 
     public function __invoke(MailCareRequest $request)

src/Http/Controllers/PostmarkController.php

@@ -10,7 +10,7 @@ class PostmarkController extends Controller
 {
     public function __construct()
     {
-        $this->middleware('laravel-mailbox');
+        $this->middleware('laravel-mailbox-auth');
     }
 
     public function __invoke(PostmarkRequest $request)

src/Http/Controllers/SendGridController.php

@@ -10,7 +10,7 @@ class SendGridController extends Controller
 {
     public function __construct()
     {
-        $this->middleware('laravel-mailbox');
+        $this->middleware('laravel-mailbox-auth');
     }
 
     public function __invoke(SendGridRequest $request)

src/Http/Requests/MailCareRequest.php

@@ -17,6 +17,9 @@ public function validator()
 
     public function email()
     {
-        return InboundEmail::fromMessage($this->get('email'));
+        /** @var InboundEmail $modelClass */
+        $modelClass = config('mailbox.model');
+
+        return $modelClass::fromMessage($this->get('email'));
     }
 }

src/MailboxManager.php

@@ -2,47 +2,47 @@
 
 namespace BeyondCode\Mailbox;
 
-use BeyondCode\Mailbox\Drivers\Log;
-use BeyondCode\Mailbox\Drivers\MailCare;
-use BeyondCode\Mailbox\Drivers\Mailgun;
-use BeyondCode\Mailbox\Drivers\Postmark;
-use BeyondCode\Mailbox\Drivers\SendGrid;
+use BeyondCode\Mailbox\Drivers\DriverInterface;
+use Closure;
+use Illuminate\Contracts\Container\Container;
 use Illuminate\Support\Manager;
 
 class MailboxManager extends Manager
 {
-    public function mailbox($name = null)
+    /**
+     * Create a new manager instance.
+     *
+     * @param Container $container
+     * @return void
+     */
+    public function __construct(Container $container)
     {
-        return $this->driver($name);
-    }
+        parent::__construct($container);
 
-    public function createLogDriver()
-    {
-        return new Log;
+        $this->registerDrivers();
     }
 
-    public function createMailgunDriver()
+    public function getDefaultDriver()
     {
-        return new Mailgun;
+        return $this->container['config']['mailbox.driver'];
     }
 
-    public function createSendGridDriver()
+    protected function registerDrivers(): void
     {
-        return new SendGrid;
-    }
+        $supported = config('mailbox.supported_drivers');
 
-    public function createMailCareDriver()
-    {
-        return new MailCare;
-    }
+        foreach ($supported as $driver => $mappedTo) {
+            $callback = is_callable($mappedTo) ?
+                $mappedTo : $this->registerDriverCallable($mappedTo);
 
-    public function createPostmarkDriver()
-    {
-        return new Postmark;
+            $this->extend($driver, $callback);
+        }
     }
 
-    public function getDefaultDriver()
+    protected function registerDriverCallable(string $driver): Closure
     {
-        return $this->container['config']['mailbox.driver'];
+        return function () use ($driver): DriverInterface {
+            return new $driver;
+        };
     }
 }

src/MailboxServiceProvider.php

@@ -2,7 +2,7 @@
 
 namespace BeyondCode\Mailbox;
 
-use BeyondCode\Mailbox\Facades\Mailbox;
+use BeyondCode\Mailbox\Drivers\DriverInterface;
 use BeyondCode\Mailbox\Http\Middleware\MailboxBasicAuthentication;
 use BeyondCode\Mailbox\Routing\Router;
 use Illuminate\Support\Facades\Route;
@@ -25,7 +25,7 @@ public function boot()
             __DIR__.'/../config/mailbox.php' => config_path('mailbox.php'),
         ], 'config');
 
-        Route::aliasMiddleware('laravel-mailbox', MailboxBasicAuthentication::class);
+        Route::aliasMiddleware('laravel-mailbox-auth', MailboxBasicAuthentication::class);
 
         $this->commands([
             Console\CleanEmails::class,
@@ -45,13 +45,21 @@ public function register()
             return new Router($this->app);
         });
 
-        $this->app->singleton(MailboxManager::class, function () {
-            return new MailboxManager($this->app);
-        });
+        $this->app->singleton(MailboxManager::class);
     }
 
     protected function registerDriver()
     {
-        Mailbox::mailbox()->register();
+        /**
+         * @var $manager MailboxManager
+         */
+        $manager = app(MailboxManager::class);
+
+        /**
+         * @var $driver DriverInterface
+         */
+        $driver = $manager->driver();
+
+        $driver->register();
     }
 }