Groups: add subgroup endpoint

Author: glaubinix

lib/Gitlab/Api/Groups.php

@@ -19,36 +19,7 @@ class Groups extends AbstractApi
      */
     public function all(array $parameters = [])
     {
-        $resolver = $this->createOptionsResolver();
-        $booleanNormalizer = function (Options $resolver, $value) {
-            return $value ? 'true' : 'false';
-        };
-
-        $resolver->setDefined('skip_groups')
-            ->setAllowedTypes('skip_groups', 'array')
-            ->setAllowedValues('skip_groups', function (array $value) {
-                return count($value) == count(array_filter($value, 'is_int'));
-            })
-        ;
-        $resolver->setDefined('all_available')
-            ->setAllowedTypes('all_available', 'bool')
-            ->setNormalizer('all_available', $booleanNormalizer)
-        ;
-        $resolver->setDefined('search');
-        $resolver->setDefined('order_by')
-            ->setAllowedValues('order_by', ['name', 'path'])
-        ;
-        $resolver->setDefined('sort')
-            ->setAllowedValues('sort', ['asc', 'desc'])
-        ;
-        $resolver->setDefined('statistics')
-            ->setAllowedTypes('statistics', 'bool')
-            ->setNormalizer('statistics', $booleanNormalizer)
-        ;
-        $resolver->setDefined('owned')
-            ->setAllowedTypes('owned', 'bool')
-            ->setNormalizer('owned', $booleanNormalizer)
-        ;
+        $resolver = $this->getGroupSearchResolver();
 
         return $this->get('groups', $resolver->resolve($parameters));
     }
@@ -225,4 +196,61 @@ public function projects($id, array $parameters = [])
 
         return $this->get('groups/'.$this->encodePath($id).'/projects', $resolver->resolve($parameters));
     }
+
+    /**
+     * @param int $groupId
+     * @param array $parameters (
+     *
+     *     @var int[]  $skip_groups   Skip the group IDs passes.
+     *     @var bool   $all_available Show all the groups you have access to.
+     *     @var string $search        Return list of authorized groups matching the search criteria.
+     *     @var string $order_by      Order groups by name or path. Default is name.
+     *     @var string $sort          Order groups in asc or desc order. Default is asc.
+     *     @var bool   $statistics    Include group statistics (admins only).
+     *     @var bool   $owned         Limit by groups owned by the current user.
+     * )
+     * @return mixed
+     */
+    public function subgroups($groupId, array $parameters = [])
+    {
+        $resolver = $this->getGroupSearchResolver();
+
+        return $this->get('groups/'.$this->encodePath($groupId).'/subgroups', $resolver->resolve($parameters));
+    }
+
+    private function getGroupSearchResolver()
+    {
+        $resolver = $this->createOptionsResolver();
+        $booleanNormalizer = function (Options $resolver, $value) {
+            return $value ? 'true' : 'false';
+        };
+
+        $resolver->setDefined('skip_groups')
+            ->setAllowedTypes('skip_groups', 'array')
+            ->setAllowedValues('skip_groups', function (array $value) {
+                return count($value) == count(array_filter($value, 'is_int'));
+            })
+        ;
+        $resolver->setDefined('all_available')
+            ->setAllowedTypes('all_available', 'bool')
+            ->setNormalizer('all_available', $booleanNormalizer)
+        ;
+        $resolver->setDefined('search');
+        $resolver->setDefined('order_by')
+            ->setAllowedValues('order_by', ['name', 'path'])
+        ;
+        $resolver->setDefined('sort')
+            ->setAllowedValues('sort', ['asc', 'desc'])
+        ;
+        $resolver->setDefined('statistics')
+            ->setAllowedTypes('statistics', 'bool')
+            ->setNormalizer('statistics', $booleanNormalizer)
+        ;
+        $resolver->setDefined('owned')
+            ->setAllowedTypes('owned', 'bool')
+            ->setNormalizer('owned', $booleanNormalizer)
+        ;
+
+        return $resolver;
+    }
 }

lib/Gitlab/Model/Group.php

@@ -135,4 +135,19 @@ public function projects()
 
         return Group::fromArray($this->getClient(), $data);
     }
+
+    /**
+     * @return Group[]
+     */
+    public function subgroups()
+    {
+        $data = $this->client->groups()->subgroups($this->id);
+
+        $groups = array();
+        foreach ($data as $group) {
+            $groups[] = Group::fromArray($this->getClient(), $group);
+        }
+
+        return $groups;
+    }
 }

test/Gitlab/Tests/Api/GroupsTest.php

@@ -274,6 +274,26 @@ public function shouldRemoveGroup()
         $this->assertEquals($expectedBool, $api->remove(1));
     }
 
+    /**
+     * @test
+     */
+    public function shouldGetAllSubgroups()
+    {
+        $expectedArray = array(
+            array('id' => 101, 'name' => 'A subgroup'),
+            array('id' => 1-2, 'name' => 'Another subggroup'),
+        );
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('groups/1/subgroups', array('page' => 1, 'per_page' => 10))
+            ->will($this->returnValue($expectedArray))
+        ;
+
+        $this->assertEquals($expectedArray, $api->subgroups(1, ['page' => 1, 'per_page' => 10]));
+    }
+
     protected function getApiClass()
     {
         return 'Gitlab\Api\Groups';