Merge pull request #30 from hansott/feature-follow-unfollow

✨ Allow (un)following boards and users
hansott · Mar 18, 2018 · e894cc4 · e894cc4
2 parents 9e5d339 + 05e5b47
commit e894cc4
Show file tree

Hide file tree

Showing 33 changed files with 447 additions and 347 deletions.
diff --git a/src/Pinterest/Api.php b/src/Pinterest/Api.php
@@ -95,6 +95,8 @@ public function execute(Request $request, $processor = null)
      *
      * @param Request $request
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     private function fetchUser(Request $request)
@@ -151,7 +153,7 @@ private function fetchPin(Request $request)
     /**
      * Fetch multiple boards and processes the response.
      *
-     * @param Request  $request
+     * @param Request $request
      * @param string[] $fields
      *
      * @throws RateLimitedReached
@@ -217,6 +219,8 @@ private function fetchMultiplePins(Request $request, array $fields = null)
      *
      * @param string $usernameOrId The username or identifier of the user.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getUser($usernameOrId)
@@ -235,6 +239,8 @@ public function getUser($usernameOrId)
      *
      * @param string $boardId The board id.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getBoard($boardId)
@@ -253,6 +259,8 @@ public function getBoard($boardId)
      *
      * @param Board $board The updated board.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function updateBoard(Board $board)
@@ -279,6 +287,8 @@ public function updateBoard(Board $board)
     /**
      * Get the boards of the authenticated user.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getUserBoards()
@@ -291,6 +301,8 @@ public function getUserBoards()
     /**
      * Get the pins of the authenticated user.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getUserPins()
@@ -303,6 +315,8 @@ public function getUserPins()
     /**
      * Get the authenticated user.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getCurrentUser()
@@ -315,6 +329,8 @@ public function getCurrentUser()
     /**
      * Get the followers of the authenticated user.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getUserFollowers()
@@ -327,6 +343,8 @@ public function getUserFollowers()
     /**
      * Get the boards that the authenticated user follows.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getUserFollowingBoards()
@@ -339,6 +357,8 @@ public function getUserFollowingBoards()
     /**
      * Get the users that the authenticated user follows.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getUserFollowing()
@@ -353,6 +373,8 @@ public function getUserFollowing()
      *
      * @link https://www.pinterest.com/explore/901179409185
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getUserInterests()
@@ -367,6 +389,8 @@ public function getUserInterests()
      *
      * @param string $username The username of the user to follow.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function followUser($username)
@@ -386,12 +410,96 @@ public function followUser($username)
         return $this->execute($request);
     }
 
+    /**
+     * Unfollow a user.
+     *
+     * @param string $usernameOrUserId The username or ID of the user to unfollow.
+     *
+     * @throws RateLimitedReached
+     *
+     * @return Response The response
+     */
+    public function unfollowUser($usernameOrUserId)
+    {
+        if (empty($usernameOrUserId)) {
+            throw new InvalidArgumentException('Username or user ID is required.');
+        }
+
+        $request = new Request(
+            'DELETE',
+            "me/following/users/{$usernameOrUserId}"
+        );
+
+        return $this->execute($request);
+    }
+
+    /**
+     * Follow a board.
+     *
+     * @param string $username The username of the user that owns the board
+     * @param string $boardName The name of the board
+     *
+     * @return Response The response
+     *
+     * @throws RateLimitedReached
+     */
+    public function followBoard($username, $boardName)
+    {
+        if (empty($username)) {
+            throw new InvalidArgumentException('Username is required.');
+        }
+
+        if (empty($boardName)) {
+            throw new InvalidArgumentException('The board name is required.');
+        }
+
+        $request = new Request(
+            'POST',
+            'me/following/boards/',
+            array(
+                'board' => "{$username}/{$boardName}",
+            )
+        );
+
+        return $this->execute($request);
+    }
+
+    /**
+     * Unfollow a board.
+     *
+     * @param string $username The username of the user that owns the board
+     * @param string $boardName The name of the board
+     *
+     * @return Response The response
+     *
+     * @throws RateLimitedReached
+     */
+    public function unfollowBoard($username, $boardName)
+    {
+        if (empty($username)) {
+            throw new InvalidArgumentException('Username is required.');
+        }
+
+        if (empty($boardName)) {
+            throw new InvalidArgumentException('The board name is required.');
+        }
+
+        $request = new Request(
+            'DELETE',
+            "me/following/boards/{$username}/{$boardName}"
+        );
+
+        return $this->execute($request);
+    }
+
     /**
      * Create a board.
      *
-     * @param string $name        The board name.
+     * @param string $name The board name.
      * @param string $description The board description.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function createBoard($name, $description = null)
@@ -418,6 +526,8 @@ public function createBoard($name, $description = null)
      *
      * @param int $boardId The board id.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function deleteBoard($boardId)
@@ -434,10 +544,12 @@ public function deleteBoard($boardId)
     /**
      * Create a pin on a board.
      *
-     * @param string      $boardId The board id.
-     * @param string      $note    The note.
-     * @param Image       $image   The image.
-     * @param string|null $link    The link (Optional).
+     * @param string $boardId The board id.
+     * @param string $note The note.
+     * @param Image $image The image.
+     * @param string|null $link The link (Optional).
+     *
+     * @throws RateLimitedReached
      *
      * @return Response The response
      */
@@ -478,6 +590,8 @@ public function createPin($boardId, $note, Image $image, $link = null)
      *
      * @param string $pinId The id of the pin to delete.
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function deletePin($pinId)
@@ -496,6 +610,8 @@ public function deletePin($pinId)
      *
      * @param PagedList $pagedList
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getNextItems(PagedList $pagedList)
@@ -553,6 +669,8 @@ private function buildRequestForPagedList(PagedList $pagedList)
      *
      * @param string $boardId
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function getBoardPins($boardId)
@@ -572,6 +690,8 @@ public function getBoardPins($boardId)
      *
      * @param string $pinId
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The Response
      */
     public function getPin($pinId)
@@ -591,6 +711,8 @@ public function getPin($pinId)
      *
      * @param Pin $pin
      *
+     * @throws RateLimitedReached
+     *
      * @return Response The response
      */
     public function updatePin(Pin $pin)

diff --git a/src/Pinterest/Http/Request.php b/src/Pinterest/Http/Request.php
@@ -131,7 +131,7 @@ public function getHeaders()
      */
     public function isPost()
     {
-        return $this->getMethod() === 'post';
+        return $this->getMethod() === 'POST';
     }
 
     /**
@@ -141,6 +141,6 @@ public function isPost()
      */
     public function isGet()
     {
-        return $this->getMethod() === 'get';
+        return $this->getMethod() === 'GET';
     }
 }
diff --git a/src/Pinterest/Http/Response.php b/src/Pinterest/Http/Response.php
@@ -68,10 +68,12 @@ final class Response
     /**
      * The constructor.
      *
-     * @param Request $request    The request object.
-     * @param int     $statusCode The status code.
-     * @param string  $rawBody    The raw response body.
-     * @param array   $headers    A key => value representation of response headers.
+     * @param Request $request The request object.
+     * @param int $statusCode The status code.
+     * @param string $rawBody The raw response body.
+     * @param array $headers A key => value representation of response headers.
+     *
+     * @throws MalformedJson
      */
     public function __construct(Request $request, $statusCode, $rawBody, array $headers)
     {
@@ -89,10 +91,11 @@ public function __construct(Request $request, $statusCode, $rawBody, array $head
      */
     public function ok()
     {
-        return
+        return (
             !isset($this->body->error)
             && $this->statusCode >= 200
-            && $this->statusCode < 300;
+            && $this->statusCode < 300
+        );
     }
 
     /**