angelo 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 809986637c600091f82231a4d8b5abc98d8901f6
-  data.tar.gz: 4d85c02a50c030f4405fcb7c957e44fd7c27e3d4
+  metadata.gz: 5dd4947d9238c95169d7a38db1ff5964db35efad
+  data.tar.gz: 65d2a79bfca8c5879721516d31029fd756ebc1c5
 SHA512:
-  metadata.gz: a61261e0ff70da449f4f3b15c55ec9261947d8b49b7b6747a4d660f76862268e25d50254977ef5e428215dbfb732ae03885f9c0c4ee07a14f9ac69b405e0a1b0
-  data.tar.gz: 5558f936798f39acb2a2f56ae98a3ad90fc66fd3a47be8992753f1cf6f5fec24cee5a79833e7a4cad26e2022258aed89084bf54b420c7430479ff37eb876b134
+  metadata.gz: 1da99edfa1e946edd6f62764a95ab09e999cc6eccef9d915d0741e6ed8912ed8629d28b58605c7960972c0795c5ab912b2824bb018322c82bd90b1c7fee08be9
+  data.tar.gz: 194fda3f3e9bf9f7a7b0ce2156bf8e34d2134ba7013e1366a7a8363e1cbba72c826daed7b8f1c934894e9431c8bcc87ab1d9c2b905a0741151d212d9a6c238b2

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 changelog
 =========
 
+### 0.1.11 13 jun 2014
+
+* add halt method and handling
+
 ### 0.1.10 12 jun 2014
 
-* add RequestError
+* add RequestError and handling
 
 ### 0.1.9 5 jun 2014
 

data/README.md

@@ -29,6 +29,9 @@ route handlers denoted by HTTP verb and path. Unlike Sinatra, the only acceptabl
 route block is the body of the response in full. Chunked response support was recently added to Reel,
 and look for that support in Angelo soon.
 
+Angelo also features `before` and `after` blocks, just like Sinatra. The one difference lies in how
+after blocks are handled. See the Errors section below for more info.
+
 There is also [Mustermann](#mustermann) support for full-on, Sinatra-like path
 matching and params.
 
@@ -157,18 +160,35 @@ get '/' do
 end
 ```
 
-### Errors
+### Errors and Halting
+
+Angelo gives you two ordained methods of stopping route processing:
+
+* raise an instance of `RequestError`
+* `halt` with a status code and message
+
+The main difference is that `halt` will still run an `after` block, and raising `RequestError`
+will bypass the `after` block.
 
-In Sinatra, one can `halt` and optionally pass status codes and a body. While that functionality
-is not (yet?) present in Angelo, the ability to `raise` a `RequestError` is. Raising an instance
-of this always\* causes a 400 status code response, and the message in the instance is the body
-of the the response. If the route or class was set to respond with JSON, the body is converted
-to a JSON object with one key, `error`, that has a value of the message. If the message is a
-`Hash`, the hash is converted to a JSON object, or to a string for other content types.
+Any other exceptions or errors raised by your route handler will be handled with a 500 status
+code and the message will be the body of the response.
 
-\* If you want to return a different status code, you can pass it as a second argument to
+#### RequestError
+
+Raising an instance of `Angelo::RequestError` causes a 400 status code response, and the message
+in the instance is the body of the the response. If the route or class was set to respond with
+JSON, the body is converted to a JSON object with one key, `error`, that has a value of the message.
+If the message is a `Hash`, the hash is converted to a JSON object, or to a string for other content
+types.
+
+If you want to return a different status code, you can pass it as a second argument to
 `RequestError.new`. See example below.
 
+#### Halting
+
+You can `halt` from within any route handler, optionally passing status code and a body. The
+body is handled the same way as raising `RequestError`.
+
 ##### Example
 
 ```ruby
@@ -186,6 +206,11 @@ end
 get '/not_found' do
   raise RequestError.new 'not found', 404
 end
+
+get '/halt' do
+  halt 200, "everything's fine"
+  raise RequestError.new "won't get here"
+end
 ```
 
 ```
@@ -220,6 +245,14 @@ Connection: Keep-Alive
 Content-Length: 9
 
 not found
+
+$ curl -i http://127.0.0.1:4567/halt
+HTTP/1.1 200 OK
+Content-Type: text/html
+Connection: Keep-Alive
+Content-Length: 18
+
+everything's fine
 ```
 
 ### WORK LEFT TO DO

data/lib/angelo/base.rb

@@ -86,7 +86,7 @@ module Angelo
       end
 
       def websocket path, &block
-        routes[:socket][path] = WebsocketResponder.new &block
+        routes[:websocket][path] = WebsocketResponder.new &block
       end
 
       def on_pong &block
@@ -166,6 +166,10 @@ module Angelo
       end
     end
 
+    def halt status = 400, body = ''
+      throw :halt, HALT_STRUCT.new(status, body)
+    end
+
   end
 
 end

data/lib/angelo/responder.rb

@@ -47,6 +47,7 @@ module Angelo
     def request= request
       @params = nil
       @redirect = nil
+      @body = nil
       @request = request
       handle_request
     end
@@ -54,7 +55,7 @@ module Angelo
     def handle_request
       if @response_handler
         @base.before if @base.respond_to? :before
-        @body = @response_handler.bind(@base).call || ''
+        @body = catch(:halt) { @response_handler.bind(@base).call || '' }
         @base.after if @base.respond_to? :after
         respond
       else
@@ -122,18 +123,28 @@ module Angelo
     end
 
     def respond
-      @body = case @body
-              when String
-                JSON.parse @body if respond_with? :json # for the raises
-                @body
-              when Hash
-                raise 'html response requires String' if respond_with? :html
-                @body.to_json if respond_with? :json
-              when NilClass
-                EMPTY_STRING
-              end
-
-      status = @redirect.nil? ? :ok : :moved_permanently
+      status = nil
+      case @body
+      when HALT_STRUCT
+        status = @body.status
+        @body = @body.body
+        if Hash === @body
+          @body = {error: @body} if status != :ok or status < 200 && status >= 300
+          @body = @body.to_json if respond_with? :json
+        end
+
+      when String
+        JSON.parse @body if respond_with? :json # for the raises
+
+      when Hash
+        raise 'html response requires String' if respond_with? :html
+        @body = @body.to_json if respond_with? :json
+
+      when NilClass
+        @body = EMPTY_STRING
+      end
+
+      status ||= @redirect.nil? ? :ok : :moved_permanently
       headers LOCATION_HEADER_KEY => @redirect if @redirect
 
       Angelo.log @connection, @request, nil, status, @body.size

data/lib/angelo/server.rb

@@ -19,7 +19,7 @@ module Angelo
     def on_connection connection
       # RubyProf.resume
       connection.each_request do |request|
-        meth = request.websocket? ? :socket : request.method.downcase.to_sym
+        meth = request.websocket? ? :websocket : request.method.downcase.to_sym
         dispatch! meth, connection, request
       end
       # RubyProf.pause

data/lib/angelo/version.rb

@@ -1,3 +1,3 @@
 module Angelo
-  VERSION = '0.1.10'
+  VERSION = '0.1.11'
 end

data/lib/angelo.rb

@@ -14,7 +14,7 @@ module Angelo
   DELETE =  'DELETE'
   OPTIONS = 'OPTIONS'
 
-  ROUTABLE = [:get, :post, :put, :delete, :socket]
+  ROUTABLE = [:get, :post, :put, :delete, :websocket]
   HTTPABLE = [:get, :post, :put, :delete]
   STATICABLE = [:get, :head]
 
@@ -51,6 +51,8 @@ module Angelo
   DASH = '-'
   EMPTY_STRING = ''
 
+  HALT_STRUCT = Struct.new :status, :body
+
   def self.log connection, request, socket, status, body_size = '-'
 
     remote_ip = ->{

data/test/angelo/error_spec.rb

@@ -4,8 +4,17 @@ describe Angelo::Base do
 
   describe :handle_error do
 
+    after_ran = false
+    before do
+      after_ran = false
+    end
+
     define_app do
 
+      after do
+        after_ran = true
+      end
+
       Angelo::HTTPABLE.each do |m|
         __send__ m, '/' do
 
@@ -105,6 +114,92 @@ describe Angelo::Base do
 
     end
 
+    it 'does not run after blocks when handling a raised error' do
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/'
+        last_response.status.must_equal 400
+        last_response.headers['Content-Type'].split(';').must_include Angelo::HTML_TYPE
+        last_response.body.to_s.must_equal 'error message'
+        refute after_ran, 'after block should not have ran'
+      end
+    end
+
+  end
+
+  describe :halt do
+
+    after_ran = false
+    before do
+      after_ran = false
+    end
+
+    define_app do
+
+      after do
+        after_ran = true
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/halt' do
+          halt
+          raise RequestError.new "shouldn't get here"
+        end
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/teapot' do
+          halt 418, "i'm a teapot"
+          raise RequestError.new "shouldn't get here"
+        end
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/calm_json' do
+          content_type :json
+          halt 420, {calm: 'enhance'}
+          raise RequestError.new "shouldn't get here"
+        end
+      end
+
+    end
+
+    it 'halts properly' do
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/halt'
+        last_response.status.must_equal 400
+        last_response.headers['Content-Type'].split(';').must_include Angelo::HTML_TYPE
+        last_response.body.to_s.must_equal ''
+      end
+    end
+
+    it 'halts with different status code properly' do
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/teapot'
+        last_response.status.must_equal 418
+        last_response.headers['Content-Type'].split(';').must_include Angelo::HTML_TYPE
+        last_response.body.to_s.must_equal "i'm a teapot"
+      end
+    end
+
+    it 'halts with json content type correctly' do
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/calm_json'
+        last_response.status.must_equal 420
+        last_response.headers['Content-Type'].split(';').must_include Angelo::JSON_TYPE
+        last_response.body.to_s.must_equal({error: {calm: 'enhance'}}.to_json)
+      end
+    end
+
+    it 'runs after blocks when halting' do
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/halt'
+        last_response.status.must_equal 400
+        last_response.headers['Content-Type'].split(';').must_include Angelo::HTML_TYPE
+        last_response.body.to_s.must_equal ''
+        assert after_ran, 'after block should have ran'
+      end
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: angelo
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reel