Merge pull request #60 from Martincic/master

Added basic auth option

Author: andreaselia

README.md

@@ -5,7 +5,7 @@
 
 # Laravel API to Postman
 
-This package allows you to automatically generate a Postman collection based on your API routes. It also provides basic configuration and support for bearer auth tokens for routes behind an auth middleware.
+This package allows you to automatically generate a Postman collection based on your API routes. It also provides basic configuration and support for bearer auth tokens and basic auth for routes behind an auth middleware.
 
 ## Postman Schema
 
@@ -47,6 +47,14 @@ The following usage will generate routes with the bearer token specified.
 php artisan export:postman --bearer="1|XXNKXXqJjfzG8XXSvXX1Q4pxxnkXmp8tT8TXXKXX"
 ```
 
+The following usage will generate routes with the basic auth specified.
+
+```bash
+php artisan export:postman --basic="username:password123"
+```
+
+If both auths are specified, bearer will be favored.
+
 ## Examples
 
 This is with the default configuration and a bearer token passed in:

src/Commands/ExportPostmanCommand.php

@@ -15,7 +15,9 @@
 class ExportPostmanCommand extends Command
 {
     /** @var string */
-    protected $signature = 'export:postman {--bearer= : The bearer token to use on your endpoints}';
+    protected $signature = 'export:postman 
+                            {--bearer= : The bearer token to use on your endpoints}
+                            {--basic= : The basic auth to use on your endpoints}';
 
     /** @var string */
     protected $description = 'Automatically generate a Postman collection for your API routes';
@@ -33,7 +35,16 @@ class ExportPostmanCommand extends Command
     protected $filename;
 
     /** @var string */
-    private $bearer;
+    private $token;
+
+    /** @var string */
+    private $authType;
+
+    /** @var array */
+    private const AUTH_OPTIONS = [
+        'bearer',
+        'basic',
+    ];
 
     public function __construct(Router $router, Repository $config)
     {
@@ -46,7 +57,7 @@ public function __construct(Router $router, Repository $config)
     public function handle(): void
     {
         $this->setFilename();
-        $this->setBearerToken();
+        $this->setAuthToken();
         $this->initializeStructure();
 
         foreach ($this->router->getRoutes() as $route) {
@@ -106,11 +117,22 @@ public function handle(): void
 
                 $routeHeaders = $this->config['headers'];
 
-                if ($this->bearer && in_array($this->config['auth_middleware'], $middlewares)) {
-                    $routeHeaders[] = [
-                        'key' => 'Authorization',
-                        'value' => 'Bearer {{token}}',
-                    ];
+                if ($this->token && in_array($this->config['auth_middleware'], $middlewares)) {
+                    switch ($this->authType) {
+                        case 'bearer':
+                            $routeHeaders[] = [
+                                'key' => 'Authorization',
+                                'value' => 'Bearer {{token}}',
+                            ];
+                            break;
+
+                        case 'basic':
+                            $routeHeaders[] = [
+                                'key' => 'Authorization',
+                                'value' => 'Basic {{token}}',
+                            ];
+                            break;
+                    }
                 }
 
                 $request = $this->makeRequest($route, $method, $routeHeaders, $requestRules);
@@ -267,10 +289,10 @@ protected function initializeStructure(): void
             'item' => [],
         ];
 
-        if ($this->bearer) {
+        if ($this->token) {
             $this->structure['variable'][] = [
                 'key' => 'token',
-                'value' => $this->bearer,
+                'value' => $this->token,
             ];
         }
     }
@@ -284,9 +306,14 @@ protected function setFilename()
         );
     }
 
-    protected function setBearerToken()
+    protected function setAuthToken()
     {
-        $this->bearer = $this->option('bearer') ?? null;
+        foreach (self::AUTH_OPTIONS as $option) {
+            if ($token = $this->option($option)) {
+                $this->token = $token ?? null;
+                $this->authType = $option;
+            }
+        }
     }
 
     protected function isStructured()

tests/Feature/ExportPostmanTest.php

@@ -83,6 +83,45 @@ public function test_bearer_export_works(bool $formDataEnabled)
         }
     }
 
+    /**
+     * @dataProvider providerFormDataEnabled
+     */
+    public function test_basic_export_works(bool $formDataEnabled)
+    {
+        config()->set('api-postman.enable_formdata', $formDataEnabled);
+
+        $this->artisan('export:postman --basic=username:password1234')->assertExitCode(0);
+
+        $collection = json_decode(Storage::get('postman/'.config('api-postman.filename')), true);
+
+        $routes = $this->app['router']->getRoutes();
+
+        $collectionVariables = $collection['variable'];
+
+        foreach ($collectionVariables as $variable) {
+            if ($variable['key'] != 'token') {
+                continue;
+            }
+
+            $this->assertEquals($variable['value'], 'username:password1234');
+        }
+
+        $this->assertCount(2, $collectionVariables);
+
+        $collectionItems = $collection['item'];
+
+        $this->assertCount(count($routes), $collectionItems);
+
+        foreach ($routes as $route) {
+            $collectionRoute = Arr::first($collectionItems, function ($item) use ($route) {
+                return $item['name'] == $route->uri();
+            });
+
+            $this->assertNotNull($collectionRoute);
+            $this->assertTrue(in_array($collectionRoute['request']['method'], $route->methods()));
+        }
+    }
+
     /**
      * @dataProvider providerFormDataEnabled
      */