-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #56 from UCL-RITS/development
Development
- Loading branch information
Showing
123 changed files
with
614 additions
and
74,204 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| from email.mime.application import MIMEApplication | ||
| from email.encoders import encode_7or8bit | ||
| from email.mime.multipart import MIMEMultipart | ||
| from email.mime.base import MIMEBase | ||
|
|
||
| class HTTPRequest(object): | ||
| """ | ||
| Builds an HTTP GET or POST request that ORACC's server understands to send | ||
| and retrieve ATF data. | ||
| """ | ||
| def __init__(self, url, method, **kwargs): | ||
| self.method = method | ||
| self.url = url | ||
| if method == 'POST': | ||
| if 'command' in kwargs.keys(): | ||
| self.create_request_message(kwargs['command'], kwargs['keys'], | ||
| kwargs['attachment']) | ||
| else: | ||
| self.create_response_message(kwargs['keys']) | ||
|
|
||
| def create_request_message(self, command, keys, attachment): | ||
| """ | ||
| Send attachment to server containing ATF file and necessary data to | ||
| run given command (validate, lemmatise, etc). | ||
| """ | ||
| self.create_soap_envelope(command=command, | ||
| keys=keys, | ||
| attachment=attachment) | ||
|
|
||
| def create_response_message(self, keys): | ||
| """ | ||
| Asks the server for the response request.zip attachment containing | ||
| validated/lemmantised/etc ATF file. | ||
| """ | ||
| self.create_soap_envelope(keys=keys) | ||
|
|
||
| def create_request_body(self): | ||
| pass | ||
|
|
||
| def create_request_headers(self): | ||
| request_headers = ['Host', 'Content-Length', 'Connection'] | ||
| body_headers = ['Content-ID', 'Content-Transfer-Encoding'] | ||
| request_header_values = [self.url, len(str(mtombody)), 'close'] | ||
| envelope_header_values = ['<SOAP-ENV:Envelope>', 'binary'] | ||
| attachment_header_values = ['request_zip', 'binary'] | ||
|
|
||
| pass | ||
|
|
||
| def create_soap_envelope(self, **kwargs): | ||
| """ | ||
| Format SOAP envelope to be attached in HTTP POST request. | ||
| """ | ||
| #The number of keys in the SOAP envelope depends on the command and | ||
| #the message type (Request/Response) | ||
| osc_data_keys = '' | ||
|
|
||
| #Only Request messages have data, but the template has a reference to | ||
| #it in both cases. | ||
| data = '' | ||
|
|
||
| if 'command' in kwargs.keys(): | ||
| osc_data_keys += '<osc-data:key>{}</osc-data:key>'.format(kwargs['command']) | ||
| message_type = 'Request' | ||
| data += """<osc-data:data> | ||
| <osc-data:item xmime5:contentType="*/*"> | ||
| <xop:Include href="cid:request_zip"/> | ||
| </osc-data:item> | ||
| </osc-data:data>""" | ||
| else: | ||
| message_type = 'Response' | ||
|
|
||
| for key in kwargs['keys']: | ||
| osc_data_keys += '<osc-data:key>{}</osc-data:key>'.format(key) | ||
|
|
||
| envelope = """<?xml version="1.0" encoding="UTF-8"?> | ||
| <SOAP-ENV:Envelope | ||
| xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope" | ||
| xmlns:SOAP-ENC="http://www.w3.org/2003/05/soap-encoding" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xmlns:xsd="http://www.w3.org/2001/XMLSchema" | ||
| xmlns:xop="http://www.w3.org/2004/08/xop/include" | ||
| xmlns:xmime5="http://www.w3.org/2005/05/xmlmime" | ||
| xmlns:osc-data="http://oracc.org/wsdl/ows.xsd" | ||
| xmlns:osc-meth="http://oracc.org/wsdl/ows.wsdl"> | ||
| <SOAP-ENV:Body> | ||
| <osc-meth:{type}> | ||
| <osc-data:keys> | ||
| {keys} | ||
| </osc-data:keys> | ||
| {data} | ||
| </osc-meth:{type}> | ||
| </SOAP-ENV:Body> | ||
| </SOAP-ENV:Envelope>""".format(type=message_type, | ||
| keys=osc_data_keys, | ||
| data=data) | ||
| self.envelope = envelope | ||
|
|
||
| def get_soap_envelope(self): | ||
| return self.envelope | ||
|
|
||
| def get_headers(self): | ||
| """ | ||
| Return dict with message headers - ready to use by requests module. | ||
| """ | ||
| pass | ||
|
|
||
| def get_body(self): | ||
| """ | ||
| Return dict with message body/payload - ready to use by requests module. | ||
| """ | ||
| pass | ||
|
|
||
| def handle_server_error(self): | ||
| """ | ||
| Raise an exception when server can't be reached or request times out. | ||
| """ | ||
| pass |
Oops, something went wrong.