58 | Please activate JavaScript to enable the search 59 | functionality. 60 |
61 |63 | From here you can search these documents. Enter your search 64 | words into the box below and click "search". Note that the search 65 | function will automatically search for all of the words. Pages 66 | containing fewer words won't appear in the result list. 67 |
68 | 73 | 74 || 59 | t | ||
| 63 | |
64 | ticketpy | 65 | |
| 68 | |
69 | ticketpy.client | 70 | |
| 73 | |
74 | ticketpy.model | 75 | |
| 78 | |
79 | ticketpy.query | 80 | |
Contents:
54 |' + _('Hide Search Matches') + '
') 207 | .appendTo($('#searchbox')); 208 | } 209 | }, 210 | 211 | /** 212 | * init the domain index toggle buttons 213 | */ 214 | initIndexTable : function() { 215 | var togglers = $('img.toggler').click(function() { 216 | var src = $(this).attr('src'); 217 | var idnum = $(this).attr('id').substr(7); 218 | $('tr.cg-' + idnum).toggle(); 219 | if (src.substr(-9) == 'minus.png') 220 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 221 | else 222 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 223 | }).css('display', ''); 224 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 225 | togglers.click(); 226 | } 227 | }, 228 | 229 | /** 230 | * helper function to hide the search marks again 231 | */ 232 | hideSearchWords : function() { 233 | $('#searchbox .highlight-link').fadeOut(300); 234 | $('span.highlighted').removeClass('highlighted'); 235 | }, 236 | 237 | /** 238 | * make the url absolute 239 | */ 240 | makeURL : function(relativeURL) { 241 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 242 | }, 243 | 244 | /** 245 | * get the current relative url 246 | */ 247 | getCurrentURL : function() { 248 | var path = document.location.pathname; 249 | var parts = path.split(/\//); 250 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 251 | if (this == '..') 252 | parts.pop(); 253 | }); 254 | var url = parts.join('/'); 255 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 256 | }, 257 | 258 | initOnKeyListeners: function() { 259 | $(document).keyup(function(event) { 260 | var activeElementType = document.activeElement.tagName; 261 | // don't navigate when in search box or textarea 262 | if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { 263 | switch (event.keyCode) { 264 | case 37: // left 265 | var prevHref = $('link[rel="prev"]').prop('href'); 266 | if (prevHref) { 267 | window.location.href = prevHref; 268 | return false; 269 | } 270 | case 39: // right 271 | var nextHref = $('link[rel="next"]').prop('href'); 272 | if (nextHref) { 273 | window.location.href = nextHref; 274 | return false; 275 | } 276 | } 277 | } 278 | }); 279 | } 280 | }; 281 | 282 | // quick alias for translations 283 | _ = Documentation.gettext; 284 | 285 | $(document).ready(function() { 286 | Documentation.init(); 287 | }); -------------------------------------------------------------------------------- /ticketpy/client.py: -------------------------------------------------------------------------------- 1 | """API client classes""" 2 | import logging 3 | import requests 4 | from collections import namedtuple 5 | from urllib import parse 6 | from ticketpy.query import ( 7 | AttractionQuery, 8 | ClassificationQuery, 9 | EventQuery, 10 | VenueQuery 11 | ) 12 | from ticketpy.model import Page 13 | 14 | log = logging.getLogger(__name__) 15 | log.setLevel(logging.INFO) 16 | sh = logging.StreamHandler() 17 | sh.setLevel(logging.INFO) 18 | sf = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') 19 | sh.setFormatter(sf) 20 | log.addHandler(sh) 21 | 22 | 23 | class ApiClient: 24 | """ApiClient is the main wrapper for the Discovery API. 25 | 26 | **Example**: 27 | Get the first page result for venues matching keyword '*Tabernacle*': 28 | 29 | .. code-block:: python 30 | 31 | import ticketpy 32 | 33 | client = ticketpy.ApiClient("your_api_key") 34 | resp = client.venues.find(keyword="Tabernacle").one() 35 | for venue in resp: 36 | print(venue.name) 37 | 38 | Output:: 39 | 40 | Tabernacle 41 | The Tabernacle 42 | Tabernacle, Notting Hill 43 | Bethel Tabernacle 44 | Revivaltime Tabernacle 45 | ... 46 | 47 | Request URLs end up looking like: 48 | http://app.ticketmaster.com/discovery/v2/events.json?apikey={api_key} 49 | """ 50 | root_url = 'https://app.ticketmaster.com' 51 | url = 'https://app.ticketmaster.com/discovery/v2' 52 | 53 | def __init__(self, api_key): 54 | self.__api_key = None 55 | self.api_key = api_key 56 | self.events = EventQuery(api_client=self) 57 | self.venues = VenueQuery(api_client=self) 58 | self.attractions = AttractionQuery(api_client=self) 59 | self.classifications = ClassificationQuery(api_client=self) 60 | self.segment_by_id = self.classifications.segment_by_id 61 | self.genre_by_id = self.classifications.genre_by_id 62 | self.subgenre_by_id = self.classifications.subgenre_by_id 63 | 64 | log.debug("Root URL: {}".format(self.url)) 65 | 66 | def search(self, method, **kwargs): 67 | """Generic API request 68 | 69 | :param method: Search type (*events*, *venues*...) 70 | :param kwargs: Search parameters (*venueId*, *eventId*, 71 | *latlong*, etc...) 72 | :return: ``PagedResponse`` 73 | """ 74 | # Remove unfilled parameters, add apikey header. 75 | # Clean up values that might be passed in multiple ways. 76 | # Ex: 'includeTBA' might be passed as bool(True) instead of 'yes' 77 | # and 'radius' might be passed as int(2) instead of '2' 78 | kwargs = {k: v for (k, v) in kwargs.items() if v is not None} 79 | updates = self.api_key 80 | 81 | for k, v in kwargs.items(): 82 | if k in ['includeTBA', 'includeTBD', 'includeTest']: 83 | updates[k] = self.__yes_no_only(v) 84 | elif k in ['size', 'radius', 'marketId']: 85 | updates[k] = str(v) 86 | kwargs.update(updates) 87 | log.debug(kwargs) 88 | urls = { 89 | 'events': self.__method_url('events'), 90 | 'venues': self.__method_url('venues'), 91 | 'attractions': self.__method_url('attractions'), 92 | 'classifications': self.__method_url('classifications') 93 | } 94 | resp = requests.get(urls[method], params=kwargs) 95 | return PagedResponse(self, self._handle_response(resp)) 96 | 97 | def _handle_response(self, response): 98 | """Raises ``ApiException`` if needed, or returns response JSON obj 99 | 100 | Status codes 101 | * 401 = Invalid API key or rate limit quota violation 102 | * 400 = Invalid URL parameter 103 | """ 104 | if response.status_code == 200: 105 | return self.__success(response) 106 | elif response.status_code == 401: 107 | self.__fault(response) 108 | elif response.status_code == 400: 109 | self.__error(response) 110 | else: 111 | self.__unknown_error(response) 112 | 113 | @staticmethod 114 | def __success(response): 115 | """Successful response, just return JSON""" 116 | return response.json() 117 | 118 | @staticmethod 119 | def __error(response): 120 | """HTTP status code 400, or something with 'errors' object""" 121 | rj = response.json() 122 | error = namedtuple('error', ['code', 'detail', 'href']) 123 | errors = [ 124 | error(err['code'], err['detail'], err['_links']['about']['href']) 125 | for err in rj['errors'] 126 | ] 127 | log.error('URL: {}\nErrors: {}'.format(response.url, errors)) 128 | raise ApiException(response.status_code, errors, response.url) 129 | 130 | @staticmethod 131 | def __fault(response): 132 | """HTTP status code 401, or something with 'faults' object""" 133 | rj = response.json() 134 | fault_str = rj['fault']['faultstring'] 135 | detail = rj['fault']['detail'] 136 | log.error('URL: {}, Faultstr: {}'.format(response.url, fault_str)) 137 | raise ApiException( 138 | response.status_code, 139 | fault_str, 140 | detail, 141 | response.url 142 | ) 143 | 144 | def __unknown_error(self, response): 145 | """Unexpected HTTP status code (not 200, 400, or 401)""" 146 | rj = response.json() 147 | if 'fault' in rj: 148 | self.__fault(response) 149 | elif 'errors' in rj: 150 | self.__error(response) 151 | else: 152 | raise ApiException(response.status_code, response.text) 153 | 154 | def get_url(self, link): 155 | """Gets a specific href from '_links' object in a response""" 156 | # API sometimes return incorrectly-formatted strings, need 157 | # to parse out parameters and pass them into a new request 158 | # rather than implicitly trusting the href in _links 159 | link = self._parse_link(link) 160 | resp = requests.get(link.url, link.params) 161 | return Page.from_json(self._handle_response(resp)) 162 | 163 | def _parse_link(self, link): 164 | """Parses link into base URL and dict of parameters""" 165 | parsed_link = namedtuple('link', ['url', 'params']) 166 | link_url, link_params = link.split('?') 167 | params = self._link_params(link_params) 168 | return parsed_link(link_url, params) 169 | 170 | def _link_params(self, param_str): 171 | """Parse URL parameters from href split on '?' character""" 172 | search_params = {} 173 | params = parse.parse_qs(param_str) 174 | for k, v in params.items(): 175 | search_params[k] = v[0] 176 | search_params.update(self.api_key) 177 | return search_params 178 | 179 | @property 180 | def api_key(self): 181 | return self.__api_key 182 | 183 | @api_key.setter 184 | def api_key(self, api_key): 185 | # Set this way by default to pass in request params 186 | self.__api_key = {'apikey': api_key} 187 | 188 | @staticmethod 189 | def __method_url(method): 190 | """Formats a search method URL""" 191 | return "{}/{}.json".format(ApiClient.url, method) 192 | 193 | @staticmethod 194 | def __yes_no_only(s): 195 | """Helper for parameters expecting ['yes', 'no', 'only']""" 196 | s = str(s).lower() 197 | if s in ['true', 'yes']: 198 | s = 'yes' 199 | elif s in ['false', 'no']: 200 | s = 'no' 201 | return s 202 | 203 | 204 | class ApiException(Exception): 205 | """Exception thrown for API-related error messages""" 206 | def __init__(self, *args): 207 | super().__init__(*args) 208 | 209 | 210 | class PagedResponse: 211 | """Iterates through API response pages""" 212 | def __init__(self, api_client, response): 213 | self.api_client = api_client 214 | self.page = None 215 | self.page = Page.from_json(response) 216 | 217 | def limit(self, max_pages=5): 218 | """Retrieve X number of pages, returning a ``list`` of all entities. 219 | 220 | Rather than iterating through ``PagedResponse`` to retrieve 221 | each page (and its events/venues/etc), ``limit()`` will 222 | automatically iterate up to ``max_pages`` and return 223 | a flat/joined list of items in each ``Page`` 224 | 225 | :param max_pages: Max page requests to make before returning list 226 | :return: Flat list of results from pages 227 | """ 228 | all_items = [] 229 | counter = 0 230 | for pg in self: 231 | if counter >= max_pages: 232 | break 233 | counter += 1 234 | all_items += pg 235 | return all_items 236 | 237 | def one(self): 238 | """Get items from first page result""" 239 | return [i for i in self.page] 240 | 241 | def maximum(self): 242 | """Retrieves **maximum** pages in a result, returning a flat list. 243 | API limits paging depth to (page * size) <= 1000 244 | 245 | Use ``limit()`` to restrict the number of page requests being made. 246 | **WARNING**: Generic searches may involve *a lot* of pages... 247 | 248 | :return: Flat list of results 249 | """ 250 | max_pages = 49 # do not exceed allowed paging depth 251 | all_items = [] 252 | counter = 0 253 | for pg in self: 254 | if counter >= max_pages: 255 | break 256 | counter += 1 257 | all_items += pg 258 | return all_items 259 | 260 | def __iter__(self): 261 | yield self.page 262 | next_url = self.page.links.get('next') 263 | while next_url: 264 | log.debug("Requesting page: {}".format(next_url)) 265 | pg = self.api_client.get_url(next_url) 266 | next_url = pg.links.get('next') 267 | yield pg 268 | return 269 | -------------------------------------------------------------------------------- /docs/_build/html/_static/underscore.js: -------------------------------------------------------------------------------- 1 | // Underscore.js 1.3.1 2 | // (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc. 3 | // Underscore is freely distributable under the MIT license. 4 | // Portions of Underscore are inspired or borrowed from Prototype, 5 | // Oliver Steele's Functional, and John Resig's Micro-Templating. 6 | // For all details and documentation: 7 | // http://documentcloud.github.com/underscore 8 | (function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source== 9 | c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c, 10 | h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each= 11 | b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e
|
77 |
|
87 |
|
97 |
|
103 |
|
113 |
|
119 |
|
127 |
|
133 |
|
169 |
|
177 |
|
183 |
|
193 |
|
199 |
|
207 |
|
215 |
|
219 |
|
227 |
|
239 |
|
249 |
|
257 |
|
263 |
|
271 |
|
275 |
|
283 |
|
287 |
