Dynamic\Salsify\Model\Fetcher

Complexity

Total Complexity

22

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	salsifyRequest()	0	25	5
A	createChannelRunUrl()	0	3	1
A	__construct()	0	10	3
A	channelUrl()	0	3	1
A	getExportUrl()	0	3	1
A	channelRunsBaseUrl()	0	3	1
A	startExportRun()	0	7	2
A	channelRunUrl()	0	6	2
A	checkExportUrl()	0	9	3
A	waitForExportRunToComplete()	0	8	2
A	apiUrlSuffix()	0	3	1

<?php

namespace Dynamic\Salsify\Model;

use Exception;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Injector\Injectable;

/**
 * Class Importer
 * @package Dynamic\Salsify\Model
 *
 * Based off https://github.com/XinV/salsify-php-api/blob/master/lib/Salsify/API.php
 *
 * @mixin Configurable
 * @mixin Extensible
 * @mixin Injectable
 */
class Fetcher extends Service
{
    /**
     * @var string
     */
    const API_BASE_URL = 'https://app.salsify.com/api/';

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

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

    /**
     * Importer constructor.
     * @param string $importerKey
     * @throws \Exception
     */
    public function __construct($importerKey)
    {
        parent::__construct($importerKey);

        if (!$this->config()->get('apiKey')) {
            throw new Exception('An API key needs to be provided');
        }

        if (!$this->config()->get('channel')) {
            throw new Exception('A fetcher needs a channel');
        }
    }

    /**
     * @return string
     */
    private function channelUrl()
    {
        return self::API_BASE_URL . 'channels/' . $this->config()->get('channel');
    }

    /**
     * @return string
     */
    private function channelRunsBaseUrl()
    {
        return $this->channelUrl() . '/runs';
    }

    /**
     * @return string
     */
    private function createChannelRunUrl()
    {
        return $this->channelRunsBaseUrl();
    }

    /**
     * @return string
     */
    private function channelRunUrl()
    {
        if ($this->config()->get('useLatest')) {
            return $this->channelRunsBaseUrl() . '/latest';
        }
        return $this->channelRunsBaseUrl() . '/' . $this->channelRunID;
    }

    /**
     * @return string
     * @throws \Exception
     */
    private function apiUrlSuffix()
    {
        return '?format=json&auth_token=' . $this->config()->get('apiKey');
    }

    /**
     * @param string $url
     * @param string $method
     * @param string|null $postBody
     * @return array|string
     *
     * @throws \Exception
     */
    private function salsifyRequest($url, $method = 'GET', $postBody = null)
    {
        $defaultCurlOptions = array(
            CURLOPT_URL => $url . $this->apiUrlSuffix(),
            CURLOPT_CUSTOMREQUEST => $method,
            CURLOPT_HEADER => false,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_HTTPHEADER => array('Content-Type: application/json'),
            // seemed reasonable settings
            CURLOPT_TIMEOUT => $this->config()->get('timeout'),
            CURLOPT_FRESH_CONNECT => true,
            CURLOPT_FORBID_REUSE => true,
        );
        if ($method === 'POST' && is_array($postBody)) {

The condition is_array($postBody) is always false.

            $postBody = json_encode($postBody);

The assignment to $postBody is dead and can be removed.

        }
        $ch = curl_init($url);
        curl_setopt_array($ch, $defaultCurlOptions);

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt_array() does only seem to accept resource, maybe add an additional type check?

        $response = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

        $httpStatus = curl_getinfo($ch, CURLINFO_HTTP_CODE);

It seems like $ch can also be of type false; however, parameter $ch of curl_getinfo() does only seem to accept resource, maybe add an additional type check?

The assignment to $httpStatus is dead and can be removed.

        curl_close($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_close() does only seem to accept resource, maybe add an additional type check?

        if ($response && !empty($response)) {
            $response = json_decode($response, true);

It seems like $response can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

        }
        return $response;
    }

    /**
     * @return $this
     * @throws \Exception
     */
    public function startExportRun()
    {
        if (!$this->config()->get('useLatest')) {
            $response = $this->salsifyRequest($this->createChannelRunUrl(), 'POST');
            $this->channelRunID = $response['id'];
        }
        return $this;
    }

    /**
     * @throws Exception
     */
    private function checkExportUrl()
    {
        $exportRun = $this->salsifyRequest($this->channelRunUrl());
        $status = $exportRun['status'];
        if ($status === 'completed') {
            $this->channelRunDataUrl = $exportRun['product_export_url'];
        } elseif ($status === 'failed') {
            // this would be an internal error in Salsify
            throw new Exception('Salsify failed to produce an export.');
        }
    }

    /**
     * waits until salsify is done preparing the given export, and returns the URL when done.
     * Throws an exception if anything funky occurs.
     *
     * @return $this
     * @throws Exception
     */
    public function waitForExportRunToComplete()
    {
        $this->channelRunDataUrl = null;
        do {
            $this->checkExportUrl();
            sleep(5);
        } while (!$this->channelRunDataUrl);
        return $this;
    }

    /**
     * @return string
     */
    public function getExportUrl()
    {
        return $this->channelRunDataUrl;
    }
}