Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matsumotory/mruby-simplehttpserver
mruby-simplehttpserver is a HTTP Server with less dependency for mruby
https://github.com/matsumotory/mruby-simplehttpserver
Last synced: about 2 months ago
JSON representation
mruby-simplehttpserver is a HTTP Server with less dependency for mruby
- Host: GitHub
- URL: https://github.com/matsumotory/mruby-simplehttpserver
- Owner: matsumotory
- License: other
- Created: 2014-05-18T05:54:00.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-01-12T03:59:46.000Z (about 3 years ago)
- Last Synced: 2024-10-18T18:22:49.726Z (3 months ago)
- Language: Ruby
- Homepage: http://matsumoto-r.github.io/mruby-simplehttpserver.
- Size: 103 KB
- Stars: 26
- Watchers: 5
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mruby-simplehttpserver [](https://travis-ci.org/matsumotory/mruby-simplehttpserver)
mruby-simplehttpserver is a HTTP Server with less dependency for mruby. mruby-simplehttpserver depends on mruby-io, mruby-socket and mruby-http. A Web server using mruby-simplehttpserver run on a environment which is not very rich like [OSv](http://osv.io/) or simple Linux box.
### Install by mrbgems
add conf.gem line to `build_config.rb`:
```ruby
MRuby::Build.new do |conf|
# ... (snip) ...
conf.gem mgem: 'mruby-simplehttpserver'
end
```
## How to use SimpleHttpServer
SimpleHttpServer class provides a HTTP Server.
SimpleHttpServer has a [Rack](http://rack.github.io/)-like interface, so you should provide an "app": an object that responds to `#call`, taking the environment hash as a parameter, and returning an Array with three elements:
- HTTP Status Code
- Headers hash
- Body
#### Example: a simple "OK" server
The following example code can be used as the basis of a HTTP Server which returning "OK":
```ruby
app = -> (env) { [200, { 'Content-Type' => 'text/plain' }, ['OK']] }
server = SimpleHttpServer.new(
host: 'localhost',
port: 8000,
app: app,
)
server.run
```
`SimpleHttpServer#run` invokes a server that returns "OK". (If you want to stop the server, enter `^C` key.) You can see its response with curl:
```console
$ curl localhost:8000
OK
```
If you see more examples, see [example/server.rb](https://github.com/matsumoto-r/mruby-simplehttpserver/blob/master/example/server.rb).
#### What does `env` receive?
`env`, which an "app" takes as a parameter, receives a hash object includes request headers and the following parameters:
- REQUEST\_METHOD ... GET, PUT, POST, DELETE and so on.
- PATH\_INFO ... request path or '/'
- QUERY\_STRING ... query string
- HTTP\_VERSION ... 'HTTP/1.1'
If you want to see how to parse an request, see also [mattn/mruby-http](https://github.com/mattn/mruby-http).
Public Class Methods
---
### new(server\_ip = nil, port = nil, nonblock = nil, app = nil, debug = nil)
Creates a new SimpleHttpServer object.
The `:server_ip` should be a DNS hostname or IP address, the `:port` should be the listen port that server operates on.
If the `:nonblock` is `true`, take non-blocking mode. When default (nonblock = nil), it behaves blocking-mode.
The `:app` should be an object that responds to `#call`, taking the environment hash as a parameter, and returning an Array with three elements:
- HTTP Status Code (Integer)
- Headers hash (Hash)
- Body (Array)
it's like a [Rack](http://rack.github.io/) interface.
If you want to debug, you can set `:debug` true.
Public Instance Methods
---
### run()
A process requests on sock.
## License
under the MIT License:
- see [LICENSE](./LICENSE) file