Fetcher::waitForExportRunToComplete() - Code Metrics - Inspection of "Task now allows multiple fetchers and mappers" - dynamic/silverstripe-salsify - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#13)

by Matthew

created 2019-07-19 20:56 UTC

Fetcher::waitForExportRunToComplete() A

↳ Parent: Fetcher

Complexity

Conditions	2
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	6
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	8
rs	10

<?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)) {

            $postBody = json_encode($postBody);

        }
        $ch = curl_init($url);
        curl_setopt_array($ch, $defaultCurlOptions);
        curl_setopt_array(/** @scrutinizer ignore-type */ $ch, $defaultCurlOptions);
        $response = curl_exec($ch);
        $response = curl_exec(/** @scrutinizer ignore-type */ $ch);
        $httpStatus = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        $httpStatus = curl_getinfo(/** @scrutinizer ignore-type */ $ch, CURLINFO_HTTP_CODE);
        curl_close($ch);
        curl_close(/** @scrutinizer ignore-type */ $ch);
        if ($response && !empty($response)) {
            $response = json_decode($response, true);
            $response = json_decode(/** @scrutinizer ignore-type */ $response, true);
        }
        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;
    }
}


dynamic / silverstripe-salsify

Pull Request — master (#13)

Fetcher::waitForExportRunToComplete() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like