Merge pull request #68 from findologic/develop

Develop

Author: Dominik Brader

src/Definitions/QueryParameter.php

@@ -19,6 +19,7 @@ class QueryParameter extends Definition
         FIRST = 'first',
         IDENTIFIER = 'identifier',
         GROUP = 'group',
+        USERGROUP = 'usergrouphash',
         FORCE_ORIGINAL_QUERY = 'forceOriginalQuery',
         OUTPUT_ATTRIB = 'outputAttrib',
         SELECTED = 'selected',

src/Requests/Request.php

@@ -145,6 +145,25 @@ public function addGroup($value)
         return $this;
     }
 
+    /**
+     * Adds the hashed usergroup param.
+     *
+     * @param $value string
+     * @return $this
+     */
+    public function addUserGroup($value)
+    {
+        $validator = new ParameterValidator([QueryParameter::USERGROUP => $value]);
+        $validator->rule('string', QueryParameter::USERGROUP);
+
+        if (!$validator->validate()) {
+            throw new InvalidParamException(QueryParameter::USERGROUP);
+        }
+
+        $this->addParam(QueryParameter::USERGROUP, [$value], self::ADD_VALUE);
+        return $this;
+    }
+
     /**
      * Adds the outputAdapter param. It is used to override the output format.
      *

tests/Tests/Definitions/QueryParameterTest.php

@@ -24,6 +24,7 @@ public function testAllQueryParametersAreAvailable()
             'FIRST' => 'first',
             'IDENTIFIER' => 'identifier',
             'GROUP' => 'group',
+            'USERGROUP' => 'usergrouphash',
             'FORCE_ORIGINAL_QUERY' => 'forceOriginalQuery',
             'OUTPUT_ATTRIB' => 'outputAttrib',
             'SELECTED' => 'selected',

tests/Tests/Requests/Autocomplete/SuggestRequestTest.php

@@ -49,7 +49,7 @@ public function testSendingRequestsWithoutRequiredParamsWillThrowAnException()
             $this->assertEquals('Required param query is not set.', $e->getMessage());
         }
 
-        $this->httpClientMock->method('request')->willReturn($this->responseMock);
+        $this->httpClientMock->method('get')->willReturn($this->responseMock);
         $this->responseMock->method('getBody')->willReturn($this->streamMock);
         $this->responseMock->method('getStatusCode')->willReturn(200);
         $this->streamMock->method('getContents')

tests/Tests/Requests/SearchNavigation/SearchNavigationRequestDataProvider.php

@@ -389,4 +389,22 @@ public function individualParamProvider()
             'more different individual param' => ['best & *_\' shoes © ever!', 'very very FuNnY!!!', 'set']
         ];
     }
+
+    public function userGroupProvider()
+    {
+        return [
+            'normal usergroup' => ['NDEmNgEN'],
+            'other usergrouphash' => ['HaKeLfGN'],
+            'more different usergrouphash' => ['ThisGroupMayBeValid']
+        ];
+    }
+
+    public function invalidUserGroupProvider()
+    {
+        return [
+            'usergrouphash is an integer' => [123],
+            'usergrouphash is an array' => [['aaaah']],
+            'usergrouphash is an object' => [new \stdClass()],
+        ];
+    }
 }

tests/Tests/Requests/SearchNavigation/SearchNavigationRequestTest.php

@@ -55,7 +55,7 @@ public function requiredParamsProvider()
      */
     public function testSendingSearchRequestsWithoutRequiredParamsWillThrowAnException(array $options)
     {
-        $this->httpClientMock->method('request')->willReturn($this->responseMock);
+        $this->httpClientMock->method('get')->willReturn($this->responseMock);
         $this->responseMock->method('getBody')->willReturn($this->streamMock);
         $this->responseMock->method('getStatusCode')->willReturn(200);
         $this->streamMock->method('getContents')
@@ -88,7 +88,7 @@ public function testSendingSearchRequestsWithoutRequiredParamsWillThrowAnExcepti
 
     public function testSendingNavigationRequestsWithoutRequiredParamsWillThrowAnException()
     {
-        $this->httpClientMock->method('request')->willReturn($this->responseMock);
+        $this->httpClientMock->method('get')->willReturn($this->responseMock);
         $this->responseMock->method('getBody')->willReturn($this->streamMock);
         $this->responseMock->method('getStatusCode')->willReturn(200);
         $this->streamMock->method('getContents')
@@ -648,6 +648,39 @@ public function testInvalidGroupWillThrowAnException($invalidGroup)
         $searchRequest->addGroup($invalidGroup);
     }
 
+    /**
+     * @dataProvider userGroupProvider
+     *
+     * @param string $expectedUserGroupHash
+     */
+    public function testAddUserGroupWillSetItInAValidFormat($expectedUserGroupHash)
+    {
+        $expectedParameter = 'usergrouphash';
+
+        $searchRequest = new SearchRequest();
+        $this->setRequiredParamsForSearchNavigationRequest($searchRequest);
+
+        $searchRequest->addUserGroup($expectedUserGroupHash);
+        $params = $searchRequest->getParams();
+        $this->assertArrayHasKey($expectedParameter, $params);
+        $this->assertEquals([$expectedUserGroupHash], $params[$expectedParameter]);
+    }
+
+    /**
+     * @dataProvider invalidUserGroupProvider
+     * @param mixed $invalidUserGroup
+     */
+    public function testInvalidUserGroupWillThrowAnException($invalidUserGroup)
+    {
+        $this->expectException(InvalidParamException::class);
+        $this->expectExceptionMessage('Parameter usergrouphash is not valid.');
+
+        $searchRequest = new SearchRequest();
+        $this->setRequiredParamsForSearchNavigationRequest($searchRequest);
+
+        $searchRequest->addUserGroup($invalidUserGroup);
+    }
+
     /**
      * @dataProvider attributeProvider
      * @param string $expectedAttributeName