peterjmit / bamboo-api-client
A REST API client for Atlassian Bamboo
0.1.1
2014-05-31 03:16 UTC
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ~4.0
Requires (Dev)
- phpspec/phpspec: ~2.0
This package is not auto-updated.
Last update: 2025-03-01 18:33:27 UTC
README
An API client consuming the REST resources made available for Atlassian's CI software - Bamboo
Installation
Add this line to your composer.json file, and run composer update
"peterjmit/bamboo-api-client": "~0.1.0"
Usage
Create an API client using http basic authentication
<?php use Peterjmit\Bamboo\Bamboo; $bamboo = Bamboo::create('bamboo.com', 'username', 'password');
Specify an API version
<?php $bamboo = Bamboo::create('bamboo.com', 'username', 'password', 1);
Methods
Get all build results
<?php $bamboo->getAllBuildResults();
Get build results for a plan
<?php $bamboo->getPlanResults('AN', 'EXAMPLE');
Get build results for a plan branch
<?php $bamboo->getPlanBranchResults('AN', 'EXAMPLE', 'my-cool-feature-branch');
Get plan information for a specific branch
<?php $bamboo->getPlanBranch('AN', 'EXAMPLE', 'my-cool-feature-branch');
Todo
- Implement all endpoints/resources
- Create objects to represent resources
- Utilize "expand" functionality in bamboo
- Use HATEOS links to load relations to returned objects
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request