-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWebserviceModel.php
More file actions
231 lines (193 loc) · 5.09 KB
/
WebserviceModel.php
File metadata and controls
231 lines (193 loc) · 5.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<?php
namespace SyncEngine\Model;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use SyncEngine\Model\Abstract\ServiceModel;
use SyncEngine\Model\Interface\Configurable;
use SyncEngine\Model\Interface\Requestable;
use SyncEngine\Model\Interface\Taggable;
use SyncEngine\Model\Trait\Config;
use SyncEngine\Model\Trait\Format;
use SyncEngine\Model\Trait\Tags;
use SyncEngine\Service\Locator\Webservices;
use SyncEngine\Webservice\Helper\Result;
use SyncEngine\Webservice\Type\WebserviceTypeInterface;
abstract class WebserviceModel extends ServiceModel implements Requestable, Configurable, Taggable
{
use Config;
use Format;
use Tags;
const SERVICE = Webservices::class;
/**
* The type of webservice. Can be used for categorizing.
*
* @var string|WebserviceTypeInterface
*/
public string|WebserviceTypeInterface $type = '';
/**
* Icon used in the interface.
*
* @var string
*/
public string $icon = '';
/**
* Human-readable name used in the interface.
*
* @var string
*/
public string $name = '';
/**
* Human-readable description used in the interface.
*
* @var string
*/
public string $description = '';
public function getType(): string
{
return $this->type instanceof WebserviceTypeInterface ? $this->type->getType() : $this->type;
}
public function getIcon(): string
{
return $this->icon ?: $this->getModule()?->getIcon() ?? '';
}
public function getName(): string
{
return $this->name;
}
public function getDescription(): string
{
return $this->description;
}
public function getFields( array $defaults = [] ): array
{
return [
'request' => [
'label' => 'Request',
'nested' => $this->getRequestFields( $defaults['request'] ?? [] ),
],
'response' => [
'label' => 'Response',
'nested' => $this->getResponseFields( $defaults['response'] ?? [] ),
],
];
}
public function getAuthTags(): array
{
return [];
}
public function getAuthTagsResource( array $config ): array
{
$connection = $config['connection'] ?? $config['id'] ?? 0;
if ( ! $connection instanceof ConnectionModel ) {
$connection = ConnectionModel::get( $connection );
}
return $connection?->getTagsResource() ?? [];
}
abstract public function getAuthFields(): array;
/**
* All fields will be nested under '_connect';
* @return array|bool
*/
public function getConnectFields(): array|bool
{
return [];
}
public function getRetrieveFields( array $defaults = [] ): array
{
return $this->getFields( $defaults );
}
public function getSendFields( array $defaults = [] ): array
{
return $this->getFields( $defaults );
}
abstract public function getRequestFields( array $defaults = [] ): array;
public function getResponseFields( array $defaults = [] ): array
{
$field = $this->getFormatDecodeField( [], $defaults['format'] ?? [] );
$field['label'] = $this->trans( 'Response format' );
return [
'format' => $field,
];
}
abstract public function getRequestUrl( array $config ): string;
/**
* @throws \Throwable
*
* @param array $config
*
* @return array
*/
public function authorize( array $config ): array
{
return $config;
}
public function connect( array $config ): Result
{
return new Result(
true,
true,
[
'Message' => $this->trans( 'This webservice does not validate authorization.' ),
'Config' => $config,
]
);
}
/**
* @throws \Throwable
*
* @param array $config
*
* @return mixed
*/
abstract public function retrieve( array $config, $data = null ): Result;
/**
* @throws \Throwable
*
* @param $data
* @param array $config
*
* @return mixed
*/
abstract public function send( array $config, $data ): Result;
public function handleRequest( Request $request, ConnectionModel $connection ): Response
{
if ( 'connect' === $request->get( 'action' ) ) {
$authConfig = $request->get( 'authConfig' );
if ( $authConfig ) {
// @todo Temp update only? This will persist the config when the connection has been tested by the ConnectionModel.
$connection->setConfig( json_decode( $authConfig, true ), 'webservice' );
}
$connectConfig = (array) json_decode( $request->get( 'connectConfig' ) ?? '', true );
// @todo provide context.
return $connection->handleConnect( array_filter( $connectConfig ), null )->getDebugResponse();
}
return new Response();
}
public function normalize(): array
{
$props = [
'_class' => $this->getClassLocator(),
'type' => $this->getType(),
'icon' => $this->getIcon(),
'name' => $this->getName(),
'description' => $this->getDescription(),
'fields' => [
'retrieve' => $this->getRetrieveFields(),
'send' => $this->getSendFields(),
'auth' => $this->getAuthFields(),
'connect' => $this->getConnectFields(),
],
'tags' => [
'auth' => $this->getAuthTags(),
],
];
if ( $this->isFromModule() ) {
$props['module'] = $this->getModule()->getName();
}
return $props;
}
final static function isWebservice( $class ): bool
{
return $class instanceof WebserviceModel;
}
}