MoipResource::populate()

Completed

Pull Request — master (#173)

unknown

created 2017-09-20 18:39 UTC

↳ Parent: MoipResource

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	1
nc	1

<?php

namespace Moip\Resource;

use JsonSerializable;
use Moip\Exceptions;
use Moip\Helper\Filters;
use Moip\Helper\Links;
use Moip\Helper\Pagination;
use Moip\Moip;
use Requests;
use Requests_Exception;
use stdClass;

/**
 * Class MoipResource.
 */
abstract class MoipResource implements JsonSerializable
{
    /**
     * Version of API.
     *
     * @const string
     */
    const VERSION = 'v2';

    /**
     * @var \Moip\Moip
     */
    protected $moip;

    /**
     * @var \stdClass
     */
    protected $data;

    /**
     * Initialize a new instance.
     */
    abstract protected function initialize();

    /**
     * Mount information of a determined object.
     *
     * @param \stdClass $response
     *
     * @return mixed
     */
    abstract protected function populate(stdClass $response);

    /**
     * Create a new instance.
     *
     * @param \Moip\Moip $moip
     */
    public function __construct(Moip $moip)
    {
        $this->moip = $moip;
        $this->data = new stdClass();
        $this->initialize();
    }

    /**
     * Get a key of an object if it exists.
     *
     * @param string         $key
     * @param \stdClass|null $data
     *
     * @return mixed
     */
    protected function getIfSet($key, stdClass $data = null)
    {
        if (empty($data)) {
            $data = $this->data;
        }

        if (isset($data->$key)) {
            return $data->$key;
        }
    }

    /**
     * @return \Moip\Helper\Links
     */
    public function getLinks()
    {
        $links = $this->getIfSet('_links');

        if ($links !== null) {
            return new Links($links);
        }
    }

    /**
     * @param $key
     * @param $fmt
     * @param stdClass|null $data
     *
     * @return bool|\DateTime|null
     */
    protected function getIfSetDateFmt($key, $fmt, stdClass $data = null)

    {
        $val = $this->getIfSet($key, $data);
        if (!empty($val)) {
            $dt = \DateTime::createFromFormat($fmt, $val);

            return $dt ? $dt : null;
        }
    }

    /**
     * Get a key, representing a date (Y-m-d), of an object if it exists.
     *
     * @param string        $key
     * @param stdClass|null $data
     *
     * @return \DateTime|null
     */
    protected function getIfSetDate($key, stdClass $data = null)
    {
        return $this->getIfSetDateFmt($key, 'Y-m-d', $data);
    }

    /**
     * Get a key representing a datetime (\Datetime::ATOM), of an object if it exists.
     *
     * @param string        $key
     * @param stdClass|null $data
     *
     * @return \DateTime|null
     */
    protected function getIfSetDateTime($key, stdClass $data = null)

    {
        $rawDateTime = $this->getIfSet($key, $data);

        $dateTime = null;
        if (!empty($rawDateTime)) {
            $dateTime = new \DateTime($rawDateTime);
        }

        return $dateTime;
    }

    /**
     * Specify data which should be serialized to JSON.
     *
     * @return \stdClass
     */
    public function jsonSerialize()
    {
        return $this->data;
    }

    /**
     * Generate URL to request.
     *
     * @param $action
     * @param $id
     *
     * @return string
     */
    public function generatePath($action, $id = null)
    {
        if (!is_null($id)) {
            return sprintf('%s/%s/%s/%s', self::VERSION, static::PATH, $action, $id);
        }

        return sprintf('%s/%s/%s', self::VERSION, static::PATH, $action);
    }

    /**
     * Generate URL to request a get list.
     *
     * @param Pagination $pagination
     * @param Filters    $filters
     * @param string     $qParam     Query a specific value.
     *
     * @return string
     */
    public function generateListPath(Pagination $pagination = null, Filters $filters = null, $qParam = '')
    {
        $queryParams = [];

        if (!is_null($pagination)) {
            if ($pagination->getLimit() != 0) {
                $queryParams['limit'] = $pagination->getLimit();
            }

            if ($pagination->getOffset() >= 0) {
                $queryParams['offset'] = $pagination->getOffset();
            }
        }

        if (!is_null($filters)) {
            $queryParams['filters'] = $filters->__toString();
        }

        if (!empty($qParam)) {
            $queryParams['q'] = $qParam;
        }

        return sprintf('/%s/%s?%s', self::VERSION, static::PATH, http_build_query($queryParams));
    }

    /**
     * Execute a http request. If payload == null no body will be sent. Empty body ('{}') is supported by sending a
     * empty stdClass.
     *
     * @param string     $path
     * @param string     $method
     * @param mixed|null $payload
     *
     * @throws Exceptions\ValidationException  if the API returns a 4xx http status code. Usually means invalid data was sent.
     * @throws Exceptions\UnautorizedException if the API returns a 401 http status code. Check API token and key.
     * @throws Exceptions\UnexpectedException  if the API returns a 500 http status code or something unexpected happens (ie.: Network error).
     *
     * @return stdClass
     */
    protected function httpRequest($path, $method, $payload = null)
    {
        $http_sess = $this->moip->getSession();
        $headers = [];
        $body = null;
        if ($payload !== null) {
            $body = json_encode($payload, JSON_UNESCAPED_SLASHES);
            if ($body) {// if it's json serializable
                $headers['Content-Type'] = 'application/json';
            } else {
                $body = null;
            }
        }

        try {
            $http_response = $http_sess->request($path, $headers, $body, $method);
        } catch (Requests_Exception $e) {
            throw new Exceptions\UnexpectedException($e);
        }

        $code = $http_response->status_code;
        $response_body = $http_response->body;
        if ($code >= 200 && $code < 300) {
            return json_decode($response_body);
        } elseif ($code == 401) {
            throw new Exceptions\UnautorizedException();
        } elseif ($code >= 400 && $code <= 499) {
            $errors = Exceptions\Error::parseErrors($response_body);

            throw new Exceptions\ValidationException($code, $errors);
        }

        throw new Exceptions\UnexpectedException();
    }

    /**
     * Find by path.
     *
     * @param string $path
     *
     * @return stdClass
     */
    public function getByPath($path)
    {
        $response = $this->httpRequest($path, Requests::GET);

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

    /**
     * Find by path with no populate method.
     *
     * @param string $path
     *
     * @return stdClass
     */
    public function getByPathNoPopulate($path)
    {
        return $this->httpRequest($path, Requests::GET);
    }

    /**
     * Create a new item in Moip.
     *
     * @param string $path
     *
     * @return stdClass
     */
    public function createResource($path)
    {
        $response = $this->httpRequest($path, Requests::POST, $this);

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

    /**
     * Delete a new item in Moip.
     *
     * @param $path
     *
     * @return mixed
     */
    public function deleteByPath($path)
    {
        return $this->httpRequest($path, Requests::DELETE);
    }
}


1		<?php
2
3		namespace Moip\Resource;
4
5		use JsonSerializable;
6		use Moip\Exceptions;
7		use Moip\Helper\Filters;
8		use Moip\Helper\Links;
9		use Moip\Helper\Pagination;
10		use Moip\Moip;
11		use Requests;
12		use Requests_Exception;
13		use stdClass;
14
15		/**
16		* Class MoipResource.
17		*/
18		abstract class MoipResource implements JsonSerializable
19		{
20		/**
21		* Version of API.
22		*
23		* @const string
24		*/
25		const VERSION = 'v2';
26
27		/**
28		* @var \Moip\Moip
29		*/
30		protected $moip;
31
32		/**
33		* @var \stdClass
34		*/
35		protected $data;
36
37		/**
38		* Initialize a new instance.
39		*/
40		abstract protected function initialize();
41
42		/**
43		* Mount information of a determined object.
44		*
45		* @param \stdClass $response
46		*
47		* @return mixed
48		*/
49		abstract protected function populate(stdClass $response);
50
51		/**
52		* Create a new instance.
53		*
54		* @param \Moip\Moip $moip
55		*/
56		public function __construct(Moip $moip)
57		{
58		$this->moip = $moip;
59		$this->data = new stdClass();
60		$this->initialize();
61		}
62
63		/**
64		* Get a key of an object if it exists.
65		*
66		* @param string $key
67		* @param \stdClass\|null $data
68		*
69		* @return mixed
70		*/
71		protected function getIfSet($key, stdClass $data = null)
72		{
73		if (empty($data)) {
74		$data = $this->data;
75		}
76
77		if (isset($data->$key)) {
78		return $data->$key;
79		}
80		}
81
82		/**
83		* @return \Moip\Helper\Links
84		*/
85		public function getLinks()
86		{
87		$links = $this->getIfSet('_links');
88
89		if ($links !== null) {
90		return new Links($links);
91		}
92		}
93
94		/**
95		* @param $key
96		* @param $fmt
97		* @param stdClass\|null $data
98		*
99		* @return bool\|\DateTime\|null
100		*/
101	View Code Duplication	protected function getIfSetDateFmt($key, $fmt, stdClass $data = null)
		0 ignored issues – show Duplication introduced 2017-08-07 14:42 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...
102		{
103		$val = $this->getIfSet($key, $data);
104		if (!empty($val)) {
105		$dt = \DateTime::createFromFormat($fmt, $val);
106
107		return $dt ? $dt : null;
108		}
109		}
110
111		/**
112		* Get a key, representing a date (Y-m-d), of an object if it exists.
113		*
114		* @param string $key
115		* @param stdClass\|null $data
116		*
117		* @return \DateTime\|null
118		*/
119		protected function getIfSetDate($key, stdClass $data = null)
120		{
121		return $this->getIfSetDateFmt($key, 'Y-m-d', $data);
122		}
123
124		/**
125		* Get a key representing a datetime (\Datetime::ATOM), of an object if it exists.
126		*
127		* @param string $key
128		* @param stdClass\|null $data
129		*
130		* @return \DateTime\|null
131		*/
132	View Code Duplication	protected function getIfSetDateTime($key, stdClass $data = null)
		0 ignored issues – show Duplication introduced 2017-08-07 14:42 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...
133		{
134		$rawDateTime = $this->getIfSet($key, $data);
135
136		$dateTime = null;
137		if (!empty($rawDateTime)) {
138		$dateTime = new \DateTime($rawDateTime);
139		}
140
141		return $dateTime;
142		}
143
144		/**
145		* Specify data which should be serialized to JSON.
146		*
147		* @return \stdClass
148		*/
149		public function jsonSerialize()
150		{
151		return $this->data;
152		}
153
154		/**
155		* Generate URL to request.
156		*
157		* @param $action
158		* @param $id
159		*
160		* @return string
161		*/
162		public function generatePath($action, $id = null)
163		{
164		if (!is_null($id)) {
165		return sprintf('%s/%s/%s/%s', self::VERSION, static::PATH, $action, $id);
166		}
167
168		return sprintf('%s/%s/%s', self::VERSION, static::PATH, $action);
169		}
170
171		/**
172		* Generate URL to request a get list.
173		*
174		* @param Pagination $pagination
175		* @param Filters $filters
176		* @param string $qParam Query a specific value.
177		*
178		* @return string
179		*/
180		public function generateListPath(Pagination $pagination = null, Filters $filters = null, $qParam = '')
181		{
182		$queryParams = [];
183
184		if (!is_null($pagination)) {
185		if ($pagination->getLimit() != 0) {
186		$queryParams['limit'] = $pagination->getLimit();
187		}
188
189		if ($pagination->getOffset() >= 0) {
190		$queryParams['offset'] = $pagination->getOffset();
191		}
192		}
193
194		if (!is_null($filters)) {
195		$queryParams['filters'] = $filters->__toString();
196		}
197
198		if (!empty($qParam)) {
199		$queryParams['q'] = $qParam;
200		}
201
202		return sprintf('/%s/%s?%s', self::VERSION, static::PATH, http_build_query($queryParams));
203		}
204
205		/**
206		* Execute a http request. If payload == null no body will be sent. Empty body ('{}') is supported by sending a
207		* empty stdClass.
208		*
209		* @param string $path
210		* @param string $method
211		* @param mixed\|null $payload
212		*
213		* @throws Exceptions\ValidationException if the API returns a 4xx http status code. Usually means invalid data was sent.
214		* @throws Exceptions\UnautorizedException if the API returns a 401 http status code. Check API token and key.
215		* @throws Exceptions\UnexpectedException if the API returns a 500 http status code or something unexpected happens (ie.: Network error).
216		*
217		* @return stdClass
218		*/
219		protected function httpRequest($path, $method, $payload = null)
220		{
221		$http_sess = $this->moip->getSession();
222		$headers = [];
223		$body = null;
224		if ($payload !== null) {
225		$body = json_encode($payload, JSON_UNESCAPED_SLASHES);
226		if ($body) {// if it's json serializable
227		$headers['Content-Type'] = 'application/json';
228		} else {
229		$body = null;
230		}
231		}
232
233		try {
234		$http_response = $http_sess->request($path, $headers, $body, $method);
235		} catch (Requests_Exception $e) {
236		throw new Exceptions\UnexpectedException($e);
237		}
238
239		$code = $http_response->status_code;
240		$response_body = $http_response->body;
241		if ($code >= 200 && $code < 300) {
242		return json_decode($response_body);
243		} elseif ($code == 401) {
244		throw new Exceptions\UnautorizedException();
245		} elseif ($code >= 400 && $code <= 499) {
246		$errors = Exceptions\Error::parseErrors($response_body);
247
248		throw new Exceptions\ValidationException($code, $errors);
249		}
250
251		throw new Exceptions\UnexpectedException();
252		}
253
254		/**
255		* Find by path.
256		*
257		* @param string $path
258		*
259		* @return stdClass
260		*/
261		public function getByPath($path)
262		{
263		$response = $this->httpRequest($path, Requests::GET);
264
265		return $this->populate($response);
266		}
267
268		/**
269		* Find by path with no populate method.
270		*
271		* @param string $path
272		*
273		* @return stdClass
274		*/
275		public function getByPathNoPopulate($path)
276		{
277		return $this->httpRequest($path, Requests::GET);
278		}
279
280		/**
281		* Create a new item in Moip.
282		*
283		* @param string $path
284		*
285		* @return stdClass
286		*/
287		public function createResource($path)
288		{
289		$response = $this->httpRequest($path, Requests::POST, $this);
290
291		return $this->populate($response);
292		}
293
294		/**
295		* Delete a new item in Moip.
296		*
297		* @param $path
298		*
299		* @return mixed
300		*/
301		public function deleteByPath($path)
302		{
303		return $this->httpRequest($path, Requests::DELETE);
304		}
305		}
306

moip / moip-sdk-php

Pull Request — master (#173)

MoipResource::populate()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like