angelo 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5543dd789ee112be7d4e19f9cb94d85d838369b
-  data.tar.gz: d06335e0f1524c29b8b04d8b3c84d1d0a18a0069
+  metadata.gz: 809986637c600091f82231a4d8b5abc98d8901f6
+  data.tar.gz: 4d85c02a50c030f4405fcb7c957e44fd7c27e3d4
 SHA512:
-  metadata.gz: 1a62cffec398cb4ae84c238f78bdd7d733edaf2f0c12a60c95df4ba78e7f1651165dbe1ff32977b6e6313ae291e79200e4dbb092b61b98bab366c52d8f5f2882
-  data.tar.gz: da2f279b41793155d5e3e24737d193a1acdff58ce19e7063ea1750ffa14eb1657d611fc04db568c72cc84d2364b70cdfecd01a9429515510662f94894be2b09d
+  metadata.gz: a61261e0ff70da449f4f3b15c55ec9261947d8b49b7b6747a4d660f76862268e25d50254977ef5e428215dbfb732ae03885f9c0c4ee07a14f9ac69b405e0a1b0
+  data.tar.gz: 5558f936798f39acb2a2f56ae98a3ad90fc66fd3a47be8992753f1cf6f5fec24cee5a79833e7a4cad26e2022258aed89084bf54b420c7430479ff37eb876b134

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 changelog
 =========
 
+### 0.1.10 12 jun 2014
+
+* add RequestError
+
+### 0.1.9 5 jun 2014
+
 * make Mustermann::RouteMap not descend from Hash
 * replace WebsocketsArray < Array with Stash
 * fix WebsocketRepsonder.close_socket

data/README.md

@@ -157,6 +157,71 @@ get '/' do
 end
 ```
 
+### Errors
+
+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.
+
+\* If you want to return a different status code, you can pass it as a second argument to
+`RequestError.new`. See example below.
+
+##### Example
+
+```ruby
+get '/' do
+  raise RequestError.new '"foo" is a required parameter' unless params[:foo]
+  params[:foo]
+end
+
+get '/json' do
+  content_type :json
+  raise RequestError.new foo: "required!"
+  {foo: params[:foo]}
+end
+
+get '/not_found' do
+  raise RequestError.new 'not found', 404
+end
+```
+
+```
+$ curl -i http://127.0.0.1:4567/
+HTTP/1.1 400 Bad Request
+Content-Type: text/html
+Connection: Keep-Alive
+Content-Length: 29
+
+"foo" is a required parameter
+
+$ curl -i http://127.0.0.1:4567/?foo=bar
+HTTP/1.1 200 OK
+Content-Type: text/html
+Connection: Keep-Alive
+Content-Length: 3
+
+bar
+
+$ curl -i http://127.0.0.1:4567/json
+HTTP/1.1 400 Bad Request
+Content-Type: application/json
+Connection: Keep-Alive
+Content-Length: 29
+
+{"error":{"foo":"required!"}}
+
+$ curl -i http://127.0.0.1:4567/not_found
+HTTP/1.1 404 Not Found
+Content-Type: text/html
+Connection: Keep-Alive
+Content-Length: 9
+
+not found
+```
+
 ### WORK LEFT TO DO
 
 Lots of work left to do!

data/lib/angelo/base.rb

@@ -27,20 +27,31 @@ module Angelo
       attr_accessor :app_file, :server
 
       def inherited subclass
+
+        # set app_file from caller stack
+        #
         subclass.app_file = caller(1).map {|l| l.split(/:(?=|in )/, 3)[0,1]}.flatten[0]
 
-        def subclass.root
-          @root ||= File.expand_path '..', app_file
-        end
+        # bring RequestError into this namespace
+        #
+        subclass.class_eval 'class RequestError < Angelo::RequestError; end'
 
-        def subclass.view_dir
-          v = self.class_variable_get(:@@views) rescue DEFAULT_VIEW_DIR
-          File.join root, v
-        end
+        class << subclass
+
+          def root
+            @root ||= File.expand_path '..', app_file
+          end
+
+          def view_dir
+            v = self.class_variable_get(:@@views) rescue DEFAULT_VIEW_DIR
+            File.join root, v
+          end
+
+          def public_dir
+            p = self.class_variable_get(:@@public_dir) rescue DEFAULT_PUBLIC_DIR
+            File.join root, p
+          end
 
-        def subclass.public_dir
-          p = self.class_variable_get(:@@public_dir) rescue DEFAULT_PUBLIC_DIR
-          File.join root, p
         end
 
       end

data/lib/angelo/minitest/helpers.rb

@@ -29,9 +29,7 @@ module Angelo
 
       def hc
         @hc ||= HTTPClient.new
-        @hc
       end
-      private :hc
 
       def hc_req method, path, params = {}, headers = {}
         url = HTTP_URL % [DEFAULT_ADDR, DEFAULT_PORT]
@@ -39,8 +37,30 @@ module Angelo
       end
       private :hc_req
 
+      def http_req method, path, params = {}, headers = {}
+        url = HTTP_URL % [DEFAULT_ADDR, DEFAULT_PORT] + path
+        params = case params
+                 when String; {body: params}
+                 when Hash
+                   case method
+                   when :get, :delete, :options
+                     {params: params}
+                   else
+                     {form: params}
+                   end
+                 end
+        @last_response = case
+                         when !headers.empty?
+                           ::HTTP.with(headers).__send__ method, url, params
+                         else
+                           ::HTTP.__send__ method, url, params
+                         end
+      end
+      private :http_req
+
       [:get, :post, :put, :delete, :options, :head].each do |m|
         define_method m do |path, params = {}, headers = {}|
+          # http_req m, path, params, headers
           hc_req m, path, params, headers
         end
       end
@@ -63,13 +83,13 @@ module Angelo
 
       def last_response_must_be_html body = ''
         last_response.status.must_equal 200
-        last_response.body.must_equal body
+        last_response.body.to_s.must_equal body
         last_response.headers['Content-Type'].split(';').must_include HTML_TYPE
       end
 
       def last_response_must_be_json obj = {}
         last_response.status.must_equal 200
-        JSON.parse(last_response.body).must_equal obj
+        JSON.parse(last_response.body.to_s).must_equal obj
         last_response.headers['Content-Type'].split(';').must_include JSON_TYPE
       end
 

data/lib/angelo/responder.rb

@@ -49,7 +49,6 @@ module Angelo
       @redirect = nil
       @request = request
       handle_request
-      respond
     end
 
     def handle_request
@@ -57,6 +56,7 @@ module Angelo
         @base.before if @base.respond_to? :before
         @body = @response_handler.bind(@base).call || ''
         @base.after if @base.respond_to? :after
+        respond
       else
         raise NotImplementedError
       end
@@ -64,6 +64,8 @@ module Angelo
       handle_error jpe, :bad_request, false
     rescue FormEncodingError => fee
       handle_error fee, :bad_request, false
+    rescue RequestError => re
+      handle_error re, re.type, false
     rescue => e
       handle_error e
     end
@@ -84,7 +86,12 @@ module Angelo
       when respond_with?(:json)
         { error: _error.message }.to_json
       else
-        _error.message
+        case _error.message
+        when Hash
+          _error.message.to_s
+        else
+          _error.message
+        end
       end
     end
 

data/lib/angelo/version.rb

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

data/lib/angelo.rb

@@ -73,6 +73,31 @@ module Angelo
 
   end
 
+  class RequestError < Reel::RequestError
+
+    attr_accessor :type
+    alias_method :code=, :type=
+
+    def initialize msg = nil, type = nil
+      case msg
+      when Hash
+        @msg_hash = msg
+      else
+        super(msg)
+      end
+      self.type = type if type
+    end
+
+    def type
+      @type ||= :bad_request
+    end
+
+    def message
+      @msg_hash || super
+    end
+
+  end
+
 end
 
 require 'angelo/version'

data/test/angelo/error_spec.rb

@@ -0,0 +1,110 @@
+require_relative '../spec_helper'
+
+describe Angelo::Base do
+
+  describe :handle_error do
+
+    define_app do
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/' do
+
+          # this specificity (self.class::) is uneeded in actual practice
+          # something about the anonymous class nature of self at this point
+          # see Angelo::Minittest::Helpers#define_app
+          #
+          raise self.class::RequestError.new 'error message'
+        end
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/json' do
+          content_type :json
+          raise self.class::RequestError.new 'error message' # see above
+        end
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/msg_hash' do
+          raise self.class::RequestError.new msg: 'error', foo: 'bar' # see above
+        end
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/msg_hash_json' do
+          content_type :json
+          raise self.class::RequestError.new msg: 'error', foo: 'bar' # see above
+        end
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/not_found' do
+          raise self.class::RequestError.new 'not found', 404 # see above
+        end
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/enhance_your_calm' do
+          raise self.class::RequestError.new 'enhance your calm, bro', 420 # see above
+        end
+      end
+
+    end
+
+    it 'handles raised errors correctly' 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'
+      end
+    end
+
+    it 'handles raised errors with json content type correctly' do
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/json'
+        last_response.status.must_equal 400
+        last_response.headers['Content-Type'].split(';').must_include Angelo::JSON_TYPE
+        last_response.body.to_s.must_equal({error: 'error message'}.to_json)
+      end
+    end
+
+    it 'handles raised errors with hash messages correctly' do
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/msg_hash'
+        last_response.status.must_equal 400
+        last_response.headers['Content-Type'].split(';').must_include Angelo::HTML_TYPE
+        last_response.body.to_s.must_equal '{:msg=>"error", :foo=>"bar"}'
+      end
+    end
+
+    it 'handles raised errors with hash messages with json content type correctly' do
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/msg_hash_json'
+        last_response.status.must_equal 400
+        last_response.headers['Content-Type'].split(';').must_include Angelo::JSON_TYPE
+        last_response.body.to_s.must_equal({error: {msg: 'error', foo: 'bar'}}.to_json)
+      end
+    end
+
+    it 'handles raising errors with other status codes correctly' do
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/not_found'
+        last_response.status.must_equal 404
+        last_response.headers['Content-Type'].split(';').must_include Angelo::HTML_TYPE
+        last_response.body.to_s.must_equal 'not found'
+      end
+
+      Angelo::HTTPABLE.each do |m|
+        __send__ m, '/enhance_your_calm'
+        last_response.status.must_equal 420
+        last_response.headers['Content-Type'].split(';').must_include Angelo::HTML_TYPE
+        last_response.body.to_s.must_equal 'enhance your calm, bro'
+      end
+
+    end
+
+  end
+
+end

data/test/angelo/mustermann_spec.rb

@@ -1,4 +1,4 @@
-if RUBY_VERSION =~ /^2\./
+if RUBY_VERSION =~ /^2\./ and RUBY_PLATFORM != 'java'
 
   require_relative '../spec_helper'
   require 'angelo/mustermann'

data/test/angelo/static_spec.rb

@@ -27,8 +27,8 @@ describe Angelo::Server do
       last_response.headers['Content-Disposition'].must_equal 'attachment; filename=test.css'
       last_response.headers['Content-Length'].must_equal '116'
       last_response.headers['Etag'].must_equal css_etag
-      last_response.body.length.must_equal 116
-      last_response.body.must_equal File.read(File.join TEST_APP_ROOT, 'public', 'test.css')
+      last_response.body.to_s.length.must_equal 116
+      last_response.body.to_s.must_equal File.read(File.join TEST_APP_ROOT, 'public', 'test.css')
     end
 
     it 'serves headers for static files on head' do
@@ -38,7 +38,7 @@ describe Angelo::Server do
       last_response.headers['Content-Disposition'].must_equal 'attachment; filename=test.css'
       last_response.headers['Content-Length'].must_equal '116'
       last_response.headers['Etag'].must_equal css_etag
-      last_response.body.length.must_equal 0
+      last_response.body.to_s.length.must_equal 0
     end
 
     it 'serves static file over route' do
@@ -46,7 +46,7 @@ describe Angelo::Server do
       last_response.status.must_equal 200
       last_response.headers['Content-Type'].must_equal 'text/html'
       last_response.headers['Content-Disposition'].must_equal 'attachment; filename=test.html'
-      last_response.body.must_equal File.read(File.join TEST_APP_ROOT, 'public', 'test.html')
+      last_response.body.to_s.must_equal File.read(File.join TEST_APP_ROOT, 'public', 'test.html')
     end
 
     it 'not modifieds when if-none-match matched etag' do

data/test/angelo/websocket_spec.rb

@@ -3,7 +3,7 @@ require_relative '../spec_helper'
 describe Angelo::WebsocketResponder do
 
   def websocket_wait_for path, latch, expectation, key = :swf, &block
-    Reactor.testers[key] = Array.new(CONCURRENCY).map do
+    Reactor.testers[key] = Array.new CONCURRENCY do
       wsh = websocket_helper path
       wsh.on_message = ->(e) {
         expectation[e] if Proc === expectation

data/test/angelo_spec.rb

@@ -114,6 +114,7 @@ describe Angelo::Base do
     it 'runs after filters after routes' do
       a = %w[2 6 14 30]
       b = [4, 12, 28, 60]
+
       Angelo::HTTPABLE.each_with_index do |m,i|
         __send__ m, '/after', obj
         last_response_must_be_html a[i]

data/test/test_app_root/public/test.js

@@ -1 +1 @@
-setTimeout(function(){ alert('hi'); }, 3000);
+// setTimeout(function(){ alert('hi'); }, 3000);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: angelo
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reel
@@ -65,6 +65,7 @@ files:
 - lib/angelo/tilt/erb.rb
 - lib/angelo/version.rb
 - test/angelo/erb_spec.rb
+- test/angelo/error_spec.rb
 - test/angelo/mustermann_spec.rb
 - test/angelo/params_spec.rb
 - test/angelo/static_spec.rb