Group List implementation fixes #29

Example/GroupsExample.php

@@ -41,6 +41,9 @@ public function groupsExample()
         $createGroupResponse = $group->create('Test');
         $newGroupKey = $createGroupResponse->getGroupKey();
 
+        // Obtain list of all groups
+        $currentGroups = $group->list();
+
         // Retrieve information about the group from the API and populate the object with it.
         /** @var RetrieveGroupResponse $retrieveGroupResponse */
         $retrieveGroupResponse = $group->retrieveGroupInformation();

README.md

@@ -26,6 +26,7 @@ Light, simple and fast, yet comprehensive wrapper for the [Pushover](https://pus
   - Cancel emergency priority retry
 - Groups API ([Example](Example/GroupsExample.php))
   - Create a group
+  - List groups
   - Retrieve information about the group
   - Add / Remove users
   - Enable / Disable users

src/Api/Groups/Group.php

@@ -17,6 +17,7 @@
 use Serhiy\Pushover\Client\Request\Request;
 use Serhiy\Pushover\Client\Response\AddUserToGroupResponse;
 use Serhiy\Pushover\Client\Response\CreateGroupResponse;
+use Serhiy\Pushover\Client\Response\ListGroupResponse;
 use Serhiy\Pushover\Client\Response\DisableUserInGroupResponse;
 use Serhiy\Pushover\Client\Response\EnableUserInGroupResponse;
 use Serhiy\Pushover\Client\Response\RemoveUserFromGroupResponse;
@@ -145,6 +146,23 @@ public function create(string $name): CreateGroupResponse
         return $response;
     }
 
+    /**
+     * List the groups.
+     */
+    public function list(): ListGroupResponse
+    {
+        $client = new GroupsClient($this, GroupsClient::ACTION_LIST_GROUPS);
+        $request = new Request($client->buildApiUrl(), Request::GET);
+
+        $curlResponse = Curl::do($request);
+
+        $response = new ListGroupResponse($curlResponse);
+        $response->setRequest($request);
+
+        return $response;
+    }
+
+
     /**
      * Adds an existing Pushover user to your Delivery Group.
      *

src/Client/GroupsClient.php

@@ -28,6 +28,7 @@ class GroupsClient extends Client implements ClientInterface
     public const ACTION_ENABLE_USER = "enable_user";
     public const ACTION_RENAME_GROUP = "rename";
     public const ACTION_CREATE_GROUP = "create";
+    public const ACTION_LIST_GROUPS = "list";
 
     /**
      * @var Group
@@ -58,6 +59,10 @@ public function buildApiUrl()
             return Curl::API_BASE_URL."/".Curl::API_VERSION."/groups.json";
         }
 
+        if ($this->action == self::ACTION_LIST_GROUPS) {
+            return Curl::API_BASE_URL."/".Curl::API_VERSION."/groups.json?token=".$this->group->getApplication()->getToken();
+        }
+
         if ($this->action == self::ACTION_RETRIEVE_GROUP) {
             return Curl::API_BASE_URL."/".Curl::API_VERSION."/groups/".$this->group->getKey().".json?token=".$this->group->getApplication()->getToken();
         }

src/Client/Response/ListGroupResponse.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the Pushover package.
+ *
+ * (c) Serhiy Lunak <https://github.com/slunak>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Serhiy\Pushover\Client\Response;
+
+use Serhiy\Pushover\Client\Response\Base\Response;
+
+/**
+ * @author Serhiy Lunak
+ */
+class ListGroupResponse extends Response
+{
+    /**
+     * @var array
+     */
+    public $groups = [];
+
+    /**
+     * @param mixed $curlResponse
+     */
+    public function __construct($curlResponse)
+    {
+        $this->processCurlResponse($curlResponse);
+    }
+
+    /**
+     * @param mixed $curlResponse
+     */
+    private function processCurlResponse($curlResponse): void
+    {
+        $this->groups = [];
+        $decodedCurlResponse = $this->processInitialCurlResponse($curlResponse);
+        if (property_exists($decodedCurlResponse, 'groups')) {
+            foreach ($decodedCurlResponse->groups as $grp) {
+                $this->groups[$grp->name] = $grp->group;
+            }
+        }
+    }
+
+    public function getGroups(): array
+    {
+        return $this->groups;
+    }
+}

tests/Api/Groups/GroupTest.php

@@ -16,6 +16,7 @@
 use Serhiy\Pushover\Application;
 use Serhiy\Pushover\Client\Response\CreateGroupResponse;
 use Serhiy\Pushover\Client\Response\RetrieveGroupResponse;
+use Serhiy\Pushover\Client\Response\ListGroupResponse;
 
 /**
  * @author Serhiy Lunak
@@ -79,4 +80,18 @@ public function testCreate()
 
         $this->assertInstanceOf(CreateGroupResponse::class, $response);
     }    
+
+    /**
+     * @group Integration
+     */
+    public function testList()
+    {
+        $application = new Application("cccc3333CCCC3333dddd4444DDDD44"); // using dummy token
+        $group = new Group("eeee5555EEEE5555ffff6666FFFF66", $application);
+
+        $response = $group->list();
+
+        $this->assertInstanceOf(ListGroupResponse::class, $response);
+    }    
+
 }

tests/Client/GroupsClientTest.php

@@ -44,6 +44,10 @@ public function testBuildApiUrl()
 
         $client = new GroupsClient($group, GroupsClient::ACTION_ADD_USER);
         $this->assertEquals("https://api.pushover.net/1/groups/eeee5555EEEE5555ffff6666FFFF66/add_user.json?token=cccc3333CCCC3333dddd4444DDDD44", $client->buildApiUrl());
+
+        $client = new GroupsClient($group, GroupsClient::ACTION_LIST_GROUPS);
+        $this->assertEquals("https://api.pushover.net/1/groups.json?token=cccc3333CCCC3333dddd4444DDDD44", $client->buildApiUrl());
+
     }
 
     public function testBuildCurlPostFields()