em-midori 0.1.6.1 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9711cdf1917e423b09aaaa2d9aa793b3c81d2ea
-  data.tar.gz: e4a6120b6433adc0ec32d8f27bed05fc87985b52
+  metadata.gz: 4b8f1d0f52bac821c37368d97470d9babb3a5666
+  data.tar.gz: 50c9efd29749da9a5f12eaf3b769169b754d7024
 SHA512:
-  metadata.gz: 3118eb4484e68d3f01bcf9f3237c6e4f630e0cb55361bd06a4758ff03440fd1142fc5bc9471adfafb8a641ea97f2a4f583d119fb995d105366036519eb1295cd
-  data.tar.gz: e5af8ebdffd3d14733ab8c6d82b73458c073b7ad31f9dec7485c2cedd7c5e374b946d0ea2cccb3dc82847a193a9a68cbcb939e5903f16c1a0210b98b2d12376c
+  metadata.gz: 539fd19c14ec8a1bfbde7f4c2f8d01c41f29db187377ec8e7c0b56ab60aec097d4957067c43fb1525ed8b55c85da5315e20f73be02ba69903cf3b4c49d91ab44
+  data.tar.gz: 112bb41011fc2bf23aaf83ec10f92433f7b9bc29b7fd2b57b877dd4fad0cbf414cc1cde2717edde005403ec8c3924a96a96ee315031d720055b2687a482b9cd2

data/lib/midori/api.rb

@@ -2,7 +2,14 @@
 # This class provides methods to be inherited as route definition.
 class Midori::API
   class << self
+     # @!attribute routes
+     #   @return [Hash] merged routes defined in the instance
+     # @!attribute scope_middlewares
+     #   @return [Array] global middlewares under the scope
     attr_accessor :routes, :scope_middlewares
+
+    # Init private variables of class
+    # @return [ nil ] nil
     def class_initialize
       @routes = {
         GET: [],
@@ -18,6 +25,7 @@ class Midori::API
       }
       @scope_middlewares = []
       @temp_middlewares = []
+      nil
     end
 
     # Add GET method as a DSL for route definition
@@ -109,16 +117,26 @@ class Midori::API
     def eventsource(path, &block) end
 
     # Mount a route prefix with another API defined
-    # @param [String] prefix prefix of the route String
-    # @param [Class] api inherited from Midori::API
-    # @return [nil] nil
+    # @param [ String ] prefix prefix of the route String
+    # @param [ Class ] api inherited from Midori::API
+    # @return [ nil ] nil
     def mount(prefix, api)
       raise ArgumentError if prefix == '/' # Cannot mount route API
       @routes[:MOUNT] << [prefix, api]
+      nil
     end
 
+    # Definitions for global error handler
+    # @param [ Class ] error Error class, must be inherited form StandardError
+    # @yield what to do to deal with error
+    # @yieldparam [ StandardError ] e the detailed error
+    # @example Basic Usage
+    #   capture Midori::InternalError do |e|
+    #     Midori::Response(500, {}, e.backtrace)
+    #   end
     def capture(error, &block)
       Midori::Sandbox.add_rule(error, block)
+      nil
     end
 
     # Implementation of route DSL
@@ -149,6 +167,9 @@ class Midori::API
       nil
     end
 
+    # Use a middleware in the next route
+    # @param [Class] middleware Inherited from +Midori::Middleware+
+    # @return [nil] nil
     def filter(middleware, *args)
       middleware = middleware.new(*args)
       @temp_middlewares << middleware
@@ -169,7 +190,7 @@ class Midori::API
     end
   end
 
-  private_class_method :add_route
+  private_class_method :add_route, :inherited
 
   # Constants of supported methods in route definition
   METHODS = %w(get post put delete options link unlink websocket eventsource).freeze

data/lib/midori/api_engine.rb

@@ -1,5 +1,12 @@
+##
+# Merge and manage all APIs.
+# @attr [ Hash ] routes A hash of all routes merged
 class Midori::APIEngine
   attr_accessor :routes
+
+  # Init an API Engine
+  # @param [ Class ] root_api API inherited from [ Midori::API ]
+  # @param [ Symbol ] type type mustermann support
   def initialize(root_api, type = :sinatra)
     @routes = {
       GET: [],
@@ -23,8 +30,8 @@ class Midori::APIEngine
     end
   end
 
+  # Merge all routes with a Depth-first search
   def merge(prefix, root_api, middlewares)
-    # Merge all routes with a Depth-first search
     root_api.routes[:MOUNT].each do |mount|
       root_api.routes.merge!(merge(mount[0], mount[1], root_api.scope_middlewares)) do |_key, old_val, new_val|
         old_val + new_val
@@ -81,4 +88,6 @@ class Midori::APIEngine
     header['Sec-WebSocket-Accept'] = Digest::SHA1.base64digest(key + '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
     header
   end
+
+  private :merge
 end

data/lib/midori/clean_room.rb

@@ -6,6 +6,8 @@
 # @attr [Midori::Request] request HTTP request
 class Midori::CleanRoom
   attr_accessor :status, :header, :body, :request
+
+  # Init a Cleanroom for running
   # @param [Midori::Request] request HTTP request
   def initialize(request)
     @status = 200

data/lib/midori/core_ext/proc.rb

@@ -1,8 +1,13 @@
+##
+# Meta-programming Proc for Syntactic Sugars
 class Proc
-  # @note Converting {Proc} to {Lambda} may have incorrect behaviours on corner cases.
+  # Convert [ Proc ] to [ Lambda ]
+  # @param [ Object ] instance the context
+  # @return [ Lambda ] Lambda converted
+  # @note Converting [Proc] to [Lambda] may have incorrect behaviours on corner cases.
   # @note See {Ruby Language Issues}[https://bugs.ruby-lang.org/issues/7314] for more details.
   def to_lambda (instance = Object.new)
     instance.define_singleton_method(:_, &self)
     instance.method(:_).to_proc
   end
-end
+end

data/lib/midori/core_ext/promise.rb

@@ -2,21 +2,25 @@
 # Meta-programming String for Syntactic Sugars
 # Referenced from {Qiita}[http://qiita.com/south37/items/99a60345b22ef395d424]
 class Promise
-  # @param [Proc] callback an async method
+  # Init a Promise
+  # @param [ Proc ] callback an async method
   def initialize(callback)
     @callback = callback
   end
 
   # Define what to do after a method callbacks
-  # @param [Proc] resolve what on callback
-  # @param [Proc] reject what on callback failed
-  # @return [nil] nil
+  # @param [ Proc ] resolve what on callback
+  # @param [ Proc ] reject what on callback failed
+  # @return [ nil ] nil
   def then(resolve = ->() {}, reject = ->() {})
     @callback.call(resolve, reject)
   end
 end
 
+# A Syntactic Sugar for Promise
 class DeferPromise < Promise
+  # A Syntactic Sugar for Promise
+  # @param [ proc ] deffered To do what asynchronous
   def initialize(deffered)
     super(->(resolve, _reject){
       EventMachine.defer(proc {
@@ -32,7 +36,7 @@ end
 
 module Kernel
   # Logic dealing of async method
-  # @param [Fiber] fiber a fiber to call
+  # @param [ Fiber ] fiber a fiber to call
   def async_internal(fiber)
     chain = lambda do |result|
       return unless result.is_a?Promise
@@ -44,7 +48,7 @@ module Kernel
   end
 
   # Define an async method
-  # @param [Symbol] method_name method name
+  # @param [ Symbol ] method_name method name
   # @yield async method
   # @example
   #   async :hello do 
@@ -56,12 +60,15 @@ module Kernel
     }
   end
 
+  # Shortcut to init [ DeferPromise ]
+  # @yield To do what asynchronous
+  # @return [ DerferPromise ] instance
   def defer(&block)
     DeferPromise.new(block)
   end
 
   # Block the I/O to wait for async method response
-  # @param [Promise] promise promise method
+  # @param [ Promise ] promise promise method
   # @example
   #   result = await SQL.query('SELECT * FROM hello')
   def await(promise)

data/lib/midori/core_ext/promise_exception.rb

@@ -1,7 +1,13 @@
+##
+# A special error as containers of errors inside [ Promise ]
+# @attr [ StandardError ] raw_exception raw execption raised
 class PromiseException < StandardError
   attr_reader :raw_exception
+
+  # Init PromiseException
+  # @param [ StandardError ] raw_exception raw execption raised
   def initialize(raw_exception)
     super(nil)
     @raw_exception = raw_exception
   end
-end
+end

data/lib/midori/core_ext/safe_require.rb

@@ -1,4 +1,7 @@
 module Kernel
+  # Raise error if Load Failed
+  # @param [ String ] file file to Load
+  # @param [ String ] prompt To prompt what when load error
   def safe_require(file, prompt)
     begin
       require file
@@ -6,4 +9,4 @@ module Kernel
       raise prompt
     end
   end
-end
+end

data/lib/midori/eventsource.rb

@@ -4,6 +4,7 @@
 class Midori::EventSource
   attr_accessor :connection
 
+  # Init a EventSource instance with a connection
   # @param [EM::Connection] connection the connection instance of EventMachine
   def initialize(connection)
     @connection = connection

data/lib/midori/extension/file.rb

@@ -1,9 +1,15 @@
+##
+# Midori Extension of File reading and writing
 class Midori::File
   class << self
+    # Same APIs as File.read
+    # @param [ Array ] args args of File.read
     def read(*args)
       await(defer{File.read(*args)})
     end
 
+    # Same APIs as File.write
+    # @param [ Array ] args args of File.write
     def write(*args)
       await(defer{File.write(*args)})
     end

data/lib/midori/extension/ohm.rb

@@ -1,5 +1,10 @@
-safe_require 'redic', 'gem install redic'
+safe_require 'ohm', 'gem install ohm'
+
+##
+# Midori Extension of ohm through meta programming Redic
 class Redic
+  # Call a redis request asynchronously
+  # @param [ Array ] args args of Redic.call
   def call(*args)
     await(defer{
       @client.connect do
@@ -9,4 +14,3 @@ class Redic
     })
   end
 end
-safe_require 'ohm', 'gem install ohm'

data/lib/midori/extension/postgres.rb

@@ -1,13 +1,23 @@
 safe_require 'postgres-pr/message', 'gem install postgres-pr'
 
+##
+# Midori Extension for Postgres Driver
+# @attr [ Fixnum ] connected Connection Status
 class Midori::Postgres
   attr_reader :connected
 
+  # Init a Postgres Connection
+  # @param [ Array ] args args of EM.connect
   def initialize(*args)
     @connected = false
     @db = EM.connect(*args, EM::P::Postgres3)
   end
 
+  # Connect the Postgres server
+  # @param [ String ] db_name database name
+  # @param [ String ] username username
+  # @param [ password ] password password
+  # @return [ nil ] nil
   def connect(db_name, username, password)
     await(Promise.new(->(resolve, _reject) {
       @db.connect(db_name, username, password).callback do |status|
@@ -17,6 +27,9 @@ class Midori::Postgres
     }))
   end
 
+  # Make SQL query
+  # @param [ String ] sql sql query
+  # @return [ Midori::Postgres::Result ] query result
   def query(sql)
     await(Promise.new(->(resolve, _reject) {
       begin
@@ -29,8 +42,16 @@ class Midori::Postgres
   end
 end
 
+##
+# Postgres Result for Midori Postgres Driver Extension
+# @attr [ Array ] result result if success
+# @attr [ Array ] errors exceptions met
 class Midori::Postgres::Result
   attr_reader :result, :errors
+
+  # Init a Postgres Result
+  # @param [ Array ] result result if success
+  # @param [ Array ] errors exceptions met
   def initialize(result, errors)
     @result = result
     @errors = errors

data/lib/midori/extension/redis.rb

@@ -1,10 +1,19 @@
 safe_require 'em-hiredis', 'gem install em-hiredis'
+
+##
+# Midori Extension for Redis Driver
 class Midori::Redis
+
+  # Init a Redis Connection
+  # @param [ Array ] args args EM::Hiredis.connect
   def initialize(*args)
     @connection = EM::Hiredis.connect(*args)
     @connection
   end
 
+  # Call a redis request asynchronously
+  # @param [ String ] sys method name
+  # @param [ Array ] args args of the method calling
   def method_missing(sys, *args)
     await(Promise.new(->(resolve, _reject) {
       @connection.send(sys, *args).callback do |*ret_args|
@@ -13,6 +22,8 @@ class Midori::Redis
     }))
   end
 
+  # Return raw pubsub mode
+  # @return [ EM::Hiredis::Pubsub ] raw pubsub
   def pubsub
     @connection.pubsub
   end

data/lib/midori/extension/sequel.rb

@@ -1,14 +1,16 @@
 safe_require 'sequel', 'gem install sequel'
 require 'sequel/adapters/postgres'
 
-module Sequel
-  module Postgres
-    class Adapter < ::PGconn
-      def execute_query(sql, args)
-        @db.log_connection_yield(sql, self, args) do
-          args ? await(defer{async_exec(sql, args)}) : await(defer{async_exec(sql)})
-        end
-      end
+##
+# Midori Extension of sequel postgres through meta programming
+class Sequel::Postgres::Adapter
+  # Call a sql request asynchronously
+  # @param [ String ] sql sql request
+  # @param [ Array ] args args to send
+  # @return [ Array ] sql query result
+  def execute_query(sql, args)
+    @db.log_connection_yield(sql, self, args) do
+      args ? await(defer{async_exec(sql, args)}) : await(defer{async_exec(sql)})
     end
   end
-end
+end

data/lib/midori/middleware.rb

@@ -20,6 +20,9 @@ class Midori::Middleware
     response
   end
 
+  # Dynamically generate a method to use inside router
+  # @param [ Symbol ] name name of the method
+  # @yield the block to run
   def self.helper(name, &block)
     Midori::CleanRoom.class_exec do
       define_method(name, &block)

data/lib/midori/request.rb

@@ -3,11 +3,13 @@
 # @attr [String] ip client ip address
 # @attr [Fixnum] port client port
 # @attr [String] protocol protocol version of HTTP request
+# @attr [String] method HTTP method
 # @attr [String] path request path
 # @attr [String] query_string request query string
 # @attr [Hash] header request header
 # @attr [String] body request body
 # @attr [Boolean] parsed whether the request parsed
+# @attr [Hash] params params in the url
 class Midori::Request
   attr_accessor :ip, :port,
                 :protocol, :method, :path, :query_string,
@@ -29,7 +31,9 @@ class Midori::Request
     end
   end
 
-  # Init an request with StringIO data
+  # Init an request with String data
+  # @param [ String ] data
+  # @return [ nil ] nil
   def parse(data)
 
     offset = @parser << data

data/lib/midori/response.rb

@@ -1,14 +1,15 @@
 ##
 # Class for midori response
-# @attr [String] HTTP response status
-# @attr [Hash] HTTP response header
-# @attr [String] HTTP response body
+# @attr [String] status HTTP response status
+# @attr [Hash] header HTTP response header
+# @attr [String] body HTTP response body
 class Midori::Response
   attr_accessor :status, :header, :body
 
   # @param [Fixnum] code HTTP response code
   # @param [Hash] header HTTP response header
   # @param [String] body HTTP response body
+  # Init a Response
   def initialize(code = 200, header = Midori::Const::DEFAULT_HEADER.clone, body = '')
     @status = Midori::Const::STATUS_CODE[code]
     @header = header

data/lib/midori/route.rb

@@ -3,9 +3,11 @@
 # @attr [String] method HTTP method
 # @attr [Regexp] path regex to match
 # @attr [Proc] function what to do after matched
+# @attr [Array<Class>] middlewares middlewares used in the route
 class Midori::Route
   attr_accessor :method, :path, :function, :middlewares
 
+  # Define a route
   # @param [String] method HTTP method
   # @param [Regexp] path regex to match
   # @param [Proc] function what to do after matched

data/lib/midori/runner.rb

@@ -1,8 +1,13 @@
 ##
 # Abstract runner class to control instance of Midori Server
+# @attr [ String ] bind the address to bind
+# @attr [ Fixnum ] port the port to bind
 class Midori::Runner
   attr_reader :bind, :port
 
+  # Define status of a runner
+  # @param [ Class ] api inherited from [ Midori::API ]
+  # @param [ Class ] configure inherited from [ Midori::Configure ]
   def initialize(api, configure = Midori::Configure)
     @logger = configure.logger
     @bind = configure.bind

data/lib/midori/sandbox.rb

@@ -1,3 +1,5 @@
+##
+# Sandbox for global error capture
 class Midori::Sandbox
   class << self
     def class_initialize
@@ -6,10 +8,18 @@ class Midori::Sandbox
       @handlers[Midori::Exception::NotFound] = proc {|_e| Midori::Response.new(404, {}, '404 Not Found')}
     end
 
+    # Add a rule to Sandbox
+    # @param [ Class ] class_name the class to capture
+    # @param [ Proc ] block what to do when captured
+    # @return [ nil ] nil
     def add_rule(class_name, block)
       @handlers[class_name] = block
+      nil
     end
 
+    # Detect what to run with given error
+    # @param [ StandardError ] error the error captured
+    # @return [ nil ] nil
     def capture(error)
       if @handlers[error.class].nil?
         @handlers[Midori::Exception::InternalError].call(error)
@@ -18,6 +28,10 @@ class Midori::Sandbox
       end
     end
 
+    # Run sandbox inside given clean room
+    # @param [ Midori::CleanRoom ] clean_room Clean room to run
+    # @param [ Proc ] function the block to run
+    # @return [ nil ] nil
     def run(clean_room, function, *args)
       begin
         function.to_lambda(clean_room).call(*args)
@@ -26,5 +40,7 @@ class Midori::Sandbox
       end
     end
   end
+
+  private_class_method :class_initialize
   class_initialize
 end

data/lib/midori/server.rb

@@ -1,12 +1,17 @@
 ##
 # Logic to EventMachine TCP Server, running inside +EM::Connection+
-# @attr [Midori::Request] request
-# @attr [Class] api inherited from Midori::API
-# @attr [Midori::WebSocket] websocket websocket instance
-# @attr [Midori::EventSource] eventsource eventsource instance
 module Midori::Server
+  # @!attribute request
+  #   @return [ Midori::Request ] raw request
+  # @!attribute api
+  #   @return [ Class ] inherited from Midori::API
+  # @!attribute websocket
+  #   @return [ Midori::WebSocket ] defined websocket instance
+  # @!attribute eventsource
+  #   @return [ Midori::EventSource] defined eventsource instance
   attr_accessor :request, :api, :websocket, :eventsource
 
+  # Define server behaviour
   # @param [Class] api inherited from Midori::API
   # @param [Logger] logger global logger
   def initialize(api, logger)

data/lib/midori/version.rb

@@ -1,5 +1,5 @@
 # Midori Module
 module Midori
   # Current Version Code
-  VERSION = '0.1.6.1'.freeze
+  VERSION = '0.1.7'.freeze
 end

data/lib/midori/websocket.rb

@@ -1,20 +1,22 @@
 ##
 # This class provides methods for WebSocket connection instance.
-# @attr [Array<Fixnum>, String] msg message send from client
-# @attr [Fixnum] opcode operation code of WebSocket
-# @attr [Hash] events response for different event
-# @attr [EM::Connection] connection raw EventMachine connection
+# @attr [ Array<Fixnum>, String ] msg message send from client
+# @attr [ Fixnum ] opcode operation code of WebSocket
+# @attr [ Hash ] events response for different event
+# @attr [ EM::Connection ] connection raw EventMachine connection
+# @attr [ Midori::Request ] request raw request
 class Midori::WebSocket
   attr_accessor :msg, :opcode, :events, :connection, :request
 
-  # @param [EM::Connection] connection raw EventMachine connection
+  # Init a WebSocket instance with a connection
+  # @param [ EM::Connection ] connection raw EventMachine connection
   def initialize(connection)
     @events = {}
     @connection = connection
   end
 
   # Decode raw data send from client
-  # @param [StringIO] data raw data
+  # @param [ StringIO ] data raw data
   def decode(data)
     # Fin and Opcode
     byte_tmp = data.getbyte
@@ -29,7 +31,7 @@ class Midori::WebSocket
   end
 
   # Decode masked message send from client
-  # @param [StringIO] data raw data
+  # @param [ StringIO ] data raw data
   def decode_mask(data)
     # Mask
     byte_tmp = data.getbyte
@@ -48,7 +50,7 @@ class Midori::WebSocket
   end
 
   # API definition for events
-  # @param [Symbol] event event name(open, message, close, ping, pong)
+  # @param [ Symbol ] event event name(open, message, close, ping, pong)
   # @yield what to do after event matched
   # @example
   #   websocket '/websocket' do |ws|
@@ -61,7 +63,7 @@ class Midori::WebSocket
   end
 
   # Send data
-  # @param [Array<Fixnum>, String] msg data to send
+  # @param [ Array<Fixnum>, String ] msg data to send
   def send(msg)
     output = []
     if msg.is_a?String
@@ -77,20 +79,20 @@ class Midori::WebSocket
   end
 
   # Send a Ping request
-  # @param [String] str string to send
+  # @param [ String ] str string to send
   def ping(str)
     heartbeat(0b10001001, str)
   end
 
   # Send a Pong request
-  # @param [String] str string to send
+  # @param [ String ] str string to send
   def pong(str)
     heartbeat(0b10001010, str)
   end
 
   # Ancestor of ping pong
-  # @param [Fixnum] method opcode
-  # @param [String] str string to send
+  # @param [ Fixnum ] method opcode
+  # @param [ String ] str string to send
   def heartbeat(method, str)
       raise Midori::Exception::PingPongSizeTooLarge if str.size > 125
       @connection.send_data [method, str.size, str].pack("CCA#{str.size}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: em-midori
 version: !ruby/object:Gem::Version
-  version: 0.1.6.1
+  version: 0.1.7
 platform: ruby
 authors:
 - HeckPsi Lab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2016-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine