Helix\Asana\Api

Complexity

Total Complexity

54

Size/Duplication

Total Lines	532
Duplicated Lines	0 %

Importance

Changes	16
Bugs	1	Features	2

75 Methods

Rating	Name	Duplication	Size	Complexity
A	hp$0 ➔ setLogger()	0	2	1
A	hp$0 ➔ getWorkspaces()	0	2	1
	getWebhookEvent()	0	7	?
	delete()	0	2	?
	put()	0	6	?
	getDefaultWorkspace()	0	2	?
	setLogger()	0	2	?
A	hp$0 ➔ _jsonEncode()	0	2	1
A	hp$0 ➔ getWorkspace()	0	2	1
A	hp$0 ➔ load()	0	5	2
B	hp$0 ➔ _exec()	0	40	6
	_jsonDecode()	0	2	?
	upload()	0	5	?
A	hp$0 ➔ __construct()	0	4	2
A	hp$0 ➔ getPortfolio()	0	2	1
	getWorkspaceByName()	0	7	?
	getTag()	0	2	?
A	hp$0 ➔ loadAll()	0	2	1
A	hp$0 ➔ getUser()	0	2	1
	_exec()	0	40	?
A	hp$0 ➔ loadEach()	0	14	4
	_getPath()	0	2	?
A	hp$0 ➔ sync()	0	26	4
	getTaskList()	0	2	?
A	hp$0 ➔ getSection()	0	2	1
A	hp$0 ➔ getWebhookEvent()	0	7	1
	getAttachment()	0	2	?
A	hp$0 ➔ _jsonDecode()	0	2	1
	getUser()	0	2	?
A	hp$0 ➔ getWorkspaceByName()	0	7	3
A	hp$0 ➔ setDefault()	0	2	1
A	hp$0 ➔ post()	0	6	1
	getStory()	0	2	?
	getLogger()	0	5	?
	getWorkspace()	0	2	?
	loadAll()	0	2	?
	getSection()	0	2	?
	getProject()	0	2	?
A	hp$0 ➔ setCache()	0	2	1
	setDefault()	0	2	?
	getMe()	0	2	?
A	hp$0 ➔ getCustomField()	0	2	1
	sync()	0	26	?
A	hp$0 ➔ log()	0	1	1
A	hp$0 ➔ _getPath()	0	2	2
A	hp$0 ➔ getLogger()	0	5	1
A	hp$0 ➔ upload()	0	5	1
A	hp$0 ➔ getMe()	0	2	1
A	hp$0 ➔ factory()	0	2	1
	__construct()	0	4	?
	setCache()	0	2	?
A	hp$0 ➔ getTeam()	0	2	1
A	hp$0 ➔ getTask()	0	2	1
A	hp$0 ➔ put()	0	6	1
A	hp$0 ➔ getTag()	0	2	1
A	hp$0 ➔ getProject()	0	2	1
A	hp$0 ➔ getTaskList()	0	2	1
A	hp$0 ➔ getAttachment()	0	2	1
	getPortfolio()	0	2	?
A	getCache()	0	2	1
A	hp$0 ➔ delete()	0	2	1
	_jsonEncode()	0	2	?
	post()	0	6	?
A	hp$0 ➔ getDefaultWorkspace()	0	2	1
	getCustomField()	0	2	?
	loadEach()	0	14	?
	load()	0	5	?
	getTeam()	0	2	?
	getTask()	0	2	?
	getWorkspaces()	0	2	?
	get()	0	6	?
A	hp$0 ➔ getStory()	0	2	1
A	getDefault()	0	2	1
A	hp$0 ➔ get()	0	6	2
	factory()	0	2	?

<?php

namespace Helix\Asana;

use CURLFile;
use Generator;
use Helix\Asana\Api\Cache;
use Helix\Asana\Api\LoggerInterface;
use Helix\Asana\Base\AbstractEntity;
use Helix\Asana\Base\Data;
use Helix\Asana\Event\ProjectEvent;
use Helix\Asana\Event\StoryEvent;
use Helix\Asana\Event\TaskEvent;
use Helix\Asana\Project\Section;
use Helix\Asana\Task\Attachment;
use Helix\Asana\Task\Story;
use Helix\Asana\User\TaskList;

/**
 * API access.
 *
 * @see https://app.asana.com/-/developer_console
 */
class Api {

    /**
     * Cache is shared across all instances.
     *
     * @var Cache
     */
    protected static $cache;

    /**
     * The "default" instance (for entity deserialization).
     *
     * Defaults to the first instance created.
     *
     * @var static
     */
    protected static $default;

    /**
     * The logger is shared across all instances.
     *
     * @var LoggerInterface
     */
    protected static $logger;

    /**
     * @var string
     */
    protected $token;

    /**
     * @return Cache
     */
    public static function getCache () {
        return static::$cache ?? static::$cache = new Cache();
    }

    /**
     * @return Api
     */
    public static function getDefault () {
        return self::$default;
    }

    /**
     * @return LoggerInterface
     */
    public static function getLogger () {
        return static::$logger
            ?? static::$logger = new class implements LoggerInterface {

                public function log (string $message, string $path, array $data = null): void {
                    // stub
                }

            };
    }

    /**
     * @param Cache $cache
     */
    public static function setCache (Cache $cache) {
        static::$cache = $cache;
    }

    /**
     * @param Api $default
     */
    public static function setDefault (Api $default) {
        self::$default = $default;
    }

    /**
     * @param LoggerInterface $logger
     */
    public static function setLogger (LoggerInterface $logger) {
        static::$logger = $logger;
    }

    /**
     * @param string $token
     */
    public function __construct (string $token) {
        $this->token = $token;
        if (!static::$default) {
            static::$default = $this;
        }
    }

    /**
     * cURL transport.
     *
     * @param string $method
     * @param string $path
     * @param array $opts
     * @return null|array
     * @internal
     */
    protected function _exec (string $method, string $path, array $opts = []) {
        static::getLogger()->log($method, $path, $opts);
        /** @var resource $ch */
        $ch = curl_init();
        curl_setopt_array($ch, [
            CURLOPT_CUSTOMREQUEST => $method,
            CURLOPT_URL => "https://app.asana.com/api/1.0/{$path}",
            CURLOPT_USERAGENT => 'hfw/asana',
            CURLOPT_FOLLOWLOCATION => false, // HTTP 201 includes Location
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_HEADER => true,
        ]);
        $opts[CURLOPT_HTTPHEADER][] = "Authorization: Bearer {$this->token}";
        $opts[CURLOPT_HTTPHEADER][] = 'Accept: application/json';
        $opts[CURLOPT_HTTPHEADER][] = 'Expect:'; // prevent http 100
        curl_setopt_array($ch, $opts);
        RETRY:
        $response = curl_exec($ch);
        $info = curl_getinfo($ch);
        if ($response === false) {
            throw new Error(curl_errno($ch), curl_error($ch), $info);
        }
        /** @var string $response */
        [$head, $body] = explode("\r\n\r\n", $response, 2);
        $info['response_headers'] = $headers = array_column(array_map(function($header) {
            return explode(': ', $header, 2);
        }, array_slice(explode("\r\n", $head), 1)), 1, 0);
        switch ($info['http_code']) {
            case 200:
            case 201:
                return $this->_jsonDecode($body);
            case 404:
                return null;
            case 429:
                $sleep = $headers['Retry-After'];
                static::getLogger()->log("Retry-After {$sleep}: {$method}", $path);
                sleep($sleep);
                goto RETRY;
            default:
                throw new Error($info['http_code'], $body, $info);
        }
    }

    /**
     * @param string $path
     * @param array $query
     * @return string
     * @internal
     */
    protected function _getPath (string $path, array $query): string {
        return $query ? $path . '?' . http_build_query($query) : $path;
    }

    /**
     * @param string $json
     * @return null|array
     * @internal
     */
    protected function _jsonDecode (string $json) {
        return json_decode($json, true, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR);
    }

    /**
     * @param array $data
     * @return string
     * @internal
     */
    protected function _jsonEncode (array $data): string {
        return json_encode($data, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR);
    }

    /**
     * `HTTP DELETE`
     *
     * @param string $path
     */
    public function delete (string $path): void {
        $this->_exec('DELETE', $path);
    }

    /**
     * The central point of object creation.
     *
     * This can be overridden to return custom extensions.
     *
     * @param string $class
     * @param Api|Data $caller
     * @param array $data
     * @return mixed|Data|AbstractEntity
     */
    public function factory (string $class, $caller, array $data = []) {
        return new $class($caller, $data);
    }

    /**
     * `HTTP GET`
     *
     * @param string $path
     * @param array $query
     * @param array $options
     * @return null|array
     */
    public function get (string $path, array $query = [], array $options = []) {
        foreach ($options as $name => $value) {
            $query["opt_{$name}"] = $value;
        }
        $response = $this->_exec('GET', $this->_getPath($path, $query));
        return $response['data'] ?? null;
    }

    /**
     * Loads and returns an {@see Attachment}.
     *
     * @param string $gid
     * @return null|Attachment
     */
    public function getAttachment (string $gid) {
        return $this->load(Attachment::class, $this, "attachments/{$gid}");
    }

    /**
     * Loads and returns a {@see CustomField}.
     *
     * @param string $gid
     * @return null|CustomField
     */
    public function getCustomField (string $gid) {
        return $this->load(CustomField::class, $this, "custom_fields/{$gid}");
    }

    /**
     * Returns the first known workspace of the authorized user.
     * You should only rely on this if the authorized user is in exactly one workspace.
     *
     * @return Workspace
     */
    public function getDefaultWorkspace () {
        return $this->getMe()->getDefaultWorkspace();
    }

    /**
     * Returns the authorized user.
     *
     * @return User
     */
    public function getMe () {
        return $this->getUser('me');
    }

    /**
     * Loads and returns a {@see Portfolio}.
     *
     * @param string $gid
     * @return null|Portfolio
     */
    public function getPortfolio (string $gid) {
        return $this->load(Portfolio::class, $this, "portfolios/{$gid}");
    }

    /**
     * Loads and returns a {@see Project}.
     *
     * @param string $gid
     * @return null|Project
     */
    public function getProject (string $gid) {
        return $this->load(Project::class, $this, "projects/{$gid}");
    }

    /**
     * Loads and returns a {@see Section}.
     *
     * @param string $gid
     * @return null|Section
     */
    public function getSection (string $gid) {
        return $this->load(Section::class, $this, "sections/{$gid}");
    }

    /**
     * Loads and returns a {@see Story}.
     *
     * @param string $gid
     * @return null|Story
     */
    public function getStory (string $gid) {
        return $this->load(Story::class, $this, "stories/{$gid}");
    }

    /**
     * Loads and returns a {@see Tag}.
     *
     * @param string $gid
     * @return null|Tag
     */
    public function getTag (string $gid) {
        return $this->load(Tag::class, $this, "tags/{$gid}");
    }

    /**
     * Loads and returns a {@see Task}.
     *
     * @param string $gid
     * @return null|Task
     */
    public function getTask (string $gid) {
        return $this->load(Task::class, $this, "tasks/{$gid}");
    }

    /**
     * Loads and returns a {@see TaskList}.
     *
     * @param string $gid
     * @return null|TaskList
     */
    public function getTaskList (string $gid) {
        return $this->load(TaskList::class, $this, "user_task_lists/{$gid}");
    }

    /**
     * Loads and returns a {@see Team}.
     *
     * @param string $gid
     * @return null|Team
     */
    public function getTeam (string $gid) {
        return $this->load(Team::class, $this, "teams/{$gid}");
    }

    /**
     * Loads and returns a {@see User}.
     *
     * @param string $gid
     * @return null|User
     */
    public function getUser (string $gid) {
        return $this->load(User::class, $this, "users/{$gid}");
    }

    /**
     * Expands received webhook data as a full event object.
     *
     * @see https://developers.asana.com/docs/event
     *
     * @param array $data
     * @return ProjectEvent|TaskEvent|StoryEvent
     */
    public function getWebhookEvent (array $data) {
        static $classes = [
            Project::TYPE => ProjectEvent::class,
            Task::TYPE => TaskEvent::class,
            Story::TYPE => StoryEvent::class
        ];
        return $this->factory($classes[$data['type']], $this, $data);
    }

    /**
     * Loads and returns a {@see Workspace}.
     *
     * @param string $gid
     * @return null|Workspace
     */
    public function getWorkspace (string $gid) {
        return $this->load(Workspace::class, $this, "workspaces/{$gid}");
    }

    /**
     * Loads and returns a {@see Workspace} by name.
     *
     * @param string $name
     * @return null|Workspace
     */
    public function getWorkspaceByName (string $name) {
        foreach ($this->getWorkspaces() as $workspace) {
            if ($workspace->getName() === $name) {
                return $workspace;
            }
        }
        return null;
    }

    /**
     * All workspaces visible to the authorized user.
     *
     * @return Workspace[]
     */
    public function getWorkspaces () {
        return $this->getMe()->getWorkspaces();
    }

    /**
     * Loads the entity found at the given path + query.
     *
     * The entity is cached.
     *
     * @param string $class
     * @param Api|Data $caller
     * @param string $path
     * @param array $query
     * @return null|mixed|AbstractEntity
     */
    public function load (string $class, $caller, string $path, array $query = []) {
        $key = $this->_getPath($path, $query);
        return $this->getCache()->get($key, $caller, function($caller) use ($class, $path, $query) {
            $data = $this->get($path, $query, ['expand' => 'this']);
            return $data ? $this->factory($class, $caller, $data) : null;
        });
    }

    /**
     * Returns all results from {@see loadEach()}
     *
     * @param string $class
     * @param Api|Data $caller
     * @param string $path
     * @param array $query
     * @param int $pages
     * @return array|AbstractEntity[]
     */
    public function loadAll (string $class, $caller, string $path, array $query = [], int $pages = 0) {
        return iterator_to_array($this->loadEach(...func_get_args()));
    }

    /**
     * Loads and yields each entity found at the given path + query.
     *
     * The result-set is not cached, but individual entities are.
     *
     * @param string $class
     * @param Api|Data $caller
     * @param string $path
     * @param array $query `limit` can be included, or excluded to default at `100` (the maximum).
     * @param int $pages If positive, stops after this many pages have been fetched.
     * @return Generator|AbstractEntity[]
     */
    public function loadEach (string $class, $caller, string $path, array $query = [], int $pages = 0) {
        $query['opt_expand'] = 'this';
        $query += ['limit' => 100];
        $path = $this->_getPath($path, $query);
        $pageCount = 0;
        do {
            $page = $this->_exec('GET', $path);
            foreach ($page['data'] ?? [] as $data) {
                yield $this->getCache()->get($data['gid'], $caller, function($caller) use ($class, $data) {
                    return $this->factory($class, $caller, $data);
                });
            }
            $path = substr($page['next_page']['path'] ?? null, 1); // removes leading slash
        } while ($path and ++$pageCount !== $pages);
    }

    /**
     * `HTTP POST`
     *
     * @param string $path
     * @param array $data
     * @param array $options
     * @return null|array
     */
    public function post (string $path, array $data = [], array $options = []) {
        $response = $this->_exec('POST', $path, [
            CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
            CURLOPT_POSTFIELDS => $this->_jsonEncode(['options' => $options, 'data' => $data])
        ]);
        return $response['data'] ?? null;
    }

    /**
     * `HTTP PUT`
     *
     * @param string $path
     * @param array $data
     * @param array $options
     * @return null|array
     */
    public function put (string $path, array $data = [], array $options = []) {
        $response = $this->_exec('PUT', $path, [
            CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
            CURLOPT_POSTFIELDS => $this->_jsonEncode(['options' => $options, 'data' => $data])
        ]);
        return $response['data'] ?? null;
    }

    /**
     * Polls for new events. This can be used as an alternative to webhooks.
     *
     * If the given sync token expired, a `412` is thrown, and a new sync token is set as the message.
     *
     * @see https://developers.asana.com/docs/get-events-on-a-resource
     *
     * @param Project|Task $entity
     * @param null|string $token
     * @return ProjectEvent[]|TaskEvent[]|StoryEvent[]
     */
    public function sync ($entity, ?string &$token) {
        try {
            $response = $this->_exec('GET', $this->_getPath('events', [
                'resource' => $entity->getGid(),
                'sync' => $token,
                'opt_expand' => 'this'
            ]));
        }
        catch (Error $error) {
            if ($error->getCode() !== 412) {
                throw $error;
            }
            $response = $this->_jsonDecode($error->getMessage());
            if (isset($token)) {
                throw new Error(412, $response['sync'], $error->getCurlInfo());
            }
        }
        $token = $response['sync'];
        return array_map(function(array $each) {
            static $classes = [
                Project::TYPE => ProjectEvent::class,
                Task::TYPE => TaskEvent::class,
                Story::TYPE => StoryEvent::class
            ];
            return $this->factory($classes[$each['resource']['resource_type']], $this, $each);
        }, $response['data'] ?? []);
    }

    /**
     * `HTTP POST` (multipart/form-data)
     *
     * @param string $path
     * @param string $file
     * @return null|array
     */
    public function upload (string $path, string $file) {
        $response = $this->_exec('POST', $path, [
            CURLOPT_POSTFIELDS => ['file' => new CURLFile(realpath($file))] // multipart/form-data
        ]);
        return $response['data'] ?? null;
    }
}