TimeInTransit::getResponse() - Code Metrics - Inspection of "Update CHANGELOG.md" - gabrielbull/php-ups-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 3a2bd9...89cb66 )

by Gabriel

created 2016-03-15 14:18 UTC

TimeInTransit::getResponse() A

↳ Parent: TimeInTransit

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

namespace Ups;

use DOMDocument;
use Exception;
use Psr\Log\LoggerInterface;
use SimpleXMLElement;
use Ups\Entity\TimeInTransitRequest;
use Ups\Entity\TimeInTransitResponse;

/**
 * TimeInTransit API Wrapper.
 *
 * @author Sebastien Vergnes <[email protected]>
 */
class TimeInTransit extends Ups
{
    private $request;

    const ENDPOINT = '/TimeInTransit';

    /**
     * @param string|null $accessKey UPS License Access Key
     * @param string|null $userId UPS User ID
     * @param string|null $password UPS User Password
     * @param bool $useIntegration Determine if we should use production or CIE URLs.
     * @param RequestInterface|null $request
     * @param LoggerInterface|null $logger PSR3 compatible logger (optional)
     */
    public function __construct($accessKey = null, $userId = null, $password = null, $useIntegration = false, RequestInterface $request = null, LoggerInterface $logger = null)

    {
        if (null !== $request) {
            $this->setRequest($request);
        }
        parent::__construct($accessKey, $userId, $password, $useIntegration, $logger);
    }

    /**
     * @param TimeInTransitRequest $shipment
     *
     * @throws Exception
     *
     * @return TimeInTransitRequest
     */
    public function getTimeInTransit(TimeInTransitRequest $shipment)
    {
        return $this->sendRequest($shipment);
    }

    /**
     * Creates and sends a request for the given shipment. This handles checking for
     * errors in the response back from UPS.
     *
     * @param TimeInTransitRequest $timeInTransitRequest
     *
     * @throws Exception
     *
     * @return TimeInTransitRequest
     */
    private function sendRequest(TimeInTransitRequest $timeInTransitRequest)

    {
        $request = $this->createRequest($timeInTransitRequest);
        $this->response = $this->getRequest()->request($this->createAccess(), $request, $this->compileEndpointUrl(self::ENDPOINT));

        $response = $this->response->getResponse();


        if (null === $response) {
            throw new Exception('Failure (0): Unknown error', 0);
        }

        if ($response instanceof SimpleXMLElement && $response->Response->ResponseStatusCode == 0) {
            throw new Exception(
                "Failure ({$response->Response->Error->ErrorSeverity}): {$response->Response->Error->ErrorDescription}",
                (int)$response->Response->Error->ErrorCode
            );
        } else {
            return $this->formatResponse($response);
        }
    }

    /**
     * Create the TimeInTransit request.
     *
     * @param TimeInTransitRequest $timeInTransitRequest The request details. Refer to the UPS documentation for available structure
     *
     * @return string
     */
    private function createRequest(TimeInTransitRequest $timeInTransitRequest)
    {
        $xml = new DOMDocument();
        $xml->formatOutput = true;

        $trackRequest = $xml->appendChild($xml->createElement('TimeInTransitRequest'));
        $trackRequest->setAttribute('xml:lang', 'en-US');

        $request = $trackRequest->appendChild($xml->createElement('Request'));

        $node = $xml->importNode($this->createTransactionNode(), true);
        $request->appendChild($node);

        $request->appendChild($xml->createElement('RequestAction', 'TimeInTransit'));

        $transitFromNode = $trackRequest->appendChild($xml->createElement('TransitFrom'));
        $address = $timeInTransitRequest->getTransitFrom();
        if (isset($address)) {
            $transitFromNode->appendChild($address->toNode($xml));
        }

        $transitToNode = $trackRequest->appendChild($xml->createElement('TransitTo'));
        $address = $timeInTransitRequest->getTransitTo();
        if (isset($address)) {
            $transitToNode->appendChild($address->toNode($xml));
        }

        $weight = $timeInTransitRequest->getShipmentWeight();
        if (isset($weight)) {
            $trackRequest->appendChild($weight->toNode($xml));
        }

        $packages = $timeInTransitRequest->getTotalPackagesInShipment();
        if (isset($packages)) {
            $trackRequest->appendChild($xml->createElement('TotalPackagesInShipment', $packages));
        }

        $invoiceLineTotal = $timeInTransitRequest->getInvoiceLineTotal();
        if (isset($invoiceLineTotal)) {
            $trackRequest->appendChild($invoiceLineTotal->toNode($xml));
        }

        $pickupDate = $timeInTransitRequest->getPickupDate();
        if ($pickupDate) {
            $trackRequest->appendChild($xml->createElement('PickupDate', $pickupDate->format('Ymd')));
        }

        $indicator = $timeInTransitRequest->getDocumentsOnlyIndicator();
        if ($indicator) {
            $trackRequest->appendChild($xml->createElement('DocumentsOnlyIndicator'));
        }

        return $xml->saveXML();
    }

    /**
     * Format the response.
     *
     * @param SimpleXMLElement $response
     *
     * @return TimeInTransitRequest
     */
    private function formatResponse(SimpleXMLElement $response)
    {
        // We don't need to return data regarding the response to the user
        unset($response->Response);

        $result = $this->convertXmlObject($response);

        // Fix for when one ServiceSummary while expecting an array in later responses - easiest place to fix here
        if (isset($result->TransitResponse->ServiceSummary->Service)) {
            $result->TransitResponse->ServiceSummary = array($result->TransitResponse->ServiceSummary);
        }

        return new TimeInTransitResponse($result->TransitResponse);
    }

    /**
     * @return RequestInterface
     */
    public function getRequest()

    {
        if (null === $this->request) {
            $this->request = new Request($this->logger);
        }

        return $this->request;
    }

    /**
     * @param RequestInterface $request
     *
     * @return $this
     */
    public function setRequest(RequestInterface $request)
    {
        $this->request = $request;

        return $this;
    }

    /**
     * @return ResponseInterface
     */
    public function getResponse()
    {
        return $this->response;

    }

    /**
     * @param ResponseInterface $response
     *
     * @return $this
     */
    public function setResponse(ResponseInterface $response)
    {
        $this->response = $response;


        return $this;
    }
}


1			<?php
2
3			namespace Ups;
4
5			use DOMDocument;
6			use Exception;
7			use Psr\Log\LoggerInterface;
8			use SimpleXMLElement;
9			use Ups\Entity\TimeInTransitRequest;
10			use Ups\Entity\TimeInTransitResponse;
11
12			/**
13			* TimeInTransit API Wrapper.
14			*
15			* @author Sebastien Vergnes <[email protected]>
16			*/
17			class TimeInTransit extends Ups
18			{
19			private $request;
20
21			const ENDPOINT = '/TimeInTransit';
22
23			/**
24			* @param string\|null $accessKey UPS License Access Key
25			* @param string\|null $userId UPS User ID
26			* @param string\|null $password UPS User Password
27			* @param bool $useIntegration Determine if we should use production or CIE URLs.
28			* @param RequestInterface\|null $request
29			* @param LoggerInterface\|null $logger PSR3 compatible logger (optional)
30			*/
31	4	View Code Duplication	public function __construct($accessKey = null, $userId = null, $password = null, $useIntegration = false, RequestInterface $request = null, LoggerInterface $logger = null)
			0 ignored issues – show Duplication introduced 2015-11-23 16:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
32			{
33	4		if (null !== $request) {
34			$this->setRequest($request);
35			}
36	4		parent::__construct($accessKey, $userId, $password, $useIntegration, $logger);
37	4		}
38
39			/**
40			* @param TimeInTransitRequest $shipment
41			*
42			* @throws Exception
43			*
44			* @return TimeInTransitRequest
45			*/
46	4		public function getTimeInTransit(TimeInTransitRequest $shipment)
47			{
48	4		return $this->sendRequest($shipment);
49			}
50
51			/**
52			* Creates and sends a request for the given shipment. This handles checking for
53			* errors in the response back from UPS.
54			*
55			* @param TimeInTransitRequest $timeInTransitRequest
56			*
57			* @throws Exception
58			*
59			* @return TimeInTransitRequest
60			*/
61	4	View Code Duplication	private function sendRequest(TimeInTransitRequest $timeInTransitRequest)
			0 ignored issues – show Duplication introduced 2016-02-17 14:59 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
62			{
63	4		$request = $this->createRequest($timeInTransitRequest);
64	4		$this->response = $this->getRequest()->request($this->createAccess(), $request, $this->compileEndpointUrl(self::ENDPOINT));
			0 ignored issues – show Deprecated Code introduced 2015-11-23 16:39 UTC by Report Bug Copy Issue Report The property `Ups\Ups::$response` has been deprecated. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
65	4		$response = $this->response->getResponse();
			0 ignored issues – show Deprecated Code introduced 2015-11-23 16:39 UTC by Report Bug Copy Issue Report The property `Ups\Ups::$response` has been deprecated. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
66
67	4		if (null === $response) {
68	1		throw new Exception('Failure (0): Unknown error', 0);
69			}
70
71	3		if ($response instanceof SimpleXMLElement && $response->Response->ResponseStatusCode == 0) {
72			throw new Exception(
73			"Failure ({$response->Response->Error->ErrorSeverity}): {$response->Response->Error->ErrorDescription}",
74			(int)$response->Response->Error->ErrorCode
75			);
76			} else {
77	3		return $this->formatResponse($response);
78			}
79			}
80
81			/**
82			* Create the TimeInTransit request.
83			*
84			* @param TimeInTransitRequest $timeInTransitRequest The request details. Refer to the UPS documentation for available structure
85			*
86			* @return string
87			*/
88	4		private function createRequest(TimeInTransitRequest $timeInTransitRequest)
89			{
90	4		$xml = new DOMDocument();
91	4		$xml->formatOutput = true;
92
93	4		$trackRequest = $xml->appendChild($xml->createElement('TimeInTransitRequest'));
94	4		$trackRequest->setAttribute('xml:lang', 'en-US');
95
96	4		$request = $trackRequest->appendChild($xml->createElement('Request'));
97
98	4		$node = $xml->importNode($this->createTransactionNode(), true);
99	4		$request->appendChild($node);
100
101	4		$request->appendChild($xml->createElement('RequestAction', 'TimeInTransit'));
102
103	4		$transitFromNode = $trackRequest->appendChild($xml->createElement('TransitFrom'));
104	4		$address = $timeInTransitRequest->getTransitFrom();
105	4		if (isset($address)) {
106	4		$transitFromNode->appendChild($address->toNode($xml));
107	4		}
108
109	4		$transitToNode = $trackRequest->appendChild($xml->createElement('TransitTo'));
110	4		$address = $timeInTransitRequest->getTransitTo();
111	4		if (isset($address)) {
112	4		$transitToNode->appendChild($address->toNode($xml));
113	4		}
114
115	4		$weight = $timeInTransitRequest->getShipmentWeight();
116	4		if (isset($weight)) {
117	4		$trackRequest->appendChild($weight->toNode($xml));
118	4		}
119
120	4		$packages = $timeInTransitRequest->getTotalPackagesInShipment();
121	4		if (isset($packages)) {
122	1		$trackRequest->appendChild($xml->createElement('TotalPackagesInShipment', $packages));
123	1		}
124
125	4		$invoiceLineTotal = $timeInTransitRequest->getInvoiceLineTotal();
126	4		if (isset($invoiceLineTotal)) {
127	4		$trackRequest->appendChild($invoiceLineTotal->toNode($xml));
128	4		}
129
130	4		$pickupDate = $timeInTransitRequest->getPickupDate();
131	4		if ($pickupDate) {
132	4		$trackRequest->appendChild($xml->createElement('PickupDate', $pickupDate->format('Ymd')));
133	4		}
134
135	4		$indicator = $timeInTransitRequest->getDocumentsOnlyIndicator();
136	4		if ($indicator) {
137	1		$trackRequest->appendChild($xml->createElement('DocumentsOnlyIndicator'));
138	1		}
139
140	4		return $xml->saveXML();
141			}
142
143			/**
144			* Format the response.
145			*
146			* @param SimpleXMLElement $response
147			*
148			* @return TimeInTransitRequest
149			*/
150	3		private function formatResponse(SimpleXMLElement $response)
151			{
152			// We don't need to return data regarding the response to the user
153	3		unset($response->Response);
154
155	3		$result = $this->convertXmlObject($response);
156
157			// Fix for when one ServiceSummary while expecting an array in later responses - easiest place to fix here
158	3		if (isset($result->TransitResponse->ServiceSummary->Service)) {
159			$result->TransitResponse->ServiceSummary = array($result->TransitResponse->ServiceSummary);
160			}
161
162	3		return new TimeInTransitResponse($result->TransitResponse);
163			}
164
165			/**
166			* @return RequestInterface
167			*/
168	4	View Code Duplication	public function getRequest()
			0 ignored issues – show Duplication introduced 2015-11-23 16:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
169			{
170	4		if (null === $this->request) {
171			$this->request = new Request($this->logger);
172			}
173
174	4		return $this->request;
175			}
176
177			/**
178			* @param RequestInterface $request
179			*
180			* @return $this
181			*/
182	4		public function setRequest(RequestInterface $request)
183			{
184	4		$this->request = $request;
185
186	4		return $this;
187			}
188
189			/**
190			* @return ResponseInterface
191			*/
192			public function getResponse()
193			{
194			return $this->response;
			0 ignored issues – show Bug Compatibility introduced 2016-02-13 05:17 UTC by Report Bug Copy Issue Report The expression `$this->response;` of type `Ups\ResponseInterface\|SimpleXMLElement` adds the type `SimpleXMLElement` to the return on line 194 which is incompatible with the return type documented by `Ups\TimeInTransit::getResponse` of type `Ups\ResponseInterface`. Loading history... Deprecated Code introduced 2015-11-23 16:39 UTC by Report Bug Copy Issue Report The property `Ups\Ups::$response` has been deprecated. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
195			}
196
197			/**
198			* @param ResponseInterface $response
199			*
200			* @return $this
201			*/
202			public function setResponse(ResponseInterface $response)
203			{
204			$this->response = $response;
			0 ignored issues – show Deprecated Code introduced 2015-11-23 16:39 UTC by Report Bug Copy Issue Report The property `Ups\Ups::$response` has been deprecated. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
205
206			return $this;
207			}
208			}
209

gabrielbull / php-ups-api

Push — develop ( 3a2bd9...89cb66 )

TimeInTransit::getResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like