hobbit 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c718834426f243de65e59d905f8aed621ec9d3e0
-  data.tar.gz: bea4cc760951fa709df57ae17a4db4425996b006
+  metadata.gz: 790649ff947ec7ea93289cc41f241ae04a2b60ea
+  data.tar.gz: af6820dcde77d613276b8f80a5a0bbef188c82c9
 SHA512:
-  metadata.gz: eda1cb013991847b0a71076fbdbd00d43125d1c927fe94707f04bc8aaf3b604575d29351ff464a5ee752cc8e0e6cc4670fe2c8211eb519957ee27c55c0b8964e
-  data.tar.gz: 81b2aea8af926f5f6cb5042e6b6d887b9614d06ddd950ecb5b2a5027324e61c658644de94975fa431109b279c5e1ef449a8e6b672b4cae768e468ed94a993695
+  metadata.gz: 7a6f43952d33eb86244c7345b43a6490d487a1cc6934d428ebd0316433eaa7be801f0cc05a915cce7bf797fefe1b2184058974ddd10d9ef2aadbf114c56513b2
+  data.tar.gz: ea115f7eeb26199d18839cdfd1f03a6e05270effce2f95710e8694ccdbd7de8e24c89c18ceffa81256931e48231084dd61ed52e934280b073d0fa2da49707c26

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.4.0
+
+* Add halt method.
+
 # 0.3.1
 
 * Remove unused `attr_accessor` (`:length`) from `Hobbit::Response`.

data/README.md

@@ -229,6 +229,81 @@ end
 run App.new
 ```
 
+#### Halting
+
+To immediately stop a request within a filter or route you must specify the
+status:
+
+```ruby
+require 'hobbit'
+
+class App < Hobbit::Base
+  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
+
+  def session
+    env['rack.session']
+  end
+
+  get '/' do
+    halt 401 unless session['user_id']
+  end
+end
+```
+
+And also you can add a body:
+
+```ruby
+require 'hobbit'
+
+class App < Hobbit::Base
+  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
+
+  def session
+    env['rack.session']
+  end
+
+  get '/' do
+    halt 401, body: 'This will be the body' unless session['user_id']
+  end
+end
+```
+
+Or headers:
+
+```ruby
+require 'hobbit'
+
+class App < Hobbit::Base
+  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
+
+  def session
+    env['rack.session']
+  end
+
+  get '/' do
+    halt 401, headers: { 'Content-Type' => 'text/html; charset=utf-8' }
+  end
+end
+```
+
+Or both:
+
+``` ruby
+require 'hobbit'
+
+class App < Hobbit::Base
+  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
+
+  def session
+    env['rack.session']
+  end
+
+  get '/' do
+    halt 401, headers: { 'Content-Type' => 'text/html; charset=utf-8' }, body: 'Woops'
+  end
+end
+```
+
 ### Security
 
 By default, Hobbit (nor Rack) comes without any protection against web

data/lib/hobbit/base.rb

@@ -55,19 +55,47 @@ module Hobbit
       @response.finish
     end
 
+    # Stops the execution and return a response
+    #
+    # status  | Number - HTTP status code
+    # body    | Response body
+    # headers | Response headers
+    #
+    def halt(status, headers: {}, body: [])
+      response.status = status # Without a default, the user must know why is using halt 
+      response.headers = headers
+      response.body = Array(body) # With this we support strings, arrays or hashes
+
+      throw :halt, response
+    end
+
     private
 
     def route_eval
-      route = self.class.routes[request.request_method].detect { |r| r[:compiled_path] =~ request.path_info }
+      catch :halt do
+        if route = find_route
+          response.write instance_eval(&route[:block])
+        else
+          halt 404
+        end
+
+        response
+      end
+    end
+
+    def find_route
+      route = self.class.routes[request.request_method].detect do |r|
+        r[:compiled_path] =~ request.path_info
+      end
+
       if route
         $~.captures.each_with_index do |value, index|
           param = route[:extra_params][index]
           request.params[param] = value
         end
-        response.write instance_eval(&route[:block])
-      else
-        response.status = 404
       end
+
+      route
     end
   end
 end

data/lib/hobbit/version.rb

@@ -1,3 +1,3 @@
 module Hobbit
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/spec/base_spec.rb

@@ -205,6 +205,64 @@ EOS
     end
   end
 
+  describe '::halt' do
+    before do
+      mock_app do
+        get '/halt' do
+          halt 501
+          response.write 'Hello world'
+        end
+
+        get '/halt_string' do
+          halt 501, body: 'Halt!'
+        end
+
+        get '/halt_array' do
+          halt 501, body: ['Halt!']
+        end
+
+        get '/halt_hash' do
+          halt 501, body: { message: 'Halt!' }
+        end
+
+        get '/halt_headers' do
+          halt 501, headers: { header: 'OK' }
+        end
+      end
+    end
+
+    it 'return the response given to halt function' do
+      get '/halt'
+      last_response.headers.must_equal({ 'Content-Length' => nil })
+      last_response.body.must_equal ''
+      last_response.status.must_equal 501
+    end
+
+    it 'accepts a string as body' do
+      get '/halt_string'
+      last_response.body.must_equal 'Halt!'
+      last_response.status.must_equal 501
+    end
+
+    it 'accepts an Array as body' do
+      get '/halt_array'
+      last_response.body.must_equal 'Halt!'
+      last_response.status.must_equal 501
+    end
+
+    it 'accepts a Hash as body' do
+      get '/halt_hash'
+      last_response.body.must_equal '[:message, "Halt!"]'
+      last_response.status.must_equal 501
+    end
+
+    it 'accepts headers' do
+      get '/halt_headers'
+      last_response.headers.must_equal({ header: 'OK', 'Content-Length' => nil })
+      last_response.status.must_equal 501
+    end
+  end
+
   it 'must respond to call' do
     app.to_app.must_respond_to :call
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hobbit
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Patricio Mac Adden