nyara 0.0.1.pre.5 → 0.0.1.pre.6

data/lib/nyara/route.rb

@@ -12,52 +12,46 @@ module Nyara
     end
 
     def compile
-      global_path_templates = {} # "name#id" => path
-      @path_templates = {}       # klass => {any_id => path}
+      @global_path_templates = {} # "name#id" => path
+      mapped_controllers = {}
 
-      a = @controllers.map do |scope, c|
+      route_entries = @controllers.flat_map do |scope, c|
         if c.is_a?(String)
           c = name2const c
         end
         name = c.controller_name || const2name(c)
         raise "#{c.inspect} is not a Nyara::Controller" unless Controller > c
 
-        if @path_templates[c]
+        if mapped_controllers[c]
           raise "controller #{c.inspect} was already mapped"
         end
+        mapped_controllers[c] = true
 
-        route_entries = c.preprocess_actions
-        @path_templates[c] = {}
-        route_entries.each do |e|
-          id = e.id.to_s
-          path = File.join scope, e.path
-          global_path_templates[name + id] = path
-          @path_templates[c][id] = path
+        c.compile_route_entries(scope).each do |e|
+          @global_path_templates[name + e.id] = e.path_template
         end
-
-        [scope, c, route_entries]
       end
+      route_entries.sort_by! &:prefix
+      route_entries.reverse!
 
-      @path_templates.keys.each do |c|
-        @path_templates[c] = global_path_templates.merge @path_templates[c]
+      mapped_controllers.each do |c, _|
+        c.path_templates = @global_path_templates.merge c.path_templates
       end
 
       Ext.clear_route
-      process(a).each do |entry|
-        entry.validate
-        Ext.register_route entry
+      route_entries.each do |e|
+        Ext.register_route e
       end
     end
 
-    def path_template klass, id
-      @path_templates[klass][id]
+    def global_path_template id
+      @global_path_templates[id]
     end
 
     def clear
       # gc mark fail if wrong order?
       Ext.clear_route
       @controllers = {}
-      @path_templates = {}
     end
 
     # private
@@ -75,64 +69,5 @@ module Nyara
       name << 'Controller'
       Module.const_get name
     end
-
-    def process preprocessed
-      entries = []
-      preprocessed.each do |(scope, controller, route_entries)|
-        route_entries.each do |e|
-          e = e.dup # in case there is controller used in more than 1 maps
-          path = scope.sub /\/?$/, e.path
-          if path.empty?
-            path = '/'
-          end
-          e.prefix, suffix = analyse_path path
-          e.suffix, e.conv = compile_re suffix
-          e.scope = scope
-          e.controller = controller
-          entries << e
-        end
-      end
-      entries.sort_by! &:prefix
-      entries.reverse!
-      entries
-    end
-
-    # returns [str_re, conv]
-    def compile_re suffix
-      return ['', []] unless suffix
-      conv = []
-      re_segs = suffix.split(/(?<=%[dfsux])|(?=%[dfsux])/).map do |s|
-        case s
-        when '%d'
-          conv << :to_i
-          '(-?[0-9]+)'
-        when '%f'
-          conv << :to_f
-          # just copied from scanf
-          '([-+]?(?:0[xX](?:\.\h+|\h+(?:\.\h*)?)[pP][-+]\d+|\d+(?![\d.])|\d*\.\d*(?:[eE][-+]?\d+)?))'
-        when '%u'
-          conv << :to_i
-          '([0-9]+)'
-        when '%x'
-          conv << :hex
-          '(\h+)'
-        when '%s'
-          conv << :to_s
-          '([^/]+)'
-        else
-          Regexp.quote s
-        end
-      end
-      ["^#{re_segs.join}$", conv]
-    end
-
-    # split the path into parts
-    def analyse_path path
-      raise 'path must contain no new line' if path.index "\n"
-      raise 'path must start with /' unless path.start_with? '/'
-      path = path.sub(/\/$/, '') if path != '/'
-
-      path.split(/(?=%[dfsux])/, 2)
-    end
   end
 end

data/lib/nyara/route_entry.rb

@@ -1,7 +1,12 @@
 module Nyara
   class RouteEntry
     REQUIRED_ATTRS = [:http_method, :scope, :prefix, :suffix, :controller, :id, :conv]
-    attr_accessor *REQUIRED_ATTRS
+    attr_reader *REQUIRED_ATTRS
+    attr_writer :http_method, :id
+    # stores symbol for C conenience, and returns string for Ruby side goodness
+    def id
+      @id.to_s
+    end
 
     # optional
     attr_accessor :accept_exts, :accept_mimes
@@ -13,6 +18,25 @@ module Nyara
       instance_eval &p if p
     end
 
+    def path_template
+      File.join @scope, (@path.gsub '%z', '%s')
+    end
+
+    # compute prefix, suffix, conv
+    # NOTE route_entries may be inherited, so late-setting controller is necessary
+    def compile controller, scope
+      @controller = controller
+      @scope = scope
+
+      path = scope.sub /\/?$/, @path
+      if path.empty?
+        path = '/'
+      end
+      @prefix, suffix = analyse_path path
+      @suffix, @conv = compile_re suffix
+    end
+
+    # compute accept_exts, accept_mimes
     def set_accept_exts a
       @accept_exts = {}
       @accept_mimes = []
@@ -37,7 +61,50 @@ module Nyara
           raise ArgumentError, "missing #{attr}"
         end
       end
-      raise ArgumentError, "id must be symbol" unless id.is_a?(Symbol)
+      raise ArgumentError, "id must be symbol" unless @id.is_a?(Symbol)
+    end
+
+    # private
+
+    # returns [str_re, conv]
+    def compile_re suffix
+      return ['', []] unless suffix
+      conv = []
+      re_segs = suffix.split(/(?<=%[dfsux])|(?=%[dfsux])/).map do |s|
+        case s
+        when '%d'
+          conv << :to_i
+          '(-?[0-9]+)'
+        when '%f'
+          conv << :to_f
+          # just copied from scanf
+          '([-+]?(?:0[xX](?:\.\h+|\h+(?:\.\h*)?)[pP][-+]\d+|\d+(?![\d.])|\d*\.\d*(?:[eE][-+]?\d+)?))'
+        when '%u'
+          conv << :to_i
+          '([0-9]+)'
+        when '%x'
+          conv << :hex
+          '(\h+)'
+        when '%s'
+          conv << :to_s
+          '([^/]+)'
+        when '%z'
+          conv << :to_s
+          '(.+)'
+        else
+          Regexp.quote s
+        end
+      end
+      ["^#{re_segs.join}$", conv]
+    end
+
+    # split the path into parts
+    def analyse_path path
+      raise 'path must contain no new line' if path.index "\n"
+      raise 'path must start with /' unless path.start_with? '/'
+      path = path.sub(/\/$/, '') if path != '/'
+
+      path.split(/(?=%[dfsux])/, 2)
     end
   end
 end

data/lib/nyara/session.rb

@@ -1,42 +1,74 @@
 module Nyara
-  # cookie based
-  # usually it's no need to call cache or database data a "session"
+  # helper module for session management, cookie based<br>
+  # (usually it's no need to call cache or database data a "session")<br><br>
+  # session is by default DSA + SHA2/SHA1 signed, sub config options are:
+  #
+  # [name]       session entry name in cookie, default is +'spare_me_plz'+
+  # [expire]     expire session after seconds. default is +nil+, which means session expires when browser is closed<br>
+  # [expires]    same as +expire+
+  # [secure]     - +nil+(default): if request is https, add +Secure+ option to it
+  #              - +true+: always add +Secure+
+  #              - +false+: always no +Secure+
+  # [key]        DSA private key string, in der or pem format, use random if not given
+  # [cipher_key] if exist, use aes-256-cbc to cipher the "sig/json"<br>
+  #              NOTE: it's no need to set +cipher_key+ if using https
+  #
+  # = example
+  #
+  #   configure do
+  #     set 'session', 'key', File.read(project_path 'config/session.key')
+  #     set 'session', 'expire', 30 * 60
+  #   end
+  #
   module Session
     extend self
 
     CIPHER_BLOCK_SIZE = 256/8
 
-    # session is by default DSA + SHA2/SHA1 signed, sub config options are:
-    #
-    # - name       (session entry name in cookie, default is 'spare_me_plz')
-    # - key        (DSA private key string, in der or pem format, use random if not given)
-    # - cipher_key (if exist, use aes-256-cbc to cipher the "sig&json", the first 256bit is sliced for iv)
-    #              (it's no need to set cipher_key if using https)
-
     # init from config
     def init
-      c = Config['session'] || {}
-      @name = (c['name'] || 'spare_me_plz').to_s
+      c = Config['session'] ? Config['session'].dup : {}
+      @name = (c.delete('name') || 'spare_me_plz').to_s
 
       if c['key']
-        @dsa = OpenSSL::PKey::DSA.new c['key']
+        @dsa = OpenSSL::PKey::DSA.new c.delete 'key'
       else
-        @dsa = OpenSSL::PKey::DSA.generate 256
+        @dsa = generate_key
       end
 
       # DSA can sign on any digest since 1.0.0
       @dss = OpenSSL::VERSION >= '1.0.0' ? OpenSSL::Digest::SHA256 : OpenSSL::Digest::DSS1
 
-      @cipher_key = pad_256_bit c['cipher_key']
+      @cipher_key = pad_256_bit c.delete 'cipher_key'
+
+      @expire = c.delete('expire') || c.delete('expires')
+      @secure = c.delete('secure')
+
+      unless c.empty?
+        raise "unknown options in Nyara::Config[:session]: #{c.inspect}"
+      end
     end
 
     attr_reader :name
 
-    def encode h, cookie
+    # encode into a cookie hash, for test environment
+    def encode_to_cookie h, cookie
+      cookie[@name] = encode h
+    end
+
+    # encode to value
+    def encode h
       str = h.to_json
       sig = @dsa.syssign @dss.digest str
-      str = "#{Base64.urlsafe_encode64 sig}&#{str}"
-      cookie[@name] = @cipher_key ? cipher(str) : str
+      str = "#{encode64 sig}/#{encode64 str}"
+      @cipher_key ? cipher(str) : str
+    end
+
+    # encode as header line
+    def encode_set_cookie h, secure
+      secure = @secure unless @secure.nil?
+      expire = (Time.now + @expire).gmtime.rfc2822 if @expire
+      "Set-Cookie: #{@name}=#{encode h}; HttpOnly#{'; Secure' if secure}#{"; Expires=#{expire}" if expire}\r\n"
     end
 
     def decode cookie
@@ -44,11 +76,12 @@ module Nyara
       return empty_hash if str.empty?
 
       str = decipher(str) if @cipher_key
-      sig, str = str.split '&', 2
+      sig, str = str.split '/', 2
       return empty_hash unless str
 
       begin
-        sig = Base64.urlsafe_decode64 sig
+        sig = decode64 sig
+        str = decode64 str
         verified = @dsa.sysverify @dss.digest(str), sig
         if verified
           h = JSON.parse str, create_additions: false, object_class: ParamHash
@@ -64,16 +97,28 @@ module Nyara
       end
     end
 
+    def generate_key
+      OpenSSL::PKey::DSA.generate 256
+    end
+
     # private
 
+    def encode64 s
+      [s].pack('m0').tr("+/", "-_")
+    end
+
+    def decode64 s
+      s.tr("-_", "+/").unpack('m0').first
+    end
+
     def cipher str
       iv = rand(36**CIPHER_BLOCK_SIZE).to_s(36).ljust CIPHER_BLOCK_SIZE
       c = new_cipher true, iv
-      Base64.urlsafe_encode64(iv.dup << c.update(str) << c.final)
+      encode64(iv.dup << c.update(str) << c.final)
     end
 
     def decipher str
-      str = Base64.urlsafe_decode64 str
+      str = decode64 str
       iv = str.byteslice 0...CIPHER_BLOCK_SIZE
       str = str.byteslice CIPHER_BLOCK_SIZE..-1
       return '' if !str or str.empty?

data/lib/nyara/test.rb

@@ -0,0 +1,170 @@
+module Nyara
+  # test helper
+  module Test
+    class Response
+      # whether request is success
+      def success?
+        status < 400
+      end
+
+      def redirect_location
+        if HTTP_REDIRECT_STATUS.include?(status)
+          header['Location']
+        end
+      end
+
+      # C-ext methods: header, body, status, initialize(data), set_cookies
+    end
+
+    Env = Struct.new :cookie, :session, :request, :controller, :response, :response_size_limit
+    class Env
+      # :call-seq:
+      #
+      #   # change size limit of response data to 100M:
+      #   @_env = Env.new 10**8
+      #
+      def initialize response_size_limit=5_000_000
+        self.response_size_limit = response_size_limit
+        self.cookie = ParamHash.new
+        self.session = ParamHash.new
+      end
+
+      def process_request_data data
+        client, server = Socket.pair :UNIX, :STREAM
+        self.request = Ext.request_new
+        Ext.request_set_fd request, server.fileno
+
+        client << data
+        self.controller = Ext.handle_request request
+        response_data = client.read_nonblock response_size_limit
+        self.response = Response.new response_data
+
+        # merge session
+        session.clear
+        session.merge! request.session
+
+        # merge Set-Cookie
+        response.set_cookies.each do |cookie_seg|
+          # todo distinguish delete, value and set
+          Ext.parse_url_encoded_seg cookie, cookie_seg, false
+        end
+
+        server.close
+        client.close
+      end
+
+      def http meth, path, headers={}, body_string_or_hash=''
+        headers = (headers || {}).dup
+
+        # serialize body
+        # todo build multipart for file
+        if body_string_or_hash.is_a?(Hash)
+          body = body_string_or_hash.to_param
+          headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        else
+          body = body_string_or_hash.to_s
+          headers['Content-Type'] ||= 'text/plain'
+        end
+        if body.bytesize > 0
+          headers['Content-Length'] = body.bytesize
+        end
+
+        # serialize cookie / session
+        if headers['Cookie']
+          cookie.clear
+          cookie.merge! Cookie.decode headers
+        end
+        Session.encode_to_cookie session, cookie
+        headers['Cookie'] = Cookie.encode cookie
+
+        request_data = ["#{meth.upcase} #{path} HTTP/1.1\r\n"]
+        headers.each do |k, v|
+          request_data << "#{k}: #{v}\r\n"
+        end
+        request_data << "\r\n"
+        request_data << body
+        process_request_data request_data.join
+      end
+    end
+
+    def env
+      @_env ||= Env.new
+    end
+
+    # :call-seq:
+    #
+    #   get '/', headers
+    #
+    def get path, header={}, body_string_or_hash=""
+      env.http 'GET', path, header, body_string_or_hash
+    end
+
+    # :call-seq:
+    #
+    #   post '/', {}, page: 3
+    #   post '/', { 'content-type' => 'application/json' }, '{"page":3}'
+    #
+    def post path, header={}, body_string_or_hash=""
+      env.http 'POST', path, header, body_string_or_hash
+    end
+
+    def put path, header={}, body_string_or_hash=""
+      env.http 'PUT', path, header, body_string_or_hash
+    end
+
+    def delete path, header={}, body_string_or_hash=""
+      env.http 'DELETE', path, header, body_string_or_hash
+    end
+
+    def patch path, header={}, body_string_or_hash=""
+      env.http 'PATCH', path, header, body_string_or_hash
+    end
+
+    def options path, header={}, body_string_or_hash=""
+      env.http 'OPTIONS', path, header, body_string_or_hash
+    end
+
+    def path_to id, *args
+      # similar to Controller#path_to, but without local query
+      if args.last.is_a?(Hash)
+        opts = args.pop
+      end
+
+      r = Route.global_path_template(id) % args
+
+      if opts
+        format = opts.delete :format
+        r << ".#{format}" if format
+        r << '?' << opts.to_param unless query.empty?
+      end
+      r
+    end
+
+    def cookie
+      env.cookie
+    end
+
+    def session
+      env.session
+    end
+
+    def request
+      env.request
+    end
+
+    def response
+      env.response
+    end
+
+    def redirect_location
+      env.response.redirect_location
+    end
+
+    def follow_redirect
+      # todo validate scheme and host
+      u = URI.parse(redirect_location)
+      path = [u.path, u.query].compact.join '?'
+      get path
+    end
+  end
+end

data/lib/nyara/view.rb

@@ -42,7 +42,7 @@ module Nyara
       end
       attr_reader :root
 
-      # +path+ needs extension
+      # NOTE: +path+ needs extension
       def on_delete path
         meth = path2meth path
         Renderable.class_eval do
@@ -64,7 +64,7 @@ module Nyara
         @meth2ext.clear
       end
 
-      # +path+ needs extension
+      # NOTE: +path+ needs extension<br>
       # returns dot_ext for further use
       def on_update path
         meth = path2meth path
@@ -108,7 +108,7 @@ module Nyara
         line = 1
 
         if stream_friendly
-          Renderable.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          Renderable.class_eval <<-RUBY, __FILE__, __LINE__
             def render locals={}
               @_nyara_locals = locals
               src = locals.map{|k, _| "\#{k} = @_nyara_locals[:\#{k}];" }.join
@@ -119,7 +119,7 @@ module Nyara
           RUBY
           ENGINE_STREAM_FRIENDLY[ext] = true
         else
-          Renderable.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          Renderable.class_eval <<-RUBY, __FILE__, __LINE__
             def render locals=nil
               Tilt[#{ext.inspect}].new(#{file}, #{line}){ @_nyara_view.in }.render self, locals
             end
@@ -278,8 +278,7 @@ RUBY
       Fiber.yield :term_close
     end
 
-    # :nodoc:
-    def _render
+    def _render # :nodoc:
       t, _ = @rest_layouts.pop
       if @rest_layouts.empty?
         @instance.send t, @locals

data/lib/nyara.rb

@@ -1,18 +1,19 @@
 # auto run
 require_relative "nyara/nyara"
 
-at_exit do
-  Nyara::Route.compile
-  Nyara::View.init
-  Nyara.start_server
-end
+END {
+  if $!.nil? and !Nyara.config.test?
+    Nyara.setup
+    Nyara.start_server
+  end
+}
 
 module Nyara
   class SimpleController < Controller
   end
 end
 
-%w[on tag get post put delete patch options].each do |m|
+%w[on tag get post put delete patch options meta].each do |m|
   eval <<-RUBY
   def #{m} *xs, &blk
     Nyara::SimpleController.#{m} *xs, &blk

data/nyara.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "nyara"
-  s.version = "0.0.1.pre.5"
+  s.version = "0.0.1.pre.6"
   s.author = "Zete Lui"
   s.email = "nobody@example.com"
   s.homepage = "https://github.com/luikore/nyara"
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.summary = "Fast, slim and fuzzy ruby web framework + server"
   s.description = "Fast, slim and fuzzy ruby web framework + server, based on preforked event queue and Fiber. NO rack NOR eventmachine are used."
   s.required_ruby_version = ">=2.0.0"
-  s.licenses = ['BSD']
+  s.licenses = ['BSD 3-Clause']
 
   s.files = Dir.glob('{rakefile,nyara.gemspec,readme.md,**/*.{rb,h,c,cc,inc}}')
   s.files += Dir.glob('ext/http-parser/{AUTHORS,CONTRIBUTIONS,LICENSE-MIT}')

data/rakefile

@@ -2,13 +2,13 @@ require "rake"
 
 Dir.chdir __dir__
 
-status_file = "ext/inc/status_codes.inc"
+status_file = "ext/inc/status_codes.h"
 version_file = "ext/inc/version.inc"
 makefile = "ext/Makefile"
 extconf = "ext/extconf.rb"
 
 desc "code generate"
-task :gen => [status_file, version_file]
+task :gen => [version_file]
 
 desc "generate #{status_file}"
 file status_file => __FILE__ do
@@ -47,6 +47,7 @@ end
 desc "generate makefile"
 file makefile => extconf do
   Dir.chdir 'ext' do
+    sh 'make clean' if File.exist?('Makefile')
     sh 'ruby extconf.rb'
   end
 end
@@ -112,14 +113,20 @@ end
 desc "list Nyara::Ext methods"
 task :list_ext do
   require_relative "lib/nyara/nyara"
+  puts_methods = lambda{|methods|
+    methods.each do |m|
+      puts "#{m} /#{Nyara::Ext.method(m).arity}"
+    end
+  }
+
   methods = (Nyara::Ext.methods - Module.methods).sort
   [/queue/, /route/, /parse/, /request/].each do |r|
     group = methods.grep r
-    puts group
+    puts_methods[group]
     puts
     methods -= group
   end
-  puts methods
+  puts_methods[methods]
 end
 
 def term_color n
@@ -158,3 +165,26 @@ task :audit_arity do
     end
   end
 end
+
+desc "audit http_parser / multipart_parser struct size, they should be dividable by 8 so that Request fields are aligned"
+task :audit_sizeof_parsers do
+  require "mkmf"
+  $CFLAGS << " -Iext/http-parser -Iext/multipart-parser-c"
+  {
+    'http_parser' => 'http_parser.h',
+    'multipart_parser*' => 'multipart_parser.h' # multipart_parser is opaque -_-
+  }.each do |struct, header|
+    have_header header
+    res = check_sizeof(struct, header)
+    if res and res % 8 == 0
+      puts "OK"
+    else
+      term_color 9
+      print "Need padding"
+      reset_color
+      puts
+    end
+    puts
+  end
+  sh 'rm', 'mkmf.log'
+end