Prepare 3.0 release and remove remaining deprecated code

KnpLabs · Dec 21, 2020 · dc00db7 · dc00db7
1 parent e5a21a2
commit dc00db7
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 265 deletions.
diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md
@@ -0,0 +1,21 @@
+## UPGRADE from 2.x to 3.0
+
+### General
+
+* The `php-http/httplug` dependency requires is bumped to minimum ^2.1.
+* A client implementing `psr/http-client-implementation` is required.
+  To upgrade your application (default install) switch from guzzle 6 to guzzle 7 (or replace `php-http/guzzle6-adapter` with any `psr/http-client-implementation`), see the install instructions in the [README file](README.md)
+* All previous deprecated code in version 2 is removed.
+* The following classes are now final
+    * `Github\HttpClient\Message\ResponseMediator`
+    * `Github\HttpClient\Plugin\Authentication`
+    * `Github\HttpClient\Plugin\GithubExceptionThrower`
+    * `Github\HttpClient\Plugin\History`
+    * `Github\HttpClient\Plugin\PathPrepend`
+
+### Authetication methods
+
+* `Github\Client::AUTH_URL_TOKEN` use `Github\Client::AUTH_ACCESS_TOKEN` instead.
+* `Github\Client::AUTH_URL_CLIENT_ID` use `Github\Client::AUTH_CLIENT_ID` instead.
+* `Github\Client::AUTH_HTTP_TOKEN` use `Github\Client::AUTH_ACCESS_TOKEN` instead.
+* `Github\Client::AUTH_HTTP_PASSWORD` use `Github\Client::AUTH_ACCESS_TOKEN` instead.
diff --git a/lib/Github/Api/Repo.php b/lib/Github/Api/Repo.php
@@ -8,7 +8,6 @@
 use Github\Api\Repository\Actions\WorkflowJobs;
 use Github\Api\Repository\Actions\WorkflowRuns;
 use Github\Api\Repository\Actions\Workflows;
-use Github\Api\Repository\Checks;
 use Github\Api\Repository\Checks\CheckRuns;
 use Github\Api\Repository\Checks\CheckSuites;
 use Github\Api\Repository\Collaborators;
@@ -323,21 +322,6 @@ public function commits()
         return new Commits($this->getClient());
     }
 
-    /**
-     * Manage checks on a repository.
-     *
-     * @link https://developer.github.com/v3/checks/
-     * @deprecated since 2.17 and will be removed in 3.0. Use the "checkRuns" or "checkSuites" api's instead.
-     *
-     * @return Checks
-     */
-    public function checks()
-    {
-        @trigger_error(sprintf('The "%s" is deprecated since knp-labs/php-github-api 2.17 and will be removed in knp-labs/php-github-api 3.0. Use the "checkRuns" or "checkSuites" api\'s instead.', __METHOD__), E_USER_DEPRECATED);
-
-        return new Checks($this->getClient());
-    }
-
     /**
      * @link https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#check-runs
      */

diff --git a/lib/Github/Api/Repository/Checks.php b/lib/Github/Api/Repository/Checks.php
diff --git a/lib/Github/HttpClient/Message/ResponseMediator.php b/lib/Github/HttpClient/Message/ResponseMediator.php
@@ -5,10 +5,7 @@
 use Github\Exception\ApiLimitExceedException;
 use Psr\Http\Message\ResponseInterface;
 
-/**
- * @final since 2.19
- */
-class ResponseMediator
+final class ResponseMediator
 {
     /**
      * @param ResponseInterface $response

diff --git a/lib/Github/HttpClient/Plugin/Authentication.php b/lib/Github/HttpClient/Plugin/Authentication.php
@@ -12,9 +12,8 @@
  * Add authentication to the request.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
- * @final since 2.19
  */
-class Authentication implements Plugin
+final class Authentication implements Plugin
 {
     /**
      * @var string

diff --git a/lib/Github/HttpClient/Plugin/GithubExceptionThrower.php b/lib/Github/HttpClient/Plugin/GithubExceptionThrower.php
@@ -17,9 +17,8 @@
 /**
  * @author Joseph Bielawski <stloyd@gmail.com>
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
- * @final since 2.19
  */
-class GithubExceptionThrower implements Plugin
+final class GithubExceptionThrower implements Plugin
 {
     /**
      * @return Promise

diff --git a/lib/Github/HttpClient/Plugin/History.php b/lib/Github/HttpClient/Plugin/History.php
@@ -11,9 +11,8 @@
  * A plugin to remember the last response.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
- * @final since 2.19
  */
-class History implements Journal
+final class History implements Journal
 {
     /**
      * @var ResponseInterface|null

diff --git a/lib/Github/HttpClient/Plugin/PathPrepend.php b/lib/Github/HttpClient/Plugin/PathPrepend.php
@@ -10,9 +10,8 @@
  * Prepend the URI with a string.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
- * @final since 2.19
  */
-class PathPrepend implements Plugin
+final class PathPrepend implements Plugin
 {
     /**
      * @var string

diff --git a/test/Github/Tests/Api/RepoTest.php b/test/Github/Tests/Api/RepoTest.php
@@ -626,16 +626,6 @@ public function shouldTransferRepository()
         $this->assertEquals($expectedArray, $api->transfer('KnpLabs', 'php-github-api', 'github', [1234, 1235]));
     }
 
-    /**
-     * @test
-     */
-    public function shouldGetChecksApiObject()
-    {
-        $api = $this->getApiMock();
-
-        $this->assertInstanceOf(\Github\Api\Repository\Checks::class, $api->checks());
-    }
-
     /**
      * @return string
      */

diff --git a/test/Github/Tests/Api/Repository/ChecksTest.php b/test/Github/Tests/Api/Repository/ChecksTest.php