Merge pull request #4 from monstar-lab-oss/develop

Develop

Author: rasmusebbesen

README.md

@@ -13,6 +13,21 @@ Used to parse the N-Meta headers using following format:
 
 `Meta: [PLATFORM];[ENVIRONMENT];[APP_VERSION];[DEVICE_OS];[DEVICE]`
 
+#### PLATFORM:
+Description of the requesting platform, expects values `android`, `ios` or `web`
+
+#### ENVIRONMENT:
+Description of the environment the request is targeted at, normally `staging` or `production`
+
+#### APP_VERSION:
+Semantic version sting of the requesting client `x.y.z`
+
+#### DEVICE_OS:
+Version of the operating system the request was made from. Not if platform is web, eg. `10.2` 
+
+#### DEVICE:
+Description of the device making the request, eg. `iphone-x`
+
 ## 📦 Installation
 
 To install this package you will need:

composer.json

@@ -6,12 +6,17 @@
         "php"
     ],
     "license": "MIT",
-    "homepage": "http://monstar-lab.com",
+    "homepage": "https://monstar-lab.com",
     "authors": [
         {
             "name": "Casper Rasmussen",
             "email": "cr@nodes.dk",
             "role": "CTO & Partner"
+        },
+        {
+            "name": "Rasmus Ebbesen",
+            "email": "rasmus.ebbesen@monstar-lab.com",
+            "role": ""
         }
     ],
     "require": {

src/NMeta.php

@@ -148,8 +148,31 @@ public function __construct(?string $header = null, Config $config = null)
 
         $this->version = $headerArr[2];
         $versionArr = explode('.', $this->version);
+
+        if (count($versionArr) != 3) {
+            $message = 'Meta header: Invalid app version, invalid amount of segments. Expected semver [x.y.z]';
+            throw new BadRequestException($message);
+        }
+
+        if (!is_numeric($versionArr[0])) {
+            $message = 'Meta header: Invalid Major version, expected integer';
+            throw new BadRequestException($message);
+        }
+
         $this->majorVersion = $versionArr[0] ?? 0;
+
+        if (!is_numeric($versionArr[1])) {
+            $message = 'Meta header: Invalid Minor version, expected integer';
+            throw new BadRequestException($message);
+        }
+
         $this->minorVersion = $versionArr[1] ?? 0;
+
+        if (!is_numeric($versionArr[2])) {
+            $message = 'Meta header: Invalid Patch version, expected integer';
+            throw new BadRequestException($message);
+        }
+
         $this->patchVersion = $versionArr[2] ?? 0;
 
         // Parse device os version

tests/NMetaTest.php

@@ -78,4 +78,53 @@ public function testFailureMissingDevice()
         $this->expectException(BadRequestException::class);
         $meta = new NMeta('ios;production;1.0.0;10.2');
     }
+
+    public function testFailureInvalidAppMajorVersion()
+    {
+        $this->expectException(BadRequestException::class);
+
+        try {
+            $meta = new NMeta('android;staging;1-staging.0.0;Android 12;SM-G975F');
+        } catch (BadRequestException $e) {
+            $this->assertEquals('Meta header: Invalid Major version, expected integer', $e->getMessage());
+            throw $e;
+        }
+    }
+
+    public function testFailureInvalidAppMinorVersion()
+    {
+        $this->expectException(BadRequestException::class);
+
+        try {
+            $meta = new NMeta('android;staging;1.0-staging.0;Android 12;SM-G975F');
+        } catch (BadRequestException $e) {
+            $this->assertEquals('Meta header: Invalid Minor version, expected integer', $e->getMessage());
+            throw $e;
+        }
+    }
+
+    public function testFailureInvalidAppPatchVersion()
+    {
+        $this->expectException(BadRequestException::class);
+
+        try {
+            $meta = new NMeta('android;staging;1.0.0-staging;Android 12;SM-G975F');
+        } catch (BadRequestException $e) {
+            $this->assertEquals('Meta header: Invalid Patch version, expected integer', $e->getMessage());
+            throw $e;
+        }
+    }
+
+    public function testFailureInvalidAmountOfVersionSegments()
+    {
+        $this->expectException(BadRequestException::class);
+        
+        try {
+            $meta = new NMeta('android;staging;1.0;Android 12;SM-G975F');
+        } catch (BadRequestException $e) {
+            $expected = 'Meta header: Invalid app version, invalid amount of segments. Expected semver [x.y.z]';
+            $this->assertEquals($expected, $e->getMessage());
+            throw $e;
+        }
+    }
 }