python_3_api_interface.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from collections import namedtuple
import requests
import logging
import json
import enum


class ApiInteraction(enum.Enum):
    SUCCESS = 1
    ERROR = 2
    FAILURE = 3


ApiResponse = namedtuple('ApiResponse', 'status,payload')


def hit_endpoint(url: str) -> ApiResponse:
    try:
        response = requests.get(url)
        payload = response.json()

    except json.decoder.JSONDecodeError as e:
        logging.error('could not decode json from {}'.format(url))
        logging.info(e, exc_info=True)
        return ApiResponse(ApiInteraction.ERROR, None)
    except Exception as e:
        logging.error('Something bad happend trying to reach {}'.format(url))
        logging.info(e, exc_info=True)
        return ApiResponse(ApiInteraction.FAILURE, None)
    else:
        return ApiResponse(ApiInteraction.SUCCESS, payload)


ApiResponse.from_url = hit_endpoint


def test_endpoint_response():
    url = 'http://httpbin.org/headers'
    response = ApiResponse.from_url(url)
    assert response.status == ApiInteraction.SUCCESS
    assert response.status == hit_endpoint(url).status
    assert response.payload is not None

    url = 'http://twitter.com'
    response = ApiResponse.from_url(url)
    assert response.status == ApiInteraction.ERROR
    assert response.status == hit_endpoint(url).status
    assert response.payload is None

    url = 'foo'
    response = ApiResponse.from_url(url)
    assert response.status == ApiInteraction.FAILURE
    assert response.status == hit_endpoint(url).status
    assert response.payload is None


if __name__ == "__main__":
    test_endpoint_response()