/
Pinterest.py
953 lines (809 loc) · 37 KB
/
Pinterest.py
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
import json
import os
import requests
import mimetypes
import requests.cookies
from requests_toolbelt import MultipartEncoder
from bs4 import BeautifulSoup
from py3pin.BookmarkManager import BookmarkManager
from py3pin.Registry import Registry
from py3pin.RequestBuilder import RequestBuilder
from requests.structures import CaseInsensitiveDict
AGENT_STRING = "Mozilla/5.0 (Windows NT 6.1; Win64; x64) " \
"AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36"
# Pinterest endpoints
HOME_PAGE = 'https://www.pinterest.com/'
LOGIN_PAGE = 'https://www.pinterest.com/login/?referrer=home_page'
CREATE_USER_SESSION = 'https://www.pinterest.com/resource/UserSessionResource/create/'
DELETE_USER_SESSION = 'https://www.pinterest.com/resource/UserSessionResource/delete/'
USER_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/UserResource/get'
BOARD_PICKER_RESOURCE = 'https://www.pinterest.com/resource/BoardPickerBoardsResource/get'
BOARDS_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/BoardsResource/get'
CREATE_BOARD_RESOURCE = 'https://www.pinterest.com/resource/BoardResource/create/'
FOLLOW_BOARD_RESOURCE = 'https://www.pinterest.com/resource/BoardFollowResource/create/'
UNFOLLOW_BOARD_RESOURCE = 'https://www.pinterest.com/resource/BoardFollowResource/delete/'
FOLLOW_USER_RESOURCE = 'https://www.pinterest.com/resource/UserFollowResource/create/'
UNFOLLOW_USER_RESOURCE = 'https://www.pinterest.com/resource/UserFollowResource/delete/'
USER_FOLLOWING_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/UserFollowingResource/get'
USER_FOLLOWERS_RESOURCE = 'https://www.pinterest.com/resource/UserFollowersResource/get'
PIN_RESOURCE_CREATE = 'https://www.pinterest.com/resource/PinResource/create/'
REPIN_RESOURCE_CREATE = 'https://www.pinterest.com/resource/RepinResource/create/'
PIN_LIKE_RESOURCE = 'https://www.pinterest.com/resource/PinLikeResource/create/'
PIN_UNLIKE_RESOURCE = 'https://www.pinterest.com/resource/PinLikeResource/delete/'
DELETE_PIN_RESOURCE = 'https://www.pinterest.com/resource/PinResource/delete/'
PIN_COMMENT_RESOURCE = 'https://www.pinterest.com/resource/PinCommentResource/create/'
BOARD_INVITE_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/BoardInviteResource/create/'
BOARD_DELETE_INVITE_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/BoardCollaboratorResource/delete/'
SEARCH_RESOURCE = 'https://www.pinterest.com/resource/SearchResource/get'
BOARD_RECOMMEND_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/BoardContentRecommendationResource/get'
PINNABLE_IMAGES_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/FindPinImagesResource/get'
BOARD_FEED_RESOURCE = 'https://www.pinterest.com/resource/BoardFeedResource/get'
USER_HOME_FEED_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/UserHomefeedResource/get'
BASE_SEARCH_RESOURCE = 'https://www.pinterest.com/resource/BaseSearchResource/get'
BOARD_INVITES_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/BoardInvitesResource/get'
CREATE_COMMENT_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/AggregatedCommentResource/create/'
GET_PIN_COMMENTS_RESOURCE = 'https://www.pinterest.com/_ngjs/resource/AggregatedCommentFeedResource/get'
LOAD_PIN_URL_FORMAT = 'https://www.pinterest.com/pin/{}/'
DELETE_COMMENT = 'https://www.pinterest.com/_ngjs/resource/AggregatedCommentResource/delete/'
CONVERSATION_RESOURCE = 'https://www.pinterest.com/resource/ConversationsResource/get/'
CONVERSATION_RESOURCE_CREATE = 'https://www.pinterest.com/resource/ConversationsResource/create/'
LOAD_CONVERSATION = 'https://www.pinterest.com/resource/ConversationMessagesResource/get/'
SEND_MESSAGE = 'https://www.pinterest.com/resource/ConversationMessagesResource/create/'
BOARD_SECTION_RESOURCE = 'https://www.pinterest.com/resource/BoardSectionResource/create/'
GET_BOARD_SECTIONS = 'https://www.pinterest.com/resource/BoardSectionsResource/get/'
BOARD_SECTION_EDIT_RESOURCE = 'https://www.pinterest.com/resource/BoardSectionEditResource/delete/'
GET_BOARD_SECTION_PINS = 'https://www.pinterest.com/resource/BoardSectionPinsResource/get/'
UPLOAD_IMAGE = 'https://www.pinterest.com/upload-image/'
class Pinterest:
def __init__(self, password='', proxies=None, username='', email='', cred_root='data', user_agent=None):
self.email = email
self.username = username
self.password = password
self.req_builder = RequestBuilder()
self.bookmark_manager = BookmarkManager()
self.http = requests.session()
self.proxies = proxies
self.user_agent = user_agent
data_path = os.path.join(cred_root, self.email) + os.sep
if not os.path.isdir(data_path):
os.makedirs(data_path)
self.registry = Registry('{}registry.dat'.format(data_path))
cookies = self.registry.get(Registry.Key.COOKIES)
if cookies is not None:
self.http.cookies.update(cookies)
if self.user_agent is None:
self.user_agent = AGENT_STRING
def request(self, method, url, data=None, files=None, extra_headers=None):
headers = CaseInsensitiveDict([
('Referer', HOME_PAGE),
('X-Requested-With', 'XMLHttpRequest'),
('Accept', 'application/json'),
('Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8'),
('User-Agent', self.user_agent)])
csrftoken = self.http.cookies.get('csrftoken')
if csrftoken:
headers.update([('X-CSRFToken', csrftoken)])
if extra_headers is not None:
for h in extra_headers:
headers.update([(h, extra_headers[h])])
response = self.http.request(method, url, data=data, headers=headers, files=files, proxies=self.proxies)
response.raise_for_status()
self.registry.update(Registry.Key.COOKIES, response.cookies)
return response
def get(self, url):
return self.request('GET', url=url)
def post(self, url, data=None, files=None, headers=None):
return self.request('POST', url=url, data=data, files=files, extra_headers=headers)
def login(self):
"""
Logs user in with the provided credentials
User session is stored in the 'cred_root' folder
and reused so there is no need to login every time.
Pinterest sessions lasts for about 15 days
Ideally you need to call this method 3-4 times a month at most.
:return python dict object describing the pinterest response
"""
self.get(HOME_PAGE)
self.get(LOGIN_PAGE)
options = {
'username_or_email': self.email,
'password': self.password
}
data = self.req_builder.buildPost(options=options, source_url='/login/?referrer=home_page')
return self.post(url=CREATE_USER_SESSION, data=data)
def logout(self):
"""
Logs current user out. Takes few seconds for the session to be invalidated on pinterest's side
"""
options = {
'disable_auth_failure_redirect': True
}
data = self.req_builder.buildPost(options=options)
return self.post(url=DELETE_USER_SESSION, data=data)
def get_user_overview(self, username=None):
"""
:param username target username, if left blank current user is assumed
:return python dict describing the pinterest user profile response
"""
if username is None:
username = self.username
options = {
"isPrefetch": 'false',
"username": username,
"field_set_key": "profile"
}
url = self.req_builder.buildGet(url=USER_RESOURCE, options=options)
result = self.get(url=url).json()
return result['resource_response']['data']
def boards(self, username=None, page_size=50):
"""
The data returned is chunked, this comes from pinterest'a rest api.
Some users might have huge number of boards that is why it make sense to chunk the data.
In order to obtain all boards this method needs to be called until it returns empty list
:param username: target username, if left blank current user is assumed
:param page_size: controls the batch size for each request
:return python dict describing all the boards of a user.
"""
if username is None:
username = self.username
next_bookmark = self.bookmark_manager.get_bookmark(primary='boards', secondary=username)
options = {
"page_size": page_size,
"privacy_filter": "all",
"sort": "custom",
"username": username,
"isPrefetch": False,
"include_archived": True,
"field_set_key": "profile_grid_item",
"group_by": "visibility",
"redux_normalize_feed": True,
"bookmarks": [next_bookmark]
}
source_url = '/{}/boards/'.format(username)
url = self.req_builder.buildGet(url=BOARDS_RESOURCE, options=options, source_url=source_url)
result = self.get(url=url).json()
bookmark = result['resource']['options']['bookmarks'][0]
self.bookmark_manager.add_bookmark(primary='boards', secondary=username, bookmark=bookmark)
return result['resource_response']['data']
def boards_all(self, username=None):
"""
Obtains all boards of a user.
NOTE: some users might have hube amounts of boards.
In such cases 'boards' method (which is batched) should be used in order to avoid memory issues
:param username: target user, if left blank current user is assumed
:return all boards of a user
"""
boards = []
board_batch = self.boards(username=username)
while len(board_batch) > 0:
boards += board_batch
board_batch = self.boards(username=username)
return boards
def create_board(self, name, description='', category='other', privacy='public', layout='default'):
"""
Creates a new board and returns the response from pinterest.
:param name: board name (should be unique per user)
:param description: board description
:param category: if you have defined categories (it is not visible to external users)
:param privace: can be public or private
:param layout: looks like a legacy parameter but is it mandatory (can be left as
"""
options = {
"name": name,
"description": description,
"category": category,
"privacy": privacy,
"layout": layout,
"collab_board_email": 'true',
"collaborator_invites_enabled": 'true'
}
source_url = '/{}/boards/'.format(self.email)
data = self.req_builder.buildPost(options=options, source_url=source_url)
return self.post(url=CREATE_BOARD_RESOURCE, data=data)
def follow_board(self, board_id):
"""
Follows a board with current user.
:param board_id: the id of the board to follow
:return python dict with the pinterest response
"""
options = {"board_id": board_id}
data = self.req_builder.buildPost(options=options)
return self.post(url=FOLLOW_BOARD_RESOURCE, data=data)
def unfollow_board(self, board_id):
"""
UnFollows a board with current user.
:param board_id: the id of the board to follow
:return python dict with the pinterest response
"""
options = {"board_id": board_id}
data = self.req_builder.buildPost(options=options)
return self.post(url=UNFOLLOW_BOARD_RESOURCE, data=data)
def follow_user(self, user_id):
"""
Follows a user with current user.
:param user_id: the id of the user to follow
:return python dict with the pinterest response
"""
options = {"user_id": user_id}
data = self.req_builder.buildPost(options=options)
return self.post(url=FOLLOW_USER_RESOURCE, data=data)
def unfollow_user(self, user_id):
"""
UnFollows a user with current user.
:param user_id: the id of the user to follow
:return python dict with the pinterest response
"""
options = {"user_id": user_id}
data = self.req_builder.buildPost(options=options)
return self.post(url=UNFOLLOW_USER_RESOURCE, data=data)
def get_following(self, username=None, page_size=250):
"""
Get all users following this particular user.
The response of this method is batched, meaning it needs to be called
until empty list is returned
:param username: target user, if left blank current user is assumed
:param page_size:
:return: python dict describing the 'following' list
"""
if username is None:
username = self.username
next_bookmark = self.bookmark_manager.get_bookmark(primary='following', secondary=username)
if next_bookmark == '-end-':
return []
source_url = '/{}/_following/'.format(self.email)
options = {
'isPrefetch': 'false',
'hide_find_friends_rep': 'false',
'username': username,
'page_size': page_size,
'bookmarks': [next_bookmark]
}
url = self.req_builder.buildGet(url=USER_FOLLOWING_RESOURCE, options=options, source_url=source_url)
result = self.get(url=url).json()
result = result['resource_response']
bookmark = '-end-'
if 'bookmark' in result:
bookmark = result['bookmark']
self.bookmark_manager.add_bookmark(primary='following', secondary=username, bookmark=bookmark)
return result['data']
def get_following_all(self, username=None):
"""
Obtains list of all users that the specified user follows.
NOTE: Some users might have huge following lists.
In such cases using 'get_following' (which is batched) is preferred.
:param username: target username
:return: python dict containing all following
"""
following = []
following_batch = self.get_following(username=username)
while len(following_batch) > 0:
following += following_batch
following_batch = self.get_following(username=username)
return following
def get_user_followers(self, username=None, page_size=250):
"""
Obtains a list of user's followers.
The response from this method is batched, meaning it needs to be called until empty list is returned.
:param username: target username, is left blank current user is assumed
:param page_size: batch size
:return: python dict describing user followers
"""
if username is None:
username = self.username
next_bookmark = self.bookmark_manager.get_bookmark(primary='followers', secondary=username)
if next_bookmark is '-end-':
return []
options = {
'isPrefetch': False,
'hide_find_friends_rep': True,
'username': username,
'page_size': page_size,
'bookmarks': [next_bookmark]
}
source_url = '/{}/_followers/'.format(self.username)
url = self.req_builder.buildGet(url=USER_FOLLOWERS_RESOURCE, options=options, source_url=source_url)
result = self.get(url=url).json()
result = result['resource_response']
bookmark = '-end-'
if 'bookmark' in result:
bookmark = result['bookmark']
self.bookmark_manager.add_bookmark(primary='followers', secondary=username, bookmark=bookmark)
return result['data']
def get_user_followers_all(self, username=None):
"""
Obtains a list of all the followers a user has.
NOTE: Some users might have huge followers lists.
In such cases 'get_user_followers' should be used to avoid memory errors
:param username: target user, is left blank current user is assumed
:return: list of follower objects
"""
followers = []
followers_batch = self.get_user_followers(username=username)
while len(followers_batch) > 0:
followers += followers_batch
followers_batch = self.get_user_followers(username=username)
return followers
def pin(self, board_id, image_url, description='', link='', title='', section_id=None):
"""
Perfoms a pin operation. If you want to upload local image use 'upload_pin'
:param board_id: id of the target board (current user should have rights to pin to is)
:param image_url: web url of an image (not local one)
:param description: pin description (can be blank)
:param link: link to include (can be blank)
:param title: title can be blank
:param section_id: board section should be previously defined and its optional
:return: python dict describing the pinterest response
"""
options = {
"board_id": board_id,
"image_url": image_url,
"description": description,
"link": link if link else image_url,
"scrape_metric": {"source": "www_url_scrape"},
"method": "scraped",
"title": title,
"section": section_id
}
source_url = '/pin/find/?url={}'.format(self.req_builder.url_encode(image_url))
data = self.req_builder.buildPost(options=options, source_url=source_url)
return self.post(url=PIN_RESOURCE_CREATE, data=data)
def upload_pin(self, board_id, image_file, description='', link='', title='', section_id=None):
"""
This method is simmilar to 'pin' except the image for the pin is local file.
"""
image_url = self._upload_image(image_file=image_file).json()['image_url']
return self.pin(board_id=board_id, description=description, image_url=image_url, link=link, title=title,
section_id=section_id)
def repin(self, board_id, pin_id, section_id=None):
"""
Repin/Save action
:param board_id: board id, current user should have right to pin to this board
:param pin_id: pin id to repin
:param section_id: board section should be previously defined and its optional
:return: python dict describing the pinterest response
"""
options = {
"board_id": board_id,
"pin_id": pin_id,
"section": section_id,
"is_buyable_pin": False
}
source_url = '/pin/{}/'.format(pin_id)
data = self.req_builder.buildPost(options=options, source_url=source_url)
return self.post(url=REPIN_RESOURCE_CREATE, data=data)
def _upload_image(self, image_file):
file_name = os.path.basename(image_file)
mime_type = mimetypes.guess_type(image_file)[0]
form_data = MultipartEncoder(fields={
'img': ('%s' % file_name, open(image_file, 'rb'), mime_type)
})
headers = {
'Content-Length': '%s' % form_data.len,
'Content-Type': form_data.content_type,
'X-UPLOAD-SOURCE': 'pinner_uploader'
}
return self.post(url=UPLOAD_IMAGE, data=form_data, headers=headers)
def delete_pin(self, pin_id):
"""
Deletes a pint the user owne
:param pin_id: pin id to delete
:return: python dict describing the pinterest response
"""
options = {"id": pin_id}
source_url = '/{}/'.format(self.username)
data = self.req_builder.buildPost(options=options, source_url=source_url)
return self.post(url=DELETE_PIN_RESOURCE, data=data)
def comment(self, pin_id, text):
"""
Put comment on a pin
:param pin_id: pin id to comment on
:param text: text of the comment
:return: python dict describing the pinterest response
"""
pin_data = self.load_pin(pin_id=pin_id)
options = {
"objectId": pin_data['aggregated_pin_data']['id'],
"pinId": pin_id,
"tags": "[]",
"text": text
}
data = self.req_builder.buildPost(options=options, source_url=pin_id)
return self.post(url=CREATE_COMMENT_RESOURCE, data=data)
def load_pin(self, pin_id):
"""
Loads full information about a pin
:param pin_id: pin id to load
:return: python dict describing the pinterest response
"""
resp = self.get(url=LOAD_PIN_URL_FORMAT.format(pin_id))
soup = BeautifulSoup(resp.text, 'html.parser')
scripts = soup.findAll('script')
pin_data = {}
for s in scripts:
if 'pins' in s.text and 'aggregated_pin_data' in s.text:
pin_data = json.loads(s.text)
return pin_data['pins'][str(pin_id)]
def get_comments(self, pin_id, page_size=50):
"""
Get comments on a pin.
The response is batched, meaning this method should be called util empty list is returned
:param pin_id: target pin id
:param page_size: batch size
:return: list of comment objects
"""
pin_data = self.load_pin(pin_id=pin_id)
next_bookmark = self.bookmark_manager.get_bookmark(primary='pin_comments', secondary=pin_id)
if next_bookmark == '-end-':
return []
options = {
"isPrefetch": False,
"objectId": pin_data['aggregated_pin_data']['id'],
"page_size": page_size,
"redux_normalize_feed": True,
"bookmarks": [next_bookmark]
}
source_url = '/pin/{}/'.format(pin_id)
url = self.req_builder.buildGet(url=GET_PIN_COMMENTS_RESOURCE, options=options, source_url=source_url)
resp = self.get(url=url).json()
resp = resp['resource_response']
bookmark = '-end-'
if 'bookmark' in resp:
bookmark = resp['bookmark']
self.bookmark_manager.add_bookmark(primary='pin_comments', secondary=pin_id, bookmark=bookmark)
return resp['data']
def get_comments_all(self, pin_id):
"""
Obtains all comments of a pin.
NOTE: IF pin has too many comments this might cause memory issues.
In such cases use 'get_comments' which is batched
:param pin_id:
:return: list of comment objects
"""
results = []
search_batch = self.get_comments(pin_id=pin_id)
while len(search_batch) > 0:
results += search_batch
search_batch = self.get_comments(pin_id=pin_id)
return results
def delete_comment(self, pin_id, comment_id):
"""
Deletes a comment
:param pin_id: pin id to search the comment in
:param comment_id: comment id
:return:
"""
options = {"commentId": comment_id}
source_url = "/pin/{}/".format(pin_id)
data = self.req_builder.buildPost(options=options, source_url=source_url)
return self.post(url=DELETE_COMMENT, data=data)
def invite(self, board_id, user_id):
"""
Invite a user to one of the current users boards
:param board_id: board to invite to
:param user_id: user to invite
:return: python dict describing the pinterest response
"""
options = {"board_id": board_id, "invited_user_ids": [user_id]}
data = self.req_builder.buildPost(options=options)
return self.post(url=BOARD_INVITE_RESOURCE, data=data)
def get_board_invites(self, board_id, page_size=100):
"""
Returns a list of users invited to the specified board.
This method is batched and needs to be called until empty list is returned.
:param board_id: id of target board
:param page_size: batch size
:return: list of board objects
"""
options = {
"isPrefetch": False,
"board_id": board_id,
"sort": "viewer_first",
"field_set_key": "boardEdit",
"status_filters": "new,accepted,contact_request_not_approved,pending_approval",
"include_inactive": True,
"page_size": page_size
}
url = self.req_builder.buildGet(url=BOARD_INVITES_RESOURCE, options=options)
resp = self.get(url=url).json()
return resp['resource_response']['data']
def get_board_invites_all(self, board_id):
"""
Obtains all invites of a board.
NOTE: If board has too many invites this might cause memory issues.
In such cases use 'get_board_invites' which is batched
:param board_id:
:return: list of board invite objects
"""
results = []
search_batch = self.get_board_invites(board_id=board_id)
while len(search_batch) > 0:
results += search_batch
search_batch = self.get_board_invites(board_id=board_id)
return results
def delete_invite(self, board_id, invited_user_id, also_block=False):
"""
Deletes invite for a board
:param board_id: board id
:param invited_user_id: invited user id
:param also_block: you can also block the user (default false)
:return: python dict describing the pinterest response
"""
options = {
"ban": also_block,
"board_id": board_id,
"field_set_key": "boardEdit",
"invited_user_id": invited_user_id
}
data = self.req_builder.buildPost(options=options)
return self.post(url=BOARD_DELETE_INVITE_RESOURCE, data=data)
def search(self, scope, query, page_size=250):
"""
Gives access to pinterest search api
This method is batched, meaning is needs to be called until empty list is returned.
NOTE: there is a max number of results set by Pinterest -> 1000
:param scope: can be pins, buyable_pins, my_pins, videos, boards
:param query: search phrase
:param page_size: batch size
:return: list of search results
"""
next_bookmark = self.bookmark_manager.get_bookmark(primary='search', secondary=query)
if next_bookmark == '-end-':
return []
terms = query.split(' ')
escaped_query = "%20".join(terms)
term_meta_arr = []
for t in terms:
term_meta_arr.append('term_meta[]=' + t)
term_arg = "%7Ctyped&".join(term_meta_arr)
source_url = '/search/{}/?q={}&rs=typed&{}%7Ctyped'.format(scope, escaped_query, term_arg)
options = {
"isPrefetch": False,
"auto_correction_disabled": False,
"query": query,
"redux_normalize_feed": True,
"rs": "typed",
"scope": scope,
"page_size": page_size,
"bookmarks": [next_bookmark]
}
url = self.req_builder.buildGet(url=BASE_SEARCH_RESOURCE, options=options, source_url=source_url)
resp = self.get(url=url).json()
bookmark = resp['resource']['options']['bookmarks'][0]
self.bookmark_manager.add_bookmark(primary='search', secondary=query, bookmark=bookmark)
return resp['resource_response']['data']['results']
def board_recommendations(self, board_id='', page_size=50):
"""
This gives the list of pins you see when you open a board and click on 'More Ideas'
This method is batched and needs to be called until empty list is returned in order to obtain all
of the results.
:param board_id: target board id
:param page_size: batch size
:return:
"""
next_bookmark = self.bookmark_manager.get_bookmark(primary='boards', secondary=board_id)
if next_bookmark == '-end-':
return []
options = {
"isPrefetch": False,
"type": "board",
"id": board_id,
"page_size": page_size,
"bookmarks": [next_bookmark]
}
url = self.req_builder.buildGet(url=BOARD_RECOMMEND_RESOURCE, options=options)
response = self.get(url=url).json()
bookmark = response['resource']['options']['bookmarks'][0]
self.bookmark_manager.add_bookmark(primary='boards', secondary=board_id, bookmark=bookmark)
return response['resource_response']['data']
def get_pinnable_images(self, url):
"""
Simple API pinterest uses to suggest images from site.
"""
options = {"isPrefetch": 'false',
"url": url,
"source": "pin_create",
"appendItems": 'false',
"followRedirects": 'true'
}
url = self.req_builder.buildGet(url=PINNABLE_IMAGES_RESOURCE, source_url='/pin-builder/', options=options)
res = self.get(url=url).json()
res = res['resource_response']['data']['items']
urls = []
for item in res:
if 'url' in item:
urls.append(item['url'])
return urls
def home_feed(self, page_size=100):
"""
This gives the list of pins you see when you open the pinterest home page.
This method is batched, in order to obtain all home feed items
it needs to be called until empty list is returned
:param page_size:
:return:
"""
next_bookmark = self.bookmark_manager.get_bookmark(primary='home_feed')
if next_bookmark == '-end-':
return []
options = {
"bookmarks": [next_bookmark],
"isPrefetch": False,
"field_set_key": "hf_grid_partner",
"in_nux": False,
"prependPartner": True,
"prependUserNews": False,
"static_feed": False,
"page_size": page_size
}
url = self.req_builder.buildGet(url=USER_HOME_FEED_RESOURCE, options=options)
response = self.get(url=url).json()
bookmark = '-end-'
if 'bookmark' in response['resource_response']:
bookmark = response['resource_response']['bookmark']
self.bookmark_manager.add_bookmark(primary='home_feed', bookmark=bookmark)
return response['resource_response']['data']
def board_feed(self, board_id='', page_size=250):
"""
Gives a list of all pins in a board.
This method is batched, meaning in order to obtain all pins in a board you need
to call it until empty list is returned.
"""
next_bookmark = self.bookmark_manager.get_bookmark(primary='board_feed', secondary=board_id)
if next_bookmark == '-end-':
return []
options = {
"isPrefetch": False,
"board_id": board_id,
"field_set_key": "partner_react_grid_pin",
"filter_section_pins": True,
"layout": "default",
"page_size": page_size,
"redux_normalize_feed": True,
"bookmarks": [next_bookmark]
}
url = self.req_builder.buildGet(url=BOARD_FEED_RESOURCE, options=options)
response = self.get(url=url).json()
bookmark = response['resource']['options']['bookmarks'][0]
self.bookmark_manager.add_bookmark(primary='board_feed', secondary=board_id, bookmark=bookmark)
return response['resource_response']['data']
def initiate_conversation(self, user_ids, message='hi'):
"""
Initiates a new conversation with one or more users
:return: python dict object describing the pinterest response
"""
options = {
"user_ids": user_ids,
"text": message
}
data = self.req_builder.buildPost(options=options)
return self.post(url=CONVERSATION_RESOURCE_CREATE, data=data)
def send_message(self, message='', conversation_id='', pin_id=''):
"""
Sends a new mesage to an already initiated conversation
"""
options = {
"conversation_id": conversation_id,
"text": message,
"pin": pin_id
}
data = self.req_builder.buildPost(options=options)
return self.post(url=SEND_MESSAGE, data=data)
def load_conversation(self, conversation_id=''):
"""
Loads a list of all messages in a conversation
"""
messages = []
message_batch = self._load_conversation_batch(conversation_id=conversation_id)
while len(message_batch) > 0:
messages += message_batch
message_batch = self._load_conversation_batch(conversation_id=conversation_id)
return messages
def _load_conversation_batch(self, conversation_id='', page_size=25):
next_bookmark = self.bookmark_manager.get_bookmark(primary='conversations', secondary=conversation_id)
if next_bookmark == '-end-':
return []
options = {
"isPrefetch": False,
"page_size": page_size,
"conversation_id": conversation_id,
"bookmarks": [next_bookmark]
}
url = self.req_builder.buildGet(url=LOAD_CONVERSATION, options=options)
response = self.get(url=url).json()
bookmark = response['resource']['options']['bookmarks'][0]
self.bookmark_manager.add_bookmark(primary='conversations', secondary=conversation_id, bookmark=bookmark)
return response['resource_response']['data']
def get_conversations(self):
"""
Loads a list of all conversations the current user has
"""
conversations = []
conv_batch = self._get_conversation_batch()
while len(conv_batch) > 0:
conversations += conv_batch
conv_batch = self._get_conversation_batch()
return conversations
def _get_conversation_batch(self):
next_bookmark = self.bookmark_manager.get_bookmark(primary='conversations')
if next_bookmark == '-end-':
return []
options = {
"isPrefetch": False,
"field_set_key": "default",
"bookmarks": [next_bookmark]
}
url = self.req_builder.buildGet(url=CONVERSATION_RESOURCE, options=options)
response = self.get(url=url).json()
next_bookmark = response['resource']['options']['bookmarks'][0]
self.bookmark_manager.add_bookmark(primary='conversations', bookmark=next_bookmark)
return response['resource_response']['data']
def create_board_section(self, board_id='', section_name=''):
"""
Creates a new section in a board the current user owns
"""
options = {
"board_id": board_id,
"initial_pins": [],
"name": section_name,
"name_source": 0
}
data = self.req_builder.buildPost(options=options)
return self.post(url=BOARD_SECTION_RESOURCE, data=data)
def get_board_sections(self, board_id='', reset_bookmark=False):
"""
Obtains a list of all sections of a board
"""
next_bookmark = self.bookmark_manager.get_bookmark(primary='board_sections', secondary=board_id)
if next_bookmark == '-end-':
if reset_bookmark:
self.bookmark_manager.reset_bookmark(primary='board_sections', secondary=board_id)
return []
options = {
"isPrefetch": False,
"board_id": board_id,
"redux_normalize_feed": True,
"bookmarks": [next_bookmark]
}
url = self.req_builder.buildGet(url=GET_BOARD_SECTIONS, options=options)
response = self.get(url=url).json()
bookmark = response['resource']['options']['bookmarks'][0]
self.bookmark_manager.add_bookmark(primary='board_sections', secondary=board_id, bookmark=bookmark)
return response['resource_response']['data']
def get_section_pins(self, section_id='', page_size=250, reset_bookmark=False):
"""
Returns a list of all pins in a board section.
This method is batched meaning in order to obtain all pins in the section
you need to call is until empty list is returned
"""
next_bookmark = self.bookmark_manager.get_bookmark(primary='section_pins', secondary=section_id)
if next_bookmark == '-end-':
if reset_bookmark:
self.bookmark_manager.reset_bookmark(primary='section_pins', secondary=section_id)
return []
options = {
"isPrefetch": False,
"field_set_key": "react_grid_pin",
"is_own_profile_pins": True,
"page_size": page_size,
"redux_normalize_feed": True,
"section_id": section_id,
"bookmarks": [next_bookmark]
}
url = self.req_builder.buildGet(url=GET_BOARD_SECTION_PINS, options=options)
response = self.get(url=url).json()
bookmark = response['resource']['options']['bookmarks'][0]
self.bookmark_manager.add_bookmark(primary='section_pins', secondary=section_id, bookmark=bookmark)
data = response['resource_response']['data']
pins = []
for d in data:
if 'pinner' in d:
pins.append(d)
return pins
def delete_board_section(self, section_id=''):
"""
Deletes a board section by id
"""
options = {
"section_id": section_id
}
data = self.req_builder.buildPost(options=options)
return self.post(url=BOARD_SECTION_EDIT_RESOURCE, data=data)