angelo 0.1.22 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e0c3ba39f8e1f28399b3302508e5607e184306c
-  data.tar.gz: 80a96668a3b52d38d10128f849115f5a9ffc639c
+  metadata.gz: a3c4a56a27bb63eaf52526379dbc8424c6f194af
+  data.tar.gz: 4ab664e1d95cb17bd9d3617565d5e4005327fd37
 SHA512:
-  metadata.gz: 8692b30501f977877aca3f79246f66dcf046e9d40100577ff79afe8235e5212081c6cda1545e9dc8a78272cc1a98e9a16ce436891bc2735713f4aaac1227b068
-  data.tar.gz: 1a0a3c79e9bb12a5c49bc3af8913c4099c7b281dbd429ba2fcdbc9f32c5a606b4fcf21fd5925d25d6a678b783fcaa2152c71251c77141556553510e0bbea1430
+  metadata.gz: 4a1f2d26c2a74f064f9c35efe1f9c923849f51d48b7a4366f7ba28cbbfd808ee984a6a703d113d5cd50673121f7956bb7ed3bb3fa44173e2b23a46d2ec5e76f8
+  data.tar.gz: d4a1f1487a0f56ce0cad5da17cf5322c537752d8eb2bae6d1f4bed3999fe946310eb0184f30ee1f2d0cf9d8905598d5da0f6077876891352823a7633f44c6873

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 changelog
 =========
 
+### 0.1.23 18 sep 2014 (thanks @chewi, @samjohnduke)
+
+* multiple before/after filters with mustermann support (#3)
+* accept extra headers in eventsource route builder (#6)
+* handle errors in before blocks for eventsource-built routes (#6)
+* let DELETE and OPTIONS routes see query params (#8)
+
 ### 0.1.22 9 sep 2014
 
 * handle bad/malformed requests better

data/Gemfile.lock

@@ -16,7 +16,8 @@ GEM
     method_source (0.8.2)
     mime-types (2.3)
     minitest (5.4.0)
-    mustermann (0.2.0)
+    mustermann (0.3.1)
+      tool (~> 0.2)
     nio4r (1.0.0)
     nio4r (1.0.0-java)
     pry (0.9.12.6)
@@ -42,6 +43,7 @@ GEM
       ffi
     tilt (2.0.1)
     timers (1.1.0)
+    tool (0.2.2)
     websocket-driver (0.3.4)
     websocket-driver (0.3.4-java)
     websocket_parser (0.1.6)

data/lib/angelo/base.rb

@@ -75,12 +75,35 @@ module Angelo
         @routes
       end
 
+      def filters
+        @filters ||= {before: {default: []}, after: {default: []}}
+      end
+
+      def filter which, opts = {}, &block
+        f = compile! :filter, &block
+        case opts
+        when String
+          filter_by which, opts, f
+        when Hash
+          if opts[:path]
+            filter_by which, opts[:path], f
+          else
+            filters[which][:default] << f
+          end
+        end
+      end
+
+      def filter_by which, path, meth
+        filters[which][path] ||= []
+        filters[which][path] << meth
+      end
+
       def before opts = {}, &block
-        define_method :before, &block
+        filter :before, opts, &block
       end
 
       def after opts = {}, &block
-        define_method :after, &block
+        filter :after, opts, &block
       end
 
       HTTPABLE.each do |m|
@@ -93,8 +116,8 @@ module Angelo
         routes[:websocket][path] = Responder::Websocket.new &block
       end
 
-      def eventsource path, &block
-        routes[:get][path] = Responder::Eventsource.new &block
+      def eventsource path, headers = nil, &block
+        routes[:get][path] = Responder::Eventsource.new headers, &block
       end
 
       def on_pong &block
@@ -166,9 +189,10 @@ module Angelo
 
     def params
       @params ||= case request.method
-                  when GET;  parse_query_string
-                  when POST; parse_post_body
-                  when PUT;  parse_post_body
+                  when GET, DELETE, OPTIONS
+                    parse_query_string
+                  when POST, PUT
+                    parse_post_body
                   end
     end
 
@@ -275,6 +299,12 @@ module Angelo
       Celluloid.sleep time
     end
 
+    def filter which
+      fs = self.class.filters[which][:default]
+      fs += self.class.filters[which][request.path] if self.class.filters[which][request.path]
+      fs.each {|f| f.bind(self).call}
+    end
+
   end
 
 end

data/lib/angelo/mustermann.rb

@@ -33,9 +33,9 @@ module Angelo
         super path, &block
       end
 
-      def eventsource path, &block
+      def eventsource path, headers = nil, &block
         path = ::Mustermann.new path
-        super path, &block
+        super path, headers, &block
       end
 
       def routes
@@ -46,12 +46,38 @@ module Angelo
         @routes
       end
 
+      def filter_by which, path, meth
+        pattern = ::Mustermann.new path
+        filters[which][pattern] ||= []
+        filters[which][pattern] << meth
+      end
+
     end
 
     def params
       @params ||= super.merge mustermann.params(request.path)
     end
 
+    def filter which
+      fs = self.class.filters[which][:default].dup
+      self.class.filters[which].each do |pattern, f|
+        if ::Mustermann === pattern and pattern.match request.path
+          fs << [f, pattern]
+        end
+      end
+      fs.each do |f|
+        case f
+        when UnboundMethod
+          f.bind(self).call
+        when Array
+          @pre_filter_params = params
+          @params = @pre_filter_params.merge f[1].params(request.path)
+          f[0].each {|filter| filter.bind(self).call}
+          @params = @pre_filter_params
+        end
+      end
+    end
+
     class RouteMap
 
       def initialize

data/lib/angelo/responder/eventsource.rb

@@ -2,6 +2,11 @@ module Angelo
   class Responder
     class Eventsource < Responder
 
+      def initialize _headers = nil, &block
+        headers _headers if _headers
+        super &block
+      end
+
       def request= request
         @params = nil
         @request = request
@@ -11,14 +16,14 @@ module Angelo
       def handle_request
         begin
           if @response_handler
-            @base.before if @base.respond_to? :before
+            @base.filter :before
             @body = catch(:halt) { @base.eventsource &@response_handler.bind(@base) }
             if HALT_STRUCT === @body
               raise RequestError.new 'unknown sse error' unless @body.body == :sse
             end
 
             # TODO any real reason not to run afters with SSE?
-            # @base.after if @base.respond_to? :after
+            # @base.filter :after
 
             respond
           else
@@ -26,15 +31,8 @@ module Angelo
           end
         rescue IOError => ioe
           warn "#{ioe.class} - #{ioe.message}"
-          close_websocket
         rescue => e
-          error e.message
-          ::STDERR.puts e.backtrace
-          begin
-            @connection.close
-          rescue Reel::StateError => rcse
-            close_websocket
-          end
+          handle_error e
         end
       end
 

data/lib/angelo/responder/websocket.rb

@@ -25,9 +25,9 @@ module Angelo
             Angelo.log @connection, @request, @websocket, :switching_protocols
             @bound_response_handler ||= @response_handler.bind @base
             @websocket.on_pong &Responder::Websocket.on_pong
-            @base.before if @base.respond_to? :before
+            @base.filter :before
             @bound_response_handler[@websocket]
-            @base.after if @base.respond_to? :after
+            @base.filter :after
           else
             raise NotImplementedError
           end

data/lib/angelo/responder.rb

@@ -1,5 +1,3 @@
-require 'date'
-
 module Angelo
 
   class Responder
@@ -50,17 +48,15 @@ module Angelo
 
     def handle_request
       if @response_handler
-        @base.before if @base.respond_to? :before
+        @base.filter :before
         @body = catch(:halt) { @response_handler.bind(@base).call || EMPTY_STRING }
 
         # TODO any real reason not to run afters with SSE?
         case @body
         when HALT_STRUCT
-          if @body.body != :sse and @base.respond_to? :after
-            @base.after
-          end
+          @base.filter :after if @body.body != :sse
         else
-          @base.after if @base.respond_to? :after
+          @base.filter :after
         end
 
         respond

data/lib/angelo/version.rb

@@ -1,3 +1,3 @@
 module Angelo
-  VERSION = '0.1.22'
+  VERSION = '0.1.23'
 end

data/test/angelo/eventsource_spec.rb

@@ -4,30 +4,70 @@ describe Angelo::Responder::Eventsource do
 
   describe 'route builder' do
 
-    define_app do
+    describe 'basics' do
+
+      define_app do
+
+        eventsource '/msg' do |c|
+          c.write sse_message 'hi'
+          c.close
+        end
+
+        eventsource '/event' do |c|
+          c.write sse_event :sse, 'bye'
+          c.close
+        end
+
+        eventsource '/headers', foo: 'bar' do |c|
+          c.write sse_event :sse, 'headers'
+          c.close
+        end
 
-      eventsource '/msg' do |c|
-        c.write sse_message 'hi'
-        c.close
       end
 
-      eventsource '/event' do |c|
-        c.write sse_event :sse, 'bye'
-        c.close
+      it 'sends messages' do
+        get_sse '/msg' do |msg|
+          msg.must_equal "data: hi\n\n"
+        end
       end
 
-    end
+      it 'sends events' do
+        get_sse '/event' do |msg|
+          msg.must_equal "event: sse\ndata: bye\n\n"
+        end
+      end
 
-    it 'sends messages' do
-      get_sse '/msg' do |msg|
-        msg.must_equal "data: hi\n\n"
+      it 'accepts extra headers hash as second optional parameter' do
+        get_sse '/headers' do |msg|
+          msg.must_equal "event: sse\ndata: headers\n\n"
+        end
+        last_response.headers['Foo'].must_equal 'bar'
       end
+
     end
 
-    it 'sends events' do
-      get_sse '/event' do |msg|
-        msg.must_equal "event: sse\ndata: bye\n\n"
+    describe 'error handling' do
+
+      define_app do
+
+        before do
+          raise 'wrong'
+        end
+
+        eventsource '/msg' do |c|
+          c.write sse_message 'hi'
+          c.close
+        end
+
+      end
+
+      it 'handles exceptions in before blocks' do
+        get_sse '/msg' do |msg|
+          msg.must_equal "wrong"
+        end
+        last_response.status.must_equal 500
       end
+
     end
 
   end
@@ -52,6 +92,14 @@ describe 'eventsource helper' do
       end
     end
 
+    get '/headers' do
+      headers foo: 'bar'
+      eventsource do |c|
+        c.write sse_event :sse, 'headers'
+        c.close
+      end
+    end
+
   end
 
   it 'sends messages' do
@@ -66,4 +114,11 @@ describe 'eventsource helper' do
     end
   end
 
+  it 'allows headers to be set outside block' do
+    get_sse '/headers' do |msg|
+      msg.must_equal "event: sse\ndata: headers\n\n"
+    end
+    last_response.headers['Foo'].must_equal 'bar'
+  end
+
 end

data/test/angelo/filter_spec.rb

@@ -0,0 +1,294 @@
+require_relative '../spec_helper.rb'
+
+describe Angelo::Base do
+
+  describe 'before filter' do
+
+    describe 'single default' do
+
+      define_app do
+
+        before do
+          @set_by_before = params
+        end
+
+        [:get, :post, :put].each do |m|
+          __send__ m, '/before' do
+            content_type :json
+            @set_by_before
+          end
+        end
+
+      end
+
+      it 'runs before filters before routes' do
+
+        get '/before', obj
+        last_response_must_be_json obj_s
+
+        [:post, :put].each do |m|
+          __send__ m, '/before', obj.to_json, {Angelo::CONTENT_TYPE_HEADER_KEY => Angelo::JSON_TYPE}
+          last_response_must_be_json obj
+        end
+
+      end
+
+    end
+
+    describe 'multiple default' do
+
+      define_app do
+
+        before do
+          @foo = params[:foo]
+        end
+
+        before do
+          @bar = params[:bar] if @foo
+        end
+
+        before do
+          @bat = params[:bat] if @bar
+        end
+
+        [:get, :post, :put].each do |m|
+          __send__ m, '/before' do
+            content_type :json
+            { foo: @foo, bar: @bar, bat: @bat }
+          end
+        end
+
+      end
+
+      it 'runs before filters in order' do
+
+        get '/before', obj
+        last_response_must_be_json obj_s
+
+        [:post, :put].each do |m|
+          __send__ m, '/before', obj.to_json, {Angelo::CONTENT_TYPE_HEADER_KEY => Angelo::JSON_TYPE}
+          last_response_must_be_json obj
+        end
+
+      end
+
+    end
+
+    describe 'pathed' do
+
+      define_app do
+
+        before do
+          @foo = params[:foo]
+        end
+
+        before '/before_bar' do
+          @bar = params[:bar] if @foo
+        end
+
+        before path: '/before_bat' do
+          @bat = params[:bat] if @foo
+        end
+
+        [:get, :post, :put].each do |m|
+
+          __send__ m, '/before' do
+            content_type :json
+            { foo: @foo, bar: @bar, bat: @bat }.select! {|k,v| !v.nil?}
+          end
+
+          __send__ m, '/before_bar' do
+            content_type :json
+            { foo: @foo, bar: @bar, bat: @bat }.select! {|k,v| !v.nil?}
+          end
+
+          __send__ m, '/before_bat' do
+            content_type :json
+            { foo: @foo, bar: @bar, bat: @bat }.select! {|k,v| !v.nil?}
+          end
+        end
+
+      end
+
+      it 'runs default before filter for all paths' do
+
+        get '/before', obj
+        last_response_must_be_json obj_s.select {|k,v| k == 'foo'}
+
+        [:post, :put].each do |m|
+          __send__ m, '/before', obj.to_json, {Angelo::CONTENT_TYPE_HEADER_KEY => Angelo::JSON_TYPE}
+          last_response_must_be_json obj.select {|k,v| k == 'foo'}
+        end
+
+      end
+
+      it 'runs default and specific before filters' do
+
+        get '/before_bar', obj
+        last_response_must_be_json obj_s.select {|k,v| ['foo','bar'].include? k}
+
+        [:post, :put].each do |m|
+          __send__ m, '/before_bar', obj.to_json, {Angelo::CONTENT_TYPE_HEADER_KEY => Angelo::JSON_TYPE}
+          last_response_must_be_json obj.select {|k,v| ['foo','bar'].include? k}
+        end
+
+        get '/before_bat', obj
+        last_response_must_be_json obj_s.select {|k,v| ['foo','bat'].include? k}
+
+        [:post, :put].each do |m|
+          __send__ m, '/before_bat', obj.to_json, {Angelo::CONTENT_TYPE_HEADER_KEY => Angelo::JSON_TYPE}
+          last_response_must_be_json obj.select {|k,v| ['foo','bat'].include? k}
+        end
+
+      end
+
+    end
+
+  end
+
+  describe 'after filter' do
+
+    describe 'single default' do
+
+      invoked = 0
+
+      define_app do
+
+        before do
+          invoked += 2
+        end
+
+        after do
+          invoked *= 2
+        end
+
+        Angelo::HTTPABLE.each do |m|
+          __send__ m, '/after' do
+            invoked.to_s
+          end
+        end
+
+      end
+
+      it 'runs after filters after routes' do
+        a = %w[2 6 14 30 62]
+        b = [4, 12, 28, 60, 124]
+
+        Angelo::HTTPABLE.each_with_index do |m,i|
+          __send__ m, '/after', obj
+          last_response_must_be_html a[i]
+          invoked.must_equal b[i]
+        end
+      end
+
+    end
+
+    describe 'multiple default' do
+
+      invoked = 0
+
+      define_app do
+
+        after do
+          invoked += 2
+        end
+
+        after do
+          invoked *= 2
+        end
+
+        after do
+          invoked -= 2
+        end
+
+        Angelo::HTTPABLE.each do |m|
+          __send__ m, '/after' do
+            invoked.to_s
+          end
+        end
+
+      end
+
+      it 'runs after filters in order' do
+        a = %w[0 2 6 14 30]
+        b = [2, 6, 14, 30, 62]
+
+        Angelo::HTTPABLE.each_with_index do |m,i|
+          __send__ m, '/after', obj
+          last_response_must_be_html a[i]
+          invoked.must_equal b[i]
+        end
+      end
+
+    end
+
+    describe 'pathed' do
+
+      invoked = 0
+
+      define_app do
+
+        after do
+          invoked += 2
+        end
+
+        after '/after_bar' do
+          invoked *= 2
+        end
+
+        after '/after_bat' do
+          invoked -= 4
+        end
+
+        Angelo::HTTPABLE.each do |m|
+          __send__ m, '/after' do
+            invoked.to_s
+          end
+
+          __send__ m, '/after_bar' do
+            invoked.to_s
+          end
+
+          __send__ m, '/after_bat' do
+            invoked.to_s
+          end
+        end
+
+      end
+
+      it 'runs default and specific after filters' do
+
+        a = %w[0 2 4 6 8]
+        b = [2, 4, 6, 8, 10]
+
+        Angelo::HTTPABLE.each_with_index do |m,i|
+          __send__ m, '/after', obj
+          last_response_must_be_html a[i]
+          invoked.must_equal b[i]
+        end
+
+        c = %w[10 24 52 108 220]
+        d = [24, 52, 108, 220, 444]
+
+        Angelo::HTTPABLE.each_with_index do |m,i|
+          __send__ m, '/after_bar', obj
+          last_response_must_be_html c[i]
+          invoked.must_equal d[i]
+        end
+
+        e = %w[444 442 440 438 436]
+        f = [442, 440, 438, 436, 434]
+
+        Angelo::HTTPABLE.each_with_index do |m,i|
+          __send__ m, '/after_bat', obj
+          last_response_must_be_html e[i]
+          invoked.must_equal f[i]
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/test/angelo/mustermann_spec.rb

@@ -94,4 +94,92 @@ HTML
 
   end
 
+  describe 'filters' do
+
+    describe 'params in route blocks' do
+
+      define_app do
+        include Angelo::Mustermann
+
+        before '/before/:foo' do
+          @foo = params[:foo]
+        end
+
+        content_type :json
+
+        [:get, :post, :put].each do |m|
+          __send__ m, '/before/:bar' do
+            { bar: params[:bar], foo: params[:foo], foo_from_before: @foo }
+          end
+        end
+
+      end
+
+      it 'does not infect route block params with filter pattern params' do
+        [:get, :post, :put].each do |m|
+          __send__ m, '/before/hi'
+          last_response_must_be_json 'bar' => 'hi', 'foo' => nil, 'foo_from_before' => 'hi'
+        end
+      end
+
+    end
+
+    describe 'wildcard' do
+
+      define_app do
+        include Angelo::Mustermann
+
+        before do
+          @foo = params[:foo]
+        end
+
+        before path: '/before*' do
+          @bar = params[:bar] if @foo
+          @bat = params[:bat] if @foo
+        end
+
+        [:get, :post, :put].each do |m|
+
+          __send__ m, '/before' do
+            content_type :json
+            { foo: @foo, bar: @bar, bat: @bat }.select {|k,v| !v.nil?}
+          end
+
+          __send__ m, '/before_bar' do
+            content_type :json
+            { foo: @foo, bar: @bar, bat: @bat }.select {|k,v| !v.nil?}
+          end
+
+          __send__ m, '/before_bat' do
+            content_type :json
+            { foo: @foo, bar: @bar, bat: @bat }.select {|k,v| !v.nil?}
+          end
+        end
+
+      end
+
+      it 'runs wildcarded before filters' do
+
+        get '/before_bar', obj
+        last_response_must_be_json obj_s
+
+        [:post, :put].each do |m|
+          __send__ m, '/before_bar', obj.to_json, {Angelo::CONTENT_TYPE_HEADER_KEY => Angelo::JSON_TYPE}
+          last_response_must_be_json obj
+        end
+
+        get '/before_bat', obj
+        last_response_must_be_json obj_s
+
+        [:post, :put].each do |m|
+          __send__ m, '/before_bat', obj.to_json, {Angelo::CONTENT_TYPE_HEADER_KEY => Angelo::JSON_TYPE}
+          last_response_must_be_json obj
+        end
+
+      end
+
+    end
+
+  end
+
 end

data/test/angelo/websocket_spec.rb

@@ -194,7 +194,7 @@ describe Angelo::Responder::Websocket do
       Angelo::HTTPABLE.each do |m|
         __send__ m, '/concur' do
           websockets.each do |ws|
-            msg = "from #{params ? params[:foo] : 'http'} #{m.to_s}"
+            msg = "from #{params[:foo]} #{m.to_s}"
             ws.write msg
           end
           ''
@@ -216,7 +216,7 @@ describe Angelo::Responder::Websocket do
       }
 
       websocket_wait_for '/concur', latch, expectation do
-        Angelo::HTTPABLE.each {|m| __send__ m, '/concur', foo: 'http'}
+        Angelo::HTTPABLE.each {|m| __send__ m, '/concur?foo=http'}
         latch.wait
       end
 

data/test/angelo_spec.rb

@@ -2,14 +2,6 @@ require_relative './spec_helper'
 
 describe Angelo::Base do
 
-  def obj
-    {'foo' => 'bar', 'bar' => 123.4567890123456, 'bat' => true}
-  end
-
-  def obj_s
-    obj.keys.reduce({}){|h,k| h[k] = obj[k].to_s; h}
-  end
-
   describe 'the basics' do
 
     define_app do
@@ -108,72 +100,6 @@ describe Angelo::Base do
 
   end
 
-  describe 'before filter' do
-
-    define_app do
-
-      before do
-        @set_by_before = params
-      end
-
-      [:get, :post, :put].each do |m|
-        __send__ m, '/before' do
-          content_type :json
-          @set_by_before
-        end
-      end
-
-    end
-
-    it 'runs before filters before routes' do
-
-      get '/before', obj
-      last_response_must_be_json obj_s
-
-      [:post, :put].each do |m|
-        __send__ m, '/before', obj.to_json, {Angelo::CONTENT_TYPE_HEADER_KEY => Angelo::JSON_TYPE}
-        last_response_must_be_json obj
-      end
-
-    end
-
-  end
-
-  describe 'after filter' do
-
-    invoked = 0
-
-    define_app do
-
-      before do
-        invoked += 2
-      end
-
-      after do
-        invoked *= 2
-      end
-
-      Angelo::HTTPABLE.each do |m|
-        __send__ m, '/after' do
-          invoked.to_s
-        end
-      end
-
-    end
-
-    it 'runs after filters after routes' do
-      a = %w[2 6 14 30 62]
-      b = [4, 12, 28, 60, 124]
-
-      Angelo::HTTPABLE.each_with_index do |m,i|
-        __send__ m, '/after', obj
-        last_response_must_be_html a[i]
-        invoked.must_equal b[i]
-      end
-    end
-
-  end
-
   describe 'headers helper' do
 
     headers_count = 0
@@ -385,7 +311,7 @@ describe Angelo::Base do
 
     define_app do
 
-      [:get, :post].each do |m|
+      Angelo::HTTPABLE.each do |m|
         __send__ m, '/json' do
           content_type :json
           params
@@ -409,6 +335,13 @@ describe Angelo::Base do
       last_response_must_be_json({})
     end
 
+    (Angelo::HTTPABLE - [:post, :put]).each do |m|
+      it "returns a populated hash for #{m.to_s.upcase} requests" do
+        send m, '/json?foo=bar'
+        last_response_must_be_json('foo' => 'bar')
+      end
+    end
+
   end
 
   describe 'request_headers helper' do

data/test/spec_helper.rb

@@ -84,3 +84,11 @@ class ActorPool
 end
 
 $pool = ActorPool.pool size: CONCURRENCY
+
+def obj
+  {'foo' => 'bar', 'bar' => 123.4567890123456, 'bat' => true}
+end
+
+def obj_s
+  obj.keys.reduce({}){|h,k| h[k] = obj[k].to_s; h}
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: angelo
 version: !ruby/object:Gem::Version
-  version: 0.1.22
+  version: 0.1.23
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reel
@@ -69,6 +69,7 @@ files:
 - test/angelo/erb_spec.rb
 - test/angelo/error_spec.rb
 - test/angelo/eventsource_spec.rb
+- test/angelo/filter_spec.rb
 - test/angelo/mustermann_spec.rb
 - test/angelo/params_spec.rb
 - test/angelo/static_spec.rb