BabDev\Transifex\Projects

Complexity

Total Complexity

16

Size/Duplication

Total Lines	188
Duplicated Lines	6.38 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	16
Bugs	2	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
B	buildProjectRequest()	0	36	4
A	checkLicense()	0	15	2
B	createProject()	0	32	4
A	deleteProject()	0	4	1
A	getProject()	12	12	2
A	getProjects()	0	4	1
A	updateProject()	0	19	2

<?php

/*
 * BabDev Transifex Package
 *
 * (c) Michael Babker <michael.babker@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace BabDev\Transifex;

/**
 * Transifex API Projects class.
 *
 * @link http://docs.transifex.com/developer/api/projects
 */
class Projects extends TransifexObject
{
    /**
     * Build the data array to send with create and update requests.
     *
     * @param array $options Optional additional params to send with the request
     *
     * @return array
     */
    private function buildProjectRequest(array $options)
    {
        $data = [];

        // Valid options to check
        $validOptions = [
            'long_description',
            'private',
            'homepage',
            'trans_instructions',
            'tags',
            'maintainers',
            'team',
            'auto_join',
            'license',
            'fill_up_resources',
            'repository_url',
            'organization',
            'archived',
        ];

        // Loop through the valid options and if we have them, add them to the request data
        foreach ($validOptions as $option) {
            if (isset($options[$option])) {
                $data[$option] = $options[$option];
            }
        }

        // Set the license if present
        if (isset($options['license'])) {
            $this->checkLicense($options['license']);
            $data['license'] = $options['license'];
        }

        return $data;
    }

    /**
     * Checks that a license is an accepted value.
     *
     * @param string $license The license to check
     *
     * @throws \InvalidArgumentException
     */
    private function checkLicense($license)
    {
        $accepted = ['proprietary', 'permissive_open_source', 'other_open_source'];

        // Ensure the license option is an allowed value
        if (!in_array($license, $accepted)) {
            throw new \InvalidArgumentException(
                sprintf(
                    'The license %s is not valid, accepted license values are %s',
                    $license,
                    implode(', ', $accepted)
                )
            );
        }
    }

    /**
     * Method to create a project.
     *
     * @param string $name           The name of the project
     * @param string $slug           The slug for the project
     * @param string $description    A description of the project
     * @param string $sourceLanguage The source language code for the project
     * @param array  $options        Optional additional params to send with the request
     *
     * @return \Joomla\Http\Response
     *
     * @throws \InvalidArgumentException
     */
    public function createProject($name, $slug, $description, $sourceLanguage, array $options = [])
    {
        // Build the request data.
        $data = array_merge(
            [
                'name'                 => $name,
                'slug'                 => $slug,
                'description'          => $description,
                'source_language_code' => $sourceLanguage,
            ],
            $this->buildProjectRequest($options)
        );

        // Check mandatory fields.
        if (!isset($data['license']) || in_array($data['license'], ['permissive_open_source', 'other_open_source'])) {
            if (!isset($data['repository_url'])) {
                throw new \InvalidArgumentException(
                    'If a project is denoted either as permissive_open_source or other_open_source, the field repository_url is mandatory and should contain a link to the public repository of the project to be created.'
                );
            }
        }

        // Send the request.
        return $this->processResponse(
            $this->client->post(
                $this->fetchUrl('/projects/'),
                json_encode($data),
                ['Content-Type' => 'application/json']
            ),
            201
        );
    }

    /**
     * Method to delete a project.
     *
     * @param string $slug The slug for the resource.
     *
     * @return \Joomla\Http\Response
     */
    public function deleteProject($slug)
    {
        return $this->processResponse($this->client->delete($this->fetchUrl('/project/' . $slug)), 204);
    }

    /**
     * Method to get information about a project.
     *
     * @param string $project The project to retrieve details for
     * @param bool   $details True to retrieve additional project details
     *
     * @return \Joomla\Http\Response
     */
    public function getProject($project, $details = false)

This method seems to be duplicated in your project.

    {
        // Build the request path.
        $path = '/project/' . $project . '/';

        if ($details) {
            $path .= '?details';
        }

        // Send the request.
        return $this->processResponse($this->client->get($this->fetchUrl($path)));
    }

    /**
     * Method to get a list of projects the user is part of.
     *
     * @return \Joomla\Http\Response
     */
    public function getProjects()
    {
        return $this->processResponse($this->client->get($this->fetchUrl('/projects/')));
    }

    /**
     * Method to update a project.
     *
     * @param string $slug    The slug for the project
     * @param array  $options Optional additional params to send with the request
     *
     * @return \Joomla\Http\Response
     *
     * @throws \RuntimeException
     */
    public function updateProject($slug, array $options = [])
    {
        // Build the request data.
        $data = $this->buildProjectRequest($options);

        // Make sure we actually have data to send
        if (empty($data)) {
            throw new \RuntimeException('There is no data to send to Transifex.');
        }

        // Send the request.
        return $this->processResponse(
            $this->client->put(
                $this->fetchUrl('/project/' . $slug . '/'),
                json_encode($data),
                ['Content-Type' => 'application/json']
            )
        );
    }
}