Merge remote-tracking branch 'github/master'

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## v5.2.5 - 2017-03-18
+### Fixed:
+ - Pagination fails on last response.
+
 ## v5.2.4 - 2017-03-16
 ### Added:
  - Pinners *tried* pins.
@@ -10,6 +14,7 @@ All notable changes to this project will be documented in this file.
  - Pins *activity()* and *tried()* methods always return Pagination object.
  - Boards *forUser* method returns detailed information for every board. If no boards
  are available it returns empty array.
+  - Pagination processes *getResponseData()* as array
 
 ## v5.2.3 - 2017-01-24
 ### Fixed:

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>

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();
 

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();
 
     }
 
@@ -75,9 +74,7 @@ protected function get(array $requestOptions = [], $resourceUrl = '')
 
         $this->execute($resourceUrl . '?' . $query);
 
-        return $this->response->hasBookmarks() ?
-            $this->response :
-            $this->response->getResponseData();
+        return $this->response->getResponseData();
 
     }
 
@@ -122,12 +119,17 @@ public function isLoggedIn()
      */
     protected function paginate($data, $resourceUrl, $limit = Pagination::DEFAULT_LIMIT)
     {
-        return $this->paginateCustom(function() use ($data, $resourceUrl) {
-                return $this->get($data, $resourceUrl);
+        return $this
+            ->paginateCustom(function () use ($data, $resourceUrl) {
+                $this->get($data, $resourceUrl);
+
+                return $this->response;
             })->take($limit);
     }
 
     /**
+     * Accepts callback which should return PaginatedResponse object.
+     *
      * @param callable $callback
      * @param int $limit
      * @return Pagination

src/Api/Providers/Keywords.php

@@ -20,7 +20,7 @@ public function recommendedFor($query)
             'query' => $query,
         ];
 
-        $result = $this->get($requestOptions, UrlBuilder::getSearchUrl());
+        $result = $this->get($requestOptions, UrlBuilder::RESOURCE_SEARCH);
 
         return $this->getKeywordsFromRequest($result);
     }

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);
     }
 
     /**

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();
     }
 
     /**

src/Api/Traits/HandlesRequest.php

@@ -11,11 +11,10 @@ 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.
@@ -25,4 +24,4 @@ abstract protected function post($requestOptions, $resourceUrl, $returnResponse
      * @return array|bool|Response
      */
     abstract protected function get(array $requestOptions = [], $resourceUrl = '');
-}
+}

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);
     }

src/Helpers/Pagination.php

@@ -5,7 +5,8 @@
 use Traversable;
 use EmptyIterator;
 use IteratorAggregate;
-use seregazhuk\PinterestBot\Api\Response;
+use seregazhuk\PinterestBot\Api\Contracts\PaginatedResponse;
+
 
 /**
  * Class Pagination
@@ -53,7 +54,7 @@ public function __construct($limit = self::DEFAULT_LIMIT)
     }
 
     /**
-     * Sets a callback to make requests. Should be a closure.
+     * Sets a callback to make requests. Callback should return PaginatedResponse object.
      *
      * @param callable $callback
      * @return $this
@@ -135,15 +136,14 @@ protected function processCallback()
     {
         $this->resultsNum = 0;
         $this->processed = 0;
-        $callback = $this->callback;
 
         while (true) {
-            /** @var Response $response */
-            $response = $callback();
+            /** @var PaginatedResponse $response */
+            $response = call_user_func($this->callback);
 
             if ($response->isEmpty()) return;
 
-            foreach ($response->getResponseData() as $result) {
+            foreach ($this->getResultsFromResponse($response) as $result) {
                 $this->processed++;
 
                 if ($this->processed > $this->offset) {
@@ -157,4 +157,15 @@ protected function processCallback()
             if (!$response->hasBookmarks()) return;
         }
     }
+
+    /**
+     * @param $response
+     * @return array
+     */
+    protected function getResultsFromResponse(PaginatedResponse $response)
+    {
+        $results = $response->getResponseData();
+
+        return $results === false ? [] : $results;
+    }
 }

tests/Bot/PaginationTest.php

@@ -2,6 +2,7 @@
 
 namespace seregazhuk\tests\Bot;
 
+use Mockery;
 use PHPUnit_Framework_TestCase;
 use seregazhuk\PinterestBot\Api\Response;
 use seregazhuk\tests\Helpers\ResponseHelper;
@@ -18,7 +19,7 @@ class PaginationTest extends PHPUnit_Framework_TestCase
     public function it_returns_first_result_when_no_bookmarks()
     {
         $pagination = new Pagination();
-        $responseData = $this->createPaginatedResponse($this->paginatedResponse);
+        $responseData = $this->createSuccessApiResponse($this->paginatedResponse);
 
         $pagination->paginateOver(function() use ($responseData){
             return (new Response())->fill($responseData);
@@ -119,6 +120,17 @@ public function it_accepts_limit_in_constructor()
 
         $this->assertEquals($expected, $pagination->toArray());
     }
+
+    /** @test */
+    public function it_stops_when_response_is_empty()
+    {
+        $pagination = new Pagination();
+        $pagination->paginateOver(function(){
+            return (new Response())->fill([]);
+        });
+
+        $this->assertCount(0, $pagination->toArray());
+    }
 }