Merge pull request #20 from mycarrysun/response-key

feat: add config option to change response key

Author: mlanin

config/api-debugger.php

@@ -18,4 +18,6 @@
         // Memory usage.
         \Lanin\Laravel\ApiDebugger\Collections\MemoryCollection::class,
     ],
+
+    'response_key' => env('API_DEBUGGER_KEY', 'debug')
 ];

src/Debugger.php

@@ -16,7 +16,12 @@ class Debugger
     /**
      * @var string
      */
-    protected $responseKey = 'debug';
+    const DEFAULT_RESPONSE_KEY = 'debug';
+
+    /**
+     * @var string
+     */
+    protected $responseKey = self::DEFAULT_RESPONSE_KEY;
 
     /**
      * @var Storage
@@ -172,6 +177,16 @@ protected function setResponseData(Response $response, $data)
         return $response->setContent($content);
     }
 
+    /**
+     * Get the current response key
+     *
+     * @return string
+     */
+    public function getResponseKey()
+    {
+        return $this->responseKey;
+    }
+
     /**
      * Set response attribute key name.
      *

src/ServiceProvider.php

@@ -24,6 +24,8 @@ public function boot()
         $config = $this->app['config'];
         if ($config['api-debugger.enabled']) {
             $this->registerCollections($config['api-debugger.collections']);
+
+            $this->setResponseKey($config['api-debugger.response_key']);
         }
     }
 
@@ -62,4 +64,19 @@ protected function registerCollections(array $collections)
             $debugger->populateWith($this->app->make($collection));
         }
     }
+
+    /**
+     * Set the response key for the debug object
+     * (default: debug)
+     *
+     * @param string key
+     */
+    protected function setResponseKey($key)
+    {
+        $debugger = $this->app->make(Debugger::class);
+
+        if($key && $key !== Debugger::DEFAULT_RESPONSE_KEY){
+            $debugger->setResponseKey($key);
+        }
+    }
 }

tests/DebuggerTest.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Cache;
+use Lanin\Laravel\ApiDebugger\Debugger;
 
 class DebuggerTest extends TestCase
 {
@@ -229,4 +230,19 @@ public function it_preserves_array()
             ->assertStatus(200)
             ->assertSeeText('"baz":[]');
     }
+
+    /** @test */
+    public function it_can_set_a_new_response_key()
+    {
+        /** @var Debugger $debugger */
+        $debugger = $this->app->make(Debugger::class);
+
+        $this->assertEquals(Debugger::DEFAULT_RESPONSE_KEY, $debugger->getResponseKey(), 'Response key is not the default');
+
+        $new_response_key = 'key123';
+
+        $debugger->setResponseKey($new_response_key);
+
+        $this->assertEquals($new_response_key, $debugger->getResponseKey(), 'Response key was not changed from "'.$debugger->getResponseKey().'" to "'.$new_response_key.'"');
+    }
 }