dugan / sprintly-php
Sprintly API wrapper for PHP 5.4+
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ~5.0
Requires (Dev)
- mockery/mockery: ~0.9.0
- phpunit/phpunit: ~4.0
This package is not auto-updated.
Last update: 2024-11-05 03:05:43 UTC
README
This is a library that wraps the Sprint.ly API for PHP 5.4+.
API Status: (:heavy_check_mark: Complete, :interrobang: In Progress, :x: Todo)
"CRUD" should be interpreted as:
Create resource, delete resource, retrieve all of resource, retrieve 1+ resource, update resource
✔️ Product CRUD
✔️ Product People CRUD
✔️ Product Item CRUD
✔️ Perform lightweight queries of a product's items
✔️ Retrieve children of an item
Quickstart
This package requires Composer
composer require "dugan/sprintly-php": "dev-master"
composer update
$service = new \Dugan\Sprintly\SprintlyService('myemail@example.net', 'mySprintlyAuthKey');
$products = $service->getProductsRepository()->all();
foreach($products as $product) {
echo $product->getName()."\n";
}
How it Works
Under the hood, we use the Guzzle library to consume the Sprintly API
Top level entities can be accessed using the wrapper methods in Dugan\Sprintly\SprintlyService, or you can use the service to retrieve the individual repositories and work with them.
Authenticating
Sprintly's API uses HTTP auth with an email address and Auth token which you can retrieve from their website. All API methods require authentication, and several require you to have administrator status on a given product.
How to instantiate the API with your credentials:
$service = \Dugan\Sprintly\SprintlyService::instance($myEmail, $myAuthkey);
All examples after this will assume $service has already been instantiated with your credentials.
Since the SprintlyService implements the Singleton pattern, we can avoid having to repeatedly instantiate it when it is needed in different places. To retrieve an existing instance, simply call:
\Dugan\Sprintly\SprintlyService::instance()
Common Functionality
Instead of repeating the following code snippets several times, I will let it suffice to say that most repositories implement the two following methods, used in 3 different ways. We'll demonstrate with the PeopleRepository, but the same methods will exist on other repositories.
To retrieve all of a resource (the index):
$service->getPeopleRepository()->all()
To retrieve a single resource (the GET):
$service->getPeopleRepository()->get($id)
To retrieve a collection of resources, but not all of them:
$service->getPeopleRepository()->get([$firstId, $secondId])
Note this will execute multiple HTTP requests, so when working with more than a couple resources, it is often more efficient to retrieve all resources and filter them locally.
There are also wrapper methods for retrieving an entity's repository through the service:
$service->products()->get($id)
$service->items()->all()
etc
Products
The Product is top-level entity in Sprintly. It has items, people, attachments, tags, etc related to it, which can all be accessed through the API.
Retrieve all products:
Using SprintlyService
$service->getAllProducts()
Returns an array of \Dugan\Sprintly\Entities\Product
Retrieve a single product:
Using SprintlyService
$service->getProduct($id)
Returns an instance of \Dugan\Sprintly\Entities\Product
Retrieve a collection of products (but not all of them!):
Using SprintlyService
$service->getProduct([$firstId, $secondId])
Using ProductsRepository
$service->getProductsRepository()->get([$firstId, $secondId])
Returns an array of \Dugan\Sprintly\Entities\Product
<<<<<<< HEAD The returned product will have several properties on it which are available for your use:
$product->getName();
$product->getCreatedBy();
$product->getId();
$product->getCreatedAt();
$product->getWebhook();
The webhook is especially useful if you want to integrate Sprintly with GitHub or Bitbucket for closing items via commit messages.
The Product ID
Most of the entities represented by the Sprintly API are only accessible in the context of a product.
Unless otherwise noted, from here on out you should assume all code examples are preceded by:
$service->setProductId($productId)
This will allow the service to automatically inject the product ID into the appropriate repositories before returning them back to you.
Note that the SprintlyService is a singleton, and will therefore retain the last product ID set on it until you set another product ID on it.
Users
In the Sprintly verbiage, users are called people and person. The API wrapper reflects this. You can only retrieve people in the context of a product.
To invite a user to a product:
$user = new \Dugan\Sprintly\Entities\Person();
$user->setFirstName('Mike');
$user->setLastName('Dugan');
$user->setEmail('foo@bar.com');
$invitedUser = $service->people()->invite($user);
Items
Items are the stories, tasks, defects, etc that belong to a product. Again, these can only be retrieved in the context of a product.
To create a new item:
$item = new \Dugan\Sprintly\Entities\Item();
$item->setTitle('Something broke');
$item->setAssignedTo($myUserId);
$item->setTags('major,bug');
$service->items()->create($item);
To retrieve an item's children:
$item = $service->items()->get($itemId);
$children = $service->items()->children($item);