http-cli

#!/usr/bin/env python3

import argparse
import json
import requests
import textwrap

# 
# Information about status codes taken from
# 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes'
# 
status_codes = {
    100: {  'name'       : 'Continue',
            'description': 'The server has received the request headers and the client should proceed to send the request body (in the case of a request for which a body needs to be sent; for example, a POST request). Sending a large request body to a server after a request has been rejected for inappropriate headers would be inefficient. To have a server check the request\'s headers, a client must send Expect: 100-continue as a header in its initial request and receive a 100 Continue status code in response before sending the body. If the client receives an error code such as 403 (Forbidden) or 405 (Method Not Allowed) then it shouldn\'t send the request\'s body. The response 417 Expectation Failed indicates that the request should be repeated without the Expect header as it indicates that the server doesn\'t support expectations (this is the case, for example, of HTTP/1.0 servers).',
            'standard'   : 'http'
         },
    101: {  'name'       : 'Switching Protocols',
            'description': 'The requester has asked the server to switch protocols and the server has agreed to do so.',
            'standard'   : 'http'
         },
    102: {  'name'       : 'Processing (WebDAV; RFC 2518)',
            'description': 'A WebDAV request may contain many sub-requests involving file operations, requiring a long time to complete the request. This code indicates that the server has received and is processing the request, but no response is available yet. This prevents the client from timing out and assuming the request was lost.',
            'standard'   : 'http'
         },

    200: {  'name'       : 'OK',
            'description': 'Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.',
            'standard'   : 'http'
         },
    201: {  'name'       : 'Created',
            'description': 'The request has been fulfilled, resulting in the creation of a new resource.',
            'standard'   : 'http'
         },
    202: {  'name'       : 'Accepted',
            'description': 'The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs.',
            'standard'   : 'http'
         },
    203: {  'name'       : 'Non-Authoritative Information (since HTTP/1.1)',
            'description': 'The server is a transforming proxy (e.g. a Web accelerator) that received a 200 OK from its origin, but is returning a modified version of the origin\'s response.',
            'standard'   : 'http'
         },
    204: {  'name'       : 'No Content',
            'description': 'The server successfully processed the request and is not returning any content.',
            'standard'   : 'http'
         },
    205: {  'name'       : 'Reset Content',
            'description': 'The server successfully processed the request, but is not returning any content. Unlike a 204 response, this response requires that the requester reset the document view.',
            'standard'   : 'http'
         },
    206: {  'name'       : 'Partial Content (RFC 7233)',
            'description': 'The server is delivering only part of the resource (byte serving) due to a range header sent by the client. The range header is used by HTTP clients to enable resuming of interrupted downloads, or split a download into multiple simultaneous streams.',
            'standard'   : 'http'
         },
    207: {  'name'       : 'Multi-Status (WebDAV; RFC 4918)',
            'description': 'The message body that follows is an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.',
            'standard'   : 'http'
         },
    208: {  'name'       : 'Already Reported (WebDAV; RFC 5842)',
            'description': 'The members of a DAV binding have already been enumerated in a preceding part of the (multistatus) response, and are not being included again.',
            'standard'   : 'http'
         },
    226: {  'name'       : 'IM Used (RFC 3229)',
            'description': 'The server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.',
            'standard'   : 'http'
         },

    300: {  'name'       : 'Multiple Choices',
            'description': 'Indicates multiple options for the resource from which the client may choose (via agent-driven content negotiation). For example, this code could be used to present multiple video format options, to list files with different filename extensions, or to suggest word-sense disambiguation.',
            'standard'   : 'http'
         },
    301: {  'name'       : 'Moved Permanently',
            'description': 'This and all future requests should be directed to the given URI.',
            'standard'   : 'http'
         },
    302: {  'name'       : 'Found',
            'description': 'This is an example of industry practice contradicting the standard. The HTTP/1.0 specification (RFC 1945) required the client to perform a temporary redirect (the original describing phrase was "Moved Temporarily"), but popular browsers implemented 302 with the functionality of a 303 See Other. Therefore, HTTP/1.1 added status codes 303 and 307 to distinguish between the two behaviours. However, some Web applications and frameworks use the 302 status code as if it were the 303.',
            'standard'   : 'http'
         },
    303: {  'name'       : 'See Other (since HTTP/1.1)',
            'description': 'The response to the request can be found under another URI using the GET method. When received in response to a POST (or PUT/DELETE), the client should presume that the server has received the data and should issue a new GET request to the given URI.',
            'standard'   : 'http'
         },
    304: {  'name'       : 'Not Modified (RFC 7232)',
            'description': 'Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy.',
            'standard'   : 'http'
         },
    305: {  'name'       : 'Use Proxy (since HTTP/1.1)',
            'description': 'The requested resource is available only through a proxy, the address for which is provided in the response. Many HTTP clients (such as Mozilla and Internet Explorer) do not correctly handle responses with this status code, primarily for security reasons.',
            'standard'   : 'http'
         },
    306: {  'name'       : 'Switch Proxy',
            'description': 'No longer used. Originally meant "Subsequent requests should use the specified proxy."',
            'standard'   : 'http'
         },
    307: {  'name'       : 'Temporary Redirect (since HTTP/1.1)',
            'description': 'In this case, the request should be repeated with another URI; however, future requests should still use the original URI. In contrast to how 302 was historically implemented, the request method is not allowed to be changed when reissuing the original request. For example, a POST request should be repeated using another POST request.',
            'standard'   : 'http'
         },
    308: {  'name'       : 'Permanent Redirect (RFC 7538)',
            'description': 'The request and all future requests should be repeated using another URI. 307 and 308 parallel the behaviors of 302 and 301, but do not allow the HTTP method to change. So, for example, submitting a form to a permanently redirected resource may continue smoothly.',
            'standard'   : 'http'
         },

    400: {  'name'       : 'Bad Request',
            'description': 'The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing).',
            'standard'   : 'http'
         },
    401: {  'name'       : 'Unauthorized (RFC 7235)',
            'description': 'Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. See Basic access authentication and Digest access authentication. 401 semantically means "unauthenticated", i.e. the user does not have the necessary credentials.',
            'standard'   : 'http'
         },
    402: {  'name'       : 'Payment Required',
            'description': 'Reserved for future use. The original intention was that this code might be used as part of some form of digital cash or micropayment scheme, as proposed for example by GNU Taler, but that has not yet happened, and this code is not usually used. Google Developers API uses this status if a particular developer has exceeded the daily limit on requests. Stripe API uses this code for errors with processing credit cards.',
            'standard'   : 'http'
         },
    403: {  'name'       : 'Forbidden',
            'description': 'The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort.',
            'standard'   : 'http'
         },
    404: {  'name'       : 'Not Found',
            'description': 'The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible.',
            'standard'   : 'http'
         },
    405: {  'name'       : 'Method Not Allowed',
            'description': 'A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.',
            'standard'   : 'http'
         },
    406: {  'name'       : 'Not Acceptable',
            'description': 'The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. See Content negotiation.',
            'standard'   : 'http'
         },
    407: {  'name'       : 'Proxy Authentication Required (RFC 7235)',
            'description': 'The client must first authenticate itself with the proxy.',
            'standard'   : 'http'
         },
    408: {  'name'       : 'Request Timeout',
            'description': 'The server timed out waiting for the request. According to HTTP specifications: "The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time."',
            'standard'   : 'http'
         },
    409: {  'name'       : 'Conflict',
            'description': 'Indicates that the request could not be processed because of conflict in the request, such as an edit conflict between multiple simultaneous updates.',
            'standard'   : 'http'
         },
    410: {  'name'       : 'Gone',
            'description': 'Indicates that the resource requested is no longer available and will not be available again. This should be used when a resource has been intentionally removed and the resource should be purged. Upon receiving a 410 status code, the client should not request the resource in the future. Clients such as search engines should remove the resource from their indices. Most use cases do not require clients and search engines to purge the resource, and a "404 Not Found" may be used instead.',
            'standard'   : 'http'
         },
    411: {  'name'       : 'Length Required',
            'description': 'The request did not specify the length of its content, which is required by the requested resource.',
            'standard'   : 'http'
         },
    412: {  'name'       : 'Precondition Failed (RFC 7232)',
            'description': 'The server does not meet one of the preconditions that the requester put on the request.',
            'standard'   : 'http'
         },
    413: {  'name'       : 'Payload Too Large (RFC 7231)',
            'description': 'The request is larger than the server is willing or able to process. Previously called "Request Entity Too Large".',
            'standard'   : 'http'
         },
    414: {  'name'       : 'URI Too Long (RFC 7231)',
            'description': 'The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request, in which case it should be converted to a POST request. Called "Request-URI Too Long" previously.',
            'standard'   : 'http'
         },
    415: {  'name'       : 'Unsupported Media Type',
            'description': 'The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.',
            'standard'   : 'http'
         },
    416: {  'name'       : 'Range Not Satisfiable (RFC 7233)',
            'description': 'The client has asked for a portion of the file (byte serving), but the server cannot supply that portion. For example, if the client asked for a part of the file that lies beyond the end of the file. Called "Requested Range Not Satisfiable" previously.',
            'standard'   : 'http'
         },
    417: {  'name'       : 'Expectation Failed',
            'description': 'The server cannot meet the requirements of the Expect request-header field.',
            'standard'   : 'http'
         },
    418: {  'name'       : 'I\'m a teapot (RFC 2324)',
            'description': 'This code was defined in 1998 as one of the traditional IETF April Fools\' jokes, in RFC 2324, Hyper Text Coffee Pot Control Protocol, and is not expected to be implemented by actual HTTP servers. The RFC specifies this code should be returned by teapots requested to brew coffee. This HTTP status is used as an Easter egg in some websites, including Google.com.',
            'standard'   : 'http'
         },
    421: {  'name'       : 'Misdirected Request (RFC 7540)',
            'description': 'The request was directed at a server that is not able to produce a response. (for example because of a connection reuse)',
            'standard'   : 'http'
         },
    422: {  'name'       : 'Unprocessable Entity (WebDAV; RFC 4918)',
            'description': 'The request was well-formed but was unable to be followed due to semantic errors.',
            'standard'   : 'http'
         },
    423: {  'name'       : 'Locked (WebDAV; RFC 4918)',
            'description': 'The resource that is being accessed is locked.',
            'standard'   : 'http'
         },
    424: {  'name'       : 'Failed Dependency (WebDAV; RFC 4918)',
            'description': 'The request failed due to failure of a previous request (e.g., a PROPPATCH).',
            'standard'   : 'http'
         },
    426: {  'name'       : 'Upgrade Required',
            'description': 'The client should switch to a different protocol such as TLS/1.0, given in the Upgrade header field.',
            'standard'   : 'http'
         },
    428: {  'name'       : 'Precondition Required (RFC 6585)',
            'description': 'The origin server requires the request to be conditional. Intended to prevent the \'lost update\' problem, where a client GETs a resource\'s state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict."',
            'standard'   : 'http'
         },
    429: {  'name'       : 'Too Many Requests (RFC 6585)',
            'description': 'The user has sent too many requests in a given amount of time. Intended for use with rate-limiting schemes.',
            'standard'   : 'http'
         },
    431: {  'name'       : 'Request Header Fields Too Large (RFC 6585)',
            'description': 'The server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.',
            'standard'   : 'http'
         },
    451: {  'name'       : 'Unavailable For Legal Reasons (RFC 7725)',
            'description': 'A server operator has received a legal demand to deny access to a resource or to a set of resources that includes the requested resource. The code 451 was chosen as a reference to the novel Fahrenheit 451.',
            'standard'   : 'http'
         },

    500: {  'name'       : 'Internal Server Error', 
            'description': 'A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.',
            'standard'   : 'http'
         },
    501: {  'name'       : 'Not Implemented', 
            'description': 'The server either does not recognize the request method, or it lacks the ability to fulfill the request. Usually this implies future availability (e.g., a new feature of a web-service API).',
            'standard'   : 'http'
         },
    502: {  'name'       : 'Bad Gateway', 
            'description': 'The server was acting as a gateway or proxy and received an invalid response from the upstream server.',
            'standard'   : 'http'
         },
    503: {  'name'       : 'Service Unavailable', 
            'description': 'The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state.',
            'standard'   : 'http'
         },
    504: {  'name'       : 'Gateway Timeout', 
            'description': 'The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.',
            'standard'   : 'http'
         },
    505: {  'name'       : 'HTTP Version Not Supported', 
            'description': 'The server does not support the HTTP protocol version used in the request.',
            'standard'   : 'http'
         },
    506: {  'name'       : 'Variant Also Negotiates (RFC 2295)', 
            'description': 'Transparent content negotiation for the request results in a circular reference.',
            'standard'   : 'http'
         },
    507: {  'name'       : 'Insufficient Storage (WebDAV; RFC 4918)', 
            'description': 'The server is unable to store the representation needed to complete the request.',
            'standard'   : 'http'
         },
    508: {  'name'       : 'Loop Detected (WebDAV; RFC 5842)', 
            'description': 'The server detected an infinite loop while processing the request (sent in lieu of 208 Already Reported).',
            'standard'   : 'http'
         },
    510: {  'name'       : 'Not Extended (RFC 2774)', 
            'description': 'Further extensions to the request are required for the server to fulfil it.',
            'standard'   : 'http'
         },
    511: {  'name'       : 'Network Authentication Required (RFC 6585)', 
            'description': 'The client needs to authenticate to gain network access. Intended for use by intercepting proxies used to control access to the network (e.g., "captive portals" used to require agreement to Terms of Service before granting full Internet access via a Wi-Fi hotspot).',
            'standard'   : 'http'
         }
    }

#
# Non-standard (various)
#
# 103 Checkpoint
#     Used in the resumable requests proposal to resume aborted PUT or POST requests.
# 103 Early Hints
#     Used to return some response headers before entire HTTP response. Currently in draft status.
# 420 Method Failure (Spring Framework)
#     A deprecated response used by the Spring Framework when a method has failed.
# 420 Enhance Your Calm (Twitter)
#     Returned by version 1 of the Twitter Search and Trends API when the client is being rate limited; versions 1.1 and later use the 429 Too Many Requests response code instead.
# 450 Blocked by Windows Parental Controls (Microsoft)
#     The Microsoft extension code indicated when Windows Parental Controls are turned on and are blocking access to the requested webpage.
# 498 Invalid Token (Esri)
#     Returned by ArcGIS for Server. Code 498 indicates an expired or otherwise invalid token.
# 499 Token Required (Esri)
#     Returned by ArcGIS for Server. Code 499 indicates that a token is required but was not submitted.
# 509 Bandwidth Limit Exceeded (Apache Web Server/cPanel)
#     The server has exceeded the bandwidth specified by the server administrator; this is often used by shared hosting providers to limit the bandwidth of customers.
# 530 Site is frozen
#     Used by the Pantheon web platform to indicate a site that has been frozen due to inactivity.
# 598 (Informal convention) Network read timeout error
#     Used by some HTTP proxies to signal a network read timeout behind the proxy to a client in front of the proxy.

#
# Internet Information Services
# The Internet Information Services expands the 4xx error space to signal errors with the client's request.
#
# 440 Login Time-out
#     The client's session has expired and must log in again.
# 449 Retry With
#     The server cannot honour the request because the user has not provided the required information.
# 451 Redirect
#     Used in Exchange ActiveSync when either a more efficient server is available or the server cannot access the users' mailbox. The client is expected to re-run the HTTP AutoDiscover operation to find a more appropriate server.

#
# nginx
# The nginx web server software expands the 4xx error space to signal issues with the client's request.
#
# 444 No Response
#     Used to indicate that the server has returned no information to the client and closed the connection.
# 495 SSL Certificate Error
#     An expansion of the 400 Bad Request response code, used when the client has provided an invalid client certificate.
# 496 SSL Certificate Required
#     An expansion of the 400 Bad Request response code, used when a client certificate is required but not provided.
# 497 HTTP Request Sent to HTTPS Port
#     An expansion of the 400 Bad Request response code, used when the client has made a HTTP request to a port listening for HTTPS requests.
# 499 Client Closed Request
#     Used when the client has closed the request before the server could send a response.

#
# Cloudflare
# Cloudflare's reverse proxy service expands the 5xx series of errors space to signal issues with the origin server.
#
# 520 Unknown Error
#     The 520 error is used as a "catch-all response for when the origin server returns something unexpected", listing connection resets, large headers, and empty or invalid responses as common triggers.
# 521 Web Server Is Down
#     The origin server has refused the connection from Cloudflare.
# 522 Connection Timed Out
#     Cloudflare could not negotiate a TCP handshake with the origin server.
# 523 Origin Is Unreachable
#     Cloudflare could not reach the origin server; for example, if the DNS records for the origin server are incorrect.
# 524 A Timeout Occurred
#     Cloudflare was able to complete a TCP connection to the origin server, but did not receive a timely HTTP response.
# 525 SSL Handshake Failed
#     Cloudflare could not negotiate a SSL/TLS handshake with the origin server.
# 526 Invalid SSL Certificate
#     Cloudflare could not validate the SSL/TLS certificate that the origin server presented.
# 527 Railgun Error
#     Error 527 indicates that the request timed out or failed after the WAN connection had been established.

def print_response(r):
    print_headers = (args.status_code
                     or args.status_code_ext
                     or args.headers)
    if args.status_code or args.status_code_ext:
        if print_headers: print('\n=== STATUS CODE ===')
        print(r.status_code, status_codes[r.status_code]['name'])
        if args.status_code_ext:
            print()
            print(status_codes[r.status_code]['description'])
    if args.headers:
        if print_headers: print('\n=== HEADERS ===')
        length = max([len(key) for key in r.headers])
        fmt_str = '{:<' + str(length) + '}: {}'
        for key, value in r.headers.items():
            print( fmt_str.format(key, value) )
    if print_headers: print('\n=== RESPONSE ===')
    print(r.text)

def get_method(method_name):
    methods = {
        # 'connect' : requests.connect,
        'delete'  : requests.delete,
        'get'     : requests.get,
        'head'    : requests.head,
        'options' : requests.options,
        'patch'   : requests.patch,
        'put'     : requests.put,
        'post'    : requests.post,
        # 'trace'   : requests.trace
    }
    return methods[method_name]

parser = argparse.ArgumentParser(description='')

parser.add_argument('url', nargs='?')
parser.add_argument('json', default=None, nargs='?')
parser.add_argument('--method', choices=['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace', 'connect'], default=None)
parser.add_argument('--headers', action='store_true')
parser.add_argument('-i', '--status-code-info', default=None)
parser.add_argument('-s', '--status-code'    , action='store_true')
parser.add_argument('-S', '--status-code-ext', action='store_true')

args = parser.parse_args()

if args.status_code_info is not None:
    try:
        info = status_codes[int(args.status_code_info)]
        print()
        print( '{} {}'.format(args.status_code_info, info['name']) )
        print()
        print( '{}'.format(textwrap.fill(info['description'], 80)) )
    except ValueError:
        print("ERROR: {} is not a valid status code; Submit integer".format(args.status_code_info))
    except KeyError:
        print("ERROR: {} is not a valid status code".format(args.status_code_info))
    exit(0)

if args.json and args.method is None:
    args.method = 'post'
elif args.method is None:
    args.method = 'get'

kwargs = dict()
if args.json:
    kwargs['json']=json.loads(args.json)

r = get_method(args.method)(args.url, **kwargs)
print_response(r)