Example usage¶

$ pip3 install couchdb_download_token
$ pip3 install gunicorn
$ gunicorn couchdb_download_token:api
[2016-07-12 23:33:28 -0300] [7880] [INFO] Starting gunicorn 19.6.0
[2016-07-12 23:33:28 -0300] [7880] [INFO] Listening at: http://127.0.0.1:8000 (7880)
[2016-07-12 23:33:28 -0300] [7880] [INFO] Using worker: sync
[2016-07-12 23:33:28 -0300] [7884] [INFO] Booting worker with pid: 7884
$ curl http://localhost:5984/my_database/my_document
{
    "_id": "my_document",
    "_rev": "4-763e041701ae3e55fd4af08dff93efc4",
    "info": "test document",
    "download_token": "123456",
    "_attachments": {
        "file.txt": {
            "content_type": "text/plain",
            "revpos": 2,
            "digest": "md5-U0f+Rrm7WPnsUGK3oD8t8g==",
            "length": 100,
            "stub": true
        }
    }
}
$ curl http://localhost:8000/my_database/my_document/file.txt?token=incorrect
...
< HTTP/1.1 403 Forbidden
< Server: gunicorn/19.6.0
...
$ curl http://localhost:8000/my_database/my_document/file.txt?token=123456
...
< HTTP/1.1 200 OK
< Server: gunicorn/19.6.0
< Date: Wed, 13 Jul 2016 03:02:07 GMT
< Connection: close
< Transfer-Encoding: chunked
< content-type: text/plain
File contents

Credits¶

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Stable release¶

To install CouchDB Download Token Service, run this command in your terminal:

$ pip install couchdb_download_token

This is the preferred method to install CouchDB Download Token Service, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for CouchDB Download Token Service can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/sh4r3m4n/couchdb_download_token

Or download the tarball:

$ curl  -OL https://github.com/sh4r3m4n/couchdb_download_token/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Run the server¶

To start the server, first install the package as described in the installation page. The API can run in any WSGI server, like Gunicorn:

$ pip install gunicorn
$ gunicorn couchdb_download_token:api
[2016-07-12 23:33:28 -0300] [7880] [INFO] Starting gunicorn 19.6.0
[2016-07-12 23:33:28 -0300] [7880] [INFO] Listening at: http://127.0.0.1:8000 (7880)
[2016-07-12 23:33:28 -0300] [7880] [INFO] Using worker: sync
[2016-07-12 23:33:28 -0300] [7884] [INFO] Booting worker with pid: 7884

Web API Usage¶

GET /(str: database_name)/(str: document_id)/(str: attachment_filename)¶

Download the attachment attachment_filename of the document with id document_id in database database_name if download token matches.

Query Parameters:
	token – download token of the document
Response Headers:
	Content-Type – The content type that specified in the document’s attachment metadata
Status Codes:	200 OK – No error, permission granted 403 Forbidden – Download token mismatch, permission dennied. If there is no token in the document or if it is null a 403 error will be raised too. 404 Not Found – Attachment not found. Only raised if the token is valid.

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up couchdb_download_token for local development.

1. Fork the couchdb_download_token repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/couchdb_download_token.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv couchdb_download_token
   $ cd couchdb_download_token/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 couchdb_download_token tests
   $ python setup.py test or py.test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/sh4r3m4n/couchdb_download_token/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_couchdb_download_token