quaderno-php/quaderno_base.php at master · quaderno/quaderno-php · GitHub

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
<?php
/**
* Quaderno Base
*
* @package   Quaderno PHP
* @author    Quaderno <support@quaderno.io>
* @copyright Copyright (c) 2021, Quaderno
* @license   https://opensource.org/licenses/MIT The MIT License
*/

/* General interface that implements the calls to the message coding and transport library */
abstract class QuadernoBase
{
	protected static $api_key = null;
	protected static $api_url = null;
	protected static $api_version = null;
	protected static $timeout = 30;

	/**
	 * @param string $key
	 * @param string $url
	 * @param string|null $version
	 *
	 * @return void
	 */
	public static function init($key, $url, $version = null)
	{
		self::$api_key = $key;
		self::$api_url = $url;
		self::$api_version = $version;
	}

	/**
	 * @param int $timeout Total request timeout in seconds (0 = unlimited, not recommended)
	 *
	 * @return void
	 */
	public static function setTimeout(int $timeout): void
	{
		self::$timeout = $timeout;
	}

	/**
	 * @return int
	 */
	public static function getTimeout(): int
	{
		return self::$timeout;
	}

	/**
	 * @param string $method
	 * @param string $model
	 * @param string $id
	 * @param array|null $params
	 * @param array|null $data
	 *
	 * @return array
	 */
	public static function apiCall($method, $model, $id = '', $params = null, $data = null)
	{
		$url = self::$api_url . $model . ($id != '' ? '/' . $id : '') . '.json';
		if (isset($params)) $url .= '?'.http_build_query($params);
		return QuadernoJSON::exec($url, $method, self::$api_key, 'foo', self::$api_version, $data, self::$timeout);
	}

	/**
	 * @return bool
	 */
	public static function ping()
	{
		return self::responseIsValid(self::apiCall('GET', 'ping'));
	}

	/**
	 * @param string $model
	 * @param string $id
	 *
	 * @return array
	 */
	public static function delete($model, $id)
	{
		return self::apiCall('DELETE', $model, $id);
	}

	/**
	 * @param string $parentmodel
	 * @param string $parentid
	 * @param string $model
	 * @param string $id
	 *
	 * @return array
	 */
	public static function deleteNested($parentmodel, $parentid, $model, $id)
	{
		return self::delete($parentmodel . '/' . $parentid . '/' . $model, $id);
	}

	/**
	 * @param string $model
	 * @param string $id
	 *
	 * @return array
	 */
	public static function deliver($model, $id)
	{
		return self::apiCall('GET', $model, $id . '/deliver');
	}

	/**
	 * @param string $model
	 * @param array|null $params
	 *
	 * @return array
	 */
	public static function find($model, $params = null)
	{
		return self::apiCall('GET', $model, '', $params);
	}

	/**
	 * @param string $model
	 * @param string $id
	 *
	 * @return array
	 */
	public static function findByID($model, $id)
	{
		return self::apiCall('GET', $model, $id);
	}

	/**
	 * @param string $model
	 * @param array|null $data
	 * @param string $id
	 *
	 * @return array
	 */
	public static function save($model, $data, $id)
	{
		return self::apiCall(($id ? 'PUT' : 'POST'), $model, $id, null, $data);
	}

	/**
	 * @param string $id
	 * @param string $model
	 * @param string $gateway
	 *
	 * @return array
	 */
	public static function retrieve($id, $model, $gateway = 'stripe')
	{
		return self::apiCall('GET', $gateway . '/' . $model, $id);
	}

	/**
	 * @param string $parentmodel
	 * @param string $parentid
	 * @param string $model
	 * @param array|null $data
	 *
	 * @return array
	 */
	public static function saveNested($parentmodel, $parentid, $model, $data)
	{
		return self::save($parentmodel . '/' . $parentid . '/' . $model, $data, null);
	}

	/**
	 * @param array $response
	 *
	 * @return bool
	 */
	public static function responseIsValid($response)
	{
		return isset($response) && !$response['error'] && (int)($response['http_code'] / 100) == 2;
	}

	/**
	 * @return null|string
	 */
	public static function getApiKey()
	{
		return self::$api_key;
	}

	/**
	 * @return null|string
	 */
	public static function getApiUrl()
	{
		return self::$api_url;
	}

	/**
	 * @return null|string
	 */
	public static function getApiVersion()
	{
		return self::$api_version;
	}
}