em-midori 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f69b25e1336f4b2fd3a632c84f3560430a71c310
-  data.tar.gz: 94f873cd0e20c3fc3583a989f64d92fa4b625729
+  metadata.gz: 49747119b2524c9b0f81ca22a1c9f27010b880de
+  data.tar.gz: d32a3a67fd807cdeb7c49d5b7a90aacd24f24f43
 SHA512:
-  metadata.gz: 0362c3f0361363d6a716c7bd9e679f7ea13ff0c75a3dbc693f1f26c54ab70fcccfc982d1761a44d21591fcd2d0cd9aa3988dd8b0829ea3c1f39e2f307462e17c
-  data.tar.gz: 1a3ea21bf031fac25875876314ca31b650271a6b061d5fa22337c74218272e655ebec3c91db15124ccae47394372937c424756d50bfaf31fb93f66065ea71542
+  metadata.gz: 51732ede10120a05f89e960826aadffb5342efec233eaaff238a9b82c887c905e09cae0357b8c6802f05db0f77e011c709cd0fa2b3bcce366e8aee92297a524e
+  data.tar.gz: c7e2497cdeed26883d3a5dff6d1195a77c27926ad46e01fd3a0bb556abcdd8bb0f5fd14a7191cbb7c7f881450c23894ff7f5e389db6551a7751fecbfc0976ce3

data/.gitignore

@@ -49,3 +49,5 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+/.vscode/

data/.travis.yml

@@ -9,16 +9,16 @@ rvm:
 
 jdk:
   - openjdk7
-  - oraclejdk7
+  - oraclejdk8
 
 matrix:
   exclude:
     - rvm: 2.2.5
-      jdk: oraclejdk7
+      jdk: openjdk7
     - rvm: 2.3.1
-      jdk: oraclejdk7
+      jdk: openjdk7
     - rvm: rbx-3.20
-      jdk: oraclejdk7
+      jdk: openjdk7
   allow_failures:
     - rvm: jruby-head
     - rvm: rbx-3.20

data/lib/em-midori.rb

@@ -1,10 +1,14 @@
+require 'digest/sha1'
 require 'em-midori/version'
+require 'em-midori/debug'
+require 'em-midori/const'
 require 'em-midori/define_class'
+require 'em-midori/error'
 require 'em-midori/clean_room'
 require 'em-midori/em_midori'
 require 'em-midori/request'
 require 'em-midori/response'
 require 'em-midori/api'
+require 'em-midori/route'
 require 'em-midori/server'
-
-# Midori.run(Midori::API, '0.0.0.0', 8080)
+require 'em-midori/websocket'

data/lib/em-midori/api.rb

@@ -155,6 +155,13 @@ class Midori::API
     #   end
     def eventsource(path, &block) end
 
+    # Implementation of route DSL
+    # === Attributes
+    # * +method+ [+String+] - HTTP method
+    # * +path+ [+String+, +Regexp+] - path definition
+    # * +block+ [+Proc+] - process to run when route matched
+    # === Returns
+    # nil
     def add_route(method, path, block)
       @route = Array.new if @route.nil?
       if path.class == String
@@ -165,24 +172,33 @@ class Midori::API
       nil
     end
 
-    def receive(request)
-      @route.each do |route|
-        matched = match(route.method, route.path, request)
-        if matched
-          # puts "route matched: #{route.method} #{route.path}"
-          clean_room = CleanRoom.new
-          begin
-            result = lambda {clean_room.instance_exec(*matched, &route.function)}.call
+    # Process after receive data from client
+    # === Attributes
+    # * +request+ [+StringIO+] - Http Raw Request
+    # === Returns
+    # [+Midori::Response+] - Http response
+    def receive(request, connection=nil)
+        @route.each do |route|
+          matched = match(route.method, route.path, request.method, request.path)
+          if matched
+            clean_room = CleanRoom.new(request)
+            if request.websocket?
+              # Send 101 Switching Protocol
+              connection.send_data Midori::Response.new(101, {
+                'Upgrade' => 'websocket',
+                'Connection' => 'Upgrade',
+                'Sec-WebSocket-Accept' => Digest::SHA1.base64digest(request.header['Sec-WebSocket-Key'] +'258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
+              }, '')
+              result = lambda {clean_room.instance_exec(connection.websocket, *matched, &route.function)}.call
+              return Midori::Response.new
+            else
+              result = lambda {clean_room.instance_exec(*matched, &route.function)}.call
+            end
             clean_room.body = result if result.class == String
             return clean_room.response
-          rescue => e
-            puts e
-            return Midori::Response.new(500, {}, 'Internal Server Error')
           end
         end
-      end
-      # 404
-      Midori::Response.new(404, {}, '404 Not Found')
+        raise Midori::Error::NotFound
     end
 
     # Match route with given definition
@@ -196,10 +212,9 @@ class Midori::API
     # else returns an array of parameter string matched
     # === Examples
     #   match('GET', /^\/user\/(.*?)\/order\/(.*?)$/, '/user/foo/order/bar') # => ['foo', 'bar']
-    def match(method, path, request)
-      request = request.lines.first.split
-      if request[0] == method
-        result = request[1].match(path)
+    def match(method, path, request_method, request_path)
+      if request_method == method
+        result = request_path.match(path)
         return result.to_a[1..-1] if result
         false
       else
@@ -233,14 +248,4 @@ class Midori::API
       add_route(method.upcase, args[0], block) #args[0]: path
     end
   end
-
 end
-
-class Midori::Route
-  attr_accessor :method, :path, :function
-  def initialize(method, path, function)
-    @method = method
-    @path = path
-    @function = function
-  end
-end

data/lib/em-midori/clean_room.rb

@@ -1,9 +1,10 @@
 class CleanRoom
-  attr_accessor :code, :header, :body
-  def initialize
+  attr_accessor :code, :header, :body, :request
+  def initialize(request)
     @status = 200
     @header = {}
     @body = ''
+    @request = request
   end
 
   def response

data/lib/em-midori/const.rb

@@ -0,0 +1,48 @@
+module Midori::Const
+  STATUS_CODE = {
+      100 => '100 Continue',
+      101 => '101 Switching Protocols',
+      200 => '200 OK',
+      201 => '201 Created',
+      202 => '202 Accepted',
+      203 => '203 Non-Authoritative Information',
+      204 => '204 No Content',
+      205 => '205 Reset Content',
+      206 => '206 Partial Content',
+      300 => '300 Multiple Choices',
+      301 => '301 Moved Permanently',
+      304 => '304 Not Modified',
+      305 => '305 Use Proxy',
+      307 => '307 Temporary Redirect',
+      400 => '400 Bad Request',
+      401 => '401 Unauthorized',
+      402 => '402 Payment Required',
+      403 => '403 Forbidden',
+      404 => '404 Not Found',
+      405 => '405 Method Not Allowed',
+      406 => '406 Not Acceptable',
+      407 => '407 Proxy Authentication Required',
+      408 => '408 Request Time-out',
+      409 => '409 Conflict',
+      410 => '410 Gone',
+      411 => '411 Length Required',
+      412 => '412 Precondition Failed',
+      413 => '413 Request Entity Too Large',
+      414 => '414 Request-URI Too Large',
+      415 => '415 Unsupported Media Type',
+      416 => '416 Requested range not satisfiable',
+      417 => '417 Expectation Failed',
+      500 => '500 Internal Server Error',
+      501 => '501 Not Implemented',
+      502 => '502 Bad Gateway',
+      503 => '503 Service Unavailable',
+      504 => '504 Gateway Time-out',
+      505 => '505 HTTP Version not supported'
+  }
+  STATUS_CODE.default= '500 Internal Server Error'
+  STATUS_CODE.freeze
+
+  DEFAULT_HEADER = {
+    "Server" => "Midori/#{Midori::VERSION}"
+  }
+end

data/lib/em-midori/debug.rb

@@ -0,0 +1,29 @@
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+
+  def pink
+    colorize(35)
+  end
+
+  def light_blue
+    colorize(36)
+  end
+end

data/lib/em-midori/define_class.rb

@@ -6,4 +6,11 @@ module Kernel #:nodoc:
     Object.const_get(name).class_eval(&Proc.new) if block_given?
     Object.const_get(name)
   end
+
+  def define_error(*args)
+    args.each do |arg|
+      class_name = arg.to_s.split('_').map {|word| word[0] = word[0].upcase; word}.join
+      define_class(class_name, StandardError)
+    end
+  end
 end

data/lib/em-midori/em_midori.rb

@@ -1,24 +1,23 @@
 require 'eventmachine'
 
 module Midori
-  def self.run(api=(Midori::API), ip=nil, port=nil)
+  def self.run(api=Midori::API, ip=nil, port=nil)
     ip ||= '127.0.0.1'
     port ||= 8081
     EventMachine.run do
-      puts "Midori #{Midori::VERSION} is now running on #{ip}:#{port}"
-      Midori::Server.api = api
-      @midori_server = EventMachine.start_server ip, port, Midori::Server
+      puts "Midori #{Midori::VERSION} is now running on #{ip}:#{port}".blue
+      @midori_server = EventMachine.start_server ip, port, Midori::Server, api
     end
   end
 
   def self.stop
     if @midori_server.nil?
-      puts 'Midori Server has NOT been started'
+      puts 'Midori Server has NOT been started'.red
       return false
     else
       EventMachine.stop_server(@midori_server)
       @midori_server = nil
-      puts 'Goodbye Midori'
+      puts 'Goodbye Midori'.blue
       return true
     end
   end

data/lib/em-midori/error.rb

@@ -0,0 +1,7 @@
+module Midori::Error
+  class NotFound < StandardError; end
+  class ContinuousFrame < StandardError; end
+  class OpCodeError < StandardError; end
+  class NotMasked < StandardError; end
+  class FrameEnd < StandardError; end
+end

data/lib/em-midori/request.rb

@@ -1,3 +1,64 @@
+require 'stringio'
+
 class Midori::Request
+  attr_accessor :ip, :port,
+                :protocol, :method, :path, :query_string,
+                :header, :body
+
+  def initialize
+    @parsed = false
+    @is_websocket = false
+    @is_eventsource = false
+  end
+
+  # Init an request with StringIO data
+  # === Attributes
+  # * +data+ [+StringIO+] - Request data
+  def parse(data)
+    @header = Hash.new
+
+    # Parse request
+    line = data.gets.split
+    @protocol = line[2]
+    @method = line[0]
+    @query_string = line[1].match(/\?(.*?)$/)
+    unless @query_string.nil?
+      @query_string = @query_string[1]
+    end
+    @path = line[1].gsub(/\?(.*?)$/, '')
+
+    # Parse header
+    while (line = data.gets) != "\r\n"
+      line = line.split
+      @header[line[0][0..-2]] = line[1..-1].join(' ')
+    end
+
+    # Deal with WebSocket
+    if @header['Upgrade'] == 'websocket' && @header['Connection'] == 'Upgrade'
+      @method = 'WEBSOCKET'
+      @is_websocket = true
+    end
+
+    # Deal with EventSource
+    if @header['Accept'] == 'text/event-stream'
+      @method = 'EVENTSOURCE'
+      @is_eventsource = true
+    end
+
+    # Parse body
+    @body = data.read
+    @parsed = true
+  end
+
+  def parsed?
+    @parsed
+  end
+
+  def websocket?
+    @is_websocket
+  end
 
+  def eventsource?
+    @is_eventsource
+  end
 end

data/lib/em-midori/response.rb

@@ -1,56 +1,19 @@
 class Midori::Response
-  STATUS_CODE = {
-      100 => '100 Continue',
-      101 => '101 Switching Protocols',
-      200 => '200 OK',
-      201 => '201 Created',
-      202 => '202 Accepted',
-      203 => '203 Non-Authoritative Information',
-      204 => '204 No Content',
-      205 => '205 Reset Content',
-      206 => '206 Partial Content',
-      300 => '300 Multiple Choices',
-      301 => '301 Moved Permanently',
-      304 => '304 Not Modified',
-      305 => '305 Use Proxy',
-      307 => '307 Temporary Redirect',
-      400 => '400 Bad Request',
-      401 => '401 Unauthorized',
-      402 => '402 Payment Required',
-      403 => '403 Forbidden',
-      404 => '404 Not Found',
-      405 => '405 Method Not Allowed',
-      406 => '406 Not Acceptable',
-      407 => '407 Proxy Authentication Required',
-      408 => '408 Request Time-out',
-      409 => '409 Conflict',
-      410 => '410 Gone',
-      411 => '411 Length Required',
-      412 => '412 Precondition Failed',
-      413 => '413 Request Entity Too Large',
-      414 => '414 Request-URI Too Large',
-      415 => '415 Unsupported Media Type',
-      416 => '416 Requested range not satisfiable',
-      417 => '417 Expectation Failed',
-      500 => '500 Internal Server Error',
-      501 => '501 Not Implemented',
-      502 => '502 Bad Gateway',
-      503 => '503 Service Unavailable',
-      504 => '504 Gateway Time-out',
-      505 => '505 HTTP Version not supported'
-  }
-  STATUS_CODE.default= '500 Internal Server Error'
-  STATUS_CODE.freeze
+  attr_accessor :status, :header, :body
 
-  attr_accessor :status_code, :header, :body
-
-  def initialize(code=200, header={}, body='')
-    @status_code = STATUS_CODE[code]
+  def initialize(code=200, header= Midori::Const::DEFAULT_HEADER, body='')
+    @status = Midori::Const::STATUS_CODE[code]
     @header = header
     @body = body
   end
 
+  def generate_header
+    @header.map do |key, value|
+      "#{key}: #{value}\r\n"
+    end.join
+  end
+
   def to_s
-    "HTTP/1.1 #{@status_code}\r\nServer: Midori/#{Midori::VERSION}\r\n\r\n#{@body}"
+    "HTTP/1.1 #{@status}\r\n#{generate_header}\r\n#{@body}"
   end
 end

data/lib/em-midori/route.rb

@@ -0,0 +1,8 @@
+class Midori::Route
+  attr_accessor :method, :path, :function
+  def initialize(method, path, function)
+    @method = method
+    @path = path
+    @function = function
+  end
+end

data/lib/em-midori/server.rb

@@ -1,15 +1,78 @@
+require 'stringio'
+
 module Midori::Server
-  class << self
-    attr_accessor :api
+  attr_accessor :request, :api, :websocket
+
+  def initialize(api)
+    @api = api
+    @request = Midori::Request.new
+    @websocket = Midori::WebSocket.new(self)
   end
 
   def receive_data(data)
+    start_time = Time.now
+    data = StringIO.new(data)
     port, ip = Socket.unpack_sockaddr_in(get_peername)
-    response = Midori::Server.api.receive(data)
-    puts "from #{ip}:#{port} comes a message:"
-    puts data # Debug
-    puts response # Debug
-    send_data response
-    close_connection_after_writing
+    @request.ip = ip
+    @request.port = port
+    if @request.parsed?
+      websocket_request(data)
+    else
+      receive_new_request(data)
+    end
+    $stdout << "#{@request.ip} - - [#{Time.now.inspect}] \"#{@request.method} #{@request.path} #{@request.protocol}\" #{@response.status} #{(Time.now.to_f - start_time.to_f).round(5)}\n".green
   end
+
+  def receive_new_request(data)
+    begin
+      @request.parse(data)
+      @response = @api.receive(request, self)
+    rescue Midori::Error::NotFound => _e
+      @response = Midori::Response.new(404, {}, '404 Not Found')
+    rescue => e
+      @response = Midori::Response.new(500, {}, 'Internal Server Error')
+      puts e.inspect.yellow
+    end
+    unless (@request.websocket? || @request.eventsource?)
+      send_data @response
+      close_connection_after_writing
+    end
+    if @request.websocket? && !@websocket.events[:open].nil?
+      call_event(:open)
+    end
+  end
+
+  def websocket_request(data)
+    begin
+      @websocket.decode(data)
+      case @websocket.opcode
+        when 0x1, 0x2
+          call_event(:message, @websocket.msg)
+        when 0x9
+          call_event(:ping)
+          @websocket.pong
+        when 0xA
+          call_event(:pong)
+        else
+          # Unknown Control Frame
+          raise Midori::Error::FrameEnd
+      end
+    rescue Midori::Error::FrameEnd => _e
+      unless @websocket.events[:close].nil?
+        call_event(:close)
+      end
+      send_data "\b" # Opcode 0x8
+      close_connection_after_writing
+    rescue => e
+      puts e.inspect.yellow
+      @response = Midori::Response.new(400, {}, 'Bad Request')
+      send_data @response
+      close_connection_after_writing
+    end
+  end
+
+  def call_event(event, args=[])
+    lambda {@websocket.instance_exec(*args, &@websocket.events[event])}.call unless @websocket.events[event].nil?
+  end
+
 end

data/lib/em-midori/version.rb

@@ -1,3 +1,3 @@
 module Midori
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

data/lib/em-midori/websocket.rb

@@ -0,0 +1,63 @@
+class Midori::WebSocket
+    attr_accessor :msg, :opcode, :events, :connection
+
+    def initialize(connection)
+        @events = Hash.new
+        @connection = connection
+    end
+
+    def decode(data)
+        # Fin and Opcode
+        byte_tmp = data.getbyte
+        fin = byte_tmp & 0b10000000
+        @opcode = byte_tmp & 0b00001111
+        raise Midori::Error::ContinuousFrame unless fin
+        raise Midori::Error::OpCodeError unless [0x1, 0x2, 0x8, 0x9, 0xA].include?opcode
+        raise Midori::Error::FrameEnd if @opcode == 0x8 # Close Frame
+        return if @opcode == 0x9 || @opcode == 0xA # Ping Pong
+        decode_mask(data)
+    end
+
+    def decode_mask(data)
+        # Mask
+        byte_tmp = data.getbyte
+        is_masked = byte_tmp & 0b10000000
+        raise Midori::Error::NotMasked unless is_masked
+        # Payload
+        payload = byte_tmp & 0b01111111
+        mask = 4.times.map {data.getbyte}
+        # Message
+        masked_msg = payload.times.map {data.getbyte}
+        @msg = masked_msg.each_with_index.map {|byte, i| byte ^ mask[i % 4]}
+        @msg = @msg.pack('C*').force_encoding('utf-8') if @opcode == 0x1
+    end
+
+    def on(event, &block) # open, message, close, ping, pong
+        @events[event] = block
+    end
+
+    def send(msg)
+        output = Array.new
+        if msg.is_a?String
+            output << 0b10000001 << msg.size << msg
+        elsif msg.is_a?Array
+            output << 0b10000010 << msg.size
+            output.concat msg
+        else
+            raise Midori::Error::OpCodeError
+        end
+        @connection.send_data(output.pack("CCA#{msg.size}"))
+    end
+
+    def ping
+        @connection.send_data "\t"
+    end
+
+    def pong
+        @connection.send_data "\n"
+    end
+
+    def close
+        Midori::Error::FrameEnd
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: em-midori
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - HeckPsi Lab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-25 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: An EventMachine Based Web Framework on Ruby
 email: business@heckpsi.com
 executables: []
@@ -82,6 +96,7 @@ files:
 - ".gitignore"
 - ".resources/midori_tokiwa.gif"
 - ".resources/sapphire_kawashima.gif"
+- ".resources/slogan.png"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -89,12 +104,17 @@ files:
 - lib/em-midori.rb
 - lib/em-midori/api.rb
 - lib/em-midori/clean_room.rb
+- lib/em-midori/const.rb
+- lib/em-midori/debug.rb
 - lib/em-midori/define_class.rb
 - lib/em-midori/em_midori.rb
+- lib/em-midori/error.rb
 - lib/em-midori/request.rb
 - lib/em-midori/response.rb
+- lib/em-midori/route.rb
 - lib/em-midori/server.rb
 - lib/em-midori/version.rb
+- lib/em-midori/websocket.rb
 homepage: https://github.com/heckpsi-lab/em-midori
 licenses:
 - MIT
@@ -120,3 +140,4 @@ signing_key:
 specification_version: 4
 summary: An EventMachine Based Web Framework on Ruby
 test_files: []
+has_rdoc: