Merge pull request #252 from seregazhuk/develop

Provider refactoring
seregazhuk · Mar 18, 2017 · f44927c · f44927c
2 parents 71ed185 + 87868c5
commit f44927c
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 54 deletions.
diff --git a/phpunit.xml b/phpunit.xml
@@ -19,14 +19,18 @@
         <whitelist>
             <directory suffix=".php">./src/</directory>
             <exclude>
-                <file>/src/Api/Providers/Topics.php</file>
-                <file>/src/Api/Providers/Boards.php</file>
-                <file>/src/Api/Providers/Comments.php</file>
-                <file>/src/Api/Providers/Inbox.php</file>
-                <file>/src/Api/Providers/Pins.php</file>
-                <file>/src/Api/Providers/Pinners.php</file>
-                <file>/src/Api/Providers/Interests.php</file>
-                <file>/src/Api/Providers/User.php</file>
+                <file>./src/Api/Providers/Core/EntityProvider.php</file>
+                <file>./src/Api/Providers/Topics.php</file>
+                <file>./src/Api/Providers/Boards.php</file>
+                <file>./src/Api/Providers/Comments.php</file>
+                <file>./src/Api/Providers/Inbox.php</file>
+                <file>./src/Api/Providers/Pins.php</file>
+                <file>./src/Api/Providers/Pinners.php</file>
+                <file>./src/Api/Providers/Password.php</file>
+                <file>./src/Api/Providers/Interests.php</file>
+                <file>./src/Api/Providers/User.php</file>
+                <file>./src/Api/Providers/Auth.php</file>
+                <file>./src/Api/Providers/Keywords.php</file>
             </exclude>
         </whitelist>
     </filter>

diff --git a/src/Api/Providers/Auth.php b/src/Api/Providers/Auth.php
@@ -176,9 +176,9 @@ protected function processLogin($username, $password)
             'password'          => $password,
         ];
 
-        $response = $this->post($credentials, UrlBuilder::RESOURCE_LOGIN, true);
+        $this->post($credentials, UrlBuilder::RESOURCE_LOGIN);
 
-        if ($response->hasErrors()) return false;
+        if ($this->response->hasErrors()) return false;
 
         $this->request->login();
 

diff --git a/src/Api/Providers/Core/Provider.php b/src/Api/Providers/Core/Provider.php
@@ -45,17 +45,16 @@ public function __construct(Request $request, Response $response)
      *
      * @param array $requestOptions
      * @param string $resourceUrl
-     * @param bool $returnResponse
      *
      * @return Response|bool
      */
-    protected function post($requestOptions, $resourceUrl, $returnResponse = false)
+    protected function post($requestOptions, $resourceUrl)
     {
         $postString = Request::createQuery($requestOptions);
 
         $this->execute($resourceUrl, $postString);
 
-        return $returnResponse ? $this->response : $this->response->isOk();
+        return $this->response->isOk();
 
     }
 
@@ -64,10 +63,9 @@ protected function post($requestOptions, $resourceUrl, $returnResponse = false)
      *
      * @param array $requestOptions
      * @param string $resourceUrl
-     * @param bool $returnResponse
      * @return array|bool|Response
      */
-    protected function get(array $requestOptions = [], $resourceUrl = '', $returnResponse = false)
+    protected function get(array $requestOptions = [], $resourceUrl = '')
     {
         $query = Request::createQuery(
             $requestOptions,
@@ -76,7 +74,7 @@ protected function get(array $requestOptions = [], $resourceUrl = '', $returnRes
 
         $this->execute($resourceUrl . '?' . $query);
 
-        return $returnResponse ? $this->response : $this->response->getResponseData();
+        return $this->response->getResponseData();
 
     }
 
@@ -121,8 +119,11 @@ public function isLoggedIn()
      */
     protected function paginate($data, $resourceUrl, $limit = Pagination::DEFAULT_LIMIT)
     {
-        return $this->paginateCustom(function() use ($data, $resourceUrl) {
-                return $this->get($data, $resourceUrl, true);
+        return $this
+            ->paginateCustom(function () use ($data, $resourceUrl) {
+                $this->get($data, $resourceUrl);
+
+                return $this->response;
             })->take($limit);
     }
 

diff --git a/src/Api/Providers/Password.php b/src/Api/Providers/Password.php
@@ -54,7 +54,7 @@ public function reset($link, $newPassword)
             'expiration'           => $query['e'],
         ];
 
-        return $this->post($request, UrlBuilder::RESOURCE_RESET_PASSWORD_UPDATE, true);
+        return $this->post($request, UrlBuilder::RESOURCE_RESET_PASSWORD_UPDATE);
     }
 
     /**

diff --git a/src/Api/Providers/Pins.php b/src/Api/Providers/Pins.php
@@ -84,9 +84,9 @@ public function create($imageUrl, $boardId, $description = '', $link = '')
             'board_id'    => $boardId,
         ];
 
-        return $this
-            ->post($requestOptions, UrlBuilder::RESOURCE_CREATE_PIN, true)
-            ->getResponseData();
+        $this->post($requestOptions, UrlBuilder::RESOURCE_CREATE_PIN);
+
+        return $this->response->getResponseData();
     }
 
     /**
@@ -140,9 +140,9 @@ public function repin($repinId, $boardId, $description = '')
             'pin_id'      => $repinId,
         ];
 
-        return $this
-            ->post($requestOptions, UrlBuilder::RESOURCE_REPIN, true)
-            ->getResponseData();
+        $this->post($requestOptions, UrlBuilder::RESOURCE_REPIN);
+
+        return $this->response->getResponseData();
     }
 
     /**

diff --git a/src/Api/Traits/HandlesRequest.php b/src/Api/Traits/HandlesRequest.php
@@ -11,19 +11,17 @@ trait HandlesRequest
      *
      * @param array $requestOptions
      * @param string $resourceUrl
-     * @param bool $returnResponse
      *
      * @return Response|bool
      */
-    abstract protected function post($requestOptions, $resourceUrl, $returnResponse = false);
+    abstract protected function post($requestOptions, $resourceUrl);
 
     /**
      * Executes a GET request to Pinterest API.
      *
      * @param array $requestOptions
      * @param string $resourceUrl
-     * @param bool $returnResponse
      * @return array|bool|Response
      */
-    abstract protected function get(array $requestOptions = [], $resourceUrl = '', $returnResponse = false);
-}
+    abstract protected function get(array $requestOptions = [], $resourceUrl = '');
+}
diff --git a/src/Api/Traits/Searchable.php b/src/Api/Traits/Searchable.php
@@ -62,7 +62,7 @@ protected function execSearchRequest($query, $scope)
      */
     public function search($query, $limit = Pagination::DEFAULT_LIMIT)
     {
-        return $this->paginateCustom(function() use ($query) {
+        return $this->paginateCustom(function () use ($query) {
                 return $this->execSearchRequest($query, $this->getSearchScope());
             })->take($limit);
     }

diff --git a/tests/Bot/ProviderTest.php b/tests/Bot/ProviderTest.php
@@ -67,21 +67,6 @@ public function it_should_clear_response_before_pagination()
         $provider->dummyPaginate(['test' => 'test'], 'http://example.com')->toArray();
     }
 
-    /** @test */
-    public function it_should_return_response_object_if_required_for_get_request()
-    {
-        $provider = $this->makeProvider([]);
-
-        $this->assertInstanceOf(Response::class, $provider->dummyGet(true));
-    }
-
-    /** @test */
-    public function it_should_return_response_object_if_required_for_post_request()
-    {
-        $provider = $this->makeProvider([]);
-
-        $this->assertInstanceOf(Response::class, $provider->dummyPost(true));
-    }
 
     /** @test */
     public function it_should_return_bool_if_required_for_post_request()
@@ -90,7 +75,7 @@ public function it_should_return_bool_if_required_for_post_request()
 
         $provider = $this->makeProvider($response);
 
-        $this->assertTrue($provider->dummyPost(false));
+        $this->assertTrue($provider->dummyPost());
     }
 
     /**
@@ -134,20 +119,18 @@ public function dummyPaginate($data, $resourceUrl)
     }
 
     /**
-     * @param bool $returnResponse
      * @return array|bool|Response
      */
-    public function dummyGet($returnResponse)
+    public function dummyGet()
     {
-        return $this->get([], '', $returnResponse);
+        return $this->get([], '');
     }
 
     /**
-     * @param bool $returnResponse
      * @return array|bool|Response
      */
-    public function dummyPost($returnResponse)
+    public function dummyPost()
     {
-        return $this->post([], '', $returnResponse);
+        return $this->post([], '');
     }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -54,7 +54,7 @@ public function reset($link, $newPassword) @@
                 'expiration'           => $query['e'],
             ];
-            return $this->post($request, UrlBuilder::RESOURCE_RESET_PASSWORD_UPDATE, true);
+            return $this->post($request, UrlBuilder::RESOURCE_RESET_PASSWORD_UPDATE);
         }
         /**
@@ Expand Down @@