Request::hasSession() - Code Metrics - Inspection of "Add tests" - phone2action/ym-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev-master ( 4da17d...6bccf2 )

by Petr

created 2017-01-11 18:04 UTC

Request::hasSession() A

↳ Parent: Request

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	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);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
    }

    /**
     * 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);
    }

};


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2017-01-09 22:18 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 8 and the first side effect is on line 200. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3		namespace P2A\YourMembership\Core;
4
5		use GuzzleHttp\Psr7\Request as GuzzleRequest;
6
7
8		class Request
9		{
10
11		/**
12		* Base URL
13		* @var string
14		*/
15		const BASE_URL = 'https://api.yourmembership.com';
16		const API_VERSION = '2.25';
17
18		/**
19		* Session ID use for YourMembership API
20		* @var string
21		*/
22		private static $sessionId = null;
23		/**
24		* Call Counter for Your Membership for a given session
25		* @var integer
26		*/
27		public static $callId = 0;
28		/**
29		* API Key Used for YourMembership API
30		* @var string
31		*/
32		private $apiKey;
33		/**
34		* Sa Passcode is a supplementary API key used for YourMembership API
35		* @var string
36		*/
37		private $saPasscode;
38
39
40	4	public function __construct(string $apiKey, string $saPasscode)
41		{
42	4	$this->apiKey = $apiKey;
43	4	$this->saPasscode = $saPasscode;
44	4	}
45
46		/**
47		* Create the Base Envelope for an API call to YourMembership
48		* @method buildBasePayload
49		* @author PA
50		* @date 2017-01-09
51		* @return SimpleXMLElement XML Envelope with necessary credential parameters
52		*/
53	3	public function buildBasePayload() : \SimpleXMLElement
54		{
55		/*
56		<YourMembership>
57		<Version>2.25</Version>
58		<ApiKey>3D638C5F-CCE2-4638-A2C1-355FA7BBC917</ApiKey>
59		<CallID>001</CallID>
60		<SaPasscode>************</SaPasscode>
61		</YourMembership>
62		*/
63	3	$xml = new \SimpleXMLElement('<YourMembership></YourMembership>');
64	3	$xml->addChild('Version', self::API_VERSION);
65	3	$xml->addChild('ApiKey', $this->apiKey);
66	3	$xml->addChild('CallID', self::$callId);
67	3	$xml->addChild('SaPasscode', $this->saPasscode);
68
69	3	return $xml;
70		}
71
72		/**
73		* Generates the XML for a API method call within
74		* @method createCallPayload
75		* @author PA
76		* @date 2017-01-09
77		* @param string $method YourMembership API Function Name
78		* @param array $arguments Array of Arguments to be passed as part of the YourMembership "Call"
79		* @return \SimpleXMLElement
80		*/
81	3	public function createCallPayload(string $method, array $arguments) : \SimpleXMLElement
82		{
83		//Create Call Node
84	3	$call = new \SimpleXMLElement('<Call> </Call>');
85	3	$call->addAttribute('Method',$method);
86
87		//Add Arguments to the Call Node
88	3	foreach ($arguments as $key => $value) {
89	3	$call->addChild($key,$value);
90		}
91
92	3	return $call;
93		}
94
95		/**
96		* Builds The XML Request Body for the Your Membership API Call
97		* @method buildXMLBody
98		* @author PA
99		* @date 2017-01-10
100		* @param string $method Your Membership API Function Name
101		* @param array $arguments Your Membership Arguments
102		* @return SimpleXMLElement
103		*/
104	2	public function buildXMLBody(string $method, array $arguments) : \SimpleXMLElement
105		{
106	2	$xml = $this->buildBasePayload(); // Common Envelope
107
108	2	if ($this->isSessionRequiredForMethod($method)) {
109	2	$xml = $this->addSessionIdToRequest($xml);
110		}
111
112	2	$callPayload = $this->createCallPayload($method, $arguments); // Specific API Call Envelope
113
114		// Put Api call into common envelope
115	2	$this->sxmlAppend($xml,$callPayload);
116
117	2	return $xml;
118		}
119		/**
120		* Builds a Guzzle Request Object
121		* @method buildRequest
122		* @author PA
123		* @date 2017-01-11
124		* @param string $method YourMembership API Method
125		* @param array $arguments YourMembership API Method Call Arguments
126		* @return \GuzzleHttp\Psr7\Request Guzzle Request Object
127		*/
128	1	public function buildRequest(string $method, array $arguments) : \GuzzleHttp\Psr7\Request
129		{
130	1	$requestBody = $this->buildXMLBody($method, $arguments)->asXML();
131	1	return new GuzzleRequest('POST', self::BASE_URL, ['Content-Type' => 'application/x-www-form-urlencoded; charset=UTF8'], $requestBody);
		1 ignored issue – show Security Bug introduced 2017-01-10 22:05 UTC by Report Bug Copy Issue Report 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\|obj...essage\StreamInterface>`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
132		}
133
134		/**
135		* Checks if Request Requires Session ID
136		* @method isSessionRequiredForMethod
137		* @author PA
138		* @date 2017-01-10
139		* @param string $method YourMembership API Method
140		* @return bool
141		*/
142	2	public function isSessionRequiredForMethod(string $method) : bool
143		{
144		//TODO Add config Logic for what API Methods require Session ID
145	2	return ($method != 'Session.Create');
146		}
147
148		/**
149		* Helper for Deep Copy for of $from element into $to element for SimpleXML
150		* @method sxmlAppend
151		* @author PA
152		* @date 2017-01-09
153		* @param SimpleXMLElement $to
154		* @param SimpleXMLElement $from
155		* @return void
156		*/
157	2	private function sxmlAppend(\SimpleXMLElement $to, \SimpleXMLElement $from) {
158	2	$toDom = dom_import_simplexml($to);
159	2	$fromDom = dom_import_simplexml($from);
160	2	$toDom->appendChild($toDom->ownerDocument->importNode($fromDom, true));
161	2	}
162
163		/**
164		* Adds the Session Variable to the given XML Request Payload
165		* @method addSessionIdToRequest
166		* @author PA
167		* @date 2017-01-10
168		* @param \SimpleXMLElement $requestXML Base Request XML Payload
169		*/
170	2	private function addSessionIdToRequest(\SimpleXMLElement $requestXML) : \SimpleXMLElement
171		{
172	2	$requestXML->addChild('SessionID', self::$sessionId);
173	2	return $requestXML;
174		}
175
176
177		/**
178		* Setter Method for SessionID
179		* @method setSessionId
180		* @author PA
181		* @date 2017-01-10
182		* @param string $sessionId YourMembership Session ID
183		*/
184	1	public static function setSessionId(string $sessionId)
185		{
186	1	self::$sessionId = $sessionId;
187	1	}
188
189		/**
190		* Checks if we have an active session available
191		* @method hasSession
192		* @author PA
193		* @date 2017-01-11
194		* @return boolean
195		*/
196	1	public function hasSession() {
197	1	return !is_null(self::$sessionId);
198		}
199
200		};
201

phone2action / ym-api

Push — dev-master ( 4da17d...6bccf2 )

Request::hasSession() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like