ebanx-integration/ebanx-php

<?php
/**
 * Copyright (c) 2013, EBANX Tecnologia da Informação Ltda.
 *  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of EBANX nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace Ebanx\Http;

use Ebanx\Config;

/**
 * Abstract class for HTTP clients.
 *
 * @author Guilherme Pressutto guilherme.pressutto@ebanx.com
 */
abstract class AbstractClient
{
    /**
     * The HTTP action (URI)
     * @var string
     */
    protected $action;

    /**
     * The allowed HTTP methods
     * @var array
     */
    protected $allowedMethods = array('POST', 'GET');

    /**
     * Flag to call json_decode on response
     * @var boolean
     */
    protected $hasToDecodeResponse = false;

    /**
     * The ignored status codes
     * @var array
     */
    protected $ignoredStatusCodes = array();

    /**
     * The request HTTP method
     * @var string
     */
    protected $method;

    /**
     * The request parameters
     * @var array
     */
    protected $requestParams;


    /**
     * Sends the HTTP request
     * @return StdClass
     */
    abstract public function send();

    /**
     * Set the request target URI
     * @param string $action The target URI
     * @return Ebanx\Http\AbstractClient A "Ebanx\Http\AbstractClient" subclass object
     */
    public function setAction($action)
    {
        $this->action = Config::getURL() . $action;
        return $this;
    }

    /**
     * Set the ignored status codes
     * @param array $ignoredStatusCodes The ignored status codes
     * @return Ebanx\Http\AbstractClient A "Ebanx\Http\AbstractClient" subclass object
     */
    public function setIgnoredStatusCodes($ignoredStatusCodes)
    {
        $this->ignoredStatusCodes = $ignoredStatusCodes;
        return $this;
    }

    /**
     * Set the request HTTP method
     * @param string $method The request HTTP method
     * @return Ebanx\Http\AbstractClient A "Ebanx\Http\AbstractClient" subclass object
     * @throws InvalidArgumentException
     */
    public function setMethod($method)
    {
        if(!in_array(strtoupper($method), $this->allowedMethods)) {
          throw new \InvalidArgumentException("The HTTP Client doesn't accept $method requests.");
        }

        $this->method = $method;
        return $this;
    }

    /**
     * Set the request parameters
     * @param array $params The request parameters
     * @return Ebanx\Http\AbstractClient A "Ebanx\Http\AbstractClient" subclass object
     */
    public function setRequestParams($requestParams)
    {
        $this->requestParams = $requestParams;
        $this->requestParams['integration_key'] = Config::getIntegrationKey();
        return $this;
    }

    /**
     * Set the decodeResponse flag depending on the response type (JSON or HTML)
     * @param string $responseType The response type (JSON or HTML)
     * @return Ebanx\Http\AbstractClient A "Ebanx\Http\AbstractClient" subclass object
     */
    public function setResponseType($responseType)
    {
        $this->hasToDecodeResponse = strtoupper($responseType) == 'JSON';
        return $this;
    }

    /**
     * Set a custom source/version to be sent
     * @param string $source The string containing source/version
     */
    public function setSource($source)
    {
        $this->addUserAgentInfo($source);
        return $this;
    }
}