Repository navigation
Expand file tree
/
Copy pathcollection_proxy.py
More file actions
103 lines (76 loc) · 3.09 KB
/
Copy pathcollection_proxy.py
File metadata and controls
103 lines (76 loc) · 3.09 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
# -*- coding: utf-8 -*-
import six
from intercom import HttpError
from intercom import utils
class CollectionProxy(six.Iterator):
def __init__(
self, client, collection_cls, collection,
finder_url, finder_params={}):
self.client = client
# resource name
self.resource_name = utils.resource_class_to_collection_name(collection_cls)
# resource class
self.resource_class = collection_cls
# needed to create class instances of the resource
self.collection_cls = collection_cls
# needed to reference the collection in the response
self.collection = collection
# the original URL to retrieve the resources
self.finder_url = finder_url
# the params to filter the resources
self.finder_params = finder_params
# an iterator over the resources found in the response
self.resources = None
# a link to the next page of results
self.next_page = None
def __iter__(self):
return self
def __next__(self):
if self.resources is None:
# get the first page of results
self.get_first_page()
# try to get a resource if there are no more in the
# current resource iterator (StopIteration is raised)
# try to get the next page of results first
try:
resource = six.next(self.resources)
except StopIteration:
self.get_next_page()
resource = six.next(self.resources)
instance = self.collection_cls(**resource)
return instance
def __getitem__(self, index):
for i in range(index):
six.next(self)
return six.next(self)
def get_first_page(self):
# get the first page of results
return self.get_page(self.finder_url, self.finder_params)
def get_next_page(self):
# get the next page of results
return self.get_page(self.next_page)
def get_page(self, url, params={}):
# get a page of results
# from intercom import Intercom
# if there is no url stop iterating
if url is None:
raise StopIteration
response = self.client.get(url, params)
if response is None:
raise HttpError('Http Error - No response entity returned')
collection = response[self.collection]
# if there are no resources in the response stop iterating
if collection is None:
raise StopIteration
# create the resource iterator
self.resources = iter(collection)
# grab the next page URL if one exists
self.next_page = self.extract_next_link(response)
def paging_info_present(self, response):
return 'pages' in response and 'type' in response['pages']
def extract_next_link(self, response):
if self.paging_info_present(response):
paging_info = response["pages"]
if paging_info["next"]:
next_parsed = six.moves.urllib.parse.urlparse(paging_info["next"])
return '{}?{}'.format(next_parsed.path, next_parsed.query)