blob: 007c7bef6f0557540142f5e7ed17f8ecbe30b43d (
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
|
# Plum [](https://travis-ci.org/rhenium/plum) [](https://codeclimate.com/github/rhenium/plum) [](https://codeclimate.com/github/rhenium/plum/coverage)
A pure Ruby HTTP/2 implementation.
## Requirements
* Ruby
* Ruby 2.2 with [ALPN support patch](https://gist.github.com/rhenium/b1711edcc903e8887a51) and [ECDH support patch (r51348)](https://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/51348/diff?format=diff)
* or latest Ruby 2.3.0-dev
* OpenSSL 1.0.2 or newer (HTTP/2 requires ALPN)
* Optional:
* [http_parser.rb gem](https://rubygems.org/gems/http_parser.rb) (HTTP/1.x parser; if you use "http" URI scheme)
* [rack gem](https://rubygems.org/gems/rack) if you use Plum as Rack server.
## Usage
### As a HTTP/2 (HTTP/1.x) client library
If the server does't support HTTP/2, `Plum::Client` tries to use HTTP/1.x instead.
##### Sequential request
```ruby
client = Plum::Client.start("http2.rhe.jp", 443, user_agent: "nyaan")
res1 = client.get("/", headers: { "accept" => "*/*" })
puts res1.body # => "..."
res2 = client.post("/post", "data")
puts res2.body # => "..."
client.close
```
##### Parallel request
```ruby
res1 = res2 = nil
Plum::Client.start("rhe.jp", http2_settings: { max_frame_size: 32768 }) { |client|
res1 = client.get_async("/")
res2 = client.post_async("/post", "data")
} # wait for response(s) and close
p res1.status # => "200"
```
##### Download a large file
```ruby
Plum::Client.start("http2.rhe.jp", hostname: "assets.rhe.jp") { |client|
client.get_async("/large") do |res| # called when received response headers
p res.status # => "200"
File.open("/tmp/large.file", "wb") { |file|
res.on_chunk do |chunk|
file << chunk
end
}
end
}
```
### As a Rack-compatible server
Most existing Rack-based applications should work without modification.
```ruby
# config.ru
App = -> env {
[
200,
{ "Content-Type" => "text/plain" },
[" request: #{env["REQUEST_METHOD"]} #{env["PATH_INFO"]}"]
]
}
run App
```
You can run it:
```sh
% plum -e production -p 8080 --https config.ru
```
By default, Plum generates a dummy server certificate if `--cert` and `--key` options are not specified.
### As a library
* See documentation: http://www.rubydoc.info/gems/plum
* See examples in `examples/`
* [rhenium/plum-server](https://github.com/rhenium/plum-server) - A static-file server for https://rhe.jp and http://rhe.jp.
## TODO
* **Better API**
## License
MIT License
|
