def __init__(self, api_request, **kwargs):
self.original_api_request = api_request
kwargs.setdefault('full_path',
self.original_api_request.get_full_path())
kwargs.setdefault('site', api_request.site)
super(NamespaceAPIRequest, self).__init__(**kwargs)
self.site = api_request.site.fork(api_request=self)
self.session_state = State(substates=[api_request.session_state])
def __init__(self, site, path, url_args, url_kwargs, global_state=None):
self.site = site
self.path = path
self.url_args = url_args
self.url_kwargs = url_kwargs
#self.payload = payload
#self.method = method
#self.user = user
#self.params = params
#self.META = meta
self.session_state = State()
self.endpoint_state = State()
self.endpoint_state['endpoints'] = dict()
self.endpoint_state['link_prototypes'] = dict()
if global_state is not None:
self.session_state.update(global_state)
super(APIRequest, self).__init__()
def __init__(self, site, path, url_args, url_kwargs, global_state=None):
self.site = site
self.path = path
self.url_args = url_args
self.url_kwargs = url_kwargs
#self.payload = payload
#self.method = method
#self.user = user
#self.params = params
#self.META = meta
self.session_state = State()
self.endpoint_state = State()
self.endpoint_state['endpoints'] = dict()
self.endpoint_state['link_prototypes'] = dict()
if global_state is not None:
self.session_state.update(global_state)
super(APIRequest, self).__init__()
class APIRequest(object):
"""
An API Request
"""
def __init__(self, site, path, url_args, url_kwargs, global_state=None):
self.site = site
self.path = path
self.url_args = url_args
self.url_kwargs = url_kwargs
#self.payload = payload
#self.method = method
#self.user = user
#self.params = params
#self.META = meta
self.session_state = State()
self.endpoint_state = State()
self.endpoint_state['endpoints'] = dict()
self.endpoint_state['link_prototypes'] = dict()
if global_state is not None:
self.session_state.update(global_state)
super(APIRequest, self).__init__()
def get_django_request(self):
raise NotImplementedError
@property
def META(self):
return self.session_state['meta']
@property
def media_types(self):
return self.get_site().media_types
def get_response_type(self):
"""
Returns the active response type to be used
:rtype: string
"""
val = self.META.get('HTTP_ACCEPT', self.META.get('CONTENT_TYPE', ''))
media_types = self.media_types.keys()
if not media_types:
return val
return mimeparse.best_match(media_types, val) or val
def get_request_type(self):
"""
Returns the active request type to be used
:rtype: string
"""
val = self.META.get('CONTENT_TYPE', self.META.get('HTTP_ACCEPT', ''))
media_types = self.media_types.keys()
if not media_types:
return val
return mimeparse.best_match(media_types, val) or val
def get_request_media_type(self):
"""
Returns the request media type to be used or raises an error
:raises ValueError: when the requested content type is unrecognized
:rtype: string
"""
content_type = self.get_request_type()
media_type_cls = self.media_types.get(content_type, None)
if media_type_cls is None:
raise ValueError('Unrecognized request content type "%s". Choices are: %s' % (content_type, self.media_types.keys()))
return media_type_cls(self)
def get_response_media_type(self):
"""
Returns the response media type to be used or raises an error
:raises ValueError: when the requested content type is unrecognized
:rtype: string
"""
content_type = self.get_response_type()
media_type_cls = self.media_types.get(content_type, None)
if media_type_cls is None:
raise ValueError('Unrecognized request content type "%s". Choices are: %s' % (content_type, self.media_types.keys()))
return media_type_cls(self)
def get_endpoint(self, urlname):
"""
Returns a bound endpoint matching the urlname
:param urlname: The urlname to find
:type urlname: string
:raises KeyError: when the urlname does not match any endpoints
:rtype: Endpoint
"""
if urlname not in self.endpoint_state['endpoints']:
endpoint = self.site.get_endpoint_from_urlname(urlname)
bound_endpoint = endpoint.fork(api_request=self)
if bound_endpoint != self.endpoint_state['endpoints'][urlname]:
pass
return self.endpoint_state['endpoints'][urlname]
def record_endpoint(self, endpoint):
"""
Record the endpoint in our urlname cache
:param resource: Endpoint
"""
assert endpoint.api_request == self
urlname = endpoint.get_url_name()
if urlname not in self.endpoint_state['endpoints']:
self.endpoint_state['endpoints'][urlname] = endpoint
#else:
# original = self.endpoint_state['endpoints'][urlname]
# self.site.get_logger().debug('Double registration at api request level on %s by %s, original: %s' % (urlname, endpoint, original))
def get_link_prototypes(self, endpoint):
"""
Returns the link prototypes to be used by the endpint
:param endpoint: endpoint object
:rtype: list of link prototypes
"""
urlname = endpoint.get_url_name()
if urlname not in self.endpoint_state['link_prototypes']:
link_prototypes = endpoint.create_link_prototypes()
self.endpoint_state['link_prototypes'][urlname] = link_prototypes
return self.endpoint_state['link_prototypes'][urlname]
def get_site(self):
"""
Returns the bound site
:rtype: SiteResource
"""
if 'site' not in self.endpoint_state:
bound_site = self.site.fork(api_request=self)
self.endpoint_state['site'] = bound_site
return self.endpoint_state['site']
def generate_response(self, link, state):
"""
Returns a response generated from the response media type
:param link: The active link representing the endpoint's response
:param state: The endpoint's state
:rtype: [Http]Response
"""
media_type = self.get_response_media_type()
response_type = self.get_response_type()
return media_type.serialize(content_type=response_type, link=link, state=state)
def generate_options_response(self, links, state):
"""
Returns an OPTIONS response generated from the response media type
:param links: dictionary mapping available HTTP methods to a link
:param state: The endpoint's state
:rtype: [Http]Response
"""
media_type = self.get_response_media_type()
response_type = self.get_response_type()
return media_type.options_serialize(content_type=response_type, links=links, state=state)
def reverse(self, name, *args, **kwargs):
return self.get_site().reverse(name, *args, **kwargs)
class APIRequest(object):
"""
An API Request
"""
def __init__(self, site, path, url_args, url_kwargs, global_state=None):
self.site = site
self.path = path
self.url_args = url_args
self.url_kwargs = url_kwargs
#self.payload = payload
#self.method = method
#self.user = user
#self.params = params
#self.META = meta
self.session_state = State()
self.endpoint_state = State()
self.endpoint_state['endpoints'] = dict()
self.endpoint_state['link_prototypes'] = dict()
if global_state is not None:
self.session_state.update(global_state)
super(APIRequest, self).__init__()
def get_django_request(self):
raise NotImplementedError
@property
def META(self):
return self.session_state['meta']
@property
def media_types(self):
return self.get_site().media_types
def get_response_type(self):
"""
Returns the active response type to be used
:rtype: string
"""
val = self.META.get('HTTP_ACCEPT', self.META.get('CONTENT_TYPE', ''))
media_types = self.media_types.keys()
if not media_types:
return val
return mimeparse.best_match(media_types, val) or val
def get_request_type(self):
"""
Returns the active request type to be used
:rtype: string
"""
val = self.META.get('CONTENT_TYPE', self.META.get('HTTP_ACCEPT', ''))
media_types = self.media_types.keys()
if not media_types:
return val
return mimeparse.best_match(media_types, val) or val
def get_request_media_type(self):
"""
Returns the request media type to be used or raises an error
:raises ValueError: when the requested content type is unrecognized
:rtype: string
"""
content_type = self.get_request_type()
media_type_cls = self.media_types.get(content_type, None)
if media_type_cls is None:
raise ValueError(
'Unrecognized request content type "%s". Choices are: %s' %
(content_type, self.media_types.keys()))
return media_type_cls(self)
def get_response_media_type(self):
"""
Returns the response media type to be used or raises an error
:raises ValueError: when the requested content type is unrecognized
:rtype: string
"""
content_type = self.get_response_type()
media_type_cls = self.media_types.get(content_type, None)
if media_type_cls is None:
raise ValueError(
'Unrecognized request content type "%s". Choices are: %s' %
(content_type, self.media_types.keys()))
return media_type_cls(self)
def get_endpoint(self, urlname):
"""
Returns a bound endpoint matching the urlname
:param urlname: The urlname to find
:type urlname: string
:raises KeyError: when the urlname does not match any endpoints
:rtype: Endpoint
"""
if urlname not in self.endpoint_state['endpoints']:
endpoint = self.site.get_endpoint_from_urlname(urlname)
bound_endpoint = endpoint.fork(api_request=self)
if bound_endpoint != self.endpoint_state['endpoints'][urlname]:
pass
return self.endpoint_state['endpoints'][urlname]
def record_endpoint(self, endpoint):
"""
Record the endpoint in our urlname cache
:param resource: Endpoint
"""
assert endpoint.api_request == self
urlname = endpoint.get_url_name()
if urlname not in self.endpoint_state['endpoints']:
self.endpoint_state['endpoints'][urlname] = endpoint
#else:
# original = self.endpoint_state['endpoints'][urlname]
# self.site.get_logger().debug('Double registration at api request level on %s by %s, original: %s' % (urlname, endpoint, original))
def get_link_prototypes(self, endpoint):
"""
Returns the link prototypes to be used by the endpint
:param endpoint: endpoint object
:rtype: list of link prototypes
"""
urlname = endpoint.get_url_name()
if urlname not in self.endpoint_state['link_prototypes']:
link_prototypes = endpoint.create_link_prototypes()
self.endpoint_state['link_prototypes'][urlname] = link_prototypes
return self.endpoint_state['link_prototypes'][urlname]
def get_site(self):
"""
Returns the bound site
:rtype: SiteResource
"""
if 'site' not in self.endpoint_state:
bound_site = self.site.fork(api_request=self)
self.endpoint_state['site'] = bound_site
return self.endpoint_state['site']
def generate_response(self, link, state):
"""
Returns a response generated from the response media type
:param link: The active link representing the endpoint's response
:param state: The endpoint's state
:rtype: [Http]Response
"""
media_type = self.get_response_media_type()
response_type = self.get_response_type()
return media_type.serialize(content_type=response_type,
link=link,
state=state)
def generate_options_response(self, links, state):
"""
Returns an OPTIONS response generated from the response media type
:param links: dictionary mapping available HTTP methods to a link
:param state: The endpoint's state
:rtype: [Http]Response
"""
media_type = self.get_response_media_type()
response_type = self.get_response_type()
return media_type.options_serialize(content_type=response_type,
links=links,
state=state)
def reverse(self, name, *args, **kwargs):
return self.get_site().reverse(name, *args, **kwargs)
