FondOf\Airtable\ApiClient

Complexity

Total Complexity

11

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

85.19%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	4
A	listRecords()	0	5	1
A	listRecord()	0	4	1
A	createRecord()	0	18	3
A	setLimit()	0	4	1
A	apiUrl()	0	4	1

<?php

namespace FondOf\Airtable;

use FondOf\Airtable\Exception\MarshalFieldsException;
use FondOf\Airtable\Exception\NoWriteDataException;
use FondOf\Airtable\Exception\MissingConfigException;
use FondOf\Airtable\Service\HttpInterface;

class ApiClient implements ApiClientInterface
{
    /**
     * @var string Airtable Api
     */
    protected $apiUrl = 'https://api.airtable.com';

    /**
     * @var string Airtable API Version
     */
    protected $apiVersion = 'v0';

    /**
     * @var string Airtable base project
     */
    protected $base = '';

    /**
     * @var string Table in base project
     */
    protected $table = '';

    /**
     * @var int Max numbers of records to return
     */
    protected $limit = 10;

    /**
     * @var string Page offset if records > limit
     */
    protected $offset = '';

    /**
     * @var string Airtable API key
     */
    private $apiKey = '';

    /**
     * @var Service\HttpInterface
     */
    private $service;


    /**
     * @param HttpInterface $service
     * @param array<mixed> $config
     *
     * @throws MissingConfigException
     */
    public function __construct(HttpInterface $service, array $config)
    {
        if (!isset($config['apiKey'])) {
            throw new MissingConfigException('Airtable API Key is missing from the Config');
        }

        foreach ($config as $key => $value) {
            if (property_exists(self::class, (string)$key)) {
                $this->{$key} = $value;
            }
        }

        $this->service = $service;
        $this->service->addHeaders(['Authorization' => 'Bearer ' . $this->apiKey]);
    }

    /**
     * @param string $base
     * @param string $table
     *
     * @return string
     */
    public function listRecords(string $base, string $table): string
    {
        $params = '?maxRecords=' . $this->limit;
        return $this->service->get(sprintf('%s/%s/%s%s', $this->apiUrl(), $base, $table, $params));
    }

    /**
     * @param string $base      Airtable base id
     * @param string $table     Airtable table id
     * @param string $id        Table record id
     *
     * @return string
     */
    public function listRecord(string $base, string $table, string $id): string
    {
        return $this->service->get(sprintf('%s/%s/%s/%s', $this->apiUrl(), $base, $table, $id));
    }

    /**
     * @param string $base Airtable base id
     * @param string $table Airtable table id
     *
     * @param array<string> $fields Array containing data for the new record
     * @return string
     *
     * @throws \FondOf\Airtable\Exception\NoWriteDataException
     * @throws \FondOf\Airtable\Exception\MarshalFieldsException
     */
    public function createRecord(string $base, string $table, array $fields): string
    {
        if (empty($fields)) {
            throw new NoWriteDataException('Didn\'t receive data for write.');
        }

        $data = [
            'fields' => $fields
        ];

        $body = json_encode($data);

        if ($body === false) {
            throw new MarshalFieldsException('Couldn\'t encode fields.');
        }

        return $this->service->post(sprintf('%s/%s/%s', $this->apiUrl(), $base, $table), $body);
    }

    /**
     * @param int $limit    Max number of records to return
     */
    public function setLimit(int $limit): void
    {
        $this->limit = $limit;
    }

    /**
     * @return string
     */
    private function apiUrl(): string
    {
        return $this->apiUrl . '/' . $this->apiVersion;
    }
}