SimpleAddressValidation::formatResponse() - Code Metrics - Inspection of "Add 'simple' Address Validation class (#119)" - gabrielbull/php-ups-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5ec83a...077a27 )

by Stefan

created 2016-09-15 12:07 UTC

SimpleAddressValidation::formatResponse() A

↳ Parent: SimpleAddressValidation

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes

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

<?php

namespace Ups;

use DOMDocument;
use Exception;
use Psr\Log\LoggerInterface;
use SimpleXMLElement;
use stdClass;
use Ups\Entity\Address;
use Ups\Entity\AddressValidationResponse;

/**
 * Address Validation API Wrapper to use the basic Address Validation endpoints.
 *
 * This functionality is more basic, but available in more countries than the 'extended' Address Validation methods.
 */
class SimpleAddressValidation extends Ups
{
    const ENDPOINT = '/AV';

    /**
     * @var RequestInterface
     */
    private $request;

    /**
     * @var ResponseInterface
     *
     * @todo make private
     */
    public $response;

    /**
     * @var Address
     */
    private $address;

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

    /**
     * Get address suggestions from UPS using the default Address Validation API (/AV)
     *
     * @param Address $address
     *
     * @throws Exception
     *
     * @return array
     */
    public function validate(Address $address)
    {
        $this->address = $address;

        $access = $this->createAccess();
        $request = $this->createRequest();

        $this->response = $this->getRequest()->request($access, $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
            );
        }

        return $this->formatResponse($response);
    }

    /**
     * Create the AV request.
     *
     * @return string
     */
    private function createRequest()
    {
        $xml = new DOMDocument();
        $xml->formatOutput = true;

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

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

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

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

        if (null !== $this->address) {
            $addressNode = $avRequest->appendChild($xml->createElement('Address'));

            if ($this->address->getStateProvinceCode()) {
                $addressNode->appendChild($xml->createElement('StateProvinceCode', $this->address->getStateProvinceCode()));
            }
            if ($this->address->getCity()) {
                $addressNode->appendChild($xml->createElement('City', $this->address->getCity()));
            }
            if ($this->address->getCountryCode()) {
                $addressNode->appendChild($xml->createElement('CountryCode', $this->address->getCountryCode()));
            }
            if ($this->address->getPostalCode()) {
                $addressNode->appendChild($xml->createElement('PostalCode', $this->address->getPostalCode()));
            }
        }

        return $xml->saveXML();
    }

    /**
     * Format the response.
     *
     * @param SimpleXMLElement $response
     *
     * @return array
     */
    private function formatResponse(SimpleXMLElement $response)
    {
        $result = $this->convertXmlObject($response);

        if (!is_array($result->AddressValidationResult)) {
            return [$result->AddressValidationResult];
        }

        return $result->AddressValidationResult;
    }

    /**
     * @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 stdClass;
10			use Ups\Entity\Address;
11			use Ups\Entity\AddressValidationResponse;
12
13			/**
14			* Address Validation API Wrapper to use the basic Address Validation endpoints.
15			*
16			* This functionality is more basic, but available in more countries than the 'extended' Address Validation methods.
17			*/
18			class SimpleAddressValidation extends Ups
19			{
20			const ENDPOINT = '/AV';
21
22			/**
23			* @var RequestInterface
24			*/
25			private $request;
26
27			/**
28			* @var ResponseInterface
29			*
30			* @todo make private
31			*/
32			public $response;
33
34			/**
35			* @var Address
36			*/
37			private $address;
38
39			/**
40			* @param string\|null $accessKey UPS License Access Key
41			* @param string\|null $userId UPS User ID
42			* @param string\|null $password UPS User Password
43			* @param bool $useIntegration Determine if we should use production or CIE URLs.
44			* @param RequestInterface\|null $request
45			* @param LoggerInterface\|null $logger PSR3 compatible logger (optional)
46			*/
47	2	View Code Duplication	public function __construct(
			0 ignored issues – show Duplication introduced 2016-09-15 12:05 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...
48			$accessKey = null,
49			$userId = null,
50			$password = null,
51			$useIntegration = false,
52			RequestInterface $request = null,
53			LoggerInterface $logger = null
54			) {
55	2		if (null !== $request) {
56			$this->setRequest($request);
57			}
58	2		parent::__construct($accessKey, $userId, $password, $useIntegration, $logger);
59	2		}
60
61			/**
62			* Get address suggestions from UPS using the default Address Validation API (/AV)
63			*
64			* @param Address $address
65			*
66			* @throws Exception
67			*
68			* @return array
69			*/
70	2		public function validate(Address $address)
71			{
72	2		$this->address = $address;
73
74	2		$access = $this->createAccess();
75	2		$request = $this->createRequest();
76
77	2		$this->response = $this->getRequest()->request($access, $request, $this->compileEndpointUrl(self::ENDPOINT));
78	2		$response = $this->response->getResponse();
79
80	2		if (null === $response) {
81	1		throw new Exception('Failure (0): Unknown error', 0);
82			}
83
84	1		if ($response instanceof SimpleXMLElement && $response->Response->ResponseStatusCode == 0) {
85			throw new Exception(
86			"Failure ({$response->Response->Error->ErrorSeverity}): {$response->Response->Error->ErrorDescription}",
87			(int)$response->Response->Error->ErrorCode
88			);
89			}
90
91	1		return $this->formatResponse($response);
92			}
93
94			/**
95			* Create the AV request.
96			*
97			* @return string
98			*/
99	2		private function createRequest()
100			{
101	2		$xml = new DOMDocument();
102	2		$xml->formatOutput = true;
103
104	2		$avRequest = $xml->appendChild($xml->createElement('AddressValidationRequest'));
105	2		$avRequest->setAttribute('xml:lang', 'en-US');
106
107	2		$request = $avRequest->appendChild($xml->createElement('Request'));
108
109	2		$node = $xml->importNode($this->createTransactionNode(), true);
110	2		$request->appendChild($node);
111
112	2		$request->appendChild($xml->createElement('RequestAction', 'AV'));
113
114	2		if (null !== $this->address) {
115	2		$addressNode = $avRequest->appendChild($xml->createElement('Address'));
116
117	2		if ($this->address->getStateProvinceCode()) {
118	2		$addressNode->appendChild($xml->createElement('StateProvinceCode', $this->address->getStateProvinceCode()));
119	2		}
120	2		if ($this->address->getCity()) {
121	2		$addressNode->appendChild($xml->createElement('City', $this->address->getCity()));
122	2		}
123	2		if ($this->address->getCountryCode()) {
124	2		$addressNode->appendChild($xml->createElement('CountryCode', $this->address->getCountryCode()));
125	2		}
126	2		if ($this->address->getPostalCode()) {
127	2		$addressNode->appendChild($xml->createElement('PostalCode', $this->address->getPostalCode()));
128	2		}
129	2		}
130
131	2		return $xml->saveXML();
132			}
133
134			/**
135			* Format the response.
136			*
137			* @param SimpleXMLElement $response
138			*
139			* @return array
140			*/
141	1		private function formatResponse(SimpleXMLElement $response)
142			{
143	1		$result = $this->convertXmlObject($response);
144
145	1		if (!is_array($result->AddressValidationResult)) {
146			return [$result->AddressValidationResult];
147			}
148
149	1		return $result->AddressValidationResult;
150			}
151
152			/**
153			* @return RequestInterface
154			*/
155	2		public function getRequest()
156			{
157	2		if (null === $this->request) {
158			$this->request = new Request($this->logger);
159			}
160
161	2		return $this->request;
162			}
163
164			/**
165			* @param RequestInterface $request
166			*
167			* @return $this
168			*/
169	2		public function setRequest(RequestInterface $request)
170			{
171	2		$this->request = $request;
172
173	2		return $this;
174			}
175
176			/**
177			* @return ResponseInterface
178			*/
179			public function getResponse()
180			{
181			return $this->response;
182			}
183
184			/**
185			* @param ResponseInterface $response
186			*
187			* @return $this
188			*/
189			public function setResponse(ResponseInterface $response)
190			{
191			$this->response = $response;
192
193			return $this;
194			}
195			}
196

gabrielbull / php-ups-api

Push — master ( 5ec83a...077a27 )

SimpleAddressValidation::formatResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like