feature #1161 feat: add reactions support (ALameLlama)

This PR was merged into the 3.16-dev branch.

Discussion
----------

Adds support for https://docs.github.com/en/rest/reactions/reactions#about-reactions

This increases commits, release, issues and more

closes: #1129

let me know if you need me to make any changes :)

Commits
-------

80f4547 feat: add reaction support to endpoints

Author: acrobat

lib/Github/Api/AbstractReactionsApi.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Github\Api;
+
+use Github\Exception\MissingArgumentException;
+
+abstract class AbstractReactionsApi extends AbstractApi
+{
+    /**
+     * List reactions for a resource.
+     *
+     * @param string $username
+     * @param string $repository
+     * @param string $id
+     * @param array  $params
+     *
+     * @return array
+     */
+    public function all($username, $repository, $id, array $params = [])
+    {
+        return $this->get($this->getReactionsPath($username, $repository, $id), $params);
+    }
+
+    /**
+     * Create a reaction for a resource.
+     *
+     * @param string $username
+     * @param string $repository
+     * @param string $id
+     * @param array  $params
+     *
+     * @throws MissingArgumentException
+     *
+     * @return array
+     */
+    public function create($username, $repository, $id, array $params)
+    {
+        if (!isset($params['content'])) {
+            throw new MissingArgumentException('content');
+        }
+
+        return $this->post($this->getReactionsPath($username, $repository, $id), $params);
+    }
+
+    /**
+     * Delete a reaction from a resource.
+     *
+     * @param string $username
+     * @param string $repository
+     * @param string $id
+     * @param string $reaction
+     *
+     * @return array|string
+     */
+    public function remove($username, $repository, $id, $reaction)
+    {
+        return $this->delete($this->getReactionsPath($username, $repository, $id).'/'.rawurlencode($reaction));
+    }
+
+    /**
+     * @param string $username
+     * @param string $repository
+     * @param string $id
+     *
+     * @return string
+     */
+    abstract protected function getReactionsPath($username, $repository, $id);
+}

lib/Github/Api/Issue.php

@@ -7,6 +7,7 @@
 use Github\Api\Issue\Events;
 use Github\Api\Issue\Labels;
 use Github\Api\Issue\Milestones;
+use Github\Api\Issue\Reactions;
 use Github\Api\Issue\Timeline;
 use Github\Exception\MissingArgumentException;
 
@@ -179,6 +180,18 @@ public function comments()
         return new Comments($this->getClient());
     }
 
+    /**
+     * Manage issue reactions.
+     *
+     * @link https://docs.github.com/en/rest/reactions/reactions#list-reactions-for-an-issue
+     *
+     * @return Reactions
+     */
+    public function reactions()
+    {
+        return new Reactions($this->getClient());
+    }
+
     /**
      * List all project events.
      *

lib/Github/Api/Issue/Comments.php

@@ -4,6 +4,7 @@
 
 use Github\Api\AbstractApi;
 use Github\Api\AcceptHeaderTrait;
+use Github\Api\Issue\Comments\Reactions;
 use Github\Exception\MissingArgumentException;
 
 /**
@@ -130,4 +131,16 @@ public function remove($username, $repository, $comment)
     {
         return $this->delete('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/comments/'.$comment);
     }
+
+    /**
+     * Manage issue comment reactions.
+     *
+     * @link https://docs.github.com/en/rest/reactions/reactions#list-reactions-for-an-issue-comment
+     *
+     * @return Reactions
+     */
+    public function reactions()
+    {
+        return new Reactions($this->getClient());
+    }
 }

lib/Github/Api/Issue/Comments/Reactions.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Github\Api\Issue\Comments;
+
+use Github\Api\AbstractReactionsApi;
+
+class Reactions extends AbstractReactionsApi
+{
+    /**
+     * @param string $username
+     * @param string $repository
+     * @param string $id
+     *
+     * @return string
+     */
+    protected function getReactionsPath($username, $repository, $id)
+    {
+        return '/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/comments/'.rawurlencode($id).'/reactions';
+    }
+}

lib/Github/Api/Issue/Reactions.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Github\Api\Issue;
+
+use Github\Api\AbstractReactionsApi;
+
+class Reactions extends AbstractReactionsApi
+{
+    /**
+     * @param string $username
+     * @param string $repository
+     * @param string $id
+     *
+     * @return string
+     */
+    protected function getReactionsPath($username, $repository, $id)
+    {
+        return '/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/issues/'.rawurlencode($id).'/reactions';
+    }
+}

lib/Github/Api/PullRequest/Comments.php

@@ -4,6 +4,7 @@
 
 use Github\Api\AbstractApi;
 use Github\Api\AcceptHeaderTrait;
+use Github\Api\PullRequest\Comments\Reactions;
 use Github\Exception\MissingArgumentException;
 
 /**
@@ -150,4 +151,16 @@ public function remove($username, $repository, $comment)
     {
         return $this->delete('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls/comments/'.$comment);
     }
+
+    /**
+     * Manage pull request review comment reactions.
+     *
+     * @link https://docs.github.com/en/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
+     *
+     * @return Reactions
+     */
+    public function reactions()
+    {
+        return new Reactions($this->getClient());
+    }
 }

lib/Github/Api/PullRequest/Comments/Reactions.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Github\Api\PullRequest\Comments;
+
+use Github\Api\AbstractReactionsApi;
+
+class Reactions extends AbstractReactionsApi
+{
+    /**
+     * @param string $username
+     * @param string $repository
+     * @param string $id
+     *
+     * @return string
+     */
+    protected function getReactionsPath($username, $repository, $id)
+    {
+        return '/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/pulls/comments/'.rawurlencode($id).'/reactions';
+    }
+}

lib/Github/Api/Repository/Comments.php

@@ -4,6 +4,7 @@
 
 use Github\Api\AbstractApi;
 use Github\Api\AcceptHeaderTrait;
+use Github\Api\Repository\Comments\Reactions;
 use Github\Exception\MissingArgumentException;
 
 /**
@@ -133,4 +134,16 @@ public function remove($username, $repository, $comment)
     {
         return $this->delete('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/comments/'.rawurlencode($comment));
     }
+
+    /**
+     * Manage commit comment reactions.
+     *
+     * @link https://docs.github.com/en/rest/reactions/reactions#list-reactions-for-a-commit-comment
+     *
+     * @return Reactions
+     */
+    public function reactions()
+    {
+        return new Reactions($this->getClient());
+    }
 }

lib/Github/Api/Repository/Comments/Reactions.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Github\Api\Repository\Comments;
+
+use Github\Api\AbstractReactionsApi;
+
+class Reactions extends AbstractReactionsApi
+{
+    /**
+     * @param string $username
+     * @param string $repository
+     * @param string $id
+     *
+     * @return string
+     */
+    protected function getReactionsPath($username, $repository, $id)
+    {
+        return '/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/comments/'.rawurlencode($id).'/reactions';
+    }
+}

lib/Github/Api/Repository/Releases.php

@@ -3,6 +3,7 @@
 namespace Github\Api\Repository;
 
 use Github\Api\AbstractApi;
+use Github\Api\Repository\Releases\Reactions;
 use Github\Exception\MissingArgumentException;
 
 /**
@@ -154,4 +155,16 @@ public function assets()
     {
         return new Assets($this->getClient());
     }
+
+    /**
+     * Manage release reactions.
+     *
+     * @link https://docs.github.com/en/rest/reactions/reactions#list-reactions-for-a-release
+     *
+     * @return Reactions
+     */
+    public function reactions()
+    {
+        return new Reactions($this->getClient());
+    }
 }