Merge pull request #11 from AltThree/fix-types

Fix types

Author: GrahamCampbell

src/ThrottlingMiddleware.php

@@ -55,16 +55,42 @@ public function __construct(RateLimiter $limiter)
      *
      * @param \Illuminate\Http\Request $request
      * @param \Closure                 $next
+     * @param int|string               $limit
+     * @param int|float|string         $decay
+     * @param bool|string              $global
+     * @param bool|string              $headers
+     *
+     * @throws \AltThree\Throttle\ThrottlingException
+     *
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next, $limit = 60, $decay = 1, $global = false, $headers = true)
+    {
+        return $this->safeHandle(
+            $request,
+            $next,
+            TypeUtil::convertNumeric($limit),
+            TypeUtil::convertNumeric($decay),
+            TypeUtil::convertBoolean($global),
+            TypeUtil::convertBoolean($headers)
+        );
+    }
+
+    /**
+     * Handle an incoming request, with correct types.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Closure                 $next
      * @param int                      $limit
-     * @param float|int                $decay
+     * @param int|float                $decay
      * @param bool                     $global
      * @param bool                     $headers
      *
      * @throws \AltThree\Throttle\ThrottlingException
      *
      * @return mixed
      */
-    public function handle(Request $request, Closure $next, $limit = 60, $decay = 1, $global = false, $headers = true)
+    protected function safeHandle(Request $request, Closure $next, int $limit, $decay, bool $global, bool $headers)
     {
         if ($this->shouldPassThrough($request)) {
             return $next($request);

src/TypeUtil.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Alt Three Throttle.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace AltThree\Throttle;
+
+/**
+ * This is the type util class.
+ *
+ * @author Graham Campbell <[email protected]>
+ */
+class TypeUtil
+{
+    /**
+     * Convert the given value to numeric.
+     *
+     * @param int|float|string $v
+     *
+     * @return int|float
+     */
+    public static function convertNumeric($v)
+    {
+        return $v === '' ? 0 : $v + 0;
+    }
+
+    /**
+     * Convert the given value to boolean.
+     *
+     * @param bool|string $v
+     *
+     * @return bool
+     */
+    public static function convertBoolean($v)
+    {
+        return $v === 'false' ? false : (bool) $v;
+    }
+}

tests/TypeUtilTest.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Alt Three Throttle.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace AltThree\Tests\Throttle;
+
+use AltThree\Throttle\TypeUtil;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * This is the analysis test class.
+ *
+ * @author Graham Campbell <[email protected]>
+ */
+class TypeUtilTest extends TestCase
+{
+    /**
+     * @dataProvider providesNumericCases
+     */
+    public function testConvertNumeric($input, $output)
+    {
+        $this->assertSame($output, TypeUtil::convertNumeric($input));
+    }
+
+    public function providesNumericCases()
+    {
+        return [
+            ['', 0],
+            ['0', 0],
+            ['0.0', 0.0],
+            ['1', 1],
+            ['123', 123],
+            [2, 2],
+            [3.3, 3.3],
+        ];
+    }
+
+    /**
+     * @dataProvider providesBooleanCases
+     */
+    public function testConvertBoolean($input, $output)
+    {
+        $this->assertSame($output, TypeUtil::convertBoolean($input));
+    }
+
+    public function providesBooleanCases()
+    {
+        return [
+            ['', false],
+            ['false', false],
+            ['true', true],
+            ['0', false],
+            ['1', true],
+            [false, false],
+            [true, true],
+        ];
+    }
+}