HttpApi::httpPost()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 0
cts 4
cp 0
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 3
crap 2
1
<?php
2
3
declare(strict_types=1);
4
5
/*
6
 * This software may be modified and distributed under the terms
7
 * of the MIT license. See the LICENSE file for details.
8
 */
9
10
namespace FAPI\Fortnox\Api;
11
12
use FAPI\Fortnox\Exception\Domain as DomainExceptions;
13
use FAPI\Fortnox\Exception\DomainException;
14
use FAPI\Fortnox\Hydrator\Hydrator;
15
use FAPI\Fortnox\Hydrator\NoopHydrator;
16
use FAPI\Fortnox\RequestBuilder;
17
use Http\Client\HttpClient;
18
use Psr\Http\Message\ResponseInterface;
19
20
/**
21
 * @author Tobias Nyholm <[email protected]>
22
 */
23
abstract class HttpApi
24
{
25
    /**
26
     * @var HttpClient
27
     */
28
    protected $httpClient;
29
30
    /**
31
     * @var Hydrator
32
     */
33
    protected $hydrator;
34
35
    /**
36
     * @var RequestBuilder
37
     */
38
    protected $requestBuilder;
39
40
    public function __construct(HttpClient $httpClient, Hydrator $hydrator, RequestBuilder $requestBuilder)
41
    {
42
        $this->httpClient = $httpClient;
43
        $this->requestBuilder = $requestBuilder;
44
        if (!$hydrator instanceof NoopHydrator) {
45
            $this->hydrator = $hydrator;
46
        }
47
    }
48
49
    /**
50
     * Send a GET request with query parameters.
51
     *
52
     * @param string $path           Request path
53
     * @param array  $params         GET parameters
54
     * @param array  $requestHeaders Request Headers
55
     */
56
    protected function httpGet(string $path, array $params = [], array $requestHeaders = []): ResponseInterface
57
    {
58
        if (\count($params) > 0) {
59
            $path .= '?'.\http_build_query($params);
60
        }
61
62
        return $this->httpClient->sendRequest(
63
            $this->requestBuilder->create('GET', $path, $requestHeaders)
64
        );
65
    }
66
67
    /**
68
     * Send a POST request with JSON-encoded parameters.
69
     *
70
     * @param string $path           Request path
71
     * @param array  $params         POST parameters to be JSON encoded
72
     * @param array  $requestHeaders Request headers
73
     */
74
    protected function httpPost(string $path, array $params = [], array $requestHeaders = []): ResponseInterface
75
    {
76
        return $this->httpPostRaw($path, $this->createJsonBody($params), $requestHeaders);
77
    }
78
79
    /**
80
     * Send a POST request with raw data.
81
     *
82
     * @param string       $path           Request path
83
     * @param array|string $body           Request body
84
     * @param array        $requestHeaders Request headers
85
     */
86
    protected function httpPostRaw(string $path, $body, array $requestHeaders = []): ResponseInterface
87
    {
88
        return $response = $this->httpClient->sendRequest(
0 ignored issues
show
Unused Code introduced by
$response is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
89
            $this->requestBuilder->create('POST', $path, $requestHeaders, $body)
90
        );
91
    }
92
93
    /**
94
     * Send a PUT request with JSON-encoded parameters.
95
     *
96
     * @param string $path           Request path
97
     * @param array  $params         POST parameters to be JSON encoded
98
     * @param array  $requestHeaders Request headers
99
     */
100
    protected function httpPut(string $path, array $params = [], array $requestHeaders = []): ResponseInterface
101
    {
102
        return $this->httpClient->sendRequest(
103
            $this->requestBuilder->create('PUT', $path, $requestHeaders, $this->createJsonBody($params))
104
        );
105
    }
106
107
    /**
108
     * Send a DELETE request with JSON-encoded parameters.
109
     *
110
     * @param string $path           Request path
111
     * @param array  $params         POST parameters to be JSON encoded
112
     * @param array  $requestHeaders Request headers
113
     */
114
    protected function httpDelete(string $path, array $params = [], array $requestHeaders = []): ResponseInterface
115
    {
116
        return $this->httpClient->sendRequest(
117
            $this->requestBuilder->create('DELETE', $path, $requestHeaders, $this->createJsonBody($params))
118
        );
119
    }
120
121
    /**
122
     * Handle HTTP errors.
123
     *
124
     * Call is controlled by the specific API methods.
125
     *
126
     * @throws DomainException
127
     */
128
    protected function handleErrors(ResponseInterface $response)
129
    {
130
        $body = $response->getBody()->__toString();
131
        switch ($response->getStatusCode()) {
132
            case 400:
133
                throw new DomainExceptions\BadRequestException($body);
134
                break;
0 ignored issues
show
Unused Code introduced by
break; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
135
136
            case 403:
137
                throw new DomainExceptions\ForbiddenException();
138
                break;
0 ignored issues
show
Unused Code introduced by
break; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
139
140
            case 404:
141
                throw new DomainExceptions\NotFoundException();
142
                break;
0 ignored issues
show
Unused Code introduced by
break; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
143
144
            case 500:
145
                throw new DomainExceptions\ServerErrorException();
146
                break;
0 ignored issues
show
Unused Code introduced by
break; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
147
148
            default:
149
                throw new DomainExceptions\UnknownErrorException();
150
                break;
0 ignored issues
show
Unused Code introduced by
break; does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
151
        }
152
    }
153
154
    /**
155
     * Create a JSON encoded version of an array of parameters.
156
     *
157
     * @param array $params Request parameters
158
     *
159
     * @return string|null
160
     */
161
    private function createJsonBody(array $params)
162
    {
163
        return (0 === \count($params)) ? null : \json_encode($params, empty($params) ? \JSON_FORCE_OBJECT : 0);
164
    }
165
}
166