Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/testmonitor/devops-client
The TestMonitor Azure DevOps client.
https://github.com/testmonitor/devops-client
api azure-devops client
Last synced: 3 months ago
JSON representation
The TestMonitor Azure DevOps client.
- Host: GitHub
- URL: https://github.com/testmonitor/devops-client
- Owner: testmonitor
- License: mit
- Created: 2019-11-25T14:56:09.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-15T07:17:23.000Z (5 months ago)
- Last Synced: 2024-09-30T10:21:03.229Z (4 months ago)
- Topics: api, azure-devops, client
- Language: PHP
- Homepage:
- Size: 113 KB
- Stars: 3
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TestMonitor Azure DevOps Client
[](https://packagist.org/packages/testmonitor/devops-client)
[](https://circleci.com/gh/testmonitor/devops-client)
[](https://styleci.io/repos/223973950)
[](https://codecov.io/gh/testmonitor/devops-client)
[](https://packagist.org/packages/testmonitor/devops-client)
This package provides a very basic, convenient, and unified wrapper for [Microsoft Azure DevOps](https://azure.microsoft.com/en-us/services/devops/).
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Tests](#tests)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
To install the client you need to require the package using composer:
$ composer require testmonitor/devops-client
Use composer's autoload:
```php
require __DIR__.'/../vendor/autoload.php';
```
You're all set up now!
## Usage
This client only supports **oAuth authentication**. You'll need an Microsoft Entra ID OAuth app to proceed.
If you haven't done so, please read up with the [Azure DevOps authentication docs](https://docs.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops)
on how to create an application and set the correct permissions.
When your OAuth app is up and running, start with the oAuth authorization:
```php
$oauth = [
'clientId' => '12345',
'clientSecret' => 'abcdef',
'appId' => '12345',
'redirectUrl' => 'https://redirect.myapp.com/',
];
$devops = new \TestMonitor\DevOps\Client($oauth);
header('Location: ' . $devops->authorizationUrl());
exit();
```
This will redirect the user to a page asking confirmation for your app getting access to Azure DevOps. Make sure your redirectUrl points
back to your app. This URL should point to the following code:
```php
$oauth = [
'clientId' => '12345',
'clientSecret' => 'abcdef',
'appId' => '12345',
'redirectUrl' => 'https://redirect.myapp.com/',
];
$devops = new \TestMonitor\DevOps\Client($oauth);
$token = $devops->fetchToken($_REQUEST['code']);
```
When everything went ok, you should have an access token (available through Token object). It will be valid for **one hour**.
After that, you'll have to refresh the token to regain access:
```php
$oauth = ['clientId' => '12345', 'clientSecret' => 'abcdef', 'appId' => '12345', 'redirectUrl' => 'https://redirect.myapp.com/'];
$token = new \TestMonitor\DevOps\AccessToken('eyJ0...', '0/34ccc...', 1574601877); // the token you got last time
$organization = 'MyOrg';
$devops = new \TestMonitor\DevOps\Client($oauth, $organization, $token);
if ($token->expired()) {
$newToken = $devops->refreshToken();
}
```
The new token will be valid again for the next hour.
## Examples
Get a list of Azure DevOps accounts:
```php
$accounts = $devops->accounts();
```
Or creating a work item, for example (using a work item type 'Bug' and example project with id 12345):
```php
$workItem = $devops->createWorkItem(new \TestMonitor\DevOps\Resources\WorkItem([
'title' => 'Summary of the item',
'description' => 'Some description',
'workItemType' => 'Bug',
'stepsToReproduce' => 'Repro steps',
]), '12345');
```
## Tests
The package contains integration tests. You can run them using PHPUnit.
$ vendor/bin/phpunit
## Changelog
Refer to [CHANGELOG](CHANGELOG.md) for more information.
## Contributing
Refer to [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
## Credits
* **Thijs Kok** - *Lead developer* - [ThijsKok](https://github.com/thijskok)
* **Stephan Grootveld** - *Developer* - [Stefanius](https://github.com/stefanius)
* **Frank Keulen** - *Developer* - [FrankIsGek](https://github.com/frankisgek)
* **Muriel Nooder** - *Developer* - [ThaNoodle](https://github.com/thanoodle)
## License
The MIT License (MIT). Refer to the [License](LICENSE.md) for more information.