simon-wessel/teamcity-api

TeamCity API wrapper for PHP - usable with or without Laravel 5

TeamCity API

, _(*1)

A simple PHP wrapper for the API of your TeamCity instance which may or may not be used as a Laravel package., _(*2)

This package lacks most API functions provided by TeamCity due to the sheer amount of endpoints. If you need any of the missing functions, just add it to the API class and create a pull request., _(*3)

Table of Contents

• Installation
• Standalone usage
• Usage with Laravel

Installation

The package can be installed via composer by running, _(*4)

composer require simon-wessel/teamcity-api

Standalone usage

$url = "https://yoururltoteamcity.com/";
$username = "myusername";
$password = "mypassword";

$teamCityApi = new SimonWessel\TeamCityApi\TeamCityApi($url, $username, $password);

$builds = $teamCityApi->getBuilds();

Usage with Laravel

1. Setup

The package supports package auto-discovery which has been introduced in Laravel 5.5. If you are using 5.5 or above, you can skip this step., _(*5)

Otherwise you have to add the Service Provider to the providers array in your config/app.php file:, _(*6)

SimonWessel\TeamcityApi\ServiceProvider::class,

And if you want to use the Facade, you have to add it to the aliases array in the same file:, _(*7)

'TeamCity' => \SimonWessel\TeamCityApi\Facade::class,

2. Configuration

You will need to configure a TeamCity user account with all permissions for the data and actions you want to access. You can either set the following environment variables in your .env file:, _(*8)

TEAMCITY_URL=https://yoururltoteamcity.com/
TEAMCITY_USERNAME=myusername
TEAMCITY_PASSWORD=mypassword

Or alternatively you can publish the package config file and adjust the settings in there. To do this run this command:, _(*9)

php artisan vendor:publish --provider="SimonWessel\TeamCityApi\ServiceProvider"

You will get a new config file config/teamcity.php with the available settings., _(*10)

3. Usage

You can access the API with the Facade:, _(*11)

TeamCity::getBuilds()

Or calling the Service Provider singleton directly:, _(*12)

app('teamcity')->getBuilds()