ApiResource.php
7.65 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
<?php
abstract class Divido_ApiResource extends Divido_Object
{
protected static function _scopedRetrieve($class, $id, $apiKey=null)
{
$instance = new $class($id, $apiKey);
$instance->refresh();
return $instance;
}
/**
* @returns Divido_ApiResource The refreshed resource.
*/
public function refresh()
{
$requestor = new Divido_ApiRequestor($this->_apiKey);
$url = $this->instanceUrl();
list($response, $apiKey) = $requestor->request(
'get',
$url,
$this->_retrieveOptions
);
$this->refreshFrom($response, $apiKey);
return $this;
}
/**
* @param string $class
*
* @returns string The name of the class, with namespacing and underscores
* stripped.
*/
public static function className($class)
{
// Useful for namespaces: Foo\Divido_Charge
if ($postfixNamespaces = strrchr($class, '\\')) {
$class = substr($postfixNamespaces, 1);
}
// Useful for underscored 'namespaces': Foo_Divido_Charge
if ($postfixFakeNamespaces = strrchr($class, 'Divido_')) {
$class = $postfixFakeNamespaces;
}
if (substr($class, 0, strlen('Divido')) == 'Divido') {
$class = substr($class, strlen('Divido'));
}
$class = str_replace('_', '', $class);
$name = urlencode($class);
$name = strtolower($name);
return $name;
}
/**
* @param string $class
*
* @returns string The endpoint URL for the given class.
*/
public static function classUrl($class)
{
$base = self::_scopedLsb($class, 'className', $class);
return "/v1/${base}";
}
/**
* @returns string The full API URL for this API resource.
*/
public function instanceUrl()
{
$id = $this['id'];
$class = get_class($this);
if ($id === null) {
$message = "Could not determine which URL to request: "
. "$class instance has invalid ID: $id";
throw new Divido_InvalidRequestError($message, null);
}
$id = Divido_ApiRequestor::utf8($id);
$base = $this->_lsb('classUrl', $class);
$extn = urlencode($id);
return "$base/$extn";
}
private static function _validateCall($method, $params=null, $apiKey=null)
{
if ($params && !is_array($params)) {
$message = "You must pass an array as the first argument to Divido API "
. "method calls. (HINT: an example call to create a charge "
. "would be: \"DividoCharge::create(array('amount' => 100, "
. "'currency' => 'usd', 'card' => array('number' => "
. "4242424242424242, 'exp_month' => 5, 'exp_year' => 2015)))\")";
throw new Divido_Error($message);
}
if ($apiKey && !is_string($apiKey)) {
$message = 'The second argument to Divido API method calls is an '
. 'optional per-request apiKey, which must be a string. '
. '(HINT: you can set a global apiKey by '
. '"Divido::setApiKey(<apiKey>)")';
throw new Divido_Error($message);
}
}
protected static function _scopedAll($class, $params=null, $apiKey=null)
{
self::_validateCall('all', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('get', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedSendApplicationRequest($class, $params=null, $apiKey=null)
{
self::_validateCall('sendApplicationRequest', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedCreditRequest($class, $params=null, $apiKey=null)
{
self::_validateCall('creditRequest', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedFinalizeRequest($class, $params=null, $apiKey=null)
{
self::_validateCall('finalizeRequest', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
$url = $url."/finalize";
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedFulfillRequest($class, $params=null, $apiKey=null)
{
self::_validateCall('fulfillRequest', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedActivateRequest($class, $params=null, $apiKey=null)
{
self::_validateCall('activateRequest', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedCancellationRequest($class, $params=null, $apiKey=null)
{
self::_validateCall('cancelRequest', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedRefundRequest($class, $params=null, $apiKey=null)
{
self::_validateCall('refundRequest', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedCommentRequest($class, $params=null, $apiKey=null)
{
self::_validateCall('commentRequest', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected static function _scopedCreate($class, $params=null, $apiKey=null)
{
self::_validateCall('create', $params, $apiKey);
$requestor = new Divido_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Divido_Util::convertToDividoObject($response, $apiKey);
}
protected function _scopedSave($class, $apiKey=null)
{
self::_validateCall('save');
$requestor = new Divido_ApiRequestor($apiKey);
$params = $this->serializeParameters();
if (count($params) > 0) {
$url = $this->instanceUrl();
list($response, $apiKey) = $requestor->request('post', $url, $params);
$this->refreshFrom($response, $apiKey);
}
return $this;
}
protected function _scopedDelete($class, $params=null)
{
self::_validateCall('delete');
$requestor = new Divido_ApiRequestor($this->_apiKey);
$url = $this->instanceUrl();
list($response, $apiKey) = $requestor->request('delete', $url, $params);
$this->refreshFrom($response, $apiKey);
return $this;
}
}