Laravel YouTrack SDK
Laravel wrapper for the PHP YouTrack SDK library provides set of tools to interact with JetBrains YouTrack Issue Tracking and Project Management software.
- About CyberCog
- Using contracts to keep high customization capabilities.
- Multiple authorization strategies: Token, Cookie.
- Following PHP Standard Recommendations:
- Covered with unit tests.
- YouTrack >= 3.0 with REST-API enabled (always enabled, by default)
- PHP >= 7.1
- Guzzle HTTP Client >= 6.2
- Laravel >= 5.1.20
Once composer is installed, execute the following command in your project root to install this library:
$ composer require cybercog/laravel-youtrack-sdk
Laravel YouTrack SDK designed to work with default config, but it always could be modified. First of all publish it:
php artisan vendor:publish --tag="youtrack-config"
This will create a
config/youtrack.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
YouTrack instance location could be defined in
Starting with YouTrack 2017.1 release authorization based on permanent tokens is recommended as the main approach for the authorization in your REST API calls.
By default Token authorization will be used. You could redefine it in
YOUTRACK_AUTH=cookie YOUTRACK_USERNAME=username YOUTRACK_PASSWORD=secret
Initialize API client
$youtrack = app(\Cog\Contracts\YouTrack\Rest\Client\Client::class);
As result instantiated
\Cog\YouTrack\Rest\Client\YouTrackClient class should be returned.
$method = 'POST'; // GET, POST, PUT, DELETE, PATCH or any custom ones $response = $youtrack->request($method, '/issue', [ 'project' => 'TEST', 'summary' => 'New test issue', 'description' => 'Test description', ]);
You can customize requests created and transferred by a client using request options. Request options control various aspects of a request including, headers, query string parameters, timeout settings, the body of a request, and much more.
$options = [ 'debug' => true, 'sink' => '/path/to/dump/file', ]; $response = $youtrack->request('POST', '/issue', [ 'project' => 'TEST', 'summary' => 'New test issue', 'description' => 'Test description', ], $options);
HTTP GET request
$response = $youtrack->get('/issue/TEST-1');
HTTP POST request
$response = $youtrack->post('/issue', [ 'project' => 'TEST', 'summary' => 'New test issue', 'description' => 'Test description', ]);
HTTP PUT request
$response = $youtrack->put('/issue/TEST-1', [ 'summary' => 'Updated summary', 'description' => 'Updated description', ]);
HTTP DELETE request
$response = $youtrack->delete('/issue/TEST-1');
Each successful request to the API returns instance of
\Cog\Contracts\YouTrack\Rest\Response\Response contract. By default it's
Get PSR HTTP response
PSR HTTP response could be accessed by calling
httpResponse method on API Response.
$youtrackResponse = $youtrack->get('/issue/TEST-1'); $psrResponse = $youtrackResponse->httpResponse();
Get response Cookie
Set-Cookie headers as string from the HTTP response.
$apiResponse = $youtrack->get('/issue/TEST-1'); $cookieString = $apiResponse->cookie();
Get response Location
Location header from the HTTP response.
$apiResponse = $youtrack->get('/issue/TEST-1'); $location = $apiResponse->location();
Transform response to array
$apiResponse = $youtrack->get('/issue/TEST-1'); $location = $apiResponse->toArray();
Get HTTP response status code
$apiResponse = $youtrack->get('/issue/TEST-1'); $location = $apiResponse->statusCode();
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Run the tests with:
$ composer test
If you discover any security related issues, please email email@example.com instead of using the issue tracker.
Alternatives not found.
Feel free to add more alternatives as Pull Request.
Laravel YouTrack SDKpackage is open-sourced software licensed under the MIT License by Anton Komarev.
CyberCog is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.