-
Notifications
You must be signed in to change notification settings - Fork 5
/
linkedin_api.js
473 lines (432 loc) · 17.2 KB
/
linkedin_api.js
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
var request = require('request');
var Person = require('./persons.js');
var LinkedInApi = module.exports = {};
var _BasicProfileFields = "id,first-name,last-name,headline,location:(name),industry,distance,relation-to-viewer:(related-connections),num-connections,num-connections-capped,summary,specialties,positions,picture-url,picture-urls::(original),site-standard-profile-request,public-profile-url";
var _FullProfileFields = "last-modified-timestamp,associations,interests,publications:(title,publisher,authors:(name),summary,url),patents:(title,summary,inventors:(name),url),languages:(language:(name),proficiency:(level)),skills:(skill:(name)),certifications:(name),educations:(school-name,field-of-study,degree,activities,notes),courses:(name),volunteer:(volunteerExperiences:(role,organization)),three-current-positions,three-past-positions,num-recommenders,recommendations-received:(recommendation-type,recommendation-text,recommender),mfeed-rss-url,job-bookmarks,date-of-birth,member-url-resources,related-profile-views,connections:(id),group-memberships,network";
// skills:(???)
var _ContactInfoFields = "email-address,phone-numbers,im-accounts,main-address,twitter-accounts";
var _AllFields = _BasicProfileFields + "," + _FullProfileFields + "," + _ContactInfoFields;
var _PeopleSearchReturnFields = "(people:(" + _AllFields + "),facets:(code,name,buckets:(code,name,count)))";
// GET /people/search
// call _searchConnections to return paginated array of connections that match the query criteria
// First api call must be synchronous to get total available results
// total result number is compared to max to makes sure no unnecessary api calls are used when there are no remaining pages to fetch
// subsequent api calls for remaining pages can happen concurrently / asynchronously
// Number of connections capped by max, which is defaulted to 50 to avoid accidentially exceeding throttle limit
LinkedInApi.searchConnections = function (session, query, max, degreesArray) {
var deferred = Q.defer();
var promises = [];
max = max || 50;
query.start = query.start || 0;
query.count = query.count || 25;
var output = LinkedInApi._searchConnections(session, query, degreesArray);
promises.push(output);
output.then(
function(data){
if (typeof data === 'string'){
data = JSON.parse(data);
}
max = Math.min(max, data.people._total);
for(var i = query.count; i < max; i+=query.count) {
_(query).extend({start: i}); //pagination
var output = LinkedInApi._searchConnections(session, query);
promises.push(output);
}
Q.all(promises)
.then(
// Resolved
function(data){
data = _(data).map(function(item){
return JSON.parse(item).people.values;
});
data = _(data).flatten(true); //only flatten the first level
console.log('- GET /people/search - flattened length >>>', data.length)
deferred.resolve(JSON.stringify(data));
},
// Rejected
function(error){
deferred.reject(error);
}
);
},
function(error){
deferred.reject(error);
});
return deferred.promise;
};
// GET /people/search
// note: related connections is not available for bulk call, must use .getProfile for each person
// Return the raw data form LinkedIn API without parse out the persons array
// default api max is 25 persons per result page
LinkedInApi._searchConnections = function (session, query, degreesArray) {
console.log('- GET /people/search - searchConnections - query >>');
console.log('- GET /people/search - searchConnections - session.passport.user >>', session.passport.user);
var endPoint = "https://api.linkedin.com/v1",
accessToken = session.passport.user.accessToken,
url = endPoint + "/people-search:" + _PeopleSearchReturnFields,
defaults = {
'first-name': '', // in order to make facet connections return results, empty name fields will return all results
'last-name' : '', // in order to make facet connections return results, empty name fields will return all results
format: 'json',
count: 25, // default page max
start: 0, // specify in query for pagination
sort: 'relevance', // we already have your 1st degree
facets: 'network', // location,industry,school,current-company,past-company
facet: 'network,F,S,A,O' // F first, S second, A groups, O out-of-network(third)
};
var deferred = Q.defer();
query = parseJobQueryForLinkedIn(query, degreesArray);
request({
method: 'GET',
url: url,
qs: _.extend(defaults,
query, {
oauth2_access_token: accessToken,
})
},function(error, response, body){
if (error) {
console.log('- LinkedInApi Server error: ', error);
deferred.reject(error);
} else {
try {
// When throttle limit is exceeded, api does not return error
// so we try / catch that error when we extract persons array if that array was not returned
body = JSON.parse(body);
// Delete Private Profile
body.people.values = body.people.values.length > 0 ? deletePrivateProfiles(body.people.values) : [];
// Tracking # of API calls per user
if(body.people.values.length){
analytics.identify({
userId: session.passport.user.id,
traits: {
name: session.passport.user.displayName
}
});
analytics.track({
userId: session.passport.user.id,
event : "LinkedIn Success - People Search",
properties: {
time: new Date(),
count: body.people._count
}
});
}
// Update/Insert profiles to MongoDB
// _bulkUpsert accept either json or object
Person._bulkUpsert(body.people.values);
// Return json
deferred.resolve(JSON.stringify(body));
} catch (error){
console.log('- LinkedInApi error: ', error, body);
// Tracking API errors
analytics.identify({
userId: session.passport.user.id,
traits: {
name: session.passport.user.displayName
}
});
analytics.track({
userId: session.passport.user.id,
event : "LinkedIn Error - People Search: " + body.message,
properties: {
time: new Date()
}
});
deferred.reject(body.message);
}
}
});
return deferred.promise;
};
// GET /people
// GET all of user's 1st degree connections
// recursively call searchFirstDegree untill all 1st degree connections are fetched
// API calls happen synchronously one after another
// Performance may only suffer when person has thousands of connections
// which is rare
LinkedInApi.searchFirstDegree = function (session, query, personsArray) {
var deferred = Q.defer();
personsArray = personsArray || [];
query = query || {};
query.start = query.start || 0;
query.count = query.count || 500;
LinkedInApi._searchFirstDegree(session, query)
.then(
function(data){
if (typeof data === 'string'){
data = JSON.parse(data);
}
// plucking the persons array from api return data and combine with previously fetched persons
personsArray = personsArray.concat(data.values);
// _total, _start, _count are properties in the api return data
// _total: your total number of connections
// _start: start location for pagination in the previous api call
// _count: number of connections in the prevous api call result
data._count = data._count || data._total;
if((data._start + data._count) >= data._total ){
deferred.resolve(JSON.stringify(personsArray));
}
else{
query.start += 500;
deferred.resolve(LinkedInApi.searchFirstDegree(session, query, personsArray));
}
},
function(error){
deferred.reject(error);
});
return deferred.promise;
};
// GET /people
// GET user's 1st degree connections, default is first 500 connections
// Return the raw data form LinkedIn API without parse out the persons array
LinkedInApi._searchFirstDegree = function (session, query) {
console.log('- GET /people - _searchFirstDegree - for >> ', session.passport.user.id);
var endPoint = "https://api.linkedin.com/v1/people/",
id = session.passport.user.id,
accessToken = session.passport.user.accessToken,
url = endPoint + "id=" + id + "/connections:(" + _BasicProfileFields + ")",
defaults = {
// modified: '', // 'updated' | 'new'
// 'modified-since': '', // Unix time stamp of milliseconds since epoch
format: 'json',
count: 500, // default max
start: 0 // specify different start value in query for pagination
};
var deferred = Q.defer();
request({
method: 'GET',
url: url,
qs: _.extend(defaults,
query, {
oauth2_access_token: accessToken,
})
},function(error, response, body){
if (error) {
console.log('- LinkedInApi Server error: ', error);
deferred.reject(error);
} else {
try {
// When throttle limit is exceeded, api does not return error
// so we try / catch that error when we extract persons array if that array was not returned
body = JSON.parse(body);
// Delete Private Profile
body.values = body.values.length ? deletePrivateProfiles(body.values) : [];
// Tracking # of API calls per user
if(body.values.length){
var count = body._count || body._total;
analytics.identify({
userId: session.passport.user.id,
traits: {
name: session.passport.user.displayName
}
});
analytics.track({
userId: session.passport.user.id,
event : "LinkedIn Success - 1st Degrees",
properties: {
time: new Date(),
count: count
}
});
}
// Update/Insert profiles to MongoDB
// _bulkUpsert accept either json or object
Person._bulkUpsert(body.values);
// Return json
deferred.resolve(JSON.stringify(body));
} catch (error){
console.log('- LinkedInApi error: ', error, body);
// Tracking API errors
analytics.identify({
userId: session.passport.user.id,
traits: {
name: session.passport.user.displayName
}
});
analytics.track({
userId: session.passport.user.id,
event : "LinkedIn Error - 1st Degrees: " + body.message,
properties: {
time: new Date()
}
});
deferred.reject(body.message);
}
}
});
return deferred.promise;
};
// GET /people/:id
LinkedInApi.getProfile = function(session, id){
id = id || session.passport.user.id;
var endPoint = "https://api.linkedin.com/v1/people/",
accessToken = session.passport.user.accessToken,
url = endPoint + 'id=' + id + ":(" + _AllFields + ")",
defaults = {
format: 'json'
};
var deferred = Q.defer();
// event for tracking
var event = "";
if(id === session.passport.user.id){
event = "Get Own Profile";
}else{
event = "Get Other's Profile"
}
request({
method: 'GET',
url: url,
qs: _.extend(defaults, {
oauth2_access_token: session.passport.user.accessToken
})
}, function(error, response, body){
if (error) {
console.log('- LinkedInApi Server error: ', error);
deferred.reject(error);
} else {
try {
body = JSON.parse(body);
// When throttle limit is exceeded, api does not return error
// so we try / catch that error when we extract values that were not returned
if(body.id){
analytics.identify({
userId: session.passport.user.id,
traits: {
name: session.passport.user.displayName
}
});
analytics.track({
userId: session.passport.user.id,
event : "LinkedIn Success - User " + event,
properties: {
time: new Date()
}
});
}
// Update/Insert single profile to MongoDB
// _upsert accept either json or object
Person._upsert(body);
deferred.resolve(body);
} catch (error){
console.log('- LinkedInApi error: ', error, body);
// Tracking API errors
analytics.identify({
userId: session.passport.user.id,
traits: {
name: session.passport.user.displayName
}
});
analytics.track({
userId: session.passport.user.id,
event : "LinkedIn Error - User " + event + " - " + body.message,
properties: {
time: new Date()
}
});
deferred.reject(body.message);
}
}
});
return deferred.promise;
};
// Not Currently Used,
// will be usefull for future release when we want to pass company ids into people/search facets to make results even more relevant to job search
LinkedInApi.searchCompanies = function(session, companyNames) {
console.log('- LinkedInApi.searchCompanies >>');
// var endPoint = "https://api.linkedin.com/v1/companies::(universal-name=convergent-manufacturing-technologies-inc-)",
var endPoint = "https://api.linkedin.com/v1/company-search:(companies:(id,name,universal-name))",
accessToken = session.passport.user.accessToken,
url = endPoint,
defaults = {
keywords: 'composite software',
format: 'json',
count: '110',
sort: 'relevance'
};
var deferred = Q.defer();
request({
method: 'GET',
url: url,
qs: _.extend(defaults,{
oauth2_access_token: accessToken,
})
},function(error, response, body){
if (error) {
deferred.reject(error);
} else {
try {
deferred.resolve(body);
} catch (error){
console.log('- LinkedInApi error: ', error, body);
deferred.reject(body.message);
}
}
});
return deferred.promise;
};
// =============================================
// === Private Helper Functions ===
// =============================================
// for GET people/search, parse job search query to LinkedIn API query formats
// NOTE: currently not using locaiton and distance
var parseJobQueryForLinkedIn = function(query, degreesArray){
// ex: degreesArray = ["first", "second"]
var networkFacetKey = {
first: ",F",
second: ",S",
group: ",A",
third: ",O"
};
var apiQuery = {};
degreesArray = degreesArray || ["first", "second", "group", "third"];
if(query.jobTitle && query.jobTitle.length > 0){
apiQuery.title = orJoinKeywords(query.jobTitle);
}
if(query.company && query.company.length > 0){
apiQuery["company-name"] = orJoinKeywords(query.company);
}
if(query.jobKeywords && query.jobKeywords.length > 0){
apiQuery.keywords = orJoinKeywords(query.jobKeywords);
}
apiQuery.facet = "network";
_.each(degreesArray, function(degree){
apiQuery.facet += networkFacetKey[degree];
});
apiQuery.start = query.start || 0;
apiQuery.count = query.count || 25;
return apiQuery;
};
var orJoinKeywords = function(qArray){
qArray = _.map(qArray, function(item){
return JSON.stringify(item);
});
var qString = "("+ qArray.join(" OR ") + ")";
return qString;
};
// Delete profiles with private id or names, which belong to people who choose not to share their info
// Accept an array of profile objects
var deletePrivateProfiles = function(data){
return _.reject(data, function(person){
return (person.id.toLowerCase() === 'private' || person.lastName.toLowerCase() === 'private' || person.firstName.toLowerCase() === 'private' || person.distance === -1);
});
};
/* query: {
title= ("title1" OR "title name2" OR "title 3")
company-name= ("company1" OR "company name2" OR "company 3")
keywords= ("keyword1" OR "keywords 2" OR "keyword3")
start= [number]
count= [1-25]
facet= "network,F,S,A,O" // F = 1st degree, S = 2nd degree, A = same group, O = 3rd degree/out-of-network
sort= [connections|recommenders|distance|relevance] // connection: # of connection. recommenders: # of recommenders.
facets= [facet codes]
first-name= [first name]
last-name= [last name]
current-title= [true|false]
current-company= [true|false]
school-name= [school name]
current-school= [true|false]
country-code= [country code]
postal-code= [postal code]
distance= [miles]
}
*/