testmonitor / devops-client

src/Actions/ManagesAttachments.php

<?php

namespace TestMonitor\DevOps\Actions;

use TestMonitor\DevOps\Resources\Attachment;
use TestMonitor\DevOps\Transforms\TransformsAttachments;

trait ManagesAttachments
{
    use TransformsAttachments;

    /**
     * Add a new attachment.
     *
     * @param string $path
     * @param string $workItemId
     * @param string $projectId
     *
     * @throws \TestMonitor\DevOps\Exceptions\InvalidDataException
     *
     * @return \TestMonitor\DevOps\Resources\Attachment
     */
    public function addAttachment(string $path, string $workItemId, string $projectId): Attachment
    {
        // First, upload the file
        $response = $this->post(

It seems like post() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            "{$projectId}/_apis/wit/attachments",
            [
                'headers' => ['Content-Type' => 'application/octet-stream'],
                'query' => ['fileName' => basename($path), 'api-version' => $this->apiVersion],
                'body' => fopen($path, 'r'),
            ]
        );

        // Second, attach it to the work item
        $this->patch(

It seems like patch() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            "{$projectId}/_apis/wit/workitems/{$workItemId}",
            [
                'headers' => ['Content-Type' => 'application/json-patch+json'],
                'json' => $this->toDevOpsAttachment($response['url']),
            ]
        );

        return $this->fromDevOpsAttachment($response);
    }
}