Merge pull request #6 from renoki-co/feature/collection

[feature] Collection

Author: rennokki

README.md

@@ -31,7 +31,25 @@ $subreddit = Reddit::subreddit(
     $app
 );
 
-$posts = $subreddit->get()['data']['children'] ?? [];
+$posts = $subreddit->get();
+
+foreach ($posts as $post) {
+    $id = $post['id'];
+}
+```
+
+When retrieving posts, the results are wrapped in a `Rennokki\RedditApi\RedditList` class. This class is based on Laravel Collection and you can pipeline actions on it more easily. Please see [Laravel Collections documentantion](https://laravel.com/docs/master/collections).
+
+## Pagination
+
+For pagination purposes, you shall call `nextPage()` from the previous `$posts`:
+
+```php
+$subreddit = Reddit::subreddit('funny', $app);
+
+$posts = $subreddit->get();
+
+$nextPageOfPosts = $posts->nextPage();
 ```
 
 ## Sorting
@@ -81,18 +99,6 @@ $subreddit = Reddit::subreddit('funny', $app);
 $subreddit->setLimit(100);
 ```
 
-## Before & After tokens
-
-For paginating, you shall specify before & after from previous requests:
-
-```php
-$subreddit = Reddit::subreddit('funny', $app);
-
-$subreddit->before(...);
-
-$subreddit->after(...);
-```
-
 ## Debugging
 
 If you wish to inspect the URL that is being called, you ca do so:

composer.json

@@ -16,7 +16,8 @@
     ],
     "require": {
         "php": "^7.0",
-        "guzzlehttp/guzzle": "^6.5"
+        "guzzlehttp/guzzle": "^6.5",
+        "illuminate/support": "^5.5|^6.0|^7.0"
     },
     "require-dev": {
         "orchestra/database": "^5.0",

src/RedditList.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Rennokki\RedditApi;
+
+use Illuminate\Support\Collection;
+
+class RedditList extends Collection
+{
+    /**
+     * The Subreddit instance from which
+     * the content was filled.
+     *
+     * @var \Rennokki\RedditApi\Subreddit
+     */
+    protected $subreddit;
+
+    /**
+     * The `after` token for pagination.
+     *
+     * @return string|null
+     */
+    protected $after = null;
+
+    /**
+     * Set the Subreddit instance from which
+     * the content was filled.
+     *
+     * @param  \Rennokki\RedditApi\Subreddit  $subreddit
+     * @return $this
+     */
+    public function setSubreddit(Subreddit $subreddit)
+    {
+        $this->subreddit = $subreddit;
+
+        return $this;
+    }
+
+    /**
+     * Set the after token from the request.
+     *
+     * @param  string|null  $after
+     * @return $this
+     */
+    public function setAfter($after)
+    {
+        $this->after = $after;
+
+        return $this;
+    }
+
+    /**
+     * Get the next page of results.
+     *
+     * @return \Rennokki\RedditApi\RedditList
+     */
+    public function nextPage()
+    {
+        return $this->subreddit
+            ->after($this->getAfter())
+            ->get();
+    }
+
+    /**
+     * Get the after token.
+     *
+     * @return string|null
+     */
+    public function getAfter()
+    {
+        return $this->after;
+    }
+}

src/Subreddit.php

@@ -21,13 +21,6 @@ class Subreddit
      */
     protected $after = null;
 
-    /**
-     * The `before` token for pagination.
-     *
-     * @return string|null
-     */
-    protected $before = null;
-
     /**
      * The limit on each page.
      * An `after` is passed by the API
@@ -84,29 +77,16 @@ public function __construct(string $subreddit, App $app)
     /**
      * Set the after token.
      *
-     * @param  string  $before
+     * @param  string|null  $after
      * @return $this
      */
-    public function after(string $after)
+    public function after($after)
     {
         $this->after = $after;
 
         return $this;
     }
 
-    /**
-     * Set the before token.
-     *
-     * @param  string  $before
-     * @return $this
-     */
-    public function before(string $before)
-    {
-        $this->before = $before;
-
-        return $this;
-    }
-
     /**
      * Set the limit of posts.
      *
@@ -173,7 +153,15 @@ public function get()
             );
         }
 
-        return @json_decode($request->getBody(), true);
+        $response = @json_decode($request->getBody(), true);
+
+        $posts = collect($response['data']['children'])
+            ->pluck('data')
+            ->toArray();
+
+        return (new RedditList($posts))
+            ->setSubreddit($this)
+            ->setAfter($response['data']['after'] ?? null);
     }
 
     /**
@@ -203,10 +191,6 @@ public function getCallableUrl(): string
             $parameters['after'] = $this->after;
         }
 
-        if ($this->before) {
-            $parameters['before'] = $this->before;
-        }
-
         $query = http_build_query($parameters);
 
         return "{$url}.json?{$query}";

tests/RedditTest.php

@@ -2,8 +2,8 @@
 
 namespace Rennokki\RedditApi\Test;
 
-use Exception;
 use Rennokki\RedditApi\Reddit;
+use  Rennokki\RedditApi\RedditList;
 use Rennokki\RedditApi\Subreddit;
 
 class RedditTest extends TestCase
@@ -64,15 +64,6 @@ public function test_after()
         );
     }
 
-    public function test_before()
-    {
-        $this->api->before('111');
-
-        $this->assertStringContainsString(
-            'before=111', $this->api->getCallableUrl()
-        );
-    }
-
     public function test_sort_filtering()
     {
         foreach (Subreddit::$sorts as $sort) {
@@ -128,50 +119,66 @@ public function test_time_filtering()
 
     public function test_top()
     {
-        try {
-            $data = $this
-                ->api
-                ->sort('hot')
-                ->get();
-        } catch (Exception $e) {
-            return $this->assertFalse(true);
-        }
+        $posts = $this
+            ->api
+            ->sort('hot')
+            ->get();
 
-        $this->assertTrue(
-            count($data['data']['children']) > 1
-        );
+        $this->assertInstanceOf(RedditList::class, $posts);
+
+        $this->assertCount(22, $posts);
+
+        foreach ($posts as $post) {
+            $this->assertNotNull($post['permalink'] ?? null);
+        }
     }
 
     public function test_hot()
     {
-        try {
-            $data = $this
-                ->api
-                ->sort('top')
-                ->time('all')
-                ->get();
-        } catch (Exception $e) {
-            return $this->assertFalse(true);
-        }
+        $posts = $this
+            ->api
+            ->sort('top')
+            ->time('all')
+            ->get();
 
-        $this->assertTrue(
-            count($data['data']['children']) > 1
-        );
+        $this->assertInstanceOf(RedditList::class, $posts);
+
+        $this->assertCount(20, $posts);
+
+        foreach ($posts as $post) {
+            $this->assertNotNull($post['permalink'] ?? null);
+        }
     }
 
     public function test_new()
     {
-        try {
-            $data = $this
-                ->api
-                ->sort('new')
-                ->get();
-        } catch (Exception $e) {
-            return $this->assertFalse(true);
+        $posts = $this
+            ->api
+            ->sort('new')
+            ->get();
+
+        $this->assertInstanceOf(RedditList::class, $posts);
+
+        $this->assertCount(20, $posts);
+
+        foreach ($posts as $post) {
+            $this->assertNotNull($post['permalink'] ?? null);
         }
+    }
 
-        $this->assertTrue(
-            count($data['data']['children']) > 1
-        );
+    public function test_next_page()
+    {
+        $posts = $this
+            ->api
+            ->sort('new')
+            ->get();
+
+        $firstPageAfter = $posts->getAfter();
+
+        $posts = $posts->nextPage();
+
+        $secondPageAfter = $posts->getAfter();
+
+        $this->assertNotEquals($firstPageAfter, $secondPageAfter);
     }
 }