midori.rb 0.4.3

data/tutorial/essentials/routing.md

@@ -0,0 +1,136 @@
+# Routing
+
+## Basic Usage
+
+Routes should be defined inside a class inherited from `Midori::API`. Midori doesn't support defining routes globally like sinatra to avoid scope pollution, which affects a lot in scaling project.
+
+In midori, a route is an HTTP method with a URL-matching pattern. Each route is associated with a block:
+
+```ruby
+class ExampleAPI < Midori::API
+  get '/' do
+    #.. show something ..
+  end
+  
+  post '/' do
+    #.. create something ..
+  end
+  
+  put '/' do
+    #.. replace something ..
+  end
+  
+  delete '/' do
+    #.. annihilate something ..
+  end
+  
+  options '/' do
+    #.. appease something ..
+  end
+  
+  link '/' do
+    #.. affiliate something ..
+  end
+  
+  unlink '/' do
+    #.. separate something ..
+  end
+end
+```
+
+Routes are matched in the order they are defined. The first route that matches the request is invoked.
+
+Midori not only supports the methods above, it supports almost every method provided in RFC standards. You could look it up in [API doc](http://www.rubydoc.info/gems/em-midori/Midori/API) for more details.
+
+## Params
+
+Routes patterns may include named parameters, accessible via the `request.params` hash:
+
+```ruby
+class ExampleAPI < Midori::API
+  get '/hello/:name' do
+    "Ohayou #{request.params['name']}"
+  end
+end
+```
+
+Route patterns may also include splat (or wildcard) parameters, accessible via the `request.params['splat']` array:
+
+```ruby
+class ExampleAPI < Midori::API
+  get '/say/*/to/*' do
+    # matches /say/hello/to/world
+    request.params['splat'] # => ["hello", "world"]
+  end
+
+  get '/download/*.*' do
+    # matches /download/path/to/file.xml
+    request.params['splat'] # => ["path/to/file", "xml"]
+  end
+end
+```
+
+Routes may also utilize query string:
+
+```ruby
+class ExampleAPI < Midori::API
+  get '/posts' do
+    # matches "GET /posts?title=foo&author=bar"
+    request.query_string # => title=foo&author=bar
+  end
+end
+```
+
+## WebSocket & EventSource
+
+`WebSocket` connection uses `GET` method in HTTP protocol, but indeed, it behaves totally different from `GET` requests. You don't need to care about the protocol details. In midori, you could easily manage websocket connections easily.
+
+Here's a chatroom example using websocket in midori:
+
+```ruby
+CONNECTION_POOL = []
+
+class ExampleAPI < Midori::API
+  websocket '/' do |ws|
+    ws.on :open do
+      ws.send 'Ohayo Midori'
+      CONNECTION_POOL << ws
+    end
+    
+    ws.on :message do |msg|
+      CONNECTION_POOL.map do |client|
+        client.send msg
+      end
+    end
+    
+    ws.on :close do
+      CONNECTION_POOL.delete(ws)
+      puts 'Oyasumi midori'
+    end
+  end
+end
+```
+
+midori also supports `EventSource` connection as part of your route.
+
+Here's a chatroom example using eventsource in midori:
+
+```ruby
+CONNECTION_POOL = []
+
+class ExampleAPI < Midori::API
+  post '/pub' do
+    clients = CONNECTION_POOL.clone
+    CONNECTION_POOL.clear
+    # EventSource connection disconnects every time message sent, DO NOT reuse connection pool
+    clients.map do |client|
+      client.send request.body
+    end
+  end
+  
+  eventsource '/sub' do |es|
+    CONNECTION_POOL << es
+  end
+end
+```
+

data/tutorial/essentials/runner.md

@@ -0,0 +1,59 @@
+# Runner
+
+## Introdution
+
+`Runner` is the container of midori server. You could create, start, stop midori instance by `Runner`.
+
+`Runner` use `Midori::Configure` as its configuration by default.
+
+## Examples
+
+Here're some examples for common usages
+
+### Port Binding
+
+Start midori instance with port `4567` instead of the default `8080`.
+
+```ruby
+require 'midori'
+class API < Midori::API
+  get '/' do
+    'Hello World'
+  end
+end
+
+Midori::Configure.set :port, 4567
+Midori::Runner.new(API).start
+```
+
+### Address Binding
+
+Start midori instance listening to all IP addresses.
+
+```ruby
+require 'midori'
+class API < Midori::API
+  get '/' do
+    'Hello World'
+  end
+end
+
+Midori::Configure.set :bind, '0.0.0.0'
+Midori::Runner.new(API).start
+```
+
+### Stop Midori
+
+Stop midori instance when specified route been called.
+
+```ruby
+require 'midori'
+$runner = nil
+class API < Midori::API
+  get '/stop' do
+    $runner.stop
+  end
+end
+
+$runner = Midori::Runner.new(API).start
+```

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: midori.rb
+version: !ruby/object:Gem::Version
+  version: 0.4.3
+platform: ruby
+authors:
+- HeckPsi Lab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: murasaki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: midori_http_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Midori is a Ruby Web Framework, providing high performance and proper
+  abstraction.
+email:
+- business@heckpsi.com
+executables: []
+extensions:
+- ext/midori/extconf.rb
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- LICENSE
+- ext/midori/extconf.rb
+- ext/midori/websocket.c
+- lib/midori.rb
+- lib/midori/api.rb
+- lib/midori/api_engine.rb
+- lib/midori/clean_room.rb
+- lib/midori/configure.rb
+- lib/midori/connection.rb
+- lib/midori/const.rb
+- lib/midori/core_ext/configurable.rb
+- lib/midori/core_ext/define_class.rb
+- lib/midori/core_ext/proc.rb
+- lib/midori/core_ext/string.rb
+- lib/midori/env.rb
+- lib/midori/eventsource.rb
+- lib/midori/exception.rb
+- lib/midori/logger.rb
+- lib/midori/middleware.rb
+- lib/midori/request.rb
+- lib/midori/response.rb
+- lib/midori/route.rb
+- lib/midori/runner.rb
+- lib/midori/sandbox.rb
+- lib/midori/server.rb
+- lib/midori/version.rb
+- lib/midori/websocket.rb
+- midori.sublime-project
+- tutorial/README.md
+- tutorial/SUMMARY.md
+- tutorial/advanced/custom_extensions.md
+- tutorial/advanced/deploying_for_production.md
+- tutorial/advanced/error_handling.md
+- tutorial/advanced/rerl.md
+- tutorial/advanced/scaling_project.md
+- tutorial/advanced/unit_testing.md
+- tutorial/essentials/extensions.md
+- tutorial/essentials/getting_started.md
+- tutorial/essentials/installation.md
+- tutorial/essentials/middlewares.md
+- tutorial/essentials/request_handling.md
+- tutorial/essentials/routing.md
+- tutorial/essentials/runner.md
+- tutorial/meta/comparison_with_other_frameworks.md
+- tutorial/meta/join_the_midori_community.md
+- tutorial/meta/next_steps.md
+homepage: https://github.com/midori-rb/midori.rb
+licenses:
+- MIT
+metadata:
+  issue_tracker: https://github.com/midori-rb/midori.rb/issues
+post_install_message: "\n _____ _                       \n|  _  | |                      \n|
+  | | | |__   __ _ _   _  ___  \n| | | | '_ \\ / _` | | | |/ _ \\ \n\\ \\_/ / | |
+  | (_| | |_| | (_) |\n \\___/|_| |_|\\__,_|\\__, |\\___/ \n                    __/
+  |      \n                   |___/       \n           _     _            _ \n          (_)
+  \  | |          (_)\n _ __ ___  _  __| | ___  _ __ _ \n| '_ ` _ \\| |/ _` |/ _ \\|
+  '__| |\n| | | | | | | (_| | (_) | |  | |\n|_| |_| |_|_|\\__,_|\\___/|_|  |_|\n\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: High performance ruby web framework
+test_files: []