igorsgm / laravel-ghost

src/Apis/BaseApi.php

<?php

namespace Igorsgm\Ghost\Apis;

use Igorsgm\Ghost\Models\Resources\BaseResource;
use Igorsgm\Ghost\Responses\ErrorResponse;
use Igorsgm\Ghost\Responses\SuccessResponse;
use Illuminate\Support\Collection;

abstract class BaseApi
{
    /**
     * @var string
     */
    protected $baseUrl;

    /**
     * @var BaseResource
     */
    protected $resource;

    public string $resourceId = '';

    public string $resourceSlug = '';

    public string $include = '';

    public string $fields = '';

    public string $formats = '';

    /**
     * @var string
     */
    protected $source = '';

    public string $limit = '';

    public string $filter = '';

    public string $page = '';

    public string $order = '';

    protected string $key;

    protected string $domain;

    protected string $version;

    protected function buildEndpoint(): string
    {
        $endpoint = $this->resource->getResourceName();

        if (! empty($this->resourceId)) {
            $endpoint .= "/$this->resourceId";
        } elseif (! empty($this->resourceSlug)) {
            $endpoint .= "/slug/$this->resourceSlug";
        }

        return $endpoint;
    }

    /**
     * @param  string  $suffix
     */
    protected function makeApiUrl($suffix = ''): string
    {
        return sprintf('%s/%s/?%s', $this->baseUrl, $this->buildEndpoint().$suffix, $this->buildParams());
    }

    protected function buildParams(): string
    {
        $params = ['include', 'fields', 'formats', 'source', 'filter', 'limit', 'page', 'order', 'key'];

        $queryParams = [];
        foreach ($params as $param) {
            $queryParams[$param] = $this->{$param} ?: null;
        }

        return http_build_query($queryParams);
    }

    /**
     * @return ErrorResponse|SuccessResponse
     */
    protected function handleResponse($response)
    {
        if ($response->failed()) {
            return new ErrorResponse($response);
        }

        return new SuccessResponse($this, $this->resource, $response);
    }

    /**
     * Return resource from slug
     *
     *
     * @return array|ErrorResponse|mixed
     */
    public function fromSlug(string $slug)
    {
        $this->resourceSlug = $slug;
        $response = $this->get();

The method get() does not exist on Igorsgm\Ghost\Apis\BaseApi. Since it exists in all sub-types, consider adding an abstract or default implementation to Igorsgm\Ghost\Apis\BaseApi.

        if ($response instanceof ErrorResponse) {
            return $response;
        }

        return data_get($response->data, 0, []);
    }

    /**
     * @return Collection|array[]
     */
    public function all()
    {
        return $this->limit('all')->get();
    }

    /**
     * @return BaseResource|ErrorResponse
     */
    public function first()
    {
        $response = $this->limit(1)->get();

        return $response->data->first();
    }

    /**
     * @return array
     */
    public function paginate($limit = null)
    {
        if (isset($limit)) {
            $this->limit = $limit;
        }

        return $this->get();
    }

    /**
     * Return resource from ID
     *
     *
     * @return BaseResource|ErrorResponse
     */
    public function find(string $id)
    {
        $this->resourceId = $id;
        $response = $this->get();

        if ($response instanceof ErrorResponse) {
            return $response;
        }

        return data_get($response->data, 0, []);
    }

    /**
     * Apply fine-grained filters to target specific data.
     *
     * @param  string  $filter
     * @return $this
     *
     * @see https://ghost.org/docs/content-api/#filtering
     * @see https://gist.github.com/ErisDS/f516a859355d515aa6ad
     */
    public function filter($filter): BaseApi
    {
        $this->filter = $filter;

        return $this;
    }

    /**
     * Limit how many records are returned at once
     *
     * @param  int|string  $limit
     * @return $this
     *
     * @see https://ghost.org/docs/content-api/#limit
     */
    public function limit($limit): BaseApi
    {
        $this->limit = strval($limit);

        return $this;
    }

    /**
     * @return $this
     */
    public function setResource(string $resourceClass): BaseApi
    {
        $this->resource = resolve($resourceClass);

It seems like resolve($resourceClass) can also be of type Illuminate\Contracts\Foundation\Application. However, the property $resource is declared as type Igorsgm\Ghost\Models\Resources\BaseResource. Maybe add an additional type check?

        return $this;
    }

    /**
     * @return BaseResource
     */
    public function getResource()
    {
        return $this->resource;
    }

    /**
     * Alias for Ghost's include.
     *
     * The following includes are available:
     * Posts & Pages: authors, tags
     * Authors: count.posts
     * Tags: count.posts
     * Tiers: monthly_price, yearly_price, benefits
     *
     * @param  string|array  ...$includes
     * @return $this
     *
     * @see https://ghost.org/docs/content-api/#include
     */
    public function include(...$includes): BaseApi
    {
        $this->include = collect($includes)->flatten()->implode(',');

        return $this;
    }

    /**
     * Alias for include method
     *
     * @return $this
     */
    public function with(...$includes): BaseApi
    {
        return $this->include(...$includes);
    }

    /**
     * Limit the fields returned to the response object
     *
     * @param  string|array  ...$fields
     * @return $this
     *
     * @see https://ghost.org/docs/content-api/#fields
     */
    public function fields(...$fields): BaseApi
    {
        $this->fields = collect($fields)->flatten()->implode(',');

        return $this;
    }

    /**
     * Optionally request different format for posts and pages
     * By default, Admin API expects and returns content in the mobiledoc format only.
     * To include html in the response use this parameter.
     *
     * Possible formats: html, plaintext, mobiledoc.
     *
     *
     * @return $this
     *
     * @see https://ghost.org/docs/content-api/#formats
     */
    public function formats(string $format): BaseApi
    {
        $this->formats = $format;

        return $this;
    }

    /**
     * @return $this
     *
     * @see https://ghost.org/docs/content-api/#page
     */
    public function page(int $page): BaseApi
    {
        $this->page = strval($page);

        return $this;
    }

    /**
     * @return $this
     *
     * @see https://ghost.org/docs/content-api/#order
     */
    public function order(string $attr, string $order = 'DESC'): BaseApi
    {
        $this->order = $attr.' '.strtolower($order);

        return $this;
    }

    /**
     * Alias for order method
     *
     * @return $this
     */
    public function orderBy(string $attr, string $order = 'DESC'): BaseApi
    {
        return $this->order($attr, $order);
    }
}