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
|
# HTTP library for Lua.
## Features
- Optionally asynchronous (including DNS lookups and TLS)
- Supports HTTP(S) version 1.0, 1.1 and 2
- Functionality for both client and server
- Cookie Management
- Websockets
- Compatible with Lua 5.1, 5.2, 5.3 and [LuaJIT](http://luajit.org/)
## Documentation
Can be found at [https://daurnimator.github.io/lua-http/](https://daurnimator.github.io/lua-http/)
## Status
[](https://github.com/daurnimator/lua-http/actions?query=workflow%3Aci)
[](https://coveralls.io/github/daurnimator/lua-http?branch=master)
[](https://bestpractices.coreinfrastructure.org/projects/108)
# Installation
It's recommended to install lua-http by using [luarocks](https://luarocks.org/).
This will automatically install run-time lua dependencies for you.
$ luarocks install http
## Dependencies
- [cqueues](http://25thandclement.com/~william/projects/cqueues.html) >= 20161214 (Note: cqueues currently doesn't support Microsoft Windows operating systems)
- [luaossl](http://25thandclement.com/~william/projects/luaossl.html) >= 20161208
- [basexx](https://github.com/aiq/basexx/) >= 0.2.0
- [lpeg](http://www.inf.puc-rio.br/~roberto/lpeg/lpeg.html)
- [lpeg_patterns](https://github.com/daurnimator/lpeg_patterns) >= 0.5
- [binaryheap](https://github.com/Tieske/binaryheap.lua) >= 0.3
- [fifo](https://github.com/daurnimator/fifo.lua)
To use gzip compression you need **one** of:
- [lzlib](https://github.com/LuaDist/lzlib) or [lua-zlib](https://github.com/brimworks/lua-zlib)
To check cookies against a public suffix list:
- [lua-psl](https://github.com/daurnimator/lua-psl)
If using lua < 5.3 you will need
- [compat-5.3](https://github.com/keplerproject/lua-compat-5.3) >= 0.3
If using lua 5.1 you will need
- [luabitop](http://bitop.luajit.org/) (comes [with LuaJIT](http://luajit.org/extensions.html)) or a [backported bit32](https://luarocks.org/modules/siffiejoe/bit32)
### For running tests
- [luacheck](https://github.com/mpeterv/luacheck)
- [busted](http://olivinelabs.com/busted/)
- [luacov](https://keplerproject.github.io/luacov/)
# Development
## Getting started
- Clone the repo:
```
$ git clone https://github.com/daurnimator/lua-http.git
$ cd lua-http
```
- Install dependencies
```
$ luarocks install --only-deps http-scm-0.rockspec
```
- Lint the code (check for common programming errors)
```
$ luacheck .
```
- Run tests and view coverage report ([install tools first](#for-running-tests))
```
$ busted -c
$ luacov && less luacov.report.out
```
- Install your local copy:
```
$ luarocks make http-scm-0.rockspec
```
## Generating documentation
Documentation is written in markdown and intended to be consumed by [pandoc](http://pandoc.org/). See the `doc/` directory for more information.
|
