MarioBlazek / easy-pdf-cloud

lib/RestApi.php

<?php
/*
 * The MIT License
 *
 * Copyright 2016 BCL Technologies.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace Bcl\EasyPdfCloud;

use InvalidArgumentException;
use function is_file;
use function basename;
use function file_get_contents;

class RestApi
{
    /**
     * @var RestApiImpl
     */
    private $impl;

    public function __construct($clientId, $clientSecret, IOAuth2TokenManager $tokenManager = null, UrlInfo $urlInfo = null)
    {
        $this->impl = new RestApiImpl($clientId, $clientSecret, $tokenManager, $urlInfo);
    }

    // GET: /workflows
    public function getWorkflowInfoList()
    {
        return $this->impl->getWorkflowInfoList(true);
    }

    // GET: /workflows/{id}
    public function getWorkflowInfo($workflowId)
    {
        $this->impl->validateWorkflowId($workflowId);

        return $this->impl->getWorkflowInfo($workflowId, true);
    }

    // PUT: /workflows/{id}/job
    public function createNewJobWithFilePath($workflowId, $filePath, $start, $test)
    {
        $this->impl->validateWorkflowId($workflowId);

        $this->validateFilePath($filePath);

        $fileName = basename($filePath);

        $fileContents = $this->getFileContents($filePath);

        return $this->impl->createNewJobWithFileContents($workflowId, $fileContents, $fileName, $start, $test, true);
    }

    // PUT: /workflows/{id}/job
    public function createNewJobWithFilePathAndName($workflowId, $filePath, $fileName, $start, $test)
    {
        $this->impl->validateWorkflowId($workflowId);

        $this->validateFilePath($filePath);
        $this->validateFileName($fileName);

        $fileContents = $this->getFileContents($filePath);

        return $this->impl->createNewJobWithFileContents($workflowId, $fileContents, $fileName, $start, $test, true);
    }

    // PUT: /workflows/{id}/job
    public function createNewJobWithFileContents($workflowId, $fileContents, $fileName, $start, $test)
    {
        $this->impl->validateWorkflowId($workflowId);

        $this->validateInputFile($fileContents);
        $this->validateFileName($fileName);

        return $this->impl->createNewJobWithFileContents($workflowId, $fileContents, $fileName, $start, $test, true);
    }

    // PUT: /jobs/{id}
    public function uploadInputWithFilePath($jobId, $filePath)
    {
        $this->impl->validateJobId($jobId);

        $this->validateFilePath($filePath);

        $fileName = basename($filePath);

        $fileContents = $this->getFileContents($filePath);

        return $this->impl->uploadInputWithFileContents($jobId, $fileContents, $fileName, true);

Are you sure the usage of $this->impl->uploadInputWithFileContents($jobId, $fileContents, $fileName, true) targeting Bcl\EasyPdfCloud\RestApiImpl::uploadInputWithFileContents() seems to always return null.

    }

    // PUT: /jobs/{id}
    public function uploadInputWithFilePathAndName($jobId, $filePath, $fileName)
    {
        $this->impl->validateJobId($jobId);

        $this->validateFilePath($filePath);
        $this->validateFileName($fileName);

        $fileContents = $this->getFileContents($filePath);

        return $this->impl->uploadInputWithFileContents($jobId, $fileContents, $fileName, true);

Are you sure the usage of $this->impl->uploadInputWithFileContents($jobId, $fileContents, $fileName, true) targeting Bcl\EasyPdfCloud\RestApiImpl::uploadInputWithFileContents() seems to always return null.

    }

    // PUT: /jobs/{id}/<filename>
    public function uploadInputWithFileContents($jobId, $fileContents, $fileName)
    {
        $this->impl->validateJobId($jobId);

        $this->validateInputFile($fileContents);
        $this->validateFileName($fileName);

        return $this->impl->uploadInputWithFileContents($jobId, $fileContents, $fileName, true);

Are you sure the usage of $this->impl->uploadInputWithFileContents($jobId, $fileContents, $fileName, true) targeting Bcl\EasyPdfCloud\RestApiImpl::uploadInputWithFileContents() seems to always return null.

    }

    // GET: /jobs/{id}/output?type=metadata
    public function getOutputInfo($jobId)
    {
        $this->impl->validateJobId($jobId);

        return $this->impl->getOutputInfoForFileName($jobId, null, true);
    }

    // GET: /jobs/{id}/output/<filename>?type=metadata
    public function getOutputInfoForFileName($jobId, $fileName)
    {
        $this->impl->validateJobId($jobId);

        $this->validateFileName($fileName);

        return $this->impl->getOutputInfoForFileName($jobId, $fileName, true);
    }

    // GET: /jobs/{id}/output?type=file
    public function downloadOutput($jobId)
    {
        $this->impl->validateJobId($jobId);

        return $this->impl->downloadOutputForFileName($jobId, null, true);
    }

    // GET: /jobs/{id}/output/<filename>?type=file
    public function downloadOutputForFileName($jobId, $fileName)
    {
        $this->impl->validateJobId($jobId);

        $this->validateFileName($fileName);

        return $this->impl->downloadOutputForFileName($jobId, $fileName, true);
    }

    // GET: /jobs/{id}
    public function getJobInfo($jobId)
    {
        $this->impl->validateJobId($jobId);

        return $this->impl->getJobInfo($jobId, true);
    }

    // POST: /jobs/{id}?operation=start
    public function startJob($jobId)
    {
        $this->impl->validateJobId($jobId);

        $this->impl->startOrStopJob($jobId, true, true);
    }

    // POST: /jobs/{id}?operation=stop
    public function stopJob($jobId)
    {
        $this->impl->validateJobId($jobId);

        $this->impl->startOrStopJob($jobId, false, true);
    }

    // POST: /jobs/{id}?operation=stop
    public function deleteJob($jobId)
    {
        $this->impl->validateJobId($jobId);

        $this->impl->deleteJob($jobId, true);
    }

    // POST: /jobs/{id}/event
    public function waitForJobEvent($jobId)
    {
        $this->impl->validateJobId($jobId);

        return $this->impl->waitForJobEvent($jobId, true);
    }

    protected function validateFilePath($filePath)
    {
        if (StringUtils::isEmpty($filePath)) {
            throw new InvalidArgumentException('Input file is not specified');
        }

        if (false === is_file($filePath)) {
            throw new InvalidArgumentException('Input file does not exist');
        }
    }

    protected function validateFileName($fileName)
    {
        if (StringUtils::isEmpty($fileName)) {
            throw new InvalidArgumentException('File name is not specified');
        }
    }

    protected function getFileContents($filePath)
    {
        $fileContents = file_get_contents($filePath);
        if (false === $fileContents) {
            throw new InvalidArgumentException('Unable to open input file');
        }

        return $fileContents;
    }

    protected function validateInputFile($fileContents)
    {
        if (null === $fileContents || false === $fileContents) {
            throw new InvalidArgumentException('Input file is not specified');
        }
    }
}