rack-app 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc6e00653368212644684d6ba3c19c409eee6bad
-  data.tar.gz: 165212d0e3eaba27ff27f0b3e2534d70864be7dc
+  metadata.gz: fa7ed787ed29cd062ef3cbc6f721693f4a1d70df
+  data.tar.gz: e79de1870917b30fe6a4f940c16775deed6a49ae
 SHA512:
-  metadata.gz: 09b60839ee3b5a49f95c891f0b2c8a93be41503572c6943b313d42d0925e7be2a7c75625262da893c49bf2eac9707f53ad8ddae25d6c87fe0c8439fcb975c660
-  data.tar.gz: 5e808fc8b28adde7e389fd97f219ab9fde05d0a67d44bdab870e5e5aa18093f23f85aa5e1cfb9f1c5063dad9caf161d83792220704b60a571e6ade5dcc3d1134
+  metadata.gz: 030aa3836cb585f3a3c0d006efdae86646efe531fa48c97418f93dae495604fd8526cf7afdeb05a8adc6dd69b9349f5e1d25a31c4265f41968c3536cda00bf63
+  data.tar.gz: 58fd6808e3716ae0de6d4c90edd2ac61edfa353013502499ef1027b775c5b806111f481e7d80fa37dfd23ded75ba32f8457555d74eee072ff985fc11bde9231d

data/README.md

@@ -45,6 +45,41 @@ Or install it yourself as:
 
 Yes, in fact it's already powering heroku hosted micro-services.
 
+## Principles
+
+* Keep It Simple
+* No Code bloat
+* No on run time processing, or keep at the bare minimum
+* Fully BDD (Behaviour Driven Design)
+  * build in test module to ease the development with easy to use tests
+* Easy to Learn
+  * rack-app use well known and easy to understand conventions, such as sinatra like DSL
+* Principle Of Least Surprise
+* Modular design
+* Only dependency is rack, nothing more
+* Open development
+* Try to create Examples for every feature so even the "sketch to learn new" types can feel in comfort
+
+## Features
+
+* easy to understand syntax 
+  * module method level endpoint definition inspirited heavily by the Sinatra DSL
+  * unified error handling
+  * syntax sugar for default header definitions 
+  * namespaces for endpoint request path declarations so it can be dry and unified
+* no Class method bloat, so you can enjoy pure ruby without any surprises 
+* App mounting so you can crete separated controllers for different task  
+* Null time look up routing
+  * allows as many endpoint registration to you as you want, without impact on route look up speed
+* only basic sets for instance method lvl for the must need tools, such as params, payload
+* simple to use class level response serializer 
+  * so you can choose what type of serialization you want without any enforced convention
+* static file serving so you can mount even filesystem based endpoints too
+* built in testing module so your app can easily written with BDD approach
+* made with performance in mind so your app don't lose time by your framework
+* per endpoint middleware definitions
+  * you can define middleware stack before endpoints and it will only applied to them, similar like protected method workflow
+
 ## Usage
 
 config.ru
@@ -180,20 +215,26 @@ end
 
 ## [Benchmarking](https://github.com/adamluzsi/rack-app.rb-benchmark)
 
-| name             |      user                  | system                 | total                 | real                   |
-|------------------|----------------------------|------------------------|-----------------------|------------------------|
-| rack             |      3.150000000000001e-05 | 1.3000000000000003e-06 | 3.280000000000001e-05 | 3.602101e-05           |
-| rack-app         |      0.0005159999999999999 | 1.4000000000000005e-05 | 0.0005300000000000001 | 0.0005141295           |
-| ramaze           |      0.0005166999999999999 | 1.98e-05               | 0.0005365             | 0.0005347348           |
-| brooklyn         |      0.0007564             | 3.700000000000001e-06  | 0.0007601000000000001 | 0.0007743060099999998  |
-| nancy            |      0.000812              | 5.900000000000001e-06  | 0.0008179000000000001 | 0.0008314749300000001  |
-| scorched         |      0.0008451000000000001 | 4.699999999999999e-06  | 0.0008498000000000001 | 0.00085131501          |
-| sinatra          |      0.0008465000000000001 | 7.000000000000001e-06  | 0.0008535000000000001 | 0.00086448211          |
-| hobbit           |      0.0013664             | 4.5e-06                | 0.0013709             | 0.0013804752700000004  |
-| grape            |      0.0018807             | 2.7800000000000005e-05 | 0.0019085             | 0.0019229531400000001  |
-| rails            |      0.0018995000000000001 | 7.06e-05               | 0.0019701             | 0.00198401458          |
-| camping          |      0.002921              | 7.24e-05               | 0.0029934000000000002 | 0.0030896778800000003  |
-| cuba             |      0.0034559000000000005 | 2.8600000000000004e-05 | 0.0034845             | 0.00349655002          |
+the benchmarking was taken on the following hardware specification:
+* Processor: 2,7 GHz Intel Core i5
+* Memory: 16 GB 1867 MHz DDR3
+* Ruby: ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin15.0]
+* Endpoint declaration count: 1000
+
+| name                   | version                | current / fastest      | user                   | system                 | total                  | real                   |
+| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
+| rack                   | 1.6.4                  | 1.0                    | 4.4999999999994597e-10 | 4.999999999999855e-11  | 5.000000000001581e-10  | 4.669824999999623e-10  |
+| rack-app               | 0.23.0                 | 5.64                   | 2.6249999999995462e-09 | 5.0000000000003155e-11 | 2.674999999999656e-09  | 2.6337825000000033e-09 |
+| ramaze                 | 2012.12.08             | 10.761                 | 4.7250000000004294e-09 | 3.249999999997837e-10  | 5.0499999999999815e-09 | 5.025382500000196e-09  |
+| brooklyn               | 0.0.1                  | 135.196                | 6.202499999997365e-08  | 2.5000000000010383e-10 | 6.227499999994257e-08  | 6.31342025000291e-08   |
+| nancy                  | 0.3.0                  | 141.491                | 6.44500000000412e-08   | 4.0000000000002173e-10 | 6.485000000002128e-08  | 6.607404000000881e-08  |
+| rails                  | 4.2.5.1                | 149.063                | 6.475000000004323e-08  | 2.54999999999825e-09   | 6.729999999999027e-08  | 6.960978250001378e-08  |
+| hobbit                 | 0.6.1                  | 152.009                | 6.86499999999909e-08   | 5.50000000000627e-10   | 6.920000000002929e-08  | 7.09855800000375e-08   |
+| scorched               | 0.25                   | 206.02                 | 9.227499999997586e-08  | 6.249999999997911e-10  | 9.289999999997338e-08  | 9.620763750005751e-08  |
+| sinatra                | 1.4.7                  | 252.893                | 1.1582499999996941e-07 | 9.000000000006287e-10  | 1.167249999999214e-07  | 1.1809659249996387e-07 |
+| grape                  | 0.14.0                 | 999.893                | 4.5052499999980065e-07 | 4.900000000001301e-09  | 4.554249999998522e-07  | 4.66932680000025e-07   |
+| camping                | 2.1.532                | 2246.199               | 1.0080499999997654e-06 | 1.4049999999999699e-08 | 1.0220999999995006e-06 | 1.0489356725004438e-06 |
+| cuba                   | 3.5.0                  | 2951.837               | 1.3101249999997173e-06 | 1.302499999999637e-08  | 1.3231499999997228e-06 | 1.3784562299989904e-06 |
 
 ## Roadmap 
 

data/VERSION

@@ -1 +1 @@
-0.22.0
+0.23.0

data/lib/rack/app.rb

@@ -1,4 +1,5 @@
 require 'rack'
+require 'rack/builder'
 require 'rack/request'
 require 'rack/response'
 class Rack::App
@@ -100,6 +101,7 @@ class Rack::App
           :error_handler => error,
           :description => @last_description,
           :serializer => serializer,
+          :middleware => middleware,
           :app_class => self
       }
 
@@ -156,6 +158,12 @@ class Rack::App
       nil
     end
 
+    def middleware(&block)
+      @builder ||= Rack::Builder.new
+      block.call(@builder) unless block.nil?
+      @builder
+    end
+
   end
 
   def params

data/lib/rack/app/endpoint.rb

@@ -7,16 +7,25 @@ class Rack::App::Endpoint
   def initialize(properties)
     @properties = properties
 
-    @error_handler = properties[:error_handler]
-    @serializer = properties[:serializer]
     @api_class = properties[:app_class]
-    @headers = properties[:default_headers]
+    @error_handler = properties[:error_handler] || Rack::App::ErrorHandler.new
+    @serializer = properties[:serializer] || Rack::App::Serializer.new
+    @headers = properties[:default_headers] || {}
+
+    @middleware = (properties[:middleware] || Rack::Builder.new).dup
+    @middleware.run(lambda { |env| self.execute(env) })
 
     @path_params_matcher = {}
     @endpoint_method_name = register_method_to_app_class(properties[:user_defined_logic])
+
+    @app = @middleware.to_app
+  end
+
+  def call(env)
+    @app.call(env)
   end
 
-  def call(request_env)
+  def execute(request_env)
 
     request = Rack::Request.new(request_env)
     response = Rack::Response.new

data/lib/rack/app/endpoint/not_found.rb

@@ -4,12 +4,9 @@ not_found_properties = {
       response.status= 404
       return '404 Not Found'
     },
-    :default_headers => {},
     :request_method => 'GET',
-    :error_handler => Rack::App::ErrorHandler.new,
     :request_path => '\404',
     :description => 'page not found',
-    :serializer => Rack::App::Serializer.new,
     :app_class => app_class
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-app
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Adam Luzsi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-21 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler