angelo 0.1.24 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8706df3687ca6b50dce03271b1b67a0920304bb5
-  data.tar.gz: 1602e019534f5e051a238fc925691c65d7ad0676
+  metadata.gz: 71b7b6db8f9dc6f54045817b05e45895e9a30158
+  data.tar.gz: 0f7c1f1b602476811076b98df9829f15476819f1
 SHA512:
-  metadata.gz: 13c04846c759e13e2bc13801b3e73c65e84c5669c58080403710de7727965b9ba61472d57cffcf45e5b42e3aaaafa0ed1a7431d2971a3996620047ef05574e0a
-  data.tar.gz: bec89a7501d6b2726ad865b3e93834a9dae956a466114fe5736bca1bbb88534e415d7da726684fdebe68b0941cda603e7a4676fb3d9f97218477812275fcbf68
+  metadata.gz: 96b4ed9df8cff7a12a62bbd9e5fcbd7b9ffc912587d094f85beb0dbdf1c59c1e7f0501d8dfdab4f66a960845570731c6582739ce23689a5075d595ceb2db88ea
+  data.tar.gz: 3ebb1e69058a7733e05a5f7f990514a3ebdd001382f20129e7e3862404abc242617fc8cc1d6ee8f0111fc5ecb1f92a8c808c9c1d5af3d0b98e628e8f2927458f

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 changelog
 =========
 
+### 0.2.0 23 sep 2014
+
+* chunked responses with `transfer_encoding :chunked` and `return_obj.each`
+* chunked responses with `chunked_response(){|r| ... }`
+* `event` and `message` helpers on sse objects
+
 ### 0.1.24 19 sep 2014
 
 thanks: @chewi

data/README.md

@@ -26,16 +26,21 @@ Celluloid::IO and gives you a reactor with evented IO in Ruby!**
 Note: There currently is no "standalone" capability where one can define route handlers at the top level.
 
 Things will feel very familiar to anyone experienced with Sinatra. Inside the subclass, you can define
-route handlers denoted by HTTP verb and path. Unlike Sinatra, the only acceptable return value from a
-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.
+route handlers denoted by HTTP verb and path. One acceptable return value from a route block is the body
+of the response in full as a `String`. Another is a `Hash` if the content type is set to `:json`. Finally,
+you may return any object that responds to `#each(&block)` if the transfer encoding is set to `:chunked`.
+There is also a `chunked_response` helper that will take a block, set the transfer encoding, and return
+an appropriate object for you.
 
 There is also [Mustermann](#mustermann) support for full-on, Sinatra-like path
 matching and params.
 
+Angelo also features `before` and `after` blocks, just like Sinatra. Filters are ordered as defined,
+and called in that order. When defined without a path, they run for all matched requests. With a path,
+the path must match exactly for the block to be called. If `Angelo::Mustermann` is included, the paths
+are interpreted as a Mustermann pattern and params are merged. For more info on the difference in how
+after blocks are handled, see the Errors section below for more info.
+
 ### Websockets!
 
 One of the main motivations for Angelo was the ability to define websocket handlers with ease. Through
@@ -48,7 +53,7 @@ The `websocket` route builder accepts a path and a block, and passes the actual
 as the only argument. This socket is an instance of Reel's
 [WebSocket](https://github.com/celluloid/reel/blob/master/lib/reel/websocket.rb) class, and, as such,
 responds to methods like `on_message` and `on_close`. A service-wide `on_pong` handler (defined at the
-class-level of the Angelo app) is available to customize the behavior when a pong frame comes back from
+
 a connected websocket client.
 
 ##### `websockets` helper
@@ -130,14 +135,23 @@ sse.addEventListener('foo', function(e){ console.log("got foo event!\n" + JSON.p
 The `sse_event` helper accepts a normal `String` for the data, but will automatically convert a `Hash`
 argument to a JSON object.
 
+NOTE: there is a shortcut helper on the actual SSE object itself:
+
+```ruby
+eventsource '/sse' do |sse|
+  sse.event :foo, some_key: 'blah', other_key: 'boo'
+  sse.event :close
+end
+```
+
 ##### `sse_message` helper
 
 The `sse_message` helper behaves exactly the same as `sse_event`, but does not take an event name:
 
 ```ruby
 eventsource '/sse' do |s|
-  msg = sse_msg some_key: 'blah', other_key: 'boo'
-  s.write msg 
+  msg = sse_message some_key: 'blah', other_key: 'boo'
+  s.write msg
   s.close
 end
 ```
@@ -149,6 +163,15 @@ var sse = new EventSource('/sse');
 sse.onmessage = function(e){ console.log("got message!\n" + JSON.parse(e.data)); };
 ```
 
+NOTE: there is a shortcut helper on the actual SSE object itself:
+
+```ruby
+eventsource '/sse' do |sse|
+  sse.message some_key: 'blah', other_key: 'boo'
+  sse.event :close
+end
+```
+
 ##### `sses` helper
 
 Angelo also includes a "stash" helper for SSE connections. One can `<<` a socket into `sses` from
@@ -355,6 +378,67 @@ Content-Length: 18
 everything's fine
 ```
 
+### [Tilt](https://github.com/rtomayko/tilt) / ERB
+
+To make `erb` available in route blocks
+
+1. add `tilt` to your `Gemfile`: `gem 'tilt'`
+2. require `angelo/tilt/erb`
+3. include `Angelo::Tilt::ERB` in your app
+
+```ruby
+class Foo < Angelo::Base
+  include Angelo::Tilt::ERB
+
+  @@views = 'some/other/path' # defaults to './views'
+
+  get '/' do
+    erb :index
+  end
+
+end
+```
+
+### [Mustermann](https://github.com/rkh/mustermann)
+
+To make routes blocks match path with Mustermann patterns
+
+1. be using ruby &gt;=2.0.0
+2. add 'mustermann' to to your `Gemfile`: `platform(:ruby_20){ gem 'mustermann' }`
+3. require `angelo/mustermann`
+4. include `Angelo::Mustermann` in your app
+
+```ruby
+class Foo < Angelo::Base
+  include Angelo::Tilt::ERB
+  include Angelo::Mustermann
+
+  get '/:foo/things/:bar' do
+
+    # `params` is merged with the Mustermann object#params hash, so
+    # a "GET /some/things/are_good?foo=other&bar=are_bad" would have:
+    #   params: {
+    #     'foo' => 'some',
+    #     'bar' => 'are_good'
+    #   }
+
+    @foo = params[:foo]
+    @bar = params[:bar]
+    erb :index
+  end
+
+  before '/:fu/things/*' do
+
+    # `params` is merged with the Mustermann object#params hash, as
+    # parsed with the current request path against this before block's
+    # pattern. in the route handler, `params[:fu]` is no longer available.
+
+    @fu = params[:fu]
+  end
+
+end
+```
+
 ### WORK LEFT TO DO
 
 Lots of work left to do!
@@ -466,61 +550,26 @@ class Foo < Angelo::Base
     msg
   end
 
-end
-
-Foo.run
-```
-
-### [Tilt](https://github.com/rtomayko/tilt) / ERB
-
-To make `erb` available in route blocks
-
-1. add `tilt` to your `Gemfile`: `gem 'tilt'`
-2. require `angelo/tilt/erb`
-3. include `Angelo::Tilt::ERB` in your app
-
-```ruby
-class Foo < Angelo::Base
-  include Angelo::Tilt::ERB
-
-  @@views = 'some/other/path' # defaults to './views'
+  # return a chunked response of JSON for 5 seconds
+  #
+  get '/chunky_json' do
+    content_type :json
 
-  get '/' do
-    erb :index
+    # this helper requires a block that takes one arg, the response 
+    # proc to call with each chunk (i.e. the block that is passed to
+    # `#each`)
+    #
+    chunked_response do |response|
+      5.times do
+        response.call time: Time.now.to_i
+        sleep 1
+      end
+    end
   end
 
 end
-```
 
-### [Mustermann](https://github.com/rkh/mustermann)
-
-To make routes blocks match path with Mustermann patterns
-
-1. be using ruby &gt;=2.0.0
-2. add 'mustermann' to to your `Gemfile`: `platform(:ruby_20){ gem 'mustermann' }`
-3. require `angelo/mustermann`
-4. include `Angelo::Mustermann` in your app
-
-```ruby
-class Foo < Angelo::Base
-  include Angelo::Tilt::ERB
-  include Angelo::Mustermann
-
-  get '/:foo/things/:bar' do
-
-    # `params` is merged with the Mustermann object#params hash, so
-    # a "GET /some/things/are_good?foo=other&bar=are_bad" would have:
-    #   params: {
-    #     'foo' => 'some',
-    #     'bar' => 'are_good'
-    #   }
-
-    @foo = params[:foo]
-    @bar = params[:bar]
-    erb :index
-  end
-
-end
+Foo.run
 ```
 
 ### Contributing

data/lib/angelo.rb

@@ -55,6 +55,7 @@ module Angelo
   UNDERSCORE = '_'
   DASH = '-'
   EMPTY_STRING = ''
+  NEWLINE = "\n"
 
   HALT_STRUCT = Struct.new :status, :body
 

data/lib/angelo/base.rb

@@ -5,7 +5,7 @@ module Angelo
     include Celluloid::Logger
 
     extend Forwardable
-    def_delegators :@responder, :content_type, :headers, :redirect, :request
+    def_delegators :@responder, :content_type, :headers, :redirect, :request, :transfer_encoding
     def_delegators :@klass, :websockets, :sses, :sse_event, :sse_message
 
     @@addr = DEFAULT_ADDR
@@ -287,7 +287,7 @@ module Angelo
 
     def eventsource &block
       headers SSE_HEADER
-      async :handle_event_source, responder.connection.detach.socket, block
+      async :handle_event_source, EventSource.new(responder.connection.detach.socket), block
       halt 200, :sse
     end
 
@@ -305,6 +305,43 @@ module Angelo
       fs.each {|f| f.bind(self).call}
     end
 
+    def chunked_response &block
+      transfer_encoding :chunked
+      ChunkedResponse.new &block
+    end
+
+    class EventSource
+      extend Forwardable
+
+      def_delegators :@socket, :close, :closed?, :<<, :write
+      attr_reader :socket
+
+      def initialize socket
+        @socket = socket
+      end
+
+      def event name, data = nil
+        @socket.write Base.sse_event(name, data)
+      end
+
+      def message data
+        @socket.write Base.sse_message(data)
+      end
+
+    end
+
+    class ChunkedResponse
+
+      def initialize &block
+        @chunker = block
+      end
+
+      def each &block
+        @chunker[block]
+      end
+
+    end
+
   end
 
 end

data/lib/angelo/minitest/helpers.rb

@@ -38,7 +38,11 @@ module Angelo
       end
 
       def hc_req method, path, params = {}, headers = {}
-        @last_response = hc.__send__ method, url(path), params, headers
+        @last_response = if block_given?
+                           hc.__send__ method, url(path), params, headers, &Proc.new
+                         else
+                           hc.__send__ method, url(path), params, headers
+                         end
       end
       private :hc_req
 
@@ -64,8 +68,14 @@ module Angelo
 
       [: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
+
+          if block_given?
+            hc_req m, path, params, headers, &Proc.new
+          else
+            hc_req m, path, params, headers
+          end
         end
       end
 

data/lib/angelo/responder.rb

@@ -117,6 +117,19 @@ module Angelo
       end
     end
 
+    def transfer_encoding *encodings
+      encodings.flatten.each do |encoding|
+        case encoding
+        when :chunked
+          @chunked = true
+          headers transfer_encoding: :chunked
+        # when :compress, :deflate, :gzip, :identity
+        else
+          raise ArgumentError.new "invalid transfer_conding: #{encoding}"
+        end
+      end
+    end
+
     def respond_with? type
       case headers[CONTENT_TYPE_HEADER_KEY]
       when JSON_TYPE
@@ -147,14 +160,37 @@ module Angelo
 
       when NilClass
         @body = EMPTY_STRING
+
+      else
+        unless @chunked and @body.respond_to? :each
+          raise RequestError.new "what is this? #{@body}"
+        end
       end
 
       status ||= @redirect.nil? ? :ok : :moved_permanently
       headers LOCATION_HEADER_KEY => @redirect if @redirect
-      size = @body.nil? ? 0 : @body.size
 
-      Angelo.log @connection, @request, nil, status, size
-      @request.respond status, headers, @body
+      if @chunked
+        Angelo.log @connection, @request, nil, status
+        @request.respond status, headers
+        err = nil
+        begin
+          @body.each do |r|
+            r = r.to_json + NEWLINE if respond_with? :json
+            @request << r
+          end
+        rescue => e
+          err = e
+        ensure
+          @request.finish_response
+          raise err if err
+        end
+      else
+        size = @body.nil? ? 0 : @body.size
+        Angelo.log @connection, @request, nil, status, size
+        @request.respond status, headers, @body
+      end
+
     rescue => e
       handle_error e, :internal_server_error
     end

data/lib/angelo/responder/eventsource.rb

@@ -32,6 +32,7 @@ module Angelo
         rescue IOError => ioe
           warn "#{ioe.class} - #{ioe.message}"
         rescue RequestError => re
+          headers SSE_HEADER
           handle_error re, re.type
         rescue => e
           handle_error e

data/lib/angelo/version.rb

@@ -1,3 +1,3 @@
 module Angelo
-  VERSION = '0.1.24'
+  VERSION = '0.2.0'
 end

data/test/angelo/eventsource_spec.rb

@@ -9,17 +9,17 @@ describe Angelo::Responder::Eventsource do
       define_app do
 
         eventsource '/msg' do |c|
-          c.write sse_message 'hi'
+          c.message 'hi'
           c.close
         end
 
         eventsource '/event' do |c|
-          c.write sse_event :sse, 'bye'
+          c.event :sse, 'bye'
           c.close
         end
 
         eventsource '/headers', foo: 'bar' do |c|
-          c.write sse_event :sse, 'headers'
+          c.event :sse, 'headers'
           c.close
         end
 
@@ -59,12 +59,12 @@ describe Angelo::Responder::Eventsource do
         end
 
         eventsource '/msg' do |c|
-          c.write sse_message 'hi'
+          c.message 'hi'
           c.close
         end
 
         eventsource '/other' do |c|
-          c.write sse_message 'other'
+          c.message 'other'
           c.close
         end
 

data/test/angelo_spec.rb

@@ -379,4 +379,60 @@ describe Angelo::Base do
 
   end
 
+  describe 'chunked responses' do
+
+    define_app do
+
+      get '/chunk' do
+        chunked_response do |r|
+          5.times {|n| r[n + "\n"]}
+        end
+      end
+
+      get '/chunk.json' do
+        content_type :json
+        chunked_response do |r|
+          5.times {|n| r[{n: n}]}
+        end
+      end
+
+      get '/chunk_each' do
+        transfer_encoding :chunked
+        Object.new.tap do |o|
+          def o.each; 5.times {|n| yield n + "\n"}; end
+        end
+      end
+
+    end
+
+    it 'chunks responses with helper' do
+      i = 0
+      get '/chunk' do |c|
+        c.must_equal i.to_s
+        i += 1
+      end
+      last_response_must_be_html
+    end
+
+    it 'chunks responses with helper in json' do
+      i = 0
+      get '/chunk.json' do |c|
+        JSON.parse(c)['n'].must_equal i
+        i += 1
+      end
+      last_response.status.must_equal 200
+      last_response.headers['Content-Type'].split(';').must_include Angelo::JSON_TYPE
+    end
+
+    it 'chunks responses with any object that responds_to? :each' do
+      i = 0
+      get '/chunk_each' do |c|
+        c.must_equal i.to_s
+        i += 1
+      end
+      last_response_must_be_html
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: angelo
 version: !ruby/object:Gem::Version
-  version: 0.1.24
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reel