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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<?php
/*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2010, StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Basic client class for Yammer's OAuth/JSON API.
*
* @package YammerImportPlugin
* @author Brion Vibber <brion@status.net>
*/
class SN_YammerClient
{
protected $apiBase = "https://www.yammer.com";
protected $consumerKey, $consumerSecret;
protected $token, $tokenSecret, $verifier;
public function __construct($consumerKey, $consumerSecret, $token=null, $tokenSecret=null)
{
$this->consumerKey = $consumerKey;
$this->consumerSecret = $consumerSecret;
$this->token = $token;
$this->tokenSecret = $tokenSecret;
}
/**
* Make an HTTP GET request with OAuth headers and return an HTTPResponse
* with the returned body and codes.
*
* @param string $url
* @return HTTPResponse
*
* @throws Exception on low-level network error
*/
protected function httpGet($url)
{
$headers = array('Authorization: ' . $this->authHeader());
$client = HTTPClient::start();
return $client->get($url, $headers);
}
/**
* Make an HTTP GET request with OAuth headers and return the response body
* on success.
*
* @param string $url
* @return string
*
* @throws Exception on low-level network or HTTP error
*/
public function fetchUrl($url)
{
$response = $this->httpGet($url);
if ($response->isOk()) {
return $response->getBody();
} else {
throw new Exception("Yammer API returned HTTP code " . $response->getStatus() . ': ' . $response->getBody());
}
}
/**
* Make an HTTP hit with OAuth headers and return the response body on success.
*
* @param string $path URL chunk for the API method
* @param array $params
* @return string
*
* @throws Exception on low-level network or HTTP error
*/
protected function fetchApi($path, $params=array())
{
$url = $this->apiBase . '/' . $path;
if ($params) {
$url .= '?' . http_build_query($params, null, '&');
}
return $this->fetchUrl($url);
}
/**
* Hit the main Yammer API point and decode returned JSON data.
*
* @param string $method
* @param array $params
* @return array from JSON data
*
* @throws Exception for HTTP error or bad JSON return
*/
public function api($method, $params=array())
{
$body = $this->fetchApi("api/v1/$method.json", $params);
$data = json_decode($body, true);
if ($data === null) {
common_log(LOG_ERR, "Invalid JSON response from Yammer API: " . $body);
throw new Exception("Invalid JSON response from Yammer API");
}
return $data;
}
/**
* Build an Authorization header value from the keys we have available.
*/
protected function authHeader()
{
// token
// token_secret
$params = array('realm' => '',
'oauth_consumer_key' => $this->consumerKey,
'oauth_signature_method' => 'PLAINTEXT',
'oauth_timestamp' => time(),
'oauth_nonce' => time(),
'oauth_version' => '1.0');
if ($this->token) {
$params['oauth_token'] = $this->token;
}
if ($this->tokenSecret) {
$params['oauth_signature'] = $this->consumerSecret . '&' . $this->tokenSecret;
} else {
$params['oauth_signature'] = $this->consumerSecret . '&';
}
if ($this->verifier) {
$params['oauth_verifier'] = $this->verifier;
}
$parts = array_map(array($this, 'authHeaderChunk'), array_keys($params), array_values($params));
return 'OAuth ' . implode(', ', $parts);
}
/**
* Encode a key-value pair for use in an authentication header.
*
* @param string $key
* @param string $val
* @return string
*/
protected function authHeaderChunk($key, $val)
{
return urlencode($key) . '="' . urlencode($val) . '"';
}
/**
* Ask the Yammer server for a request token, which can be passed on
* to authorizeUrl() for the user to start the authentication process.
*
* @return array of oauth return data; should contain nice things
*/
public function requestToken()
{
if ($this->token || $this->tokenSecret) {
throw new Exception("Requesting a token, but already set up with a token");
}
$data = $this->fetchApi('oauth/request_token');
$arr = array();
parse_str($data, $arr);
return $arr;
}
/**
* Get a final access token from the verifier/PIN code provided to
* the user from Yammer's auth pages.
*
* @return array of oauth return data; should contain nice things
*/
public function accessToken($verifier)
{
$this->verifier = $verifier;
$data = $this->fetchApi('oauth/access_token');
$this->verifier = null;
$arr = array();
parse_str($data, $arr);
return $arr;
}
/**
* Give the URL to send users to to authorize a new app setup.
*
* @param string $token as returned from accessToken()
* @return string URL
*/
public function authorizeUrl($token)
{
return $this->apiBase . '/oauth/authorize?oauth_token=' . urlencode($token);
}
/**
* High-level API hit: fetch all messages in the network (up to 20 at a time).
* Return data is the full JSON array returned, including meta and references
* sections.
*
* The matching messages themselves will be in the 'messages' item within.
*
* @param array $options optional set of additional params for the request.
* @return array
*
* @throws Exception on low-level or HTTP error
*/
public function messages($params=array())
{
return $this->api('messages', $params);
}
/**
* High-level API hit: fetch all users in the network (up to 50 at a time).
* Return data is the full JSON array returned, listing user items.
*
* The matching messages themselves will be in the 'users' item within.
*
* @param array $options optional set of additional params for the request.
* @return array of JSON-sourced user data arrays
*
* @throws Exception on low-level or HTTP error
*/
public function users($params=array())
{
return $this->api('users', $params);
}
/**
* High-level API hit: fetch all groups in the network (up to 20 at a time).
* Return data is the full JSON array returned, listing user items.
*
* The matching messages themselves will be in the 'users' item within.
*
* @param array $options optional set of additional params for the request.
* @return array of JSON-sourced user data arrays
*
* @throws Exception on low-level or HTTP error
*/
public function groups($params=array())
{
return $this->api('groups', $params);
}
}
|
