Update the post method to support JSON string and JSON encoded object

[anthonyroux]

request.py line 106:

the body of the post is always dumps, this means we cannot use a JSON string as the body for a POST request.

We should update this part to be able to manage both

[basil08]

Hi @tsolakoua, I would like to look into this. Can you assign me?

[tsolakoua]

Hello @basil08, sure! Thank you!

[basil08]

In /client/request.py

if (self.verb == 'POST'):
            return HTTPRequest(self.url, headers=self.headers, method='POST',
                               data=json.dumps(self.params).encode())

My understanding so far: data is a JSON valid string constructed from self.params. So, what is the requirement here? If data should be a JSON valid dict, then how to logically switch b/w them?

[tsolakoua]

Hello @basil08 , let's say we want to make a search using the POST method of Flight Offers Search with the following criteria:

{
    "originDestinations": [
        {
            "id": "1",
            "originLocationCode": "BOS",
            "destinationLocationCode": "MAD",
            "departureDateTimeRange": {
                "date": "2021-11-01",
                "time": "10:00:00"
            }
        }
    ],
    "travelers": [
        {
            "id": "1",
            "travelerType": "ADULT",
            "fareOptions": [
                "STANDARD"
            ]
        },
        {
            "id": "2",
            "travelerType": "CHILD",
            "fareOptions": [
                "STANDARD"
            ]
        }
    ],
    "sources": [
        "GDS"
    ],
    "searchCriteria": {
        "maxFlightOffers": 2
    }
}

Now if I try to make the API call in Python SDK: The following code is going to run successfully because I convert the JSON String to Python Dict and in request.py it's going to be used as input to the json.dumps.

import json
from amadeus import Client, ResponseError, Location

amadeus = Client(client_id="YOUR_ID",
                 client_secret="YOUR_SECRET")

body = '{ "currencyCode": "USD", "originDestinations": [ { "id": "1", "originLocationCode": "BOS",' \
     '"destinationLocationCode": "MAD", "departureDateTimeRange": { "date": "2021-11-01", "time": "10:00:00" } }, ' \
         '{ "id": "2", "originLocationCode": "MAD", "destinationLocationCode": "BOS", "departureDateTimeRange": ' \
             '{ "date": "2021-11-18", "time": "17:00:00" } } ], "travelers": [ { "id": "1", "travelerType": "ADULT", ' \
                 '"fareOptions": [ "STANDARD" ] }, { "id": "2", "travelerType": "CHILD", "fareOptions": [ "STANDARD" ] } ], ' \
                     '"sources": [ "GDS" ], "searchCriteria": { "maxFlightOffers": 2, "flightFilters": { "cabinRestrictions": ' \
                         '[ { "cabin": "BUSINESS", "coverage": "MOST_SEGMENTS", "originDestinationIds": [ "1" ] } ], ' \
                             '"carrierRestrictions": { "excludedCarrierCodes": [ "AA", "TP", "AZ" ] } } } }'

try:
# converts to Python dictionary
    response = amadeus.shopping.flight_offers_search.post(json.loads(body))
    print(response.data)
except ResponseError as error:
    raise error

Now if i pass the JSON String directly it's going to fail.

import json
from amadeus import Client, ResponseError, Location

amadeus = Client(client_id="YOUR_ID",
                 client_secret="YOUR_SECRET")

body = '{ "currencyCode": "USD", "originDestinations": [ { "id": "1", "originLocationCode": "BOS",' \
     '"destinationLocationCode": "MAD", "departureDateTimeRange": { "date": "2021-11-01", "time": "10:00:00" } }, ' \
         '{ "id": "2", "originLocationCode": "MAD", "destinationLocationCode": "BOS", "departureDateTimeRange": ' \
             '{ "date": "2021-11-18", "time": "17:00:00" } } ], "travelers": [ { "id": "1", "travelerType": "ADULT", ' \
                 '"fareOptions": [ "STANDARD" ] }, { "id": "2", "travelerType": "CHILD", "fareOptions": [ "STANDARD" ] } ], ' \
                     '"sources": [ "GDS" ], "searchCriteria": { "maxFlightOffers": 2, "flightFilters": { "cabinRestrictions": ' \
                         '[ { "cabin": "BUSINESS", "coverage": "MOST_SEGMENTS", "originDestinationIds": [ "1" ] } ], ' \
                             '"carrierRestrictions": { "excludedCarrierCodes": [ "AA", "TP", "AZ" ] } } } }'

try:
    response = amadeus.shopping.flight_offers_search.post(body)
    print(response.data)
except ResponseError as error:
    raise error

A draft and just on top of my head solution I came up with could be something like:

        if (self.verb == 'POST'):
            if type(self.params) is dict:
                return HTTPRequest(self.url, headers=self.headers, method='POST',
                                data=json.dumps(self.params).encode())
            else: 
                return HTTPRequest(self.url, headers=self.headers, method='POST',
                data=self.params.encode())
        else:
            return HTTPRequest(self.url, headers=self.headers, method=self.verb)

Feel free to check it out and let me know if you have any more questions, I hope that's clear. What I also want to avoid with any new changes is to break the code of developers who already use the SDK.

To avoid any misunderstanding we won't be able to review solutions during the weekend and then the month of October is over. However, if you create a valid PR I'm happy to label it as hacktoberfest-accepted in order to count your contribution as valid and then we can finish reviewing the PR without time pressure.

[basil08]

Wow, this is very clearly explained. Appreciate your effort.

As for the labelling part, that sounds good. I hope to open a PR soon.

[basil08]

Just a quick note: If this repo is participating in hacktoberfest, then it should be labelled with a hacktoberfest label too so that contributions are counted.

[tsolakoua]

You are totally right @basil08, I forgot to include the hacktoberfest topic in this repository! Thanks for your contribution as well as for the reminder :)