Merge pull request #119 from tiborb/internal_search

Added addReferer method to config reader

Author: lstrojny

php/src/Snowplow/RefererParser/Config/ConfigFileReaderTrait.php

@@ -18,6 +18,8 @@ private function init($fileName)
         }
 
         $this->fileName = $fileName;
+        
+        $this->read();
     }
 
     abstract protected function parse($content);
@@ -29,24 +31,42 @@ private function read()
         }
 
         $hash = $this->parse(file_get_contents($this->fileName));
-
+ 
         foreach ($hash as $medium => $referers) {
             foreach ($referers as $source => $referer) {
                 foreach ($referer['domains'] as $domain) {
-                    $this->referers[$domain] = [
-                        'source'     => $source,
-                        'medium'     => $medium,
-                        'parameters' => isset($referer['parameters']) ? $referer['parameters'] : [],
-                    ];
+                    $parameters = isset($referer['parameters']) ? $referer['parameters'] : [];
+                    $this->addReferer($domain, $source, $medium, $parameters);
                 }
             }
         }
     }
+    
+    /**
+     * Add referer
+     * 
+     * @param string $domain 
+     * @param string $source
+     * @param string $medium
+     * @param array $parameters
+     */
+    public function addReferer($domain, $source, $medium, array $parameters = [])
+    {
+        $this->referers[$domain] = [
+            'source' => $source,
+            'medium' => $medium,
+            'parameters' => $parameters,
+        ];
+    }
 
+    /**
+     * Lookup host
+     * 
+     * @param string $lookupString
+     * @return array|null
+     */
     public function lookup($lookupString)
     {
-        $this->read();
-
         return isset($this->referers[$lookupString]) ? $this->referers[$lookupString] : null;
     }
 }

php/tests/Snowplow/RefererParser/Tests/Config/AbstractConfigReaderTest.php

@@ -17,4 +17,24 @@ public function testExceptionIsThrownIfFileDoesNotExist()
         );
         $this->createConfigReader('INVALIDFILE');
     }
+    
+    public function testAddReferer()
+    {
+        $reader = $this->createConfigReaderFromFile();
+        $this->assertNull($reader->addReferer("intra.example.com", "Custom search", "search", ['searchq']));
+        
+        $res = $reader->lookup("intra.example.com");
+        $this->assertArrayHasKey('source', $res);
+        $this->assertArrayHasKey('medium', $res);
+        $this->assertNotEmpty('parameters', $res);
+        
+        $this->assertNull($reader->lookup("nosearch.example.com"));
+    }
+    
+    public function testErrorOnAddingWrongReferer()
+    {
+        $reader = $this->createConfigReaderFromFile();
+        $this->setExpectedException('Exception');
+        $this->assertNull($reader->addReferer("intra.example.com", "Custom search", "search", 'noarray'));
+    }
 }

php/tests/Snowplow/RefererParser/Tests/Config/JsonConfigReaderTest.php

@@ -9,4 +9,9 @@ protected function createConfigReader($fileName)
     {
         return new JsonConfigReader($fileName);
     }
+    
+    protected function createConfigReaderFromFile()
+    {
+        return $this->createConfigReader(__DIR__ . '/../../../../../data/referers.json');
+    }
 }

php/tests/Snowplow/RefererParser/Tests/Config/YamlConfigReaderTest.php

@@ -9,4 +9,9 @@ protected function createConfigReader($fileName)
     {
         return new YamlConfigReader($fileName);
     }
+    
+    protected function createConfigReaderFromFile()
+    {
+        return $this->createConfigReader(__DIR__ . '/../../../../../data/referers.yml');
+    }
 }