Merge pull request #3 from turanct/bugfix-return-types

Bugfix return types

src/Pinterest/Api.php

@@ -100,7 +100,7 @@ private function execute(Request $request, callable $processor = null)
     /**
      * Fetches a single user and processes the response.
      *
-     * @return Http\Response The response.
+     * @return Objects\User The User.
      */
     private function fetchUser(Request $request)
     {
@@ -114,7 +114,7 @@ private function fetchUser(Request $request)
     /**
      * Fetches a single board and processes the response.
      *
-     * @return Http\Response The response.
+     * @return Objects\Board The Board.
      */
     private function fetchBoard(Request $request)
     {
@@ -128,7 +128,7 @@ private function fetchBoard(Request $request)
     /**
      * Fetches multiple boards and processes the response.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\Board] A list of Boards.
      */
     private function fetchMultipleBoards(Request $request)
     {
@@ -142,7 +142,7 @@ private function fetchMultipleBoards(Request $request)
     /**
      * Fetches multiple users and processes the response.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\User] A list of Users.
      */
     private function fetchMultipleUsers(Request $request)
     {
@@ -156,7 +156,7 @@ private function fetchMultipleUsers(Request $request)
     /**
      * Fetches multiple boards and processes the response.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\Pin] A list of Pins.
      */
     private function fetchMultiplePins(Request $request)
     {
@@ -172,7 +172,7 @@ private function fetchMultiplePins(Request $request)
      *
      * @param $usernameOrId string The username or identifier of the user.
      *
-     * @return Http\Response The response.
+     * @return Objects\User The User.
      */
     public function getUser($usernameOrId)
     {
@@ -187,7 +187,7 @@ public function getUser($usernameOrId)
      *
      * @param string $id The board identifier.
      *
-     * @return Http\Response The response.
+     * @return Objects\Board The Board.
      */
     public function getBoard($id)
     {
@@ -199,7 +199,7 @@ public function getBoard($id)
     /**
      * Returns the boards of the authenticated user.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\Board] A list of Boards.
      */
     public function getUserBoards()
     {
@@ -211,7 +211,7 @@ public function getUserBoards()
     /**
      * Returns the pins of the authenticated user.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\Pin] A list of Likes.
      */
     public function getUserLikes()
     {
@@ -223,7 +223,7 @@ public function getUserLikes()
     /**
      * Returns the pins of the authenticated user.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\Pin] A list of Pins.
      */
     public function getUserPins()
     {
@@ -235,7 +235,7 @@ public function getUserPins()
     /**
      * Returns the authenticated user.
      *
-     * @return Http\Response The response.
+     * @return Objects\User The current User.
      */
     public function getCurrentUser()
     {
@@ -247,7 +247,7 @@ public function getCurrentUser()
     /**
      * Returns the followers of the authenticated user.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\User] The current User's followers.
      */
     public function getUserFollowers()
     {
@@ -259,7 +259,7 @@ public function getUserFollowers()
     /**
      * Returns the boards that the authenticated user follows.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\Board] The Boards the current user follows.
      */
     public function getUserFollowingBoards()
     {
@@ -271,7 +271,7 @@ public function getUserFollowingBoards()
     /**
      * Returns the users that the authenticated user follows.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\User] A list of users.
      */
     public function getUserFollowing()
     {
@@ -283,7 +283,7 @@ public function getUserFollowing()
     /**
      * Returns the interests (pins) that the authenticated user follows.
      *
-     * @return Http\Response The response.
+     * @return PagedList[Objects\Pin] The current User's interests.
      */
     public function getUserInterests()
     {
@@ -295,7 +295,7 @@ public function getUserInterests()
     /**
      * Follows a user.
      *
-     * @param  User $user The user to follow.
+     * @param User $user The user to follow.
      *
      * @return Http\Response The response.
      */
@@ -306,7 +306,7 @@ public function followUser(User $user)
         }
 
         $request = new Request('POST', 'me/following/users', [
-            'user' => $user->username
+            'user' => $user->username,
         ]);
 
         return $this->execute($request);

src/Pinterest/Http/GuzzleClient.php

@@ -75,8 +75,7 @@ public function execute(Request $request, $token)
 
         if ($request->isPost()) {
             $this->addTokenToHeaders($headers, $token);
-        }
-        else {
+        } else {
             $this->addToken($params, $token);
         }
 

tests/ApiTest.php

@@ -1,7 +1,6 @@
 <?php
 
 use Pinterest\Api;
-use Pinterest\Mapper;
 use Pinterest\Objects\User;
 
 class ApiTest extends TestCase