Add support to Trip parser (#55)

* add support for trip purpose

* fix pep errors

* refactor name

* update tests

* update docs

* update result docs

* add methods to encode to base64

* update encoding

* update docs

* update method docs

* update structure of encoding

* update readme

* minor fix

* add from_file and from_base64 paths to test

* add from_file and from_base64 paths to test

* fixes in docs

* test post methods for prediction and trip parser

* refactor the method that constructs post body

* add tests for encoding

* update tests description

* add patch with name update

Author: tsolakoua

README.rst

@@ -279,6 +279,18 @@ List of supported endpoints
     # AI Generated Photos
     amadeus.media.files.generated_photos.get(category='MOUNTAIN')
 
+    # Trip Parser
+    # Encode to Base64 your booking confirmation file (.html, .eml, .pdf supported)
+    response = amadeus.travel.trip_parser_jobs.post(amadeus.travel.from_file(path_to_file))
+    # Alternatively you can use a Base64 encoded content directly
+    response = amadeus.travel.trip_parser_jobs.post(amadeus.travel.from_base64(base64))
+    # Or you can call the API with the JSON directly
+    response = amadeus.travel.trip_parser_jobs.post(body)
+    # Get the parsing status of the process by jobId
+    amadeus.travel.trip_parser_jobs.status(response.data['id']).get()
+    # Get the result of the process by jobId
+    amadeus.travel.trip_parser_jobs.result(response.data['id']).get()
+
 Development & Contributing
 --------------------------
 

amadeus/mixins/encoder.py

@@ -0,0 +1,7 @@
+import base64
+
+
+# Encodes a file to Base64 format
+def encode_file_to_base64(file):
+    with open(file, 'rb') as opened_file:
+        return base64.b64encode(opened_file.read()).decode()

amadeus/namespaces/_travel.py

@@ -1,10 +1,19 @@
 from amadeus.client.decorator import Decorator
 from amadeus.travel._analytics import Analytics
 from amadeus.travel._predictions import Predictions
+from amadeus.travel._trip_parser_jobs import TripParser
+from amadeus.travel._encoder import from_file, from_base64
 
 
 class Travel(Decorator, object):
     def __init__(self, client):
         Decorator.__init__(self, client)
         self.analytics = Analytics(client)
         self.predictions = Predictions(client)
+        self.trip_parser_jobs = TripParser(client)
+
+    def from_file(self, file):
+        return from_file(file)
+
+    def from_base64(self, base64):
+        return from_base64(base64)

amadeus/shopping/flight_offers/_prediction.py

@@ -12,7 +12,7 @@ def post(self, body):
                 amadeus.shopping.flight_offers.get(origin='MAD',
                 destination='NYC',
                 departureDate='2019-08-01'
-            ).body
+            ).result
         )
 
         :rtype: amadeus.Response

amadeus/travel/__init__.py

@@ -1,4 +1,5 @@
 from ._analytics import Analytics
 from ._predictions import TripPurpose, FlightDelay
+from ._trip_parser_jobs import TripParser
 
-__all__ = ['Analytics', 'TripPurpose', 'FlightDelay']
+__all__ = ['Analytics', 'TripPurpose', 'FlightDelay', 'TripParser']

amadeus/travel/_encoder.py

@@ -0,0 +1,22 @@
+from amadeus.mixins.encoder import encode_file_to_base64
+
+
+# Encodes file to Base64 and constructs POST body
+def from_file(file):
+    encoded_file = encode_file_to_base64(file)
+    return __build_trip_parser_body(encoded_file)
+
+
+# Constructs POST body from Base64
+def from_base64(base64):
+    return __build_trip_parser_body(base64)
+
+
+# Takes a Base64 and returns a dict
+def __build_trip_parser_body(base64):
+    return {
+        'data': {
+            'type': 'trip-parser-job',
+            'content': base64,
+        },
+    }

amadeus/travel/_trip_parser_jobs.py

@@ -0,0 +1,38 @@
+from amadeus.client.decorator import Decorator
+from amadeus.travel.trip_parser_jobs._status import TripParserStatus
+from amadeus.travel.trip_parser_jobs._result import TripParserResult
+
+
+class TripParser(Decorator, object):
+    def __init__(self, client):
+        Decorator.__init__(self, client)
+
+    def status(self, job_id):
+        return TripParserStatus(self.client, job_id)
+
+    def result(self, job_id):
+        return TripParserResult(self.client, job_id)
+
+    def post(self, body):
+        '''
+        Sends the request for the parsing with the
+        booking details and input parameters.
+
+        .. code-block:: python
+
+            amadeus.travel.trip_parser_jobs.post(
+            '{ "data": {
+             "type": "trip-parser-job",
+             "content": : "base64string" }}'
+
+        You can call our helper functions with your booking details
+        in a file or the content encoded in Base64
+
+        .. code-block:: python
+            amadeus.travel.trip_parser_jobs.post(amadeus.travel.from_file(path_to_file))
+            amadeus.travel.trip_parser_jobs.post(amadeus.travel.from_base64(base64))
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.post('/v2/travel/trip-parser-jobs', body)

amadeus/travel/trip_parser_jobs/__init__.py

@@ -0,0 +1,4 @@
+from ._result import TripParserResult
+from ._status import TripParserStatus
+
+__all__ = ['TripParserResult', 'TripParserStatus']

amadeus/travel/trip_parser_jobs/_result.py

@@ -0,0 +1,22 @@
+from amadeus.client.decorator import Decorator
+
+
+class TripParserResult(Decorator, object):
+    def __init__(self, client, job_id):
+        Decorator.__init__(self, client)
+        self.job_id = job_id
+
+    def get(self, **params):
+        '''
+        Returns the complete result of parsing as a aggregated view of Trip
+
+        .. code-block:: python
+
+            amadeus.travel.trip_parser_jobs.result('XXX').get
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get(
+            '/v2/travel/trip-parser-jobs/{0}/result'.format(self.job_id),
+            **params)

amadeus/travel/trip_parser_jobs/_status.py

@@ -0,0 +1,23 @@
+from amadeus.client.decorator import Decorator
+
+
+class TripParserStatus(Decorator, object):
+    def __init__(self, client, job_id):
+        Decorator.__init__(self, client)
+        self.job_id = job_id
+
+    def get(self, **params):
+        '''
+        Returns the parsing status and the link to the result
+        in case of successful parsing.
+
+        .. code-block:: python
+
+            amadeus.travel.trip_parser_jobs.status('XXX').get
+
+        :rtype: amadeus.Response
+        :raises amadeus.ResponseError: if the request could not be completed
+        '''
+        return self.client.get(
+            '/v2/travel/trip-parser-jobs/{0}'.format(self.job_id),
+            **params)