Provide Group Labels API

https://docs.gitlab.com/ee/api/group_labels.html

Author: o.trelin

lib/Gitlab/Api/Groups.php

@@ -198,7 +198,7 @@ public function projects($id, array $parameters = [])
     }
 
     /**
-     * @param int $groupId
+     * @param int $group_id
      * @param array $parameters (
      *
      *     @var int[]  $skip_groups   Skip the group IDs passes.
@@ -211,17 +211,60 @@ public function projects($id, array $parameters = [])
      * )
      * @return mixed
      */
-    public function subgroups($groupId, array $parameters = [])
+    public function subgroups($group_id, array $parameters = [])
     {
         $resolver = $this->getGroupSearchResolver();
 
-        return $this->get('groups/'.$this->encodePath($groupId).'/subgroups', $resolver->resolve($parameters));
+        return $this->get('groups/'.$this->encodePath($group_id).'/subgroups', $resolver->resolve($parameters));
+    }
+
+    /**
+     * @param int $group_id
+     * @param array $parameters
+     * @return mixed
+     */
+    public function labels($group_id, array $parameters = [])
+    {
+        $resolver = $this->createOptionsResolver();
+
+        return $this->get('groups/'.$this->encodePath($group_id). '/labels', $resolver->resolve($parameters));
+    }
+
+    /**
+     * @param int $group_id
+     * @param array $params
+     * @return mixed
+     */
+    public function addLabel($group_id, array $params)
+    {
+        return $this->post('groups/'.$this->encodePath($group_id). '/labels', $params);
+    }
+
+    /**
+     * @param int $group_id
+     * @param array $params
+     * @return mixed
+     */
+    public function updateLabel($group_id, array $params)
+    {
+        return $this->put('groups/'.$this->encodePath($group_id). '/labels', $params);
+    }
+
+    /**
+     * @param int $group_id
+     * @param string $name
+     * @return mixed
+     */
+    public function removeLabel($group_id, $name)
+    {
+        return $this->delete('groups/'.$this->encodePath($group_id). '/labels', array(
+            'name' => $name
+        ));
     }
 
     /**
      * @param int $group_id
      * @param array $parameters
-     *
      * @return mixed
      */
     public function variables($group_id, array $parameters = [])
@@ -234,7 +277,6 @@ public function variables($group_id, array $parameters = [])
     /**
      * @param int $group_id
      * @param string $key
-     *
      * @return mixed
      */
     public function variable($group_id, $key)
@@ -247,7 +289,6 @@ public function variable($group_id, $key)
      * @param string $key
      * @param string $value
      * @param bool $protected
-     *
      * @return mixed
      */
     public function addVariable($group_id, $key, $value, $protected = null)
@@ -269,7 +310,6 @@ public function addVariable($group_id, $key, $value, $protected = null)
      * @param string $key
      * @param string $value
      * @param bool $protected
-     *
      * @return mixed
      */
     public function updateVariable($group_id, $key, $value, $protected = null)
@@ -288,7 +328,6 @@ public function updateVariable($group_id, $key, $value, $protected = null)
     /**
      * @param int $group_id
      * @param string $key
-     *
      * @return mixed
      */
     public function removeVariable($group_id, $key)

lib/Gitlab/Api/GroupsMilestones.php

@@ -62,7 +62,7 @@ public function update($group_id, $milestone_id, array $params)
     }
 
     /**
-     * @param int $project_id
+     * @param int $group_id
      * @param int $milestone_id
      * @return mixed
      */
@@ -71,7 +71,6 @@ public function remove($group_id, $milestone_id)
         return $this->delete($this->getGroupPath($group_id, 'milestones/'.$this->encodePath($milestone_id)));
     }
 
-
     /**
      * @param int $group_id
      * @param int $milestone_id

lib/Gitlab/Api/Issues.php

@@ -260,6 +260,7 @@ public function removeDiscussionNote($project_id, $issue_iid, $discussion_id, $n
      * @param int $project_id
      * @param int $issue_iid
      * @param string $duration
+     * @return mixed
      */
     public function setTimeEstimate($project_id, $issue_iid, $duration)
     {
@@ -269,6 +270,7 @@ public function setTimeEstimate($project_id, $issue_iid, $duration)
     /**
      * @param int $project_id
      * @param int $issue_iid
+     * @return mixed
      */
     public function resetTimeEstimate($project_id, $issue_iid)
     {
@@ -279,6 +281,7 @@ public function resetTimeEstimate($project_id, $issue_iid)
      * @param int $project_id
      * @param int $issue_iid
      * @param string $duration
+     * @return mixed
      */
     public function addSpentTime($project_id, $issue_iid, $duration)
     {
@@ -288,6 +291,7 @@ public function addSpentTime($project_id, $issue_iid, $duration)
     /**
      * @param int $project_id
      * @param int $issue_iid
+     * @return mixed
      */
     public function resetSpentTime($project_id, $issue_iid)
     {

lib/Gitlab/Api/MergeRequests.php

@@ -155,8 +155,8 @@ public function merge($project_id, $mr_id, $message = null)
     }
 
     /**
-     * @param int   $project_id
-     * @param int   $mr_id
+     * @param int $project_id
+     * @param int $mr_id
      *
      * @return mixed
      */
@@ -182,7 +182,6 @@ public function addNote($project_id, $mr_id, $note)
      * @param int $projectId
      * @param int $mrId
      * @param int $noteId
-     *
      * @return mixed
      */
     public function removeNote($projectId, $mrId, $noteId)
@@ -337,45 +336,41 @@ public function closesIssues($project_id, $mr_id)
 
     /**
      * @param int $project_id
-     * @param int $mr_id
-     *
+     * @param int $mr_iid
      * @return mixed
      */
-    public function approvals($project_id, $merge_request_iid)
+    public function approvals($project_id, $mr_iid)
     {
-        return $this->get($this->getProjectPath($project_id, 'merge_requests/'.$this->encodePath($merge_request_iid).'/approvals'));
+        return $this->get($this->getProjectPath($project_id, 'merge_requests/'.$this->encodePath($mr_iid).'/approvals'));
     }
 
     /**
      * @param int $project_id
-     * @param int $mr_id
-     *
+     * @param int $mr_iid
      * @return mixed
      */
-    public function approve($project_id, $merge_request_iid)
+    public function approve($project_id, $mr_iid)
     {
-        return $this->post($this->getProjectPath($project_id, 'merge_requests/'.$this->encodePath($merge_request_iid).'/approve'));
+        return $this->post($this->getProjectPath($project_id, 'merge_requests/'.$this->encodePath($mr_iid).'/approve'));
     }
 
     /**
      * @param int $project_id
-     * @param int $mr_id
-     *
+     * @param int $mr_iid
      * @return mixed
      */
-    public function unapprove($project_id, $merge_request_iid)
+    public function unapprove($project_id, $mr_iid)
     {
-        return $this->post($this->getProjectPath($project_id, 'merge_requests/'.$this->encodePath($merge_request_iid).'/unapprove'));
+        return $this->post($this->getProjectPath($project_id, 'merge_requests/'.$this->encodePath($mr_iid).'/unapprove'));
     }
 
     /**
      * @param int $project_id
-     * @param int $merge_request_iid
-     *
+     * @param int $mr_iid
      * @return mixed
      */
-    public function awardEmoji($project_id, $merge_request_iid)
+    public function awardEmoji($project_id, $mr_iid)
     {
-        return $this->get($this->getProjectPath($project_id, 'merge_requests/'.$this->encodePath($merge_request_iid).'/award_emoji'));
+        return $this->get($this->getProjectPath($project_id, 'merge_requests/'.$this->encodePath($mr_iid).'/award_emoji'));
     }
 }

lib/Gitlab/Api/Milestones.php

@@ -71,7 +71,6 @@ public function remove($project_id, $milestone_id)
         return $this->delete($this->getProjectPath($project_id, 'milestones/'.$this->encodePath($milestone_id)));
     }
 
-
     /**
      * @param int $project_id
      * @param int $milestone_id

lib/Gitlab/Api/Projects.php

@@ -373,7 +373,6 @@ public function removeMember($project_id, $user_id)
     /**
      * @param int $project_id
      * @param array $parameters
-     *
      * @return mixed
      */
     public function hooks($project_id, array $parameters = [])
@@ -686,7 +685,6 @@ public function removeService($project_id, $service_name)
     /**
      * @param int $project_id
      * @param array $parameters
-     *
      * @return mixed
      */
     public function variables($project_id, array $parameters = [])
@@ -780,7 +778,6 @@ public function uploadFile($project_id, $file)
     /**
      * @param int $project_id
      * @param array $parameters
-     *
      * @return mixed
      */
     public function deployments($project_id, array $parameters = [])

lib/Gitlab/Api/Repositories.php

@@ -107,10 +107,9 @@ public function createTag($project_id, $name, $ref, $message = null)
     }
 
     /**
-     * @param int    $project_id
+     * @param int $project_id
      * @param string $tag_name
      * @param string $description
-     *
      * @return mixed
      */
     public function createRelease($project_id, $tag_name, $description)
@@ -123,10 +122,9 @@ public function createRelease($project_id, $tag_name, $description)
     }
 
     /**
-     * @param int    $project_id
+     * @param int $project_id
      * @param string $tag_name
      * @param string $description
-     *
      * @return mixed
      */
     public function updateRelease($project_id, $tag_name, $description)
@@ -186,7 +184,6 @@ public function commit($project_id, $sha)
      * @param int $project_id
      * @param $sha
      * @param array $parameters
-     *
      * @return mixed
      */
     public function commitRefs($project_id, $sha, array $parameters = [])
@@ -261,10 +258,9 @@ public function createCommit($project_id, array $parameters = [])
     }
 
     /**
-     * @param int    $project_id
+     * @param int $project_id
      * @param string $sha
-     * @param array  $parameters
-     *
+     * @param array $parameters
      * @return mixed
      */
     public function commitComments($project_id, $sha, array $parameters = [])

test/Gitlab/Tests/Api/GroupsTest.php

@@ -294,6 +294,77 @@ public function shouldGetAllSubgroups()
         $this->assertEquals($expectedArray, $api->subgroups(1, ['page' => 1, 'per_page' => 10]));
     }
 
+    /**
+     * @test
+     */
+    public function shouldGetLabels()
+    {
+        $expectedArray = array(
+            array('name' => 'bug', 'color' => '#000000'),
+            array('name' => 'feature', 'color' => '#ff0000')
+        );
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('groups/1/labels')
+            ->will($this->returnValue($expectedArray))
+        ;
+
+        $this->assertEquals($expectedArray, $api->labels(1));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldAddLabel()
+    {
+        $expectedArray = array('name' => 'bug', 'color' => '#000000');
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('groups/1/labels', array('name' => 'wont-fix', 'color' => '#ffffff'))
+            ->will($this->returnValue($expectedArray))
+        ;
+
+        $this->assertEquals($expectedArray, $api->addLabel(1, array('name' => 'wont-fix', 'color' => '#ffffff')));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldUpdateLabel()
+    {
+        $expectedArray = array('name' => 'bug', 'color' => '#00ffff');
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('put')
+            ->with('groups/1/labels', array('name' => 'bug', 'new_name' => 'big-bug', 'color' => '#00ffff'))
+            ->will($this->returnValue($expectedArray))
+        ;
+
+        $this->assertEquals($expectedArray, $api->updateLabel(1, array('name' => 'bug', 'new_name' => 'big-bug', 'color' => '#00ffff')));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldRemoveLabel()
+    {
+        $expectedBool = true;
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('delete')
+            ->with('groups/1/labels', array('name' => 'bug'))
+            ->will($this->returnValue($expectedBool))
+        ;
+
+        $this->assertEquals($expectedBool, $api->removeLabel(1, 'bug'));
+    }
+
     public function shouldGetVariables()
     {
         $expectedArray = array(