Allow empty shortname in search results (#63)

Author: FabienVINCENT

src/ResultDecoder.php

@@ -23,7 +23,7 @@ class ResultDecoder
     public const HISTORICAL_DATA_HEADER_LINE = ['Date', 'Open', 'High', 'Low', 'Close', 'Adj Close', 'Volume'];
     public const DIVIDEND_DATA_HEADER_LINE = ['Date', 'Dividends'];
     public const SPLIT_DATA_HEADER_LINE = ['Date', 'Stock Splits'];
-    public const SEARCH_RESULT_FIELDS = ['symbol', 'shortname', 'exchange', 'quoteType', 'exchDisp', 'typeDisp'];
+    public const SEARCH_RESULT_FIELDS = ['symbol', 'exchange', 'quoteType', 'exchDisp', 'typeDisp'];
 
     public const OPTION_CHAIN_FIELDS_MAP = [
         'underlyingSymbol' => ValueMapperInterface::TYPE_STRING,
@@ -154,7 +154,7 @@ private function createSearchResultFromJson(array $json): SearchResult
 
         return new SearchResult(
             $json['symbol'],
-            $json['shortname'],
+            $json['shortname'] ?? null,
             $json['exchange'],
             $json['quoteType'],
             $json['exchDisp'],

tests/Unit/ResultDecoderTest.php

@@ -514,6 +514,39 @@ public function transformSearchResult_jsonWithMissedFieldGiven_createSearchResul
         $this->resultDecoder->transformSearchResult(json_encode($jsonArray));
     }
 
+    #[Test]
+    public function transformSearchResult_jsonWithoutShortname_createSearchResultWithNullShortname(): void
+    {
+        $jsonArray = [
+            'quotes' => [
+                [
+                    'symbol' => 'AAPL',
+                    'exchange' => 'NMS',
+                    'quoteType' => 'EQUITY',
+                    'exchDisp' => 'NASDAQ',
+                    'typeDisp' => 'Equity',
+                    // shortname is intentionally missing
+                ],
+            ],
+        ];
+
+        $returnedResult = $this->resultDecoder->transformSearchResult(json_encode($jsonArray));
+
+        $this->assertIsArray($returnedResult);
+        $this->assertCount(1, $returnedResult);
+        $this->assertContainsOnlyInstancesOf(SearchResult::class, $returnedResult);
+
+        $expectedItem = new SearchResult(
+            'AAPL',
+            null, // shortname should be null
+            'NMS',
+            'EQUITY',
+            'NASDAQ',
+            'Equity'
+        );
+        $this->assertEquals($expectedItem, $returnedResult[0]);
+    }
+
     #[Test]
     #[DataProvider('provideTransformQuotesInvalidResult')]
     public function transformOptionChains_jsonGiven_createArrayOfInvalidResult(array $responseBody): void