angelo 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb21b9dcec8959a4845e5e6063ae0051b71589c4
-  data.tar.gz: 88e2ca4bd79df106deaa35c7509d22b237e5918a
+  metadata.gz: b034c03ba6c0b50e1d31e5ee1c0bd043b70d8d2e
+  data.tar.gz: b4e9ba5af2b009a7fa292f97d6a8b2a3831ec709
 SHA512:
-  metadata.gz: a468e2ad3a12a7b3a7fab94816d13141f25675651d456651470c287b1773ef9e766b3a3eba7e45cb6310159caeef32b222026cc2853bded2c7b78ce6d6ccd4ad
-  data.tar.gz: f844a3b8410c35392490058ee699202b7a29f4b9df923635ec8500485789832db69f470db62f39e4001842cde0581b178207ab9d4bd80bff6ca5175bf85c3014
+  metadata.gz: 64b482cc286556b98b03f211134bed314d2c3b3564640aca4b9d2882d4b31d157760d7ef476d7fcb257d3065152f38c4573a24226d3de19f1309136c9a3f8730
+  data.tar.gz: 000d06333538e664c71d40e6f0371d6d946c586efe2f1cb3dd42c08d510cb459faa772cacef57c3135315609f85387c70bc147cd0a26f16e8cb0eb8c62e1c632

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 changelog
 =========
 
+### 0.1.4 26 mar 2014
+
+* add Base.async, Base.on_pong, and Base#async
+* fix websockets context handling, removal
+* add ping task to reactor
+
 ### 0.1.3 24 mar 2014
 
 * better testing of websockets

data/README.md

@@ -9,7 +9,8 @@ A [Sinatra](https://github.com/sinatra/sinatra)-esque DSL for [Reel](https://git
 
 * "easy" websocket support via `socket '/path' do |s|` route handler
 * "easy" websocket stashing via `websockets` helper
-* no rack/rack-style params
+* "easy" event handling via `async` helpers
+* no rack
 * optional tilt/erb support
 * optional mustermann support
 
@@ -24,6 +25,9 @@ class Foo < Angelo::Base
 
   TEST = {foo: "bar", baz: 123, bat: false}.to_json
 
+  HEART = '<3'
+  @@hearting = false
+
   def pong; 'pong'; end
   def foo; params[:foo]; end
 
@@ -46,7 +50,7 @@ class Foo < Angelo::Base
 
   socket '/ws' do |ws|
     websockets[:emit_test] << ws
-    while msg = ws.read
+    ws.on_message do |msg|
       5.times { ws.write TEST }
       ws.write foo.to_json
     end
@@ -60,6 +64,24 @@ class Foo < Angelo::Base
     websockets[:other] << ws
   end
 
+  socket '/hearts' do |ws|
+
+    # this is a call to Base#async, actually calling 
+    # the reactor to start the task
+    # 
+    async :hearts unless @@hearting
+
+    websockets[:hearts] << ws
+  end
+
+  # this is a call to Base.async, defining the task
+  # to perform on the reactor
+  #
+  async :hearts do
+    @@hearting = true
+    every(10){ websockets[:hearts].each {|ws| ws.write HEART } }
+  end
+
 end
 
 Foo.run

data/lib/angelo.rb

@@ -44,6 +44,8 @@ module Angelo
 
   LOG_FORMAT = '%s - - "%s %s%s HTTP/%s" %d %s'
 
+  DEFAULT_PING_TIME = 30
+
   def self.log connection, request, socket, status, body_size = '-'
 
     remote_ip = ->{

data/lib/angelo/base.rb

@@ -10,7 +10,9 @@ module Angelo
     @@addr = DEFAULT_ADDR
     @@port = DEFAULT_PORT
 
-    if ARGV.any?
+    @@ping_time = DEFAULT_PING_TIME
+
+    if ARGV.any? and not Kernel.const_defined?('RSpec')
       require 'optparse'
       OptionParser.new { |op|
         op.on('-p port',   'set the port (default is 4567)')      { |val| @@port = Integer(val) }
@@ -22,7 +24,7 @@ module Angelo
 
     class << self
 
-      attr_accessor :app_file
+      attr_accessor :app_file, :server
 
       def inherited subclass
         subclass.app_file = caller(1).map {|l| l.split(/:(?=|in )/, 3)[0,1]}.flatten[0]
@@ -76,8 +78,16 @@ module Angelo
         routes[:socket][path] = WebsocketResponder.new &block
       end
 
+      def on_pong &block
+        WebsocketResponder.on_pong = block
+      end
+
+      def async name, &block
+        Angelo::Server.define_action name, &block
+      end
+
       def websockets
-        @websockets ||= WebsocketsArray.new
+        @websockets ||= WebsocketsArray.new server
         @websockets.reject! &:closed?
         @websockets
       end
@@ -88,6 +98,7 @@ module Angelo
 
       def run addr = @@addr, port = @@port
         @server = Angelo::Server.new self, addr, port
+        @server.async.ping_websockets
         trap "INT" do
           @server.terminate if @server and @server.alive?
           exit
@@ -97,6 +108,10 @@ module Angelo
 
     end
 
+    def async meth, *args
+      self.class.server.async.__send__ meth, *args
+    end
+
     def params
       @params ||= case request.method
                   when GET;  parse_query_string
@@ -107,22 +122,67 @@ module Angelo
 
     def websockets; self.class.websockets; end
 
+    async :handle_websocket do |ws|
+      begin
+        while !ws.closed? do
+          ws.read
+        end
+      rescue IOError
+        websockets.remove_socket ws
+      end
+    end
+
+    async :ping_websockets do
+      every(@@ping_time) do
+        websockets.each do |ws|
+          ws.socket << ::WebSocket::Message.ping.to_data
+        end
+      end
+    end
+
     class WebsocketsArray < Array
+      include Celluloid::Logger
+
+      @@peeraddrs = {}
+      @@socket_context = {}
+
+      def initialize server, context = nil
+        @context, @server = context, server
+        super()
+      end
+
+      def << ws
+        @@socket_context[ws] = @context if @context
+        @@peeraddrs[ws] = ws.peeraddr
+        @server.async.handle_websocket ws
+        super ws
+      end
 
       def each &block
         super do |ws|
           begin
             yield ws
-          rescue Reel::SocketError => rse
-            warn "#{rse.class} - #{rse.message}"
-            delete ws
+          rescue Reel::SocketError
+            remove_socket ws
           end
         end
       end
 
+      def remove_socket ws
+        if c = @@socket_context[ws]
+          warn "removing socket from context ':#{c}' (#{@@peeraddrs[ws][2]})"
+          self[c].delete ws
+        else
+          warn "removing socket (#{@@peeraddrs[ws][2]})"
+          delete ws
+        end
+        @@peeraddrs.delete ws
+      end
+
       def [] context
+        raise ArgumentError.new "symbol required" unless Symbol === context
         @@websockets ||= {}
-        @@websockets[context] ||= self.class.new
+        @@websockets[context] ||= self.class.new @server, context
       end
 
     end

data/lib/angelo/responder/websocket.rb

@@ -2,6 +2,16 @@ module Angelo
 
   class WebsocketResponder < Responder
 
+    class << self
+
+      attr_writer :on_pong
+
+      def on_pong
+        @on_pong ||= ->(e){}
+      end
+
+    end
+
     def params
       @params ||= parse_query_string
       @params
@@ -19,6 +29,7 @@ module Angelo
         if @response_handler
           Angelo.log @connection, @request, @websocket, :switching_protocols
           @bound_response_handler ||= @response_handler.bind @base
+          @websocket.on_pong &WebsocketResponder.on_pong
           @bound_response_handler[@websocket]
         else
           raise NotImplementedError

data/lib/angelo/rspec/helpers.rb

@@ -6,7 +6,6 @@ module Angelo
     module Helpers
 
       HTTP_URL = 'http://%s:%d'
-      WS_URL = 'ws://%s:%d'
 
       attr_reader :last_response
 
@@ -17,6 +16,7 @@ module Angelo
           app.class_eval { content_type :html } # reset
           app.class_eval &block
           @server = Angelo::Server.new app
+          app.server = @server
           $reactor = Reactor.new unless $reactor.alive?
         end
 
@@ -82,6 +82,8 @@ module Angelo
       def_delegator :@socket, :write
       def_delegators :@driver, :binary, :close, :text
 
+      WS_URL = 'ws://%s:%d'
+
       attr_reader :driver, :socket
       attr_writer :addr, :port, :path, :on_close, :on_message, :on_open
 

data/lib/angelo/server.rb

@@ -4,8 +4,11 @@ require 'mime-types'
 module Angelo
 
   class Server < Reel::Server
+    extend Forwardable
     include Celluloid::Logger
 
+    def_delegator :@base, :websockets
+
     def initialize base, host = '127.0.0.1', port = 4567
       @base = base
       info "Angelo #{VERSION}"
@@ -22,6 +25,14 @@ module Angelo
       # RubyProf.pause
     end
 
+    def self.define_action name, &action
+      define_method name, &action
+    end
+
+    def self.remove_action name
+      remove_method name
+    end
+
     private
 
     def dispatch! meth, connection, request

data/lib/angelo/version.rb

@@ -1,3 +1,3 @@
 module Angelo
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: angelo
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reel
@@ -113,3 +113,4 @@ test_files:
 - spec/test_app_root/public/what.png
 - spec/test_app_root/views/index.html.erb
 - spec/test_app_root/views/layout.html.erb
+has_rdoc: