em-eventsource 0.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,90 @@
+# EventSource client for EventMachine
+
+This is currently a work in progress.
+
+See the specification: http://dev.w3.org/html5/eventsource/
+
+## Install
+
+Install with Rubygems:
+
+    gem install em-eventsource
+
+If you use bundler, add it to your Gemfile:
+
+    gem "em-ucengine", "~>0.1.2"
+
+## Usage
+
+Basic usage:
+
+    require "em-eventsource"
+    EM.run do
+      source = EventMachine::EventSource.new("http://example.com/streaming")
+      source.message do |message|
+        puts "new message #{message}"
+      end
+      source.start # Start listening
+    end
+
+Listening specific event name:
+
+    source.on "eventname" do |message|
+      puts "eventname #{message}"
+    end
+
+Handle error:
+
+    source.error do |error|
+      puts "error #{error}"
+    end
+
+Handle open stream:
+
+    source.open do
+      puts "opened"
+    end
+
+Close the stream:
+
+    source.close
+
+Current status of the connection:
+
+    source.ready_state # Can be EM::EventSource::CLOSED, EM::EventSource::CONNECTING, EM::EventSource::OPEN
+
+Override the default retry value (if the connection is lost):
+
+    source.retry = 5 # in seconds
+
+Get Last-Event-Id value:
+
+    source.last_event_id
+
+Attach middleware:
+
+    source.use EM::Middleware::JSONResponse
+
+## Licence
+
+MIT License
+
+Copyright (C) 2011 by af83
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/em-eventsource.rb

@@ -0,0 +1,163 @@
+# encoding: utf-8
+
+require "eventmachine"
+require "em-http-request"
+
+module EventMachine
+  # EventSource
+  # dev.w3.org/html5/eventsource/
+  class EventSource
+    # Get API url
+    attr_reader :url
+    # Get ready state
+    attr_reader :ready_state
+    # Get current retry value (in seconds)
+    attr_reader :retry
+    # Override retry value (in seconds)
+    attr_writer :retry
+    # Get value of last event id
+    attr_reader :last_event_id
+    # Ready state
+    # The connection has not yet been established, or it was closed and the user agent is reconnecting.
+    CONNECTING = 0
+    # The user agent has an open connection and is dispatching events as it receives them.
+    OPEN       = 1
+    # The connection is not open, and the user agent is not trying to reconnect. Either there was a fatal error or the close() method was invoked.
+    CLOSED     = 2
+    # Create a new stream
+    #
+    # @param [String] url
+    # @param [Hash] query
+    # @param [Hash] headers
+    def initialize(url, query={}, headers={})
+      @url = url
+      @query = query
+      @headers = headers
+      @ready_state = CLOSED
+
+      @last_event_id = nil
+      @retry = 3 # seconds
+
+      @opens = []
+      @errors = []
+      @messages = []
+      @on = {}
+      @middlewares = []
+    end
+
+    # Add open event handler
+    def open(&block)
+      @opens << block
+    end
+
+    # Add a specific event handler
+    #
+    # @param [String] name of event
+    def on(name, &block)
+      @on[name] ||= []
+      @on[name] << block
+    end
+
+    # Add message event handler
+    def message(&block)
+      @messages << block
+    end
+
+    # Add error event handler
+    def error(&block)
+      @errors << block
+    end
+
+    # Add a middleware
+    def use(*args, &block)
+      @middlewares << (args << block)
+    end
+
+    # Start subscription
+    def start
+      @ready_state = CONNECTING
+      listen
+    end
+
+    # Cancel subscription
+    def close
+      @ready_state = CLOSED
+      @req.close
+    end
+
+    protected
+
+    def listen
+      @req = prepare_request
+      @req.errback do
+        next if @ready_state == CLOSED
+        @ready_state = CONNECTING
+        @errors.each { |error| error.call("Connection lost. Reconnecting.") }
+        EM.add_timer(@retry) do
+          listen
+        end
+      end
+      @req.headers do |headers|
+        if headers.status != 200
+          close
+          @errors.each { |error| error.call("Unexpected response status #{headers.status}") }
+          next
+        end
+        if /^text\/event-stream/.match headers['CONTENT_TYPE']
+          @ready_state = OPEN
+          @opens.each { |open| open.call }
+        else
+          close
+          @errors.each { |error| error.call("The content-type '#{headers['CONTENT_TYPE']}' is not text/event-stream") }
+        end
+      end
+      buffer = ""
+      @req.stream do |chunk|
+        buffer += chunk
+        # TODO: manage \r, \r\n, \n
+        while index = buffer.index("\n\n")
+          stream = buffer.slice!(0..index)
+          handle_stream(stream)
+        end
+      end
+    end
+
+    def handle_stream(stream)
+      event = []
+      name = nil
+      stream.split("\n").each do |part|
+        /^data:(.+)$/.match(part) do |m|
+          event << m[1].strip
+        end
+        /^id:(.+)$/.match(part) do |m|
+          @last_event_id = m[1].strip
+        end
+        /^event:(.+)$/.match(part) do |m|
+          name = m[1].strip
+        end
+        /^retry:(.+)$/.match(part) do |m|
+          if m[1].strip! =~ /^[0-9]+$/
+            @retry = m[1].to_i
+          end
+        end
+      end
+      if name.nil?
+        @messages.each { |message| message.call(event.join("\n")) }
+      else
+        @on[name].each { |message| message.call(event.join("\n")) } if not @on[name].nil?
+      end
+    end
+
+    def prepare_request
+      conn = EM::HttpRequest.new(@url)
+      @middlewares.each { |middleware|
+        block = middleware.pop
+        conn.use *middleware, &block
+      }
+      headers = @headers.merge({'Cache-Control' => 'no-cache'})
+      headers.merge!({'Last-Event-Id' => @last_event_id }) if not @last_event_id.nil?
+      conn.get({ :query => @query,
+                 :head  => headers})
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: em-eventsource
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- François de Metz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &11648200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta3
+  type: :runtime
+  prerelease: false
+  version_requirements: *11648200
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &11647720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta4
+  type: :runtime
+  prerelease: false
+  version_requirements: *11647720
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &11647260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *11647260
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &11646880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11646880
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &11646420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11646420
+description: ! "     em-eventsource is an eventmachine library to consume Server-Sent
+  Events streaming API.\n     You can find the specification here: http://dev.w3.org/html5/eventsource/\n"
+email: francois.de.metz@af83.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- Gemfile
+- lib/em-eventsource.rb
+homepage: http://github.com/af83/em-eventsource
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: em-eventsource is an eventmachine library to consume Server-Sent Events streaming
+  API.
+test_files: []