Bitbucket\API\Repositories\Commits

Complexity

Total Complexity

6

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	all()	0	14	2
A	get()	0	6	1
A	approve()	0	6	1
A	deleteApproval()	0	6	1
A	comments()	0	4	1

<?php

/**
 * This file is part of the bitbucket-api package.
 *
 * (c) Alexandru G. <alex@gentle.ro>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Bitbucket\API\Repositories;

use Bitbucket\API\Api;
use Bitbucket\API\Repositories\Commits\Comments;
use Psr\Http\Message\ResponseInterface;

/**
 * @author  Alexandru G.    <alex@gentle.ro>
 */
class Commits extends Api
{
    /**
     * Get a list of commits
     *
     * @access public
     * @param  string           $account The team or individual account owning the repository.
     * @param  string           $repo    The repository identifier.
     * @param  array            $params  Additional parameters
     * @return ResponseInterface
     */
    public function all($account, $repo, array $params = array())
    {
        $endpoint = sprintf('/repositories/%s/%s/commits', $account, $repo);

        if (!empty($params['branch'])) {
            $endpoint .= '/'.$params['branch']; // can also be a tag
            unset($params['branch']);
        }

        return $this->getClient()->setApiVersion('2.0')->get(
            $endpoint,
            $params
        );
    }

    /**
     * Get an individual commit
     *
     * @access public
     * @param  string           $account  The team or individual account owning the repository.
     * @param  string           $repo     The repository identifier.
     * @param  string           $revision A SHA1 value for the commit.
     * @return ResponseInterface
     */
    public function get($account, $repo, $revision)
    {
        return $this->getClient()->setApiVersion('2.0')->get(
            sprintf('/repositories/%s/%s/commit/%s', $account, $repo, $revision)
        );
    }

    /**
     * Approve a commit
     *
     * @access public
     * @param  string           $account  The team or individual account owning the repository.
     * @param  string           $repo     The repository identifier.
     * @param  string           $revision A SHA1 value for the commit.
     * @return ResponseInterface
     */
    public function approve($account, $repo, $revision)
    {
        return $this->getClient()->setApiVersion('2.0')->post(
            sprintf('/repositories/%s/%s/commit/%s/approve', $account, $repo, $revision)
        );
    }

    /**
     * Delete a commit approval
     *
     * NOTE: On success returns `HTTP/1.1 204 NO CONTENT`
     *
     * @access public
     * @param  string           $account  The team or individual account owning the repository.
     * @param  string           $repo     The repository identifier.
     * @param  string           $revision A SHA1 value for the commit.
     * @return ResponseInterface
     */
    public function deleteApproval($account, $repo, $revision)
    {
        return $this->getClient()->setApiVersion('2.0')->delete(
            sprintf('/repositories/%s/%s/commit/%s/approve', $account, $repo, $revision)
        );
    }

    /**
     * Get comments
     *
     * @access public
     * @return Commits\Comments
     *
     * @throws \InvalidArgumentException
     * @codeCoverageIgnore
     */
    public function comments()
    {
        return $this->api(Comments::class);
    }
}