cybercog/youtrack-rest-php

JetBrains YouTrack REST API PHP Client

youtrack-rest-php's Issues

Refactor Client

Goals

• Provide an ability to write HTTP Clint adapters for custom PSR-7 implementations.
• Separation of concerns.
• Exceptions should be related to their namespace classes responsibilities.
• Client version should be part of Client contract.
• User-Agent headers should be more verbose: CLIENT/VERSION HTTP_CLIENT/VERSION PHP/VERSION.

Use PSR-18

https://www.php-fig.org/psr/psr-18/

Refactor authorizers

Goals

• Tell Authorizers what to do, and don't ask them.
• Remove authenticate method from Authorizer contract (not it's responsibility).
• Delegate authentication process to Authenticators.
• Create factory for Authorizer building since this process is more complicated.

New API proposals will be described below.

[Concept] Remove Authorization responsibility from YouTrackClient

I've started to overlook an API and I maybe it should be refactored.

Wrong Authenticator behavior

Authenticator shouldn't append headers to Client request. Authorizer should do it.

This change will lead us to extend Authenticator contract by adding token method.

GET request error

In example for time tracking of issue we refer to the next request
GET /api/issues/{issueID}/timeTracking?{fields}

For GET request we need send params in 'query' key for Guzzle Http, but in function buildOptions we can see that it is impossible to do.

In result we got wrong request

The solution is to change the $defaultOptions parameter
$defaultOptions = [ 'headers' => $this->buildHeaders() ];
and add additional action for value $options

API client connection design

Version 1

Token Authenticator

$http = new \GuzzleHttp\Client([
    'base_uri' => 'https://example.com',
]);

$client = new \Cog\YouTrack\Services\YouTrackClient($http, [
    'driver' => \Cog\YouTrack\Authenticators\TokenAuthenticator::class,
    'token' => 'YOUTRACK_API_TOKEN',
]);

Cookie Authenticator

$http = new \GuzzleHttp\Client([
    'base_uri' => 'https://example.com',
]);

$client = new \Cog\YouTrack\Services\YouTrackClient($http, [
    'driver' => \Cog\YouTrack\Authenticators\CookieAuthenticator::class,
    'username' => 'YOUTRACK_USERNAME',
    'password' => 'YOUTRACK_PASSWORD',
]);

Container Binding

$this->app->bind(YouTrackClientContract::class, function () {
    $config = $this->app->make('config');

    $http = new Client([
        'base_uri' => $config->get('youtrack.base_uri'),
    ]);

    $options = $config->get('youtrack.authenticators.' . $config->get('youtrack.authenticator'));

    return new YouTrackClient($http, $options);
});

Conclusion

Pros

• All drivers has same API.

Cons

• Authenticator building encapsulated inside YouTrackClient.
• Violate Single Responsibility Principle.

OAuth support

Goals

• Create OAuthAuthorizer to allow OAuth 2.0 authorization and to have all default available methods implemented.

Guzzle 7

At the moment this module holds us from upgrading to Guzzle 7. Any plans to support it please?

How to update issue (priority)?

Request options & headers

Goals

• Building request is very complicated and requires simplification.
• buildHeaders never accept $options variable, remove param or make it usable.
• request method $options revert back to $formData and add new $options param which will overwrite HTTP client options.

Configurable API endpoint prefix

Related to cybercog/laravel-youtrack-sdk#10

Add factories to simplify instantiation process

Move documentation to wiki

Goals

• Move documentation to the YouTrack PHP SDK wiki.

Make client endpointPathPrefix configurable

Goals

• Make $endpointPathPrefix configurable to be usable for YouTrack cloud instances.
• Determine is there are any other REST client configurations could be required in future?

Write more PHPUnit tests

Goals

• Cover all the functionality with tests.

Refactor exceptions

• Stop using *Exception postfix on each exception. Make them more verbose.
• Cog\Contracts\YouTrack\Rest\Client\Exceptions\ClientException should extend RuntimeException?