em-midori 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3925b4b9ef7e976cc1e1af24b2979a0e3a276f06
-  data.tar.gz: 6b8a7e0d0300709096247aed4755a285d128cf94
+  metadata.gz: '081416a49873c3fef7ed675ec2640bc3923284cc'
+  data.tar.gz: f2ab1575e5b6664572a2167f7dbdbced1b94a45a
 SHA512:
-  metadata.gz: 449941b9d262ef8a1e8727524976e3af90effde6efc56d043258b37db1eb3a932dc16c6ff701ccd18911dbd23d9c0c821441d687ccabc9e811a5c91b197cf419
-  data.tar.gz: 512051dcf9e5d764ba1c46b4cc1f817189b91d65875b08472a2337cdbe3da6d9aac72124e49da4b71b6a43ca3e607382d862ed9b699f6ae2aa3cc30cb7bc72dd
+  metadata.gz: 128bb0d384e2eb10978a03532c68db04d8bf668260a211ce6d94a46d5970bea2fa5e9bad94a9797329843a611e657618858d988313764031c5452cbf37b17458
+  data.tar.gz: 441c0ee3debb05818d91417533ef0a42f1ab609b3dd28a7b422ee28a9ce84b1b30208d6d20927fb8c6d6ccc90cc54b0e13bb7f881e260f9ace5f26c71d25d3de

data/lib/midori.rb

@@ -19,6 +19,7 @@ require_relative 'midori/core_ext/safe_require'
 require_relative 'midori/version'
 require_relative 'midori/const'
 require_relative 'midori/exception'
+require_relative 'midori/env'
 require_relative 'midori/clean_room'
 require_relative 'midori/server'
 require_relative 'midori/connection'
@@ -33,3 +34,5 @@ require_relative 'midori/eventsource'
 require_relative 'midori/middleware'
 require_relative 'midori/configure'
 require_relative 'midori/runner'
+require_relative 'midori/logger'
+

data/lib/midori/api_engine.rb

@@ -52,12 +52,17 @@ class Midori::APIEngine
       clean_room = Midori::CleanRoom.new(request)
       if request.websocket?
         # Send 101 Switching Protocol
-        connection.send_data Midori::Response.new(101, Midori::APIEngine.websocket_header(request.header['Sec-WebSocket-Key']), '')
+        connection.send_data Midori::Response.new(
+          status: 101,
+          header: Midori::APIEngine.websocket_header(request.header['Sec-WebSocket-Key']),
+          body: '')
         connection.websocket.request = request
         Midori::Sandbox.run(clean_room, route.function, connection.websocket)
         return Midori::Response.new
       elsif request.eventsource?
-        connection.send_data Midori::Response.new(200, Midori::Const::EVENTSOURCE_HEADER, '')
+        connection.send_data Midori::Response.new(
+          status: 200,
+          header: Midori::Const::EVENTSOURCE_HEADER)
         Midori::Sandbox.run(clean_room, route.function, connection.eventsource)
         return Midori::Response.new
       else

data/lib/midori/clean_room.rb

@@ -19,6 +19,6 @@ class Midori::CleanRoom
   # Generate response from variables inside +Midori::CleanRoom+
   # @return [Midori::Response] midori response
   def raw_response
-    Midori::Response.new(@status, @header, @body)
+    Midori::Response.new(status: @status, header: @header, body: @body)
   end
 end

data/lib/midori/env.rb

@@ -0,0 +1,18 @@
+module Midori
+  # @return [String] midori environment
+  def self.env
+    ENV['MIDORI_ENV'] || 'development'
+  end
+end
+
+class String
+  # @return [TrueClass | FalseClass] if string is equal to production
+  def production?
+    self == 'production'
+  end
+
+  #@return [TrueClass | FalseClass] if string is equal to development
+  def development?
+    self == 'development'
+  end
+end

data/lib/midori/extension/redic.rb

@@ -17,7 +17,7 @@ module Hiredis
     # Meta-programming hiredis for redis async extension
     class Connection
       # Do redis query
-      # @param [String] data generated string data
+      # @param [Array] args equal to Hiredis write args
       def query(args)
         await(Promise.new do |resolve|
           read_flag = false
@@ -65,22 +65,33 @@ end
 
 require 'redic'
 
+##
+# Meta-programming Redic for redis async extension
 class Redic
+  # Meta-programming Redic for redis async extension
   class Client
+    # Connect redis, yield optional
     def connect
       establish_connection unless connected?
       if block_given?
+        # Redic default yield
+        # :nocov:
         @semaphore.synchronize do
           yield
         end
+        # :nocov:
       end
     end
-
+    
+    # Call without thread lock
+    # @param [Array] args same params as Redic
     def call(*args)
       @connection.query(*args)
     end
   end
 
+  # Call without thread lock
+  # @param [Array] args same params as Redic
   def call(*args)
     @client.connect
     @client.call(args)

data/lib/midori/extension/sequel/postgres.rb

@@ -32,8 +32,11 @@ class Sequel::Postgres::Adapter
               EventLoop.deregister(socket_object)
               resolve.call(get_result)
             end
+          # For extra errors
+          # :nocov:
           rescue => e
             resolve.call(PromiseException.new(e))
+          # :nocov:
           end
         end
       end)

data/lib/midori/logger.rb

@@ -0,0 +1,16 @@
+module Midori
+  class << self
+    # Return current logger midori is using
+    # @return [Logger] the current logger midori is using
+    def logger
+      @logger = ::Logger.new(STDOUT) if @logger.nil?
+      @logger
+    end
+
+    # Return midori's logger
+    # @param [Logger] logger set midori logger
+    def logger=(logger)
+      @logger = logger
+    end
+  end
+end

data/lib/midori/response.rb

@@ -6,14 +6,16 @@
 class Midori::Response
   attr_accessor :status, :header, :body
 
-  # @param [Integer] code HTTP response code
-  # @param [Hash] header HTTP response header
-  # @param [String] body HTTP response body
+  # @param [Hash] options HTTP response
+  # @option options [Integer] code HTTP response code
+  # @option options [Hash] header HTTP response header
+  # @option options [String] body HTTP response body
   # Init a Response
-  def initialize(code = 200, header = Midori::Const::DEFAULT_HEADER.clone, body = '')
+  def initialize(options = {})
+    code = options[:status] || 200
     @status = Midori::Const::STATUS_CODE[code]
-    @header = header
-    @body = body
+    @header = options[:header] || Midori::Const::DEFAULT_HEADER.clone
+    @body = options[:body] || ''
   end
 
   # Generate header string from hash

data/lib/midori/runner.rb

@@ -11,6 +11,7 @@ class Midori::Runner
   # @param [Class] configure inherited from [Midori::Configure]
   def initialize(api, configure = Midori::Configure)
     @logger = configure.logger
+    Midori.logger = configure.logger
     @bind = configure.bind
     @port = configure.port
     @api = ((api.is_a?Midori::APIEngine) ? api : Midori::APIEngine.new(api, configure.route_type))

data/lib/midori/sandbox.rb

@@ -4,8 +4,8 @@ class Midori::Sandbox
   class << self
     def class_initialize
       @handlers = Hash.new
-      @handlers[Midori::Exception::InternalError] = proc {|e| Midori::Response.new(500, {}, "#{e.inspect} #{e.backtrace}")}
-      @handlers[Midori::Exception::NotFound] = proc {|_e| Midori::Response.new(404, {}, '404 Not Found')}
+      @handlers[Midori::Exception::InternalError] = proc {|e| Midori::Response.new(status: 500, body: "#{e.inspect} #{e.backtrace}")}
+      @handlers[Midori::Exception::NotFound] = proc {|_e| Midori::Response.new(status: 404, body: '404 Not Found')}
     end
 
     # Add a rule to Sandbox

data/lib/midori/server.rb

@@ -41,7 +41,7 @@ module Midori::Server
           end
         rescue => e
           close_connection
-          @logger.warn "#{@request.ip} - - #{e.backtrace.join("\n")}".yellow
+          @logger.warn "#{@request.ip} - - #{e.class} #{e.backtrace.join("\n")}".yellow
         end
       end)
     end.call

data/lib/midori/version.rb

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

data/tutorial/essentials/installation.md

@@ -92,7 +92,7 @@ Using bunlder could make dependency management much easier, which helps a lot in
 
 You may probably meet problems with rubygems due to unstable overseas internet connection issues in China. The most popular way to solve it is to use mirror provided by [RubyChina](https://gems.ruby-china.org/) or [TUNA](https://mirror.tuna.tsinghua.edu.cn/help/rubygems/) as your gem source. This may have some side effects in development, because there's a few minutes' delay in receiving gem updates.
 
-Alternatively, you could use proxy to connect the main repository directly to avoid the delay problem. But using proxy is a little too complex in production environment.
+Alternatively, you could use proxy to connect to the main repository directly to avoid the delay problem. But using proxy is a little too complex in production environment.
 
 Choose the solution better fits your requirements. Mixing the solutions like using proxy in development and using mirror in production is also a good choice.
 

data/tutorial/essentials/request_handling.md

@@ -40,7 +40,7 @@ class ExampleAPI < Midori::API
   end
   
   get '/case_1' do
-    status = 418
+    @status = 418
     "I\'m a teapot"
     # HTTP/1.1 418 I'm a teapot
     # Server: Midori/1.0
@@ -51,21 +51,23 @@ class ExampleAPI < Midori::API
   get '/case_2' do
     header['Example-Header'] = 'Example-Value'
     'Hello'
+    # HTTP/1.1 200 OK
+    # Server: Midori/1.0
+    # Example-Header: Example-Value
+    #
+    # Hello
   end
-  # HTTP/1.1 200 OK
-  # Server: Midori/1.0
-  # Example-Header: Example-Value
-  #
-  # Hello
   
   get '/case_3' do
-    status = 202
+    @status = 202
     header['Example-Header'] = 'Example-Value'
-    Midori::Response.new(200, {}, 'Hello')
+    Midori::Response.new(status: 200, header: {}, body: 'Hello') # Overrides everything else
+    # HTTP/1.1 200 OK
+    # Server: Midori/1.0
+    # Example-Header: Example-Value
+    #
+    # Hello
   end
-  # HTTP/1.1 200 OK
-  #
-  # Hello
 end
 ```
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: em-midori
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - HeckPsi Lab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -77,6 +77,7 @@ files:
 - lib/midori/core_ext/safe_require.rb
 - lib/midori/core_ext/string.rb
 - lib/midori/core_ext/timer.rb
+- lib/midori/env.rb
 - lib/midori/eventsource.rb
 - lib/midori/exception.rb
 - lib/midori/extension/file.rb
@@ -84,6 +85,7 @@ files:
 - lib/midori/extension/redic.rb
 - lib/midori/extension/sequel/mysql2.rb
 - lib/midori/extension/sequel/postgres.rb
+- lib/midori/logger.rb
 - lib/midori/middleware.rb
 - lib/midori/request.rb
 - lib/midori/response.rb