0.7.1

Closes #140.

README.rst

@@ -425,7 +425,7 @@ To set custom headers you can use the ``Header:Value`` notation:
 
 .. code-block:: bash
 
-    $ http example.org  User-Agent:Bacon/1.0  Cookie:valued-visitor=yes  X-Foo:Bar  Referer:http://httpie.org/
+    $ http example.org  User-Agent:Bacon/1.0  'Cookie:valued-visitor=yes;foo=bar'  X-Foo:Bar  Referer:http://httpie.org/
 
 
 .. code-block:: http
@@ -433,7 +433,7 @@ To set custom headers you can use the ``Header:Value`` notation:
     GET / HTTP/1.1
     Accept: */*
     Accept-Encoding: identity, deflate, compress, gzip
-    Cookie: valued-visitor=yes
+    Cookie: valued-visitor=yes;foo=bar
     Host: example.org
     Referer: http://httpie.org/
     User-Agent: Bacon/1.0
@@ -458,8 +458,8 @@ Any of the default headers can be overwritten.
 Authentication
 ==============
 
-The currently supported authentication schemes are Basic and Digest (more to
-come). There are two flags that control authentication:
+The currently supported authentication schemes are Basic and Digest
+(see `auth plugins`_ for more). There are two flags that control authentication:
 
 ===================     ======================================================
 ``--auth, -a``          Pass a ``username:password`` pair as
@@ -501,19 +501,28 @@ With password prompt:
     $ http -a username example.org
 
 
-Authorization information from your ``.netrc`` file is honored as well:
+Authorization information from your ``~/.netrc`` file is honored as well:
 
 .. code-block:: bash
 
-    $ cat .netrc
+    $ cat ~/.netrc
     machine httpbin.org
     login httpie
     password test
+
     $ http httpbin.org/basic-auth/httpie/test
     HTTP/1.1 200 OK
     [...]
 
 
+------------
+Auth Plugins
+------------
+
+* `httpie-ntlm <https://github.com/jkbr/httpie-ntlm>`_
+* `httpie-oauth <https://github.com/jkbr/httpie-oauth>`_
+
+
 =======
 Proxies
 =======
@@ -709,7 +718,16 @@ On OS X, you can send the contents of the clipboard with ``pbpaste``:
 
 
 Passing data through ``stdin`` cannot be combined with data fields specified
-on the command line.
+on the command line:
+
+
+.. code-block:: bash
+
+    $ echo 'data' | http POST example.org more=data   # This is invalid
+
+
+To prevent HTTPie from reading ``stdin`` data you can use the
+``--ignore-stdin`` option.
 
 
 -------------------------
@@ -840,7 +858,7 @@ by adding the following to your ``~/.bash_profile``:
 
     function httpless {
         # `httpless example.org'
-        http --pretty=all "$@" | less -R;
+        http --pretty=all --print=hb "$@" | less -R;
     }
 
 
@@ -1055,14 +1073,18 @@ When using HTTPie from **shell scripts**, it can be handy to set the
 ``--check-status`` flag. It instructs HTTPie to exit with an error if the
 HTTP status is one of ``3xx``, ``4xx``, or ``5xx``. The exit status will
 be ``3`` (unless ``--follow`` is set), ``4``, or ``5``,
-respectively. Also, the ``--timeout`` option allows to overwrite the default
-30s timeout:
+respectively.
+
+The ``--ignore-stdin`` option prevents HTTPie from reading data from ``stdin``,
+which is usually not desirable during non-interactive invocations.
+
+Also, the ``--timeout`` option allows to overwrite the default 30s timeout:
 
 .. code-block:: bash
 
     #!/bin/bash
 
-    if http --timeout=2.5 --check-status HEAD example.org/health &> /dev/null; then
+    if http --check-status --ignore-stdin --timeout=2.5 HEAD example.org/health &> /dev/null; then
         echo 'OK!'
     else
         case $? in
@@ -1191,8 +1213,14 @@ Changelog
 
 *You can click a version name to see a diff with the previous one.*
 
-* `0.7.0-dev`_
-* `0.6.0`_
+* `0.8.0-dev`_
+* `0.7.1`_ (2013-09-24)
+    * Added ``--ignore-stdin``.
+    * Added support for auth plugins.
+    * Improved ``--help`` output.
+    * Improved ``Content-Disposition`` parsing for ``--download`` mode.
+    * Update to Requests 2.0.0
+* `0.6.0`_ (2013-06-03)
     * XML data is now formatted.
     * ``--session`` and ``--session-read-only`` now also accept paths to
       session files (eg. ``http --session=/tmp/session.json example.org``).
@@ -1310,6 +1338,7 @@ Changelog
 .. _0.5.0: https://github.com/jkbr/httpie/compare/0.4.1...0.5.0
 .. _0.5.1: https://github.com/jkbr/httpie/compare/0.5.0...0.5.1
 .. _0.6.0: https://github.com/jkbr/httpie/compare/0.5.1...0.6.0
-.. _0.7.0-dev: https://github.com/jkbr/httpie/compare/0.6.0...master
+.. _0.7.1: https://github.com/jkbr/httpie/compare/0.6.0...0.7.1
+.. _0.8.0-dev: https://github.com/jkbr/httpie/compare/0.7.1...master
 .. _AUTHORS.rst: https://github.com/jkbr/httpie/blob/master/AUTHORS.rst
 .. _LICENSE: https://github.com/jkbr/httpie/blob/master/LICENSE

httpie/__init__.py

@@ -3,7 +3,7 @@ HTTPie - a CLI, cURL-like tool for humans.
 
 """
 __author__ = 'Jakub Roztocil'
-__version__ = '0.6.0'
+__version__ = '0.7.1'
 __licence__ = 'BSD'
 
 

httpie/cli.py

@@ -3,86 +3,134 @@
 NOTE: the CLI interface may change before reaching v1.0.
 
 """
-from argparse import FileType, OPTIONAL, ZERO_OR_MORE, SUPPRESS
+from textwrap import dedent, wrap
+#noinspection PyCompatibility
+from argparse import (RawDescriptionHelpFormatter, FileType,
+                      OPTIONAL, ZERO_OR_MORE, SUPPRESS)
 
 from . import __doc__
 from . import __version__
+from .plugins.builtin import BuiltinAuthPlugin
+from .plugins import plugin_manager
 from .sessions import DEFAULT_SESSIONS_DIR
 from .output import AVAILABLE_STYLES, DEFAULT_STYLE
 from .input import (Parser, AuthCredentialsArgType, KeyValueArgType,
                     SEP_PROXY, SEP_CREDENTIALS, SEP_GROUP_ITEMS,
                     OUT_REQ_HEAD, OUT_REQ_BODY, OUT_RESP_HEAD,
-                    OUT_RESP_BODY, OUTPUT_OPTIONS,
+                    OUT_RESP_BODY, OUTPUT_OPTIONS, OUTPUT_OPTIONS_DEFAULT,
                     PRETTY_MAP, PRETTY_STDOUT_TTY_ONLY, SessionNameValidator)
 
 
-def _(text):
-    """Normalize whitespace."""
-    return ' '.join(text.strip().split())
+class HTTPieHelpFormatter(RawDescriptionHelpFormatter):
+    """A nicer help formatter.
 
+    Help for arguments can be indented and contain new lines.
+    It will be de-dented and arguments in the help
+    will be separated by a blank line for better readability.
+
+
+    """
+    def __init__(self, max_help_position=6, *args, **kwargs):
+        # A smaller indent for args help.
+        kwargs['max_help_position'] = max_help_position
+        super(HTTPieHelpFormatter, self).__init__(*args, **kwargs)
+
+    def _split_lines(self, text, width):
+        text = dedent(text).strip() + '\n\n'
+        return text.splitlines()
 
 parser = Parser(
+    formatter_class=HTTPieHelpFormatter,
     description='%s <http://httpie.org>' % __doc__.strip(),
-    epilog='For every --option there is a --no-option'
-           ' that reverts the option to its default value.\n\n'
-           'Suggestions and bug reports are greatly appreciated:\n'
-           'https://github.com/jkbr/httpie/issues'
+    epilog=dedent("""
+    For every --OPTION there is also a --no-OPTION that reverts OPTION
+    to its default value.
+
+    Suggestions and bug reports are greatly appreciated:
+
+        https://github.com/jkbr/httpie/issues
+
+    """)
 )
 
 
-###############################################################################
+#######################################################################
 # Positional arguments.
-###############################################################################
+#######################################################################
 
 positional = parser.add_argument_group(
     title='Positional arguments',
-    description=_('''
-        These arguments come after any flags and in the
-        order they are listed here. Only URL is required.
-    ''')
+    description=dedent("""
+    These arguments come after any flags and in the order they are listed here.
+    Only URL is required.
+
+    """)
 )
 positional.add_argument(
     'method',
     metavar='METHOD',
     nargs=OPTIONAL,
     default=None,
-    help=_('''
-        The HTTP method to be used for the request
-        (GET, POST, PUT, DELETE, PATCH, ...).
-        If this argument is omitted, then HTTPie
-        will guess the HTTP method. If there is some
-        data to be sent, then it will be POST, otherwise GET.
-    ''')
+    help="""
+    The HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).
+
+    This argument can be omitted in which case HTTPie will use POST if there
+    is some data to be sent, otherwise GET:
+
+        $ http example.org               # => GET
+        $ http example.org hello=world   # => POST
+
+    """
 )
 positional.add_argument(
     'url',
     metavar='URL',
-    help=_('''
-        The protocol defaults to http:// if the
-        URL does not include one.
-    ''')
+    help="""
+    The scheme defaults to 'http://' if the URL does not include one.
+
+    """
 )
 positional.add_argument(
     'items',
     metavar='REQUEST ITEM',
     nargs=ZERO_OR_MORE,
     type=KeyValueArgType(*SEP_GROUP_ITEMS),
-    help=_('''
-        A key-value pair whose type is defined by the
-        separator used. It can be an HTTP header (header:value),
-        a data field to be used in the request body (field_name=value),
-        a raw JSON data field (field_name:=value),
-        a query parameter (name==value),
-        or a file field (field_name@/path/to/file).
-        You can use a backslash to escape a colliding
-        separator in the field name.
-    ''')
+    help=r"""
+    Optional key-value pairs to be included in the request. The separator used
+    determines the type:
+
+    ':' HTTP headers:
+
+        Referer:http://httpie.org  Cookie:foo=bar  User-Agent:bacon/1.0
+
+    '==' URL parameters to be appended to the request URI:
+
+        search==httpie
+
+    '=' Data fields to be serialized into a JSON object (with --json, -j)
+        or form data (with --form, -f):
+
+        name=HTTPie  language=Python  description='CLI HTTP client'
+
+    '@' Form file fields (only with --form, -f):
+
+        cs@~/Documents/CV.pdf
+
+    ':=' Non-string JSON data fields (only with --json, -j):
+
+        awesome:=true  amount:=42  colors:='["red", "green", "blue"]'
+
+    You can use a backslash to escape a colliding separator in the field name:
+
+        field-name-with\:colon=value
+
+    """
 )
 
 
-###############################################################################
+#######################################################################
 # Content type.
-###############################################################################
+#######################################################################
 
 content_type = parser.add_argument_group(
     title='Predefined content types',
@@ -92,29 +140,30 @@ content_type = parser.add_argument_group(
 content_type.add_argument(
     '--json', '-j',
     action='store_true',
-    help=_('''
-        (default) Data items from the command
-        line are serialized as a JSON object.
-        The Content-Type and Accept headers
-        are set to application/json (if not specified).
-    ''')
+    help="""
+    (default) Data items from the command line are serialized as a JSON object.
+    The Content-Type and Accept headers are set to application/json
+    (if not specified).
+
+    """
 )
 content_type.add_argument(
     '--form', '-f',
     action='store_true',
-    help=_('''
-        Data items from the command line are serialized as form fields.
-        The Content-Type is set to application/x-www-form-urlencoded
-        (if not specified).
-        The presence of any file fields results
-        in a multipart/form-data request.
-     ''')
+    help="""
+    Data items from the command line are serialized as form fields.
+
+    The Content-Type is set to application/x-www-form-urlencoded (if not
+    specified). The presence of any file fields results in a
+    multipart/form-data request.
+
+    """
 )
 
 
-###############################################################################
+#######################################################################
 # Output processing
-###############################################################################
+#######################################################################
 
 output_processing = parser.add_argument_group(title='Output processing')
 
@@ -123,12 +172,12 @@ output_processing.add_argument(
     dest='prettify',
     default=PRETTY_STDOUT_TTY_ONLY,
     choices=sorted(PRETTY_MAP.keys()),
-    help=_('''
-        Controls output processing. The value can be "none" to not prettify
-        the output (default for redirected output), "all" to apply both colors
-        and formatting
-        (default for terminal output), "colors", or "format".
-    ''')
+    help="""
+    Controls output processing. The value can be "none" to not prettify
+    the output (default for redirected output), "all" to apply both colors
+    and formatting (default for terminal output), "colors", or "format".
+
+    """
 )
 output_processing.add_argument(
     '--style', '-s',
@@ -136,75 +185,97 @@ output_processing.add_argument(
     metavar='STYLE',
     default=DEFAULT_STYLE,
     choices=AVAILABLE_STYLES,
-    help=_('''
-        Output coloring style. One of %s. Defaults to "%s".
-        For this option to work properly, please make sure that the
-        $TERM environment variable is set to "xterm-256color" or similar
-        (e.g., via `export TERM=xterm-256color' in your ~/.bashrc).
-    ''') % (', '.join(sorted(AVAILABLE_STYLES)), DEFAULT_STYLE)
+    help="""
+    Output coloring style (default is "{default}"). On of:
+
+{available}
+
+    For this option to work properly, please make sure that the $TERM
+    environment variable is set to "xterm-256color" or similar
+    (e.g., via `export TERM=xterm-256color' in your ~/.bashrc).
+
+    """
+    .format(
+        default=DEFAULT_STYLE,
+        available='\n'.join(
+            '{0: >20}'.format(line.strip())
+            for line in
+            wrap(' '.join(sorted(AVAILABLE_STYLES)), 60)
+        ),
+    )
 )
 
 
-###############################################################################
+#######################################################################
 # Output options
-###############################################################################
+#######################################################################
 output_options = parser.add_argument_group(title='Output options')
 
 output_options.add_argument(
     '--print', '-p',
     dest='output_options',
     metavar='WHAT',
-    help=_('''
-        String specifying what the output should contain:
-        "{request_headers}" stands for the request headers,  and
-        "{request_body}" for the request body.
-        "{response_headers}" stands for the response headers and
-        "{response_body}" for response the body.
-        The default behaviour is "hb" (i.e., the response
-        headers and body is printed), if standard output is not redirected.
-        If the output is piped to another program or to a file,
-        then only the body is printed by default.
-        '''.format(request_headers=OUT_REQ_HEAD,
-                   request_body=OUT_REQ_BODY,
-                   response_headers=OUT_RESP_HEAD,
-                   response_body=OUT_RESP_BODY,))
+    help="""
+    String specifying what the output should contain:
+
+        '{req_head}' request headers
+        '{req_body}' request body
+        '{res_head}' response headers
+        '{res_body}' response body
+
+    The default behaviour is '{default}' (i.e., the response headers and body
+    is printed), if standard output is not redirected. If the output is piped
+    to another program or to a file, then only the response body is printed
+    by default.
+
+    """
+    .format(
+        req_head=OUT_REQ_HEAD,
+        req_body=OUT_REQ_BODY,
+        res_head=OUT_RESP_HEAD,
+        res_body=OUT_RESP_BODY,
+        default=OUTPUT_OPTIONS_DEFAULT,
+    )
 )
 output_options.add_argument(
     '--verbose', '-v',
     dest='output_options',
     action='store_const',
     const=''.join(OUTPUT_OPTIONS),
-    help=_('''
-        Print the whole request as well as the response.
-        Shortcut for --print={0}.
-    '''.format(''.join(OUTPUT_OPTIONS)))
+    help="""
+    Print the whole request as well as the response. Shortcut for --print={0}.
+
+    """
+    .format(''.join(OUTPUT_OPTIONS))
 )
 output_options.add_argument(
     '--headers', '-h',
     dest='output_options',
     action='store_const',
     const=OUT_RESP_HEAD,
-    help=_('''
-        Print only the response headers.
-        Shortcut for --print={0}.
-    '''.format(OUT_RESP_HEAD))
+    help="""
+    Print only the response headers. Shortcut for --print={0}.
+
+    """
+    .format(OUT_RESP_HEAD)
 )
 output_options.add_argument(
     '--body', '-b',
     dest='output_options',
     action='store_const',
     const=OUT_RESP_BODY,
-    help=_('''
-        Print only the response body.
-        Shortcut for --print={0}.
-    '''.format(OUT_RESP_BODY))
+    help="""
+    Print only the response body. Shortcut for --print={0}.
+
+    """
+    .format(OUT_RESP_BODY)
 )
 
 output_options.add_argument(
     '--stream', '-S',
     action='store_true',
     default=False,
-    help=_('''
+    help="""
     Always stream the output by line, i.e., behave like `tail -f'.
 
     Without --stream and with --pretty (either set or implied),
@@ -216,33 +287,31 @@ output_options.add_argument(
     It is useful also without --pretty: It ensures that the output is flushed
     more often and in smaller chunks.
 
-    ''')
+    """
 )
-output_processing.add_argument(
+output_options.add_argument(
     '--output', '-o',
     type=FileType('a+b'),
     dest='output_file',
     metavar='FILE',
-    help=_(
-        '''
-        Save output to FILE. If --download is set, then only the response
-        body is saved to the file. Other parts of the HTTP exchange are
-        printed to stderr.
+    help="""
+    Save output to FILE. If --download is set, then only the response body is
+    saved to the file. Other parts of the HTTP exchange are printed to stderr.
+
+    """
 
-        '''
-    )
 )
 
 output_options.add_argument(
     '--download', '-d',
     action='store_true',
     default=False,
-    help=_('''
+    help="""
     Do not print the response body to stdout. Rather, download it and store it
     in a file. The filename is guessed unless specified with --output
     [filename]. This action is similar to the default behaviour of wget.
 
-    ''')
+    """
 )
 
 output_options.add_argument(
@@ -250,48 +319,56 @@ output_options.add_argument(
     dest='download_resume',
     action='store_true',
     default=False,
-    help=_('''
-    Resume an interrupted download.
-    The --output option needs to be specified as well.
-    ''')
+    help="""
+    Resume an interrupted download. Note that the --output option needs to be
+    specified as well.
+
+    """
 )
 
 
-###############################################################################
+#######################################################################
 # Sessions
-###############################################################################
+#######################################################################
 
 sessions = parser.add_argument_group(title='Sessions')\
                  .add_mutually_exclusive_group(required=False)
 
 session_name_validator = SessionNameValidator(
-    'Session name contains invalid characters.')
+    'Session name contains invalid characters.'
+)
 
 sessions.add_argument(
     '--session',
     metavar='SESSION_NAME_OR_PATH',
     type=session_name_validator,
-    help=_('''
-    Create, or reuse and update a session.
-    Within a session, custom headers, auth credential, as well as any
-    cookies sent by the server persist between requests.
-    Session files are stored in %s/<HOST>/<SESSION_NAME>.json.
-    ''' % DEFAULT_SESSIONS_DIR)
+    help="""
+    Create, or reuse and update a session. Within a session, custom headers,
+    auth credential, as well as any cookies sent by the server persist between
+    requests.
+
+    Session files are stored in:
+
+        {session_dir}/<HOST>/<SESSION_NAME>.json.
+
+    """
+    .format(session_dir=DEFAULT_SESSIONS_DIR)
 )
 sessions.add_argument(
     '--session-read-only',
     metavar='SESSION_NAME_OR_PATH',
     type=session_name_validator,
-    help=_('''
-        Create or read a session without updating it form the
-        request/response exchange.
-    ''')
+    help="""
+    Create or read a session without updating it form the request/response
+    exchange.
+
+    """
 )
 
 
-###############################################################################
+#######################################################################
 # Authentication
-###############################################################################
+#######################################################################
 
 # ``requests.request`` keyword arguments.
 auth = parser.add_argument_group(title='Authentication')
@@ -299,26 +376,45 @@ auth.add_argument(
     '--auth', '-a',
     metavar='USER[:PASS]',
     type=AuthCredentialsArgType(SEP_CREDENTIALS),
-    help=_('''
-        If only the username is provided (-a username),
-        HTTPie will prompt for the password.
-    '''),
+    help="""
+    If only the username is provided (-a username), HTTPie will prompt
+    for the password.
+
+    """,
 )
 
+_auth_plugins = plugin_manager.get_auth_plugins()
 auth.add_argument(
     '--auth-type',
-    choices=['basic', 'digest'],
-    default='basic',
-    help=_('''
-        The authentication mechanism to be used.
-        Defaults to "basic".
-    ''')
+    choices=[plugin.auth_type for plugin in _auth_plugins],
+    default=_auth_plugins[0].auth_type,
+    help="""
+    The authentication mechanism to be used. Defaults to "{default}".
+
+    {types}
+
+    """
+    .format(default=_auth_plugins[0].auth_type, types='\n    '.join(
+        '"{type}": {name}{package}{description}'.format(
+            type=plugin.auth_type,
+            name=plugin.name,
+            package=(
+                '' if issubclass(plugin, BuiltinAuthPlugin)
+                else ' (provided by %s)' % plugin.package_name
+            ),
+            description=(
+                '' if not plugin.description else
+                '\n      ' + ('\n      '.join(wrap(plugin.description)))
+            )
+        )
+        for plugin in _auth_plugins
+    )),
 )
 
 
-###############################################################################
+#######################################################################
 # Network
-###############################################################################
+#######################################################################
 
 network = parser.add_argument_group(title='Network')
 
@@ -328,31 +424,31 @@ network.add_argument(
     action='append',
     metavar='PROTOCOL:HOST',
     type=KeyValueArgType(SEP_PROXY),
-    help=_('''
-        String mapping protocol to the URL of the proxy
-        (e.g. http:foo.bar:3128). You can specify multiple
-        proxies with different protocols.
-    ''')
+    help="""
+    String mapping protocol to the URL of the proxy (e.g. http:foo.bar:3128).
+    You can specify multiple proxies with different protocols.
+
+    """
 )
 network.add_argument(
     '--follow',
     default=False,
     action='store_true',
-    help=_('''
-        Set this flag if full redirects are allowed
-        (e.g. re-POST-ing of data at new ``Location``)
-    ''')
+    help="""
+    Set this flag if full redirects are allowed (e.g. re-POST-ing of data at
+    new Location).
+
+    """
 )
 network.add_argument(
     '--verify',
     default='yes',
-    help=_('''
-        Set to "no" to skip checking the host\'s SSL certificate.
-        You can also pass the  path to a CA_BUNDLE
-        file for private certs. You can also set
-        the REQUESTS_CA_BUNDLE  environment variable.
-        Defaults to "yes".
-    ''')
+    help="""
+    Set to "no" to skip checking the host's SSL certificate. You can also pass
+    the  path to a CA_BUNDLE file for private certs. You can also set the
+    REQUESTS_CA_BUNDLE  environment variable. Defaults to "yes".
+
+    """
 )
 
 network.add_argument(
@@ -360,63 +456,79 @@ network.add_argument(
     type=float,
     default=30,
     metavar='SECONDS',
-    help=_('''
-        The connection timeout of the request in seconds.
-        The default value is 30 seconds.
-    ''')
+    help="""
+    The connection timeout of the request in seconds. The default value is
+    30 seconds.
+
+    """
 )
 network.add_argument(
     '--check-status',
     default=False,
     action='store_true',
-    help=_('''
-        By default, HTTPie exits with 0 when no network or other fatal
-        errors occur.
+    help="""
+    By default, HTTPie exits with 0 when no network or other fatal errors
+    occur. This flag instructs HTTPie to also check the HTTP status code and
+    exit with an error if the status indicates one.
 
-        This flag instructs HTTPie to also check the HTTP status code and
-        exit with an error if the status indicates one.
+    When the server replies with a 4xx (Client Error) or 5xx (Server Error)
+    status code, HTTPie exits with 4 or 5 respectively. If the response is a
+    3xx (Redirect) and --follow hasn't been set, then the exit status is 3.
+    Also an error message is written to stderr if stdout is redirected.
 
-        When the server replies with a 4xx (Client Error) or 5xx
-        (Server Error) status code, HTTPie exits with 4 or 5 respectively.
-        If the response is a 3xx (Redirect) and --follow
-        hasn't been set, then the exit status is 3.
-
-        Also an error message is written to stderr if stdout is redirected.
-
-    ''')
+    """
 )
 
 
-###############################################################################
+#######################################################################
 # Troubleshooting
-###############################################################################
+#######################################################################
 
 troubleshooting = parser.add_argument_group(title='Troubleshooting')
 
+troubleshooting.add_argument(
+    '--ignore-stdin',
+    action='store_true',
+    default=False,
+    help="""
+    Do not attempt to read stdin.
+
+    """
+)
 troubleshooting.add_argument(
     '--help',
     action='help',
     default=SUPPRESS,
-    help='Show this help message and exit'
+    help="""
+    Show this help message and exit.
+
+    """
 )
 troubleshooting.add_argument(
     '--version',
     action='version',
-    version=__version__
+    version=__version__,
+    help="""
+    Show version and exit.
+
+    """
 )
 troubleshooting.add_argument(
     '--traceback',
     action='store_true',
     default=False,
-    help='Prints exception traceback should one occur.'
+    help="""
+    Prints exception traceback should one occur.
+
+    """
 )
 troubleshooting.add_argument(
     '--debug',
     action='store_true',
     default=False,
-    help=_('''
-        Prints exception traceback should one occur, and also other
-        information that is useful for debugging HTTPie itself and
-        for bug reports.
-    ''')
+    help="""
+    Prints exception traceback should one occur, and also other information
+    that is useful for debugging HTTPie itself and for reporting bugs.
+
+    """
 )

httpie/client.py

@@ -3,10 +3,10 @@ import sys
 from pprint import pformat
 
 import requests
-import requests.auth
 
 from . import sessions
 from . import __version__
+from .plugins import plugin_manager
 
 
 FORM = 'application/x-www-form-urlencoded; charset=utf-8'
@@ -27,6 +27,7 @@ def get_response(args, config_dir):
         response = requests.request(**requests_kwargs)
     else:
         response = sessions.get_response(
+            args=args,
             config_dir=config_dir,
             session_name=args.session or args.session_read_only,
             requests_kwargs=requests_kwargs,
@@ -69,10 +70,8 @@ def get_requests_kwargs(args):
 
     credentials = None
     if args.auth:
-        credentials = {
-            'basic': requests.auth.HTTPBasicAuth,
-            'digest': requests.auth.HTTPDigestAuth,
-        }[args.auth_type](args.auth.key, args.auth.value)
+        auth_plugin = plugin_manager.get_auth_plugin(args.auth_type)()
+        credentials = auth_plugin.get_auth(args.auth.key, args.auth.value)
 
     kwargs = {
         'stream': True,

httpie/compat.py

@@ -12,7 +12,8 @@ from requests.compat import (
 )
 
 try:
+    #noinspection PyUnresolvedReferences,PyCompatibility
     from urllib.parse import urlsplit
 except ImportError:
+    #noinspection PyUnresolvedReferences,PyCompatibility
     from urlparse import urlsplit
-

httpie/core.py

@@ -18,13 +18,13 @@ from httpie import __version__ as httpie_version
 from requests import __version__ as requests_version
 from pygments import __version__ as pygments_version
 
-from .cli import parser
 from .compat import str, is_py3
 from .client import get_response
 from .downloads import Download
 from .models import Environment
 from .output import build_output_stream, write, write_with_colors_win_py3
 from . import ExitStatus
+from .plugins import plugin_manager
 
 
 def get_exit_status(http_status, follow=False):
@@ -58,6 +58,9 @@ def main(args=sys.argv[1:], env=Environment()):
     Return exit status code.
 
     """
+    plugin_manager.load_installed_plugins()
+    from .cli import parser
+
     if env.config.default_options:
         args = env.config.default_options + args
 
@@ -132,6 +135,10 @@ def main(args=sys.argv[1:], env=Environment()):
                 download.finish()
                 if download.interrupted:
                     exit_status = ExitStatus.ERROR
+                    error('Incomplete download: size=%d; downloaded=%d' % (
+                        download.status.total_size,
+                        download.status.downloaded
+                    ))
 
         except IOError as e:
             if not traceback and e.errno == errno.EPIPE:

httpie/downloads.py

@@ -10,6 +10,7 @@ import sys
 import mimetypes
 import threading
 from time import sleep, time
+from mailbox import Message
 
 from .output import RawStream
 from .models import HTTPResponse
@@ -104,11 +105,14 @@ def filename_from_content_disposition(content_disposition):
 
     """
     # attachment; filename=jkbr-httpie-0.4.1-20-g40bd8f6.tar.gz
-    match = re.search('filename=(\S+)', content_disposition)
-    if match and match.group(1):
-        fn = match.group(1).strip('."')
-        if re.match('^[a-zA-Z0-9._-]+$', fn):
-            return fn
+
+    msg = Message('Content-Disposition: %s' % content_disposition)
+    filename = msg.get_filename()
+    if filename:
+        # Basic sanitation.
+        filename = os.path.basename(filename).lstrip('.').strip()
+        if filename:
+            return filename
 
 
 def filename_from_url(url, content_type):
@@ -162,9 +166,9 @@ class Download(object):
         self._resumed_from = 0
         self.finished = False
 
-        self._status = Status()
+        self.status = Status()
         self._progress_reporter = ProgressReporterThread(
-            status=self._status,
+            status=self.status,
             output=progress_file
         )
 
@@ -197,7 +201,7 @@ class Download(object):
         :return: RawStream, output_file
 
         """
-        assert not self._status.time_started
+        assert not self.status.time_started
 
         try:
             total_size = int(response.headers['Content-Length'])
@@ -232,7 +236,7 @@ class Download(object):
                 )
             self._output_file = open(get_unique_filename(fn), mode='a+b')
 
-        self._status.started(
+        self.status.started(
             resumed_from=self._resumed_from,
             total_size=total_size
         )
@@ -241,7 +245,7 @@ class Download(object):
             msg=HTTPResponse(response),
             with_headers=False,
             with_body=True,
-            on_body_chunk_downloaded=self._chunk_downloaded,
+            on_body_chunk_downloaded=self.chunk_downloaded,
             chunk_size=1024 * 8
         )
 
@@ -260,7 +264,7 @@ class Download(object):
     def finish(self):
         assert not self.finished
         self.finished = True
-        self._status.finished()
+        self.status.finished()
 
     def failed(self):
         self._progress_reporter.stop()
@@ -269,11 +273,11 @@ class Download(object):
     def interrupted(self):
         return (
             self.finished
-            and self._status.total_size
-            and self._status.total_size != self._status.downloaded
+            and self.status.total_size
+            and self.status.total_size != self.status.downloaded
         )
 
-    def _chunk_downloaded(self, chunk):
+    def chunk_downloaded(self, chunk):
         """
         A download progress callback.
 
@@ -282,7 +286,7 @@ class Download(object):
         :type chunk: bytes
 
         """
-        self._status.chunk_downloaded(len(chunk))
+        self.status.chunk_downloaded(len(chunk))
 
 
 class Status(object):

httpie/input.py

@@ -6,8 +6,9 @@ import sys
 import re
 import json
 import mimetypes
-import getpass
+from getpass import getpass
 from io import BytesIO
+#noinspection PyCompatibility
 from argparse import ArgumentParser, ArgumentTypeError, ArgumentError
 
 try:
@@ -114,7 +115,7 @@ class Parser(ArgumentParser):
         self._process_pretty_options()
         self._guess_method()
         self._parse_items()
-        if not env.stdin_isatty:
+        if not self.args.ignore_stdin and not env.stdin_isatty:
             self._body_from_file(self.env.stdin)
         if not (self.args.url.startswith((HTTP, HTTPS))):
             # Default to 'https://' if invoked as `https args`.
@@ -183,6 +184,9 @@ class Parser(ArgumentParser):
         if self.args.auth:
             if not self.args.auth.has_password():
                 # Stdin already read (if not a tty) so it's save to prompt.
+                if self.args.ignore_stdin:
+                    self.error('Unable to prompt for passwords because'
+                               ' --ignore-stdin is set.')
                 self.args.auth.prompt_password(url.netloc)
 
         elif url.username is not None:
@@ -240,7 +244,7 @@ class Parser(ArgumentParser):
         if self.args.method is None:
             # Invoked as `http URL'.
             assert not self.args.items
-            if not self.env.stdin_isatty:
+            if not self.args.ignore_stdin and not self.env.stdin_isatty:
                 self.args.method = HTTP_POST
             else:
                 self.args.method = HTTP_GET
@@ -265,9 +269,12 @@ class Parser(ArgumentParser):
                 # Set the URL correctly
                 self.args.url = self.args.method
                 # Infer the method
-                has_data = not self.env.stdin_isatty or any(
-                    item.sep in SEP_GROUP_DATA_ITEMS
-                    for item in self.args.items
+                has_data = (
+                    (not self.args.ignore_stdin and
+                     not self.env.stdin_isatty) or any(
+                        item.sep in SEP_GROUP_DATA_ITEMS
+                        for item in self.args.items
+                    )
                 )
                 self.args.method = HTTP_POST if has_data else HTTP_GET
 
@@ -417,8 +424,8 @@ class KeyValueArgType(object):
             """Tokenize `s`. There are only two token types - strings
             and escaped characters:
 
-            >>> tokenize(r'foo\=bar\\baz')
-            ['foo', Escaped('='), 'bar', Escaped('\\'), 'baz']
+            tokenize(r'foo\=bar\\baz')
+            => ['foo', Escaped('='), 'bar', Escaped('\\'), 'baz']
 
             """
             tokens = ['']

httpie/models.py

@@ -88,16 +88,7 @@ class HTTPMessage(object):
     @property
     def content_type(self):
         """Return the message content type."""
-        ct = self._orig.headers.get(
-            b'Content-Type',
-            self._orig.headers.get(
-                'Content-Type',
-                ''
-            )
-        )
-        if isinstance(ct, bytes):
-            ct = ct.decode()
-        return ct
+        return self._orig.headers.get('Content-Type', '')
 
 
 class HTTPResponse(HTTPMessage):
@@ -109,6 +100,7 @@ class HTTPResponse(HTTPMessage):
     def iter_lines(self, chunk_size):
         return ((line, b'\n') for line in self._orig.iter_lines(chunk_size))
 
+    #noinspection PyProtectedMember
     @property
     def headers(self):
         original = self._orig.raw._original_response

httpie/plugins/__init__.py

@@ -0,0 +1,9 @@
+from .base import AuthPlugin
+from .manager import PluginManager
+from .builtin import BasicAuthPlugin, DigestAuthPlugin
+
+
+plugin_manager = PluginManager()
+plugin_manager.register(BasicAuthPlugin)
+plugin_manager.register(DigestAuthPlugin)
+

httpie/plugins/base.py

@@ -0,0 +1,28 @@
+class AuthPlugin(object):
+    """
+    Base auth plugin class.
+
+    See <https://github.com/jkbr/httpie-ntlm> for an example auth plugin.
+
+    """
+
+    # The value that should be passed to --auth-type
+    # to use this auth plugin. Eg. "my-auth"
+    auth_type = None
+
+    # The name of the plugin, eg. "My auth".
+    name = None
+
+    # Optional short description. Will be be shown in the help
+    # under --auth-type.
+    description = None
+
+    # This be set automatically once the plugin has been loaded.
+    package_name = None
+
+    def get_auth(self, username, password):
+        """
+        Return a ``requests.auth.AuthBase`` subclass instance.
+
+        """
+        raise NotImplementedError()

httpie/plugins/builtin.py

@@ -0,0 +1,26 @@
+import requests.auth
+
+from .base import AuthPlugin
+
+
+class BuiltinAuthPlugin(AuthPlugin):
+
+    package_name = '(builtin)'
+
+
+class BasicAuthPlugin(BuiltinAuthPlugin):
+
+    name = 'Basic HTTP auth'
+    auth_type = 'basic'
+
+    def get_auth(self, username, password):
+        return requests.auth.HTTPBasicAuth(username, password)
+
+
+class DigestAuthPlugin(BuiltinAuthPlugin):
+
+    name = 'Digest HTTP auth'
+    auth_type = 'digest'
+
+    def get_auth(self, username, password):
+        return requests.auth.HTTPDigestAuth(username, password)

httpie/plugins/manager.py

@@ -0,0 +1,35 @@
+from pkg_resources import iter_entry_points
+
+
+ENTRY_POINT_NAMES = [
+    'httpie.plugins.auth.v1'
+]
+
+
+class PluginManager(object):
+
+    def __init__(self):
+        self._plugins = []
+
+    def __iter__(self):
+        return iter(self._plugins)
+
+    def register(self, plugin):
+        self._plugins.append(plugin)
+
+    def get_auth_plugins(self):
+        return list(self._plugins)
+
+    def get_auth_plugin_mapping(self):
+        return dict((plugin.auth_type, plugin) for plugin in self)
+
+    def get_auth_plugin(self, auth_type):
+        return self.get_auth_plugin_mapping()[auth_type]
+
+    def load_installed_plugins(self):
+
+        for entry_point_name in ENTRY_POINT_NAMES:
+            for entry_point in iter_entry_points(entry_point_name):
+                plugin = entry_point.load()
+                plugin.package_name = entry_point.dist.key
+                self.register(entry_point.load())

httpie/sessions.py

@@ -6,10 +6,10 @@ import os
 
 import requests
 from requests.cookies import RequestsCookieJar, create_cookie
-from requests.auth import HTTPBasicAuth, HTTPDigestAuth
 
 from .compat import urlsplit
 from .config import BaseConfigDict, DEFAULT_CONFIG_DIR
+from httpie.plugins import plugin_manager
 
 
 SESSIONS_DIR_NAME = 'sessions'
@@ -21,7 +21,8 @@ VALID_SESSION_NAME_PATTERN = re.compile('^[a-zA-Z0-9_.-]+$')
 SESSION_IGNORED_HEADER_PREFIXES = ['Content-', 'If-']
 
 
-def get_response(session_name, requests_kwargs, config_dir, read_only=False):
+def get_response(session_name, requests_kwargs, config_dir, args,
+                 read_only=False):
     """Like `client.get_response`, but applies permanent
     aspects of the session to the request.
 
@@ -50,9 +51,12 @@ def get_response(session_name, requests_kwargs, config_dir, read_only=False):
     requests_kwargs['headers'] = dict(session.headers, **request_headers)
     session.update_headers(request_headers)
 
-    auth = requests_kwargs.get('auth', None)
-    if auth:
-        session.auth = auth
+    if args.auth:
+        session.auth = {
+            'type': args.auth_type,
+            'username': args.auth.key,
+            'password': args.auth.value,
+        }
     elif session.auth:
         requests_kwargs['auth'] = session.auth
 
@@ -140,15 +144,10 @@ class Session(BaseConfigDict):
         auth = self.get('auth', None)
         if not auth or not auth['type']:
             return
-        Auth = {'basic': HTTPBasicAuth,
-                'digest': HTTPDigestAuth}[auth['type']]
-        return Auth(auth['username'], auth['password'])
+        auth_plugin = plugin_manager.get_auth_plugin(auth['type'])()
+        return auth_plugin.get_auth(auth['username'], auth['password'])
 
     @auth.setter
-    def auth(self, cred):
-        self['auth'] = {
-            'type': {HTTPBasicAuth: 'basic',
-                     HTTPDigestAuth: 'digest'}[type(cred)],
-            'username': cred.username,
-            'password': cred.password,
-        }
+    def auth(self, auth):
+        assert set(['type', 'username', 'password']) == set(auth.keys())
+        self['auth'] = auth

setup.py

@@ -1,6 +1,5 @@
 import os
 import sys
-import re
 import codecs
 from setuptools import setup
 import httpie
@@ -12,24 +11,23 @@ if sys.argv[-1] == 'test':
 
 
 requirements = [
-    'requests>=1.2.3',
+    'requests>=2.0.0',
     'Pygments>=1.5'
 ]
-if sys.version_info[:2] in ((2, 6), (3, 1)):
-    # argparse has been added in Python 3.2 / 2.7
+try:
+    #noinspection PyUnresolvedReferences
+    import argparse
+except ImportError:
     requirements.append('argparse>=1.2.1')
+
 if 'win32' in str(sys.platform).lower():
     # Terminal colors for Windows
     requirements.append('colorama>=0.2.4')
 
 
 def long_description():
-    """Pre-process the README so that PyPi can render it properly."""
     with codecs.open('README.rst', encoding='utf8') as f:
-        rst = f.read()
-    code_block = '(:\n\n)?\.\. code-block::.*'
-    rst = re.sub(code_block, '::', rst)
-    return rst
+        return f.read()
 
 
 setup(
@@ -42,7 +40,7 @@ setup(
     author=httpie.__author__,
     author_email='jakub@roztocil.name',
     license=httpie.__licence__,
-    packages=['httpie'],
+    packages=['httpie', 'httpie.plugins'],
     entry_points={
         'console_scripts': [
             'http = httpie.__main__:main',

tests/tests.py

@@ -23,6 +23,7 @@ import subprocess
 import os
 import sys
 import json
+#noinspection PyCompatibility
 import argparse
 import tempfile
 import unittest
@@ -31,9 +32,11 @@ import time
 from requests.structures import CaseInsensitiveDict
 
 try:
+    #noinspection PyCompatibility
     from urllib.request import urlopen
 except ImportError:
     # noinspection PyUnresolvedReferences
+    #noinspection PyCompatibility
     from urllib2 import urlopen
 try:
     from unittest import skipIf, skip
@@ -110,7 +113,8 @@ with open(BIN_FILE_PATH, 'rb') as f:
 
 
 def httpbin(path):
-    return HTTPBIN_URL + path
+    url = HTTPBIN_URL + path
+    return url
 
 
 def mk_config_dir():
@@ -805,9 +809,8 @@ class RequestBodyFromFilePathTest(BaseTestCase):
 
     """
     def test_request_body_from_file_by_path(self):
-        # FIXME: *sometimes* fails on py33, the content-type is form.
-        # https://github.com/jkbr/httpie/issues/140
         r = http(
+            '--verbose',
             'POST',
             httpbin('/post'),
             '@' + FILE_PATH_ARG
@@ -817,8 +820,6 @@ class RequestBodyFromFilePathTest(BaseTestCase):
         self.assertIn('"Content-Type": "text/plain"', r)
 
     def test_request_body_from_file_by_path_with_explicit_content_type(self):
-        # FIXME: *sometimes* fails on py33, the content-type is form.
-        # https://github.com/jkbr/httpie/issues/140
         r = http(
             'POST',
             httpbin('/post'),
@@ -1078,6 +1079,30 @@ class StreamTest(BaseTestCase):
         self.assertIn(BIN_FILE_CONTENT, r)
 
 
+class IgnoreStdinTest(BaseTestCase):
+
+    def test_ignore_stdin(self):
+        with open(FILE_PATH) as f:
+            r = http(
+                '--ignore-stdin',
+                '--verbose',
+                httpbin('/get'),
+                env=TestEnvironment(stdin=f, stdin_isatty=False)
+            )
+        self.assertIn(OK, r)
+        self.assertIn('GET /get HTTP', r)  # Don't default to POST.
+        self.assertNotIn(FILE_CONTENT, r)  # Don't send stdin data.
+
+    def test_ignore_stdin_cannot_prompt_password(self):
+        r = http(
+            '--ignore-stdin',
+            '--auth=username-without-password',
+            httpbin('/get'),
+        )
+        self.assertEqual(r.exit_status, ExitStatus.ERROR)
+        self.assertIn('because --ignore-stdin', r.stderr)
+
+
 class LineEndingsTest(BaseTestCase):
     """Test that CRLF is properly used in headers and
     as the headers/body separator."""
@@ -1230,6 +1255,7 @@ class ArgumentParserTestCase(unittest.TestCase):
         self.parser.args.method = 'GET'
         self.parser.args.url = 'http://example.com/'
         self.parser.args.items = []
+        self.parser.args.ignore_stdin = False
 
         self.parser.env = TestEnvironment()
 
@@ -1245,6 +1271,7 @@ class ArgumentParserTestCase(unittest.TestCase):
         self.parser.args.method = None
         self.parser.args.url = 'http://example.com/'
         self.parser.args.items = []
+        self.parser.args.ignore_stdin = False
         self.parser.env = TestEnvironment()
 
         self.parser._guess_method()
@@ -1258,6 +1285,7 @@ class ArgumentParserTestCase(unittest.TestCase):
         self.parser.args.method = 'http://example.com/'
         self.parser.args.url = 'data=field'
         self.parser.args.items = []
+        self.parser.args.ignore_stdin = False
         self.parser.env = TestEnvironment()
         self.parser._guess_method()
 
@@ -1273,6 +1301,7 @@ class ArgumentParserTestCase(unittest.TestCase):
         self.parser.args.method = 'http://example.com/'
         self.parser.args.url = 'test:header'
         self.parser.args.items = []
+        self.parser.args.ignore_stdin = False
 
         self.parser.env = TestEnvironment()
 
@@ -1293,6 +1322,7 @@ class ArgumentParserTestCase(unittest.TestCase):
             input.KeyValue(
                 key='old_item', value='b', sep='=', orig='old_item=b')
         ]
+        self.parser.args.ignore_stdin = False
 
         self.parser.env = TestEnvironment()
 
@@ -1528,9 +1558,16 @@ class DownloadUtilsTest(BaseTestCase):
             parse('attachment; filename=".hello-WORLD_123.txt"'),
             'hello-WORLD_123.txt'
         )
+        self.assertEqual(
+            parse('attachment; filename="white space.txt"'),
+            'white space.txt'
+        )
+        self.assertEqual(
+            parse(r'attachment; filename="\"quotes\".txt"'),
+            '"quotes".txt'
+        )
+        self.assertEqual(parse('attachment; filename=/etc/hosts'), 'hosts')
         self.assertIsNone(parse('attachment; filename='))
-        self.assertIsNone(parse('attachment; filename=/etc/hosts'))
-        self.assertIsNone(parse('attachment; filename=hello@world'))
 
     def test_filename_from_url(self):
         self.assertEqual(filename_from_url(
@@ -1612,9 +1649,9 @@ class DownloadTest(BaseTestCase):
              headers={'Content-Length': 10}
         ))
         time.sleep(1.1)
-        download._chunk_downloaded(b'12345')
+        download.chunk_downloaded(b'12345')
         time.sleep(1.1)
-        download._chunk_downloaded(b'12345')
+        download.chunk_downloaded(b'12345')
         download.finish()
         self.assertFalse(download.interrupted)
 
@@ -1622,19 +1659,17 @@ class DownloadTest(BaseTestCase):
         download = Download(output_file=open(os.devnull, 'w'))
         download.start(Response(url=httpbin('/')))
         time.sleep(1.1)
-        download._chunk_downloaded(b'12345')
+        download.chunk_downloaded(b'12345')
         download.finish()
         self.assertFalse(download.interrupted)
 
     def test_download_interrupted(self):
-        download = Download(
-            output_file=open(os.devnull, 'w')
-        )
+        download = Download(output_file=open(os.devnull, 'w'))
         download.start(Response(
             url=httpbin('/'),
             headers={'Content-Length': 5}
         ))
-        download._chunk_downloaded(b'1234')
+        download.chunk_downloaded(b'1234')
         download.finish()
         self.assertTrue(download.interrupted)