P2A\YourMembership\Core\Request

Complexity

Total Complexity

12

Size/Duplication

Total Lines	194
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	buildBasePayload()	0	18	1
A	createCallPayload()	0	13	2
A	buildXMLBody()	0	15	2
A	buildRequest()	0	5	1
A	isSessionRequiredForMethod()	0	5	1
A	sxmlAppend()	0	5	1
A	addSessionIdToRequest()	0	5	1
A	setSessionId()	0	4	1
A	hasSession()	0	4	1

<?php

namespace P2A\YourMembership\Core;

use GuzzleHttp\Psr7\Request as GuzzleRequest;


class Request
{

    /**
     * Base URL
     * @var string
     */
    const BASE_URL = 'https://api.yourmembership.com';
    const API_VERSION = '2.25';

    /**
     * Session ID use for YourMembership API
     * @var string
     */
    private static $sessionId = null;
    /**
     * Call Counter for Your Membership for a given session
     * @var integer
     */
    public static $callId = 0;
    /**
     * API Key Used for YourMembership API
     * @var string
     */
    private $apiKey;
    /**
     * Sa Passcode is a supplementary API key used for YourMembership API
     * @var string
     */
    private $saPasscode;


    public function __construct(string $apiKey, string $saPasscode)
    {
        $this->apiKey = $apiKey;
        $this->saPasscode = $saPasscode;
    }

    /**
     * Create the Base Envelope for an API call to YourMembership
     * @method buildBasePayload
     * @author PA
     * @date   2017-01-09
     * @return \SimpleXMLElement  XML Envelope with necessary credential parameters
     */
    public function buildBasePayload() : \SimpleXMLElement
    {
        /*
            <YourMembership>
            <Version>2.25</Version>
            <ApiKey>3D638C5F-CCE2-4638-A2C1-355FA7BBC917</ApiKey>
            <CallID>001</CallID>
            <SaPasscode>************</SaPasscode>
            </YourMembership>
        */
        $xml = new \SimpleXMLElement('<YourMembership></YourMembership>');
        $xml->addChild('Version', self::API_VERSION);
        $xml->addChild('ApiKey', $this->apiKey);
        $xml->addChild('CallID', self::$callId);
        $xml->addChild('SaPasscode', $this->saPasscode);

        return $xml;
    }

    /**
     * Generates the XML for a API method call within
     * @method createCallPayload
     * @author PA
     * @date   2017-01-09
     * @param  string            $method    YourMembership API Function Name
     * @param  array             $arguments Array of Arguments to be passed as part of the YourMembership "Call"
     * @return \SimpleXMLElement
     */
    public function createCallPayload(string $method, array $arguments) : \SimpleXMLElement
    {
        //Create Call Node
        $call = new \SimpleXMLElement('<Call> </Call>');
        $call->addAttribute('Method', $method);

        //Add Arguments to the Call Node
        foreach ($arguments as $key => $value) {
            $call->addChild($key, $value);
        }

        return $call;
    }

    /**
     * Builds The XML Request Body for the Your Membership API Call
     * @method buildXMLBody
     * @author PA
     * @date   2017-01-10
     * @param  string            $method    Your Membership API Function Name
     * @param  array             $arguments Your Membership Arguments
     * @return \SimpleXMLElement
     */
    public function buildXMLBody(string $method, array $arguments) : \SimpleXMLElement
    {
        $xml = $this->buildBasePayload(); // Common Envelope

        if ($this->isSessionRequiredForMethod($method)) {
            $xml = $this->addSessionIdToRequest($xml);
        }

        $callPayload = $this->createCallPayload($method, $arguments); // Specific API Call Envelope

        // Put Api call into common envelope
        $this->sxmlAppend($xml, $callPayload);

        return $xml;
    }
    /**
     * Builds a Guzzle Request Object
     * @method buildRequest
     * @author PA
     * @date   2017-01-11
     * @param  string        $method    YourMembership API Method
     * @param  array         $arguments YourMembership API Method Call Arguments
     * @return \GuzzleHttp\Psr7\Request            Guzzle Request Object
     */
    public function buildRequest(string $method, array $arguments) : \GuzzleHttp\Psr7\Request
    {
        $requestBody = $this->buildXMLBody($method, $arguments)->asXML();
        return new GuzzleRequest('POST', self::BASE_URL, ['Content-Type' => 'application/x-www-form-urlencoded; charset=UTF8'], $requestBody);

It seems like $requestBody defined by $this->buildXMLBody($method, $arguments)->asXML() on line 130 can also be of type false; however, GuzzleHttp\Psr7\Request::__construct() does only seem to accept string|null|resource|object<Psr\Http\Message\StreamInterface>, did you maybe forget to handle an error condition?

    }

    /**
     * Checks if Request Requires Session ID
     * @method isSessionRequiredForMethod
     * @author PA
     * @date   2017-01-10
     * @param  string                     $method YourMembership API Method
     * @return bool
     */
    public function isSessionRequiredForMethod(string $method) : bool
    {
        //TODO Add config Logic for what API Methods require Session ID
        return ($method != 'Session.Create');
    }

    /**
     * Helper for Deep Copy for of $from element into $to element for SimpleXML
     * @method sxmlAppend
     * @author PA
     * @date   2017-01-09
     * @param  \SimpleXMLElement $to
     * @param  \SimpleXMLElement $from
     * @return void
     */
    private function sxmlAppend(\SimpleXMLElement $to, \SimpleXMLElement $from) {
        $toDom = dom_import_simplexml($to);
        $fromDom = dom_import_simplexml($from);
        $toDom->appendChild($toDom->ownerDocument->importNode($fromDom, true));
    }

    /**
     * Adds the Session Variable to the given XML Request Payload
     * @method addSessionIdToRequest
     * @author PA
     * @date   2017-01-10
     * @param  \SimpleXMLElement                $requestXML Base Request XML Payload
     */
    private function addSessionIdToRequest(\SimpleXMLElement $requestXML) : \SimpleXMLElement
    {
        $requestXML->addChild('SessionID', self::$sessionId);
        return $requestXML;
    }


    /**
     * Setter Method for SessionID
     * @method setSessionId
     * @author PA
     * @date   2017-01-10
     * @param  string       $sessionId YourMembership Session ID
     */
    public static function setSessionId(string $sessionId)
    {
        self::$sessionId = $sessionId;
    }

    /**
     * Checks if we have an active session available
     * @method hasSession
     * @author PA
     * @date   2017-01-11
     * @return boolean
     */
    public function hasSession()
    {
        return !is_null(self::$sessionId);
    }

}