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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
# Accept header(s) for Erlang/Elixir #
Copyright (c) 2016 Ilya Khaprov <<i.khaprov@gmail.com>>.
__Version:__ 0.3.5
[](https://hex.pm/packages/accept)
[](https://hex.pm/packages/accept)
[](https://travis-ci.org/deadtrickster/accept)
[](https://coveralls.io/github/deadtrickster/accept?branch=master)
## TOC
- [Accept](#accept-header)
- [Accept-Encoding](#accept-encoding-header)
- [Contributing](#contributing)
- [License](#license)
## Headers
### Accept
[RFC](https://tools.ietf.org/html/rfc7231#section-5.3.2)
#### Parsing
```erlang
1> accept_header:parse("text/*;q=0.3, text/html;q=0.7, text/html;level=1,"
"text/html;level=2;q=0.4, */*;q=0.5").
[{media_range,"text","*",0.3,[]},
{media_range,"text","html",0.7,[]},
{media_range,"text","html",1,[{"level","1"}]},
{media_range,"text","html",0.4,[{"level","2"}]},
{media_range,"*","*",0.5,[]}]
```
#### Content Negotiation
```erlang
2> accept_header:negotiate("text/*;q=0.3, text/html;q=0.7, text/html;level=1,"
"text/html;level=2;q=0.4, */*;q=0.5",
["text/html;level=2", "text/html;level-3"]).
"text/html;level-3"
```
`"text/html;level-3"` returned because `"text/html;level=2"` matches to
`text/html;level=2;q=0.4` with score 0.4 and most specific match for
`"text/html;level-3"` is `text/html;q=0.7` with score 0.7.
```erlang
3> accept_header:negotiate("application/xml,application/xhtml+xml,"
3> "text/html;q=0.9,text/plain;q=0.8,image/png,image/*;q=0.9,*/*;q=0.5",
3> ["text/n3",
3> "application/rdf+xml"]).
"text/n3"
```
Negotiate preserves user-defined order for equally scored alternatives.
### Accept-Encoding
[RFC](https://tools.ietf.org/html/rfc7231#section-5.3.4)
#### Parsing
```erlang
1> accept_encoding_header:parse("gzip;q=1.0, identity; q=0.5, *;q=0").
[{content_coding,"gzip",1.0,[]},
{content_coding,"identity",0.5,[]},
{content_coding,"*",0,[]}]
```
#### Content Negotiation
```erlang
1> accept_encoding_header:negotiate("compress, gzip",
1> ["identity", "compress"]).
"compress"
2> accept_encoding_header:negotiate("gzip;q=1.0, identity; q=0.5, *;q=0",
2> ["identity", "sdc", "gzip", "compress"]).
"gzip"
3> accept_encoding_header:negotiate("compress, gzip, *;q=0",
3> ["qwe"]).
undefined
```
Negotiate preserves user-defined order for equally scored alternatives.
## Contributing
Sections order:
`Types -> Macros -> Callbacks -> Public API -> Deprecations -> Private Parts`
install git precommit hook:
```
./bin/pre-commit.sh install
```
Pre-commit check can be skipped passing `--no-verify` option to git commit.
## License
MIT
## Modules ##
<table width="100%" border="0" summary="list of modules">
<tr><td><a href="https://github.com/deadtrickster/accept/blob/master/doc/accept_encoding_header.md" class="module">accept_encoding_header</a></td></tr>
<tr><td><a href="https://github.com/deadtrickster/accept/blob/master/doc/accept_header.md" class="module">accept_header</a></td></tr></table>
|
