onesky / api-library-php5

src/Onesky/Api/Client.php

<?php

namespace Onesky\Api;

/**
 * Onesky API wrapper PHP5 library
 */

/**
 * @method string projectGroups(string $action, array $arrayWithProjectGroupId) Possible actions: list, show, create, delete, languages
 * @method string project(string $action, array $arrayWithProjectIdOrProjectGroupId = null) Possible actions: list, show, create, delete, languages
 * @method string files(string $action, array $arrayWithProjectId) Possible actions: list, upload, delete
 * @method string translations(string $action, array $arrayWithProjectId) Possible actions: export, status
 * @method string importTasks(string $action, array $arrayWithProjectIdAndOrImportId) Possible actions: list, show
 * @method string quotations(string $action, array $arrayWithProjectId) Possible actions: show
 * @method string orders(string $action, array $arrayWithProjectIdAndOrOrderId) Possible actions: list, show, create
 * @method string locales(string $action) Possible actions: list
 * @method string projectTypes(string $action) Possible actions: list
 */

class Client
{
    /**
     * Onesky API endpoint
     */
    protected $endpoint = 'https://platform.api.onesky.io/1';

    /**
     * Client authenticate token
     */
    protected $apiKey = null;

    /**
     * Client authenticate secret
     */
    protected $secret = null;

    /**
     * Resources with actions
     */
    protected $resources = array(
        'project_groups' => array(
            'list'      => '/project-groups',
            'show'      => '/project-groups/:project_group_id',
            'create'    => '/project-groups',
            'delete'    => '/project-groups/:project_group_id',
            'languages' => '/project-groups/:project_group_id/languages',
        ),
        'projects'       => array(
            'list'      => '/project-groups/:project_group_id/projects',
            'show'      => '/projects/:project_id',
            'create'    => '/project-groups/:project_group_id/projects',
            'update'    => '/projects/:project_id',
            'delete'    => '/projects/:project_id',
            'languages' => '/projects/:project_id/languages',
        ),
        'files'          => array(
            'list'   => '/projects/:project_id/files',
            'upload' => '/projects/:project_id/files',
            'delete' => '/projects/:project_id/files',
        ),
        'translations'   => array(
            'export' => '/projects/:project_id/translations',
            'multilingual' => '/projects/:project_id/translations/multilingual',
            'status' => '/projects/:project_id/translations/status',
        ),
        'import_tasks'   => array(
            'list' => '/projects/:project_id/import-tasks/',
            'show' => '/projects/:project_id/import-tasks/:import_id'
        ),
        'quotations'     => array(
            'show' => '/projects/:project_id/quotations'
        ),
        'orders'         => array(
            'list'   => '/projects/:project_id/orders',
            'show'   => '/projects/:project_id/orders/:order_id',
            'create' => '/projects/:project_id/orders'
        ),
        'locales'        => array(
            'list' => '/locales'
        ),
        'project_types'  => array(
            'list' => '/project-types'
        ),
    );

    /**
     * Actions to use multipart to upload file
     */
    protected $multiPartActions = array(
        'files' => array('upload'),
    );

    /**
     * Actions to use multipart to upload file
     */
    protected $exportFileActions = array(
        'translations' => array('export'),
    );

    /**
     * Methods of actions mapping
     */
    protected $methods = array(
        // 'get'    => array('list', 'show', 'languages', 'export', 'status'),

64% of this comment could be valid code. Did you maybe forget this after debugging?

        'post'   => array('create', 'upload'),
        'put'    => array('update'),
        'delete' => array('delete'),
    );

    /**
     * Default curl settings
     */
    protected $curlSettings = array(
        CURLOPT_RETURNTRANSFER => true,
    );

    protected $httpHeaders = array(
        "Onesky-Plugin: php-wrapper",
    );

    public function __construct()
    {
        if (!function_exists('curl_init')) {
            throw new \Exception('OneSky needs the CURL PHP extension.');
        }
    }

    /**
     * @param string $apiKey
     * @return $this
     */
    public function setApiKey($apiKey)
    {
        $this->apiKey = $apiKey;
        return $this;
    }

    /**
     * @param string $secret
     * @return $this
     */
    public function setSecret($secret)
    {
        $this->secret = $secret;
        return $this;
    }

    /**
     * Retrieve resources
     * @return array
     */
    public function getResources()
    {
        return array_keys($this->resources);
    }

    /**
     * Retrieve actions of a resource
     * @param  string $resource Resource name
     * @return array|null
     */
    public function getActionsByResource($resource)
    {
        if (!isset($this->resources[$resource])) {
            return null; // no resource found
        }

        $actions = array();
        foreach ($this->resources[$resource] as $action => $path) {
            $actions[] = $action;
        }

        return $actions;
    }

    /**
     * Retrieve the corresponding method to use
     * @param  string $action Action name
     * @return string
     */
    public function getMethodByAction($action)
    {
        foreach ($this->methods as $method => $actions) {
            if (in_array($action, $actions)) {
                return $method;
            }
        }

        return 'get';
    }

    /**
     * Determine if using mulit-part to upload file
     * @param  string  $resource Resource name
     * @param  string  $action   Action name
     * @return boolean
     */
    public function isMultiPartAction($resource, $action)
    {
        return isset($this->multiPartActions[$resource]) && in_array($action, $this->multiPartActions[$resource]);
    }

    /**
     * Determine if it is to export (download) file
     * @param  string  $resource Resource name
     * @param  string  $action   Action name
     * @return boolean
     */
    public function isExportFileAction($resource, $action)
    {
        return isset($this->exportFileActions[$resource]) && in_array($action, $this->exportFileActions[$resource]);
    }

    /**
     * For developers to initial request to Onesky API
     * 
     * Example:
     *     $onesky = new Onesky_Api();
     *     $onesky->setApiKey('<api-key>')->setSecret('<api-secret>');
     *     
     *     // To list project type
     *     $onesky->projectTypes('list');
     *
     *     // To create project
     *     $onesky->projects('create', array('project_group_id' => 999));
     *
     *     // To upload string file
     *     $onesky->files('upload', array('project_id' => 1099, 'file' => 'path/to/file.yml', 'file_format' => 'YAML'));
     * 
     * @param  string $fn_name Function name acted as resource name
     * @param  array  $params  Parameters passed in request
     * @return array  Response
     */
    public function __call($fn_name, $params)
    {
        // is valid resource
        $resource = strtolower(preg_replace('/([a-z])([A-Z])/', '$1_$2', $fn_name)); // camelcase to underscore
        if (!in_array($resource, $this->getResources())) {
            throw new \BadMethodCallException('Invalid resource');
        }

        // is valid action
        $action = array_shift($params); // action name
        if (!in_array($action, $this->getActionsByResource($resource))) {
            throw new \InvalidArgumentException('Invalid resource action');
        }

        // parameters
        if (count($params) > 0) {
            $params = $this->normalizeParams(array_shift($params));
        } else {
            $params = array();
        }

        // get request method
        $method = $this->getMethodByAction($action);

        // get path
        $path = $this->getRequestPath($resource, $action, $params);

        // is multi-part
        $isMultiPart = $this->isMultiPartAction($resource, $action);

        // return response
        return $this->callApi($method, $path, $params, $isMultiPart);
    }

    /**
     * Retrieve request path and replace variables with values
     * @param  string $resource Resource name
     * @param  string $action   Action name
     * @param  array  $params   Parameters
     * @return string Request path
     */
    private function getRequestPath($resource, $action, &$params)
    {
        if (!isset($this->resources[$resource]) || !isset($this->resources[$resource][$action])) {
            throw new \UnexpectedValueException('Resource path not found');
        }

        // get path
        $path = $this->resources[$resource][$action];

        // replace variables
        $matchCount = preg_match_all("/:(\w*)/", $path, $variables);
        if ($matchCount) {
            foreach ($variables[0] as $index => $placeholder) {
                if (!isset($params[$variables[1][$index]])) {
                    throw new \InvalidArgumentException('Missing parameter: ' . $variables[1][$index]);
                }

                $path = str_replace($placeholder, $params[$variables[1][$index]], $path);
                unset($params[$variables[1][$index]]); // remove parameter from $params
            }
        }

        return $path;
    }

    protected function verifyTokenAndSecret()
    {
        if (empty($this->apiKey) || empty($this->secret)) {
            throw new \UnexpectedValueException('Invalid authenticate data of api key or secret');
        }
    }

    /**
     * Initial request to Onesky API
     * @param  string  $method
     * @param  string  $path
     * @param  array   $params
     * @param  boolean $isMultiPart
     * @return array
     */
    private function callApi($method, $path, $params, $isMultiPart)
    {
        // init session
        $ch = curl_init();

        // request settings
        curl_setopt_array($ch, $this->curlSettings); // basic settings

        // url
        $url = $this->endpoint . $path;
        $url .= $method == 'get' ? $this->getAuthQueryStringWithParams($params) : $this->getAuthQueryString();

        curl_setopt($ch, CURLOPT_URL, $url);

        // http header
        $requestHeaders = $this->httpHeaders;
        if (!$isMultiPart) {
            $requestHeaders[] = "Content-Type: application/json";
        }
        curl_setopt($ch, CURLOPT_HTTPHEADER, $requestHeaders);

        // method specific settings
        switch ($method) {
            case 'post':
                curl_setopt($ch, CURLOPT_POST, 1);

                // request body
                if ($isMultiPart) {
                    if (version_compare(PHP_VERSION, '5.5.0') === -1) {
                        // fallback to old method
                        $params['file'] = '@' . $params['file'];
                    } else {
                        // make use of CURLFile
                        curl_setopt($ch, CURLOPT_SAFE_UPLOAD, true);
                        $params['file'] = new \CURLFile($params['file']);
                    }
                    $postBody = $params;
                } else {
                    $postBody = json_encode($params);
                }
                curl_setopt($ch, CURLOPT_POSTFIELDS, $postBody);
                break;

            case 'put':

This code seems to be duplicated across your project.

                curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
                curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
                break;

            case 'delete':

This code seems to be duplicated across your project.

                curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
                curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
                break;
        }

        // execute request
        $response = curl_exec($ch);

        // error handling
        if ($response === false) {
            throw new \UnexpectedValueException(curl_error($ch));
        }

        // close connection
        curl_close($ch);

        // return response
        return $response;
    }

    /**
     * @param $params
     * @return string
     */
    private function getAuthQueryStringWithParams($params)
    {
        $queryString = $this->getAuthQueryString();

        if (count($params) > 0) {
            $queryString .= '&' . http_build_query($params);
        }

        return $queryString;
    }

    /**
     * @return string
     */
    private function getAuthQueryString()
    {
        $this->verifyTokenAndSecret();

        $timestamp = time();
        $devHash = md5($timestamp . $this->secret);

        $queryString  = '?api_key=' . $this->apiKey;
        $queryString .= '&timestamp=' . $timestamp;
        $queryString .= '&dev_hash=' . $devHash;

        return $queryString;
    }

    /**
     * @param array $params
     * @return array
     */
    private function normalizeParams(array $params)
    {
        // change boolean value to integer for curl
        foreach ($params as $key => $value) {
            if (is_bool($value)) {
                $params[$key] = (int)$value;
            }
        }

        return $params;
    }
}