-
Notifications
You must be signed in to change notification settings - Fork 4
/
changeorgapi.js
2078 lines (1758 loc) · 43.4 KB
/
changeorgapi.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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* ChangeOrgApiUtils
*
* Common utilities.
*
* @package ChangeOrgApi
* @author Rick Buczynski <richard.buczynski@gmail.com>
*/
var ChangeOrgApiUtils={
debugMode: false,
lastTimestamp: 0,
proxy: '',
/**
* Append query parameters to the given URL.
*
* @param string url
* @param mixed params
* @return string
*/
addParams: function(url,params) {
if(typeof url=='string') {
var body=[], parts=url.split('?');
if(typeof params=='string')
params=this.expandRequest(params);
if(parts.length>1)
params=this.extend(this.expandRequest(parts.pop()),params || {});
for(var key in params)
body.push(key+'='+encodeURIComponent(params[key]));
return url.split('?').shift()+'?'+body.join('&');
}
},
/**
* Bind values to the given input.
*
* @param string input
* @param mixed data
* @return string
*/
bind: function(input,data) {
if(typeof data!='object')
data=[data];
if(typeof input=='string' && typeof data=='object') {
for(var key in data) {
if(data instanceof Array)
input=input.replace(new RegExp(':[a-zA-Z0-9_]+'),new String(data[key]));
else
input=input.replace(new RegExp(':'+key,'g'),new String(data[key]));
}
}
return input;
},
/**
* Expand a request body into an object.
*
* @param string data
* @param object targetForm
* @return object
*/
expandRequest: function(data,targetForm) {
var parts=data.split('&'), pair, data={};
for(var i=0;i<parts.length;i++) {
if(!parts[0])
continue;
pair=parts[i].split('=');
data[pair[0]]=decodeURIComponent(pair[1]);
if(targetForm) {
var element=document.createElement('input');
element.type='hidden';
element.name=pair[0];
element.value=data[pair[0]];
targetForm.appendChild(element);
}
}
return data;
},
/**
* Merge multiple 1-dimensional objects.
*
* @return object
*/
extend: function() {
var objects=arguments, object={};
for(var i=0;i<objects.length;i++) {
if(objects[i]) {
for(var property in objects[i])
object[property]=objects[i][property];
}
}
return object;
},
/**
* Generate a unique key.
*
* @param string prefix
* @param string suffix
* @return string
*/
getKey: function(prefix,suffix) {
if(!prefix)
prefix='';
if(!suffix)
suffix='';
var min=(this.lastTimestamp?this.lastTimestamp:(new Date()).getTime()),
max=this.lastTimestamp=(new Date()).getTime()+1;
return prefix+(Math.floor(Math.random()*(max-min+1))+min).toString()+suffix;
},
/**
* Generic use lambda.
*
* @return void
*/
lamda: function() { },
};/**
* ChangeOrgApiException
*
* Library exception wrapper.
*
* @package ChangeOrgApi
* @author Rick Buczynski <richard.buczynski@gmail.com>
*/
var ChangeOrgApiException=function(message) {
return {
name : 'ChangeOrgApiException',
'message' : message,
toString : function() {
return this.name+': '+this.message;
}
};
};/**
* ChangeOrgApiClient
*
* A standardized object for transporting Change.org API developer credentials.
*
* @see https://github.com/change/api_docs/blob/master/v1/documentation/authentication.md
*
* @package ChangeOrgApi
* @author Rick Buczynski <richard.buczynski@gmail.com>
*/
var ChangeOrgApiClient=function(data) {
this._data={};
/**
* Get default client properties.
*
* @return object
*/
this._getDefaults=function() {
return {
api_key : '',
secret : ''
};
};
/**
* Get the client API key.
*
* @return string
*/
this.getApiKey=function() {
return this._data.api_key;
};
/**
* Get the client secret.
*
* @return string
*/
this.getSecret=function() {
return this._data.secret;
};
/**
* Set the client API key.
*
* @param string apiKey
* @return ChangeOrgApiClient
*/
this.setApiKey=function(apiKey) {
this._data[api_key]=apiKey;
return this;
};
/**
* Set the client secret.
*
* @param string secret
* @return ChangeOrgApiClient
*/
this.setSecret=function(secret) {
this._data[secret]=secret;
return this;
};
/**
* Initialization
******************/
this._data=this._getDefaults();
if(typeof data=='object') {
for(var key in data) {
this._data[key]=data[key];
}
}
};/**
* ChangeOrgApiPetitionConnection
*
* A standardized connection object for interacting with the Change.org API.
*
* @package ChangeOrgApi
* @author Rick Buczynski <richard.buczynski@gmail.com>
*/
var ChangeOrgApiConnection=function(options) {
this._api='https://api.change.org';
this._data={};
/* @var _connection XMLHttpRequest */
this._connection=null;
this._params={};
this._proxy='';
/**
* Get default connection options.
*
* @return object
*/
this._getDefaults=function() {
return {
content_type : 'application/x-www-form-urlencoded',
endpoint : '',
method : 'GET',
onSuccess : ChangeOrgApiUtils.lambda
};
};
/**
* Get the real [full] endpoint as a URL.
*
* @param boolean endpointOnly
* @return string
*/
this._getEndpoint=function(endpointOnly) {
var params=[];
for(var key in this._params)
params.push(key+'='+encodeURIComponent(this._params[key]));
params=(params.length?'?':'')+params.join('&');
return (
(endpointOnly?'':this._api)
+this._data.endpoint
+params
);
};
/**
* Get the proxy URL for the given request.
*
* @param object data
* @return string
*/
this._getEndpointProxied=function(data) {
return ChangeOrgApiUtils.addParams(this._proxy,{
r : this._getEndpoint(),
p : data,
m : this._data.method,
c : this._data.content_type,
d : ChangeOrgApiUtils.debugMode?'1':'0'
});
};
/**
* Create a new connection.
*
* @param object data
* @return XMLHttpRequest
*/
this._getXmlHttpRequest=function(data) {
var object=new XMLHttpRequest();
var self=this;
object.onreadystatechange=function() {
if(self.getIsDone()) {
var response=new ChangeOrgApiResponse(self);
data.onSuccess.call(null,response);
}
};
return object;
};
/**
* Prepare the connection.
*
* @return ChangeOrgApiConnection
*/
this._prepareConnection=function() {
this._connection=this._getXmlHttpRequest(this._data);
return this;
};
/**
* Get the underlying connection object.
*
* @return XMLHttpRequest
*/
this.getConnection=function() {
return this._connection;
};
/**
* Get the request content type.
*
* @return string
*/
this.getContentType=function() {
return this._data.content_type;
};
/**
* Get the request endpoint.
*
* @param boolean withParams
* @return string
*/
this.getEndpoint=function(withParams) {
return (withParams?this._getEndpoint(true):this._data.endpoint);
};
/**
* Check if the request headers have been received.
*
* @return boolean
*/
this.getHasReceivedHeaders=function() {
return (this._connection.readyState===2);
};
/**
* Check if the request has completed.
*
* @return boolean
*/
this.getIsDone=function() {
return (this._connection.readyState===4);
};
/**
* Check if the request is loading.
*
* @return boolean
*/
this.getIsLoading=function() {
return (this._connection.readyState===3);
};
/**
* Check if the request has been opened.
*
* @return boolean
*/
this.getIsOpened=function() {
return (this._connection.readyState===1);
};
/**
* Check if the request has not been sent.
*
* @return boolean
*/
this.getIsUnsent=function() {
return (this._connection.readyState===0);
};
/**
* Get the request method.
*
* @return string
*/
this.getMethod=function() {
return this._data.method;
};
/**
* Get the request success handler.
*
* @return function
*/
this.getOnSuccess=function() {
return this._data.onSuccess;
};
/**
* Get the request URL parameters.
* @return object
*/
this.getParams=function() {
return this._params;
};
/**
* Get the parsed response.
*
* @return object|null
*/
this.getResponse=function() {
var response=null;
try {
response=JSON.parse(this._connection.responseText);
}
catch(error) {
response=null;
}
return response;
};
/**
* Get the raw connection ready state.
*
* @return number
*/
this.getReadyState=function() {
return this._connection.readyState;
};
/**
* Get the connection status.
*
* @return string
*/
this.getStatus=function() {
return this._connection.status;
}
/**
* Send the request.
*
* @param string data
* @return ChangeOrgApiConnection
*/
this.send=function(data) {
if(!this._connection || this.getIsUnsent())
this._prepareConnection();
if(!this.getIsOpened()) {
var endpoint=this._getEndpoint();
if(this._proxy) {
endpoint=this._getEndpointProxied(data);
this._data.method='GET';
}
this._connection.open(this._data.method,endpoint,true);
}
if(this._connection.setRequestHeader)
this._connection.setRequestHeader('Content-type',this._data.content_type);
this._connection.send(data);
return this;
};
/**
* Set the API URL.
*
* @param string url
*/
this.setApi=function(url) {
this._api=url;
return this;
}
/**
* Set the request content type.
*
* @param string contentType
* @return ChangeOrgApiConnection
*/
this.setContentType=function(contentType) {
this._data.content_type=contentType;
return this;
};
/**
* Set the request endpoint.
*
* @param string endpoint
* @param object params
* @return ChangeOrgApiConnection
*/
this.setEndpoint=function(endpoint,params) {
this._data.endpoint=endpoint;
if(typeof params=='object')
this._params=params;
return this;
};
/**
* Set the request method.
*
* @param string method
* @return ChangeOrgApiConnection
*/
this.setMethod=function(method) {
this._data.method=method.toUpperCase();
return this;
};
/**
* Set the request success handler.
*
* @param object callback
* @return ChangeOrgApiConnection
*/
this.setOnSuccess=function(callback) {
if(typeof callback=='function')
this._data.onSuccess=callback;
return this;
};
/**
* Set the request URL parameters.
*
* @param object params
* @return ChangeOrgApiConnection
*/
this.setParams=function(params) {
this._params=params;
return this;
};
/**
* Initialization
******************/
this._data=this._getDefaults();
if(typeof options=='object') {
for(var key in options) {
if(typeof this._data[key]!='undefined')
this._data[key]=options[key];
}
}
if(ChangeOrgApiUtils.proxy)
this._proxy=ChangeOrgApiUtils.proxy;
};/**
* ChangeOrgApiRequest
*
* A standardized request object for interacting with the Change.org API.
*
* @package ChangeOrgApi
* @author Rick Buczynski <richard.buczynski@gmail.com>
*/
var ChangeOrgApiRequest=function(client) {
/* @var _authKey string */
this._authKey=null;
/* @var _connection ChangeOrgApiConnection */
this._connection=null;
this._data={};
this._useSignature=true;
this._useAuthKeyInSignature=true;
/**
* Get default options.
*
* @return object
*/
this._getDefaults=function() {
return {
api_key : '',
endpoint : '',
timestamp : ''
};
};
/**
* Add client information to the request.
*
* @return ChangeOrgApiRequest
*/
this.addClient=function() {
this._data.api_key=this._client.getApiKey();
return this;
};
/**
* Add bulk data to the request. Overwrites existing data.
*
* @param object data
*/
this.addData=function(data) {
if(typeof this._data=='object') {
for(var key in data) {
if(key=='auth_key')
this.setAuthKey(data[key]);
else
this._data[key]=data[key];
}
}
return this;
};
/**
* Sign the request and add the signature as a parameter.
*
* @see https://github.com/change/api_docs/blob/master/v1/documentation/requests.md#request-signature
*
* @return ChangeOrgApiRequest
*/
this.addSignature=function() {
try {
if(!this.getClient().getSecret() && this.getSignatureRequiredFlag()) { // Mark signature with flag to sign server-side
this._data.server_sign=1;
this._data.include_auth_key=this.getSignatureAuthKeyRequiredFlag()?1:0;
if(this._data.include_auth_key)
this._data.auth_key=this._authKey;
}
else if(typeof this._data.rsig=='undefined' || !this._data.rsig.length) {
var body=[], signature='';
for(var key in this._data) {
if(key!='rsig')
body.push(key+'='+encodeURIComponent(this._data[key]));
}
this._data.rsig=
CryptoJS.SHA256(
body.join('&')
+this.getClient().getSecret()
+(this._useAuthKeyInSignature===true?this._authKey:'')
);
}
}
catch(error) { }
return this;
};
/**
* Add the timestamp to the request.
*
* @return ChangeOrgApiRequest
*/
this.addTimestamp=function() {
this._data.timestamp=this.newTimestamp();
return this;
};
/**
* Build the request body.
*
* @return string
*/
this.buildRequest=function() {
this.addClient();
this.addTimestamp();
if(this._useSignature===true)
this.addSignature();
else if(typeof this._data.rsig!='undefined')
delete this._data.rsig;
var body=[];
for(var key in this._data)
body.push(key+'='+encodeURIComponent(this._data[key]));
return body.join('&');
};
/**
* Get the stored authorization key.
*
* @return string|null
*/
this.getAuthKey=function() {
return this._authKey;
};
/**
* Get the stored client instance.
*
* @return ChangeOrgApiClient
*/
this.getClient=function() {
return this._client;
};
/**
* Get the resource connection.
*
* @param object options
* @return ChangeOrgApiConnection
*/
this.getConnection=function(options) {
if(!this._connection)
this._connection=new ChangeOrgApiConnection(options);
return this._connection;
};
/**
* Get request data.
*
* @param string key
* @return mixed
*/
this.getData=function(key) {
if(!key)
return this._data;
if(typeof this._data[key]!='undefined')
return this._data[key];
return null;
};
/**
* Get the request endpoint.
*
* @return string
*/
this.getEndpoint=function() {
return this._data.endpoint;
};
/**
* Get the request connection method.
*
* @return string
*/
this.getMethod=function() {
return this.getConnection().getMethod();
};
/**
* Get the authorization key signature flag.
*
* @return boolean
*/
this.getSignatureAuthKeyRequiredFlag=function() {
return this._useAuthKeyInSignature;
};
/**
* Get the signature flag.
*
* @return boolean
*/
this.getSignatureRequiredFlag=function() {
return this._useSignature;
};
/**
* Get the request timestamp.
*
* @return string
*/
this.getTimestamp=function() {
return this._data.timestamp;
};
/**
* Generate a new ISO-8601 timestamp.
*
* @return string
*/
this.newTimestamp=function() {
return (new Date()).toISOString().replace(/(\.[0-9]+)/,'');
};
/**
* Reset the connection object.
*
* @return ChangeOrgApiRequest
*/
this.resetConnection=function() {
this._connection=null;
return this;
};
/**
* Remove the signature from the request.
*
* @return ChangeOrgApiRequest
*/
this.removeSignature=function() {
if(typeof this._data.rsig!='undefined')
delete this._data.rsig;
return this;
};
/**
* Submit the request.
*
* @return ChangeOrgApiRequest
*/
this.send=function() {
var connection=this.getConnection();
connection.setEndpoint(this._data.endpoint);
if(this._doFollowup===true)
this._setFollowupCallback();
this.getConnection().send(this.buildRequest());
return this;
};
/**
* Set the authorization key.
*
* @param string authKey
* @return ChangeOrgApiRequest
*/
this.setAuthKey=function(authKey) {
this._authKey=authKey;
return this;
};
/**
* Set the client.
*
* @param ChangeOrgApiClient client
*/
this.setClient=function(client) {
if(!(client instanceof ChangeOrgApiClient))
throw new ChangeOrgApiException('Client must be an instance of ChangeOrgApiClient.');
this._client=client;
return this;
};
/**
* Set request data.
*
* @param string key
* @param mixed value
*/
this.setData=function(key,value) {
this._data[key]=value;
return this;
};
/**
* Set the request endpoint.
*
* @param string endpoint
*/
this.setEndpoint=function(endpoint) {
this._data.endpoint=endpoint;
return this;
};
/**
* Set the request connection method.
*
* @param string method
* @return ChangeOrgApiRequest
*/
this.setMethod=function(method) {
this.getConnection().setMethod(method);
return this;
};
/**
* Set the request success handler.
*
* @param function handler
* @return ChangeOrgApiRequest
*/
this.setOnSuccess=function(handler) {
this.getConnection().setOnSuccess(handler);
return this;
};
/**
* Set the authorization key signature flag.
*
* @param boolean bool
* @return ChangeOrgApiRequest
*/
this.setSignatureAuthKeyRequiredFlag=function(bool) {
this._useAuthKeyInSignature=bool;
return this;
};
/**
* Set the signature flag.
*
* @param boolean bool
* @return ChangeOrgApiRequest
*/
this.setSignatureRequiredFlag=function(bool) {
this._useSignature=bool;
return this;
};
/**
* Set the request timestamp.
*
* @param string timestamp
* @return ChangeOrgApiRequest
*/
this.setTimestamp=function(timestamp) {
this._data.timestamp=timestamp;
return this;
};
/**
* Unset request data
* @param string key
* @return ChangeOrgApiRequest
*/
this.unsetData=function(key) {
if(typeof this._data[key]!='undefined')
delete this._data[key];
return this;
};
/**
* Initialization
******************/
if(typeof CryptoJS=='undefined')
throw new ChangeOrgApiException('ChangeOrgApiRequest cannot initialize because the required library CryptoJS was not found.');
if(client)
this.setClient(client);
this._data=this._getDefaults();
};/**
* ChangeOrgApiResponse
*
* A request response wrapper object.