Completed
Push — master ( 0fdb03...027d12 )
by Stephen
15s queued 10s
created

PostcodeService::getResponse()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 10
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 6
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 5
c 1
b 0
f 0
nc 1
nop 1
dl 0
loc 10
ccs 6
cts 6
cp 1
crap 1
rs 10
1
<?php
2
3
declare(strict_types=1);
4
5
namespace JustSteveKing\LaravelPostcodes\Service;
6
7
use GuzzleHttp\Client;
8
9
class PostcodeService
10
{
11
    /**
12
     * @var string
13
     */
14
    protected $url;
15
16
    /**
17
     * @var Client
18
     */
19
    protected $http;
20
21
    /**
22
     * Postcode Service constructor.
23
     *
24
     * @param Client $client
25
     *
26
     * @return void
27
     */
28 27
    public function __construct(Client $client)
29
    {
30 27
        $this->url = config('services.postcodes.url');
31
32 27
        $this->http = $client;
33 27
    }
34
35
    /**
36
     * Validate a postcode against the API
37
     *
38
     * @param string $postcode
39
     *
40
     * @return bool
41
     */
42 9
    public function validate(string $postcode): bool
43
    {
44 9
        return $this->getResponse("postcodes/$postcode/validate");
45
    }
46
47
    /**
48
     * Get the address details from a postcode
49
     *
50
     * @param string $postcode
51
     *
52
     * @return object
53
     */
54 3
    public function getPostcode(string $postcode): object
55
    {
56 3
        return $this->getResponse("postcodes/$postcode");
57
    }
58
59
    /**
60
     * Get the address details from a random postcode
61
     *
62
     * @return object
63
     */
64 3
    public function getRandomPostcode()
65
    {
66 3
        return $this->getResponse("random/postcodes");
67
    }
68
69
    /**
70
     * Lookup a terminated postcode. Returns the postcode, year and month of termination.
71
     *
72
     * @param string $postcode
73
     *
74
     * @return object
75
     */
76 3
    public function getTerminatedPostcode($postcode)
77
    {
78 3
        return $this->getResponse("terminated_postcodes/$postcode");
79
    }
80
81
    /**
82
     * Get the response and return the result object
83
     *
84
     * @param string $uri
85
     */
86 18
    protected function getResponse(string $uri = null)
87
    {
88 18
        $url = $this->url . $uri;
89
90 18
        $request = $this->http->request(
91 18
            'GET',
92 12
            $url
93
        );
94
95 18
        return json_decode($request->getBody()->getContents())->result;
96
    }
97
}
98