summaryrefslogtreecommitdiff
path: root/tests/doc/test_basic_usage.py
blob: 899da8d84c0272978b8848fdb3f36b398f46faba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# Copyright 2015 Vladimir Rutsky <vladimir@rutsky.org>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Test basic usage."""

import unittest


class TestBasicUsage(unittest.TestCase):
    def test_main(self):
        # This tests corresponds to example from documentation.
        # If you updating it, don't forget to update documentation.

        import asyncio
        from aiohttp import web
        import aiohttp_cors

        @asyncio.coroutine
        def handler(request):
            return web.Response(
                text="Hello!",
                headers={
                    "X-Custom-Server-Header": "Custom data",
                })

        app = web.Application()

        # `aiohttp_cors.setup` returns `aiohttp_cors.CorsConfig` instance.
        # The `cors` instance will store CORS configuration for the
        # application.
        cors = aiohttp_cors.setup(app)

        # To enable CORS processing for specific route you need to add
        # that route to the CORS configuration object and specify its
        # CORS options.
        resource = cors.add(app.router.add_resource("/hello"))
        route = cors.add(
            resource.add_route("GET", handler), {
                "http://client.example.org": aiohttp_cors.ResourceOptions(
                    allow_credentials=True,
                    expose_headers=("X-Custom-Server-Header",),
                    allow_headers=("X-Requested-With", "Content-Type"),
                    max_age=3600,
                )
            })

        assert route is not None

    def test_defaults(self):
        # This tests corresponds to example from documentation.
        # If you updating it, don't forget to update documentation.

        import asyncio
        from aiohttp import web
        import aiohttp_cors

        @asyncio.coroutine
        def handler(request):
            return web.Response(
                text="Hello!",
                headers={
                    "X-Custom-Server-Header": "Custom data",
                })

        handler_post = handler
        handler_put = handler

        app = web.Application()

        # Example:

        cors = aiohttp_cors.setup(app, defaults={
                # Allow all to read all CORS-enabled resources from
                # http://client.example.org.
                "http://client.example.org": aiohttp_cors.ResourceOptions(),
            })

        # Enable CORS on routes.

        # According to defaults POST and PUT will be available only to
        # "http://client.example.org".
        hello_resource = cors.add(app.router.add_resource("/hello"))
        cors.add(hello_resource.add_route("POST", handler_post))
        cors.add(hello_resource.add_route("PUT", handler_put))

        # In addition to "http://client.example.org", GET request will be
        # allowed from "http://other-client.example.org" origin.
        cors.add(hello_resource.add_route("GET", handler), {
                "http://other-client.example.org":
                aiohttp_cors.ResourceOptions(),
            })

        # CORS will be enabled only on the resources added to `CorsConfig`,
        # so following resource will be NOT CORS-enabled.
        app.router.add_route("GET", "/private", handler)