servent 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afcf04d7de0fbed51a568743c7dad4af879042d5
-  data.tar.gz: 95b1d000e7171f9df857952d6e4698b6073aca09
+  metadata.gz: 52b302c6ed718cbeaf7717c15db7028f171d12a5
+  data.tar.gz: 5dd81fbbcbd73b0e72b02c6e666feae00f6c3f09
 SHA512:
-  metadata.gz: ca999d77e3c6f6236091167bee4e8f815c05af640ff16a990eee5d237187f31f33207811d72bae5b26c68e38e70d63b734fb3bf6386cd68a916e4e756cf90e2a
-  data.tar.gz: 1d0b871339cb5f9f281de6522a5bf699f7f2489d33b2feb968c94db512de8b3ca43c45b08326c1c0f079921da7f63a6dfd2f821abe9831ad95e27c8cc09e8f36
+  metadata.gz: 0dfae2233984931fd793d1229a3a5cd39a3d41f58b81721822f6f3a4b8f49a8e3a8b29284639b0bca29cbfc2394cd82a7ae00b1cebb303345fe33ab10b584b01
+  data.tar.gz: 44d2e1e155d868e4e1af43db8b143fbd8e8ba7d6a585768e5597e32531a987318c0c8044f706a73148b84c9969175b2c2ab0988f3231362795d7a7a1d993d54b

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project
+will be documented in this file.
+
+The format is based
+on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project
+adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## [0.1.0] - 2017-11-20
+### Added
+- Consumer for a server-sent events endpoint.
+- First fully functional example.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    servent (0.0.1)
+    servent (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # Servent
 
-[<img src="https://travis-ci.com/mistersourcerer/servent.svg?token=aMwiRm3UQ11zdWwMxGgZ&branch=master" />](https://travis-ci.com/mistersourcerer/servent)
+[<img src="https://travis-ci.org/mistersourcerer/servent.svg?branch=master" />](https://travis-ci.org/mistersourcerer/servent)
 
 Ruby _Server-Sent Events_ client.
 A _EventSource_ Ruby implementation based on the [W3C specification](https://www.w3.org/TR/eventsource).
@@ -29,17 +29,10 @@ gem 'servent'
 #   id: 42
 #   data: Omg! Hello World.
 
-events = Queue.new
-
 event_source = Servent::EventSource.new("http://example.org/event-source")
 event_source.on_message do |message|
-  events.push message
-end
-event_source.start
-
-while (event = events.pop)
   puts "Event type: #{event.type}"
-  puts "Event body: #{event.body}"
+  puts "Event body: #{event.data}"
 
   # Will print:
   #
@@ -49,8 +42,64 @@ while (event = events.pop)
   #   ```
   # And wait for the next event to arrive.
 end
+
+# join the internal event source thread
+# so we can receive event until it terminates:
+event_source.listen
 ```
 
+## More examples
+
+There is directory `examples` in this project
+with a _WEBrick_ server
+and also a `EventSource` consumer.
+
+### How to run the example
+
+#### TL;DR
+
+    # on one terminal:
+    $ rackup
+
+    # on a second one:
+    $ ruby consumer.rb
+
+    # on yeat another one
+    $ curl http://localhost:9292/broadcast
+
+    # and to make the consumer close itself:
+    $ curl http://localhost:9292/enough
+
+#### More detailed version
+
+if you are inside the directory
+(or copied the files in the example dir to your own)
+you can run a _rackup_:
+
+    $ rackup
+
+The server will run on port _9292_
+and it has 3 endpoints:
+
+    /
+    /broadcast
+    /enough
+
+The root (`/`) is intended to consumers
+and the one in the example
+starts listening to that endpoint like this:
+
+```ruby
+event_source = Servent::EventSource.new("http://localhost:9292/")
+# ...
+event_source.listen
+```
+
+If you want to test multiple messages arriving
+you can use the `repeat` parameters in the request:
+
+    $ curl http://localhost/broadcast?repeat=3
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/{hypotesis/emitter.ru → examples/config.ru}

@@ -8,15 +8,12 @@ class SSEEvent
   end
 
   def event
-    %(event: #{@type}
-id: #{@id}
-data: {
-data: "id": "#{@id}",
-data: "type": "#{@type}",
-data: "text": "#{@text}"
-data: }
-
-)
+    <<~EVENT
+      event: #{@type}
+      id: #{@id}
+      data: #{@text}
+
+    EVENT
   end
 end
 
@@ -33,20 +30,20 @@ server.mount_proc "/" do |_, res|
   res.chunked = true
 end
 
-server.mount_proc "/omg" do |_, res|
-  r, w = IO.pipe
-  clients << w
+server.mount_proc "/broadcast" do |req, _|
+  repeat = req.query["repeat"].to_i
+  repeat = 1 if repeat <= 0 || repeat.nil?
 
-  res.content_type = "text/event-stream"
-  res.body = r
-  res.chunked = true
+  clients.each do |client|
+    repeat.times do |counter|
+      client << SSEEvent.new("streaming #{counter}!").event
+    end
+  end
 end
 
-server.mount_proc "/broadcast" do |_, _|
+server.mount_proc "/enough" do |_, _|
   clients.each do |client|
-    Thread.new do
-      client << SSEEvent.new("streaming!").event
-    end
+    client << SSEEvent.new("close").event
   end
 end
 

data/examples/consumer.rb

@@ -0,0 +1,17 @@
+require "net/http"
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "servent"
+require "pp"
+
+event_source = Servent::EventSource.new("http://localhost:9292/")
+event_source.on_message do |event|
+  if event.data == "close"
+    puts "going to close this client"
+    return event_source.close
+  end
+
+  puts "received: "+ event.data
+end
+event_source.listen
+
+puts "bye"

data/lib/servent.rb

@@ -8,4 +8,13 @@ module Servent
   CONNECTING = 0
   OPEN       = 1
   CLOSED     = 2
+
+  REDIRECT_STATUSES      = [301, 302, 303, 307]
+  RECONNECTION_STATUSES  = [500, 502, 503, 504]
+  AUTHORIZATION_STATUSES = [305, 401, 407]
+
+  KNOWN_STATUSES = [200]  +
+    REDIRECT_STATUSES     +
+    RECONNECTION_STATUSES +
+    AUTHORIZATION_STATUSES
 end

data/lib/servent/event_source.rb

@@ -4,7 +4,9 @@ require "net/http"
 
 module Servent
   class EventSource
-    attr_reader :ready_state
+    DEFAULT_HEADERS = { "Accept" => "text/event-stream" }
+
+    attr_reader :ready_state, :uri
 
     def initialize(url, net_http_options: { read_timeout: 600 })
       @uri              = URI(url)
@@ -20,18 +22,29 @@ module Servent
     end
 
     def start(http_starter = Net::HTTP)
+      @http_starter ||= http_starter
       params = HTTPStartParams.new(@uri, @proxy_config, @net_http_options)
 
-      Thread.new {
-        http_starter.start(*params.parameterize) do |http|
+      @thread = Thread.new {
+        @http_starter.start(*params.parameterize) do |http|
           get = Net::HTTP::Get.new @uri
-          headers.each { |header, value| get[header] = value }
+          DEFAULT_HEADERS.each { |header, value| get[header] = value }
           yield http, get if block_given?
+
           perform_request http, get
         end
       }
     end
 
+    def listen(http_starter = Net::HTTP)
+      start(http_starter).join
+    end
+
+    def close
+      @ready_state = Servent::CLOSED
+      @thread.kill unless @thread.nil?
+    end
+
     def on_open(&open_block)
       @open_blocks << open_block
     end
@@ -46,30 +59,54 @@ module Servent
 
     private
 
-    def headers
-      { "Accept" => "text/event-stream" }
-    end
-
     def perform_request(http, type)
       http.request type do |response|
-        # FIXME: response CAN have more than one mime type
-        unless response["Content-Type"] == "text/event-stream"
-          @ready_state = Servent::CLOSED
-          @error_blocks.each { |block| block.call response, :wrong_mime_type }
-          return
-        end
+        return fail_connection response if should_fail? response
+        return schedule_reconnection if should_reconnect? response
+        store_new_parmanent_url response
 
-        handle_response response
+        open_connection response
       end
     end
 
-    def handle_response(response)
+    def open_connection(response)
       @ready_state = Servent::OPEN
       @open_blocks.each { |block| block.call response }
       response.read_body do |chunk|
-        @message_blocks.each { |block| block.call chunk }
+        # FIXME: use the same stream object to parse
+        #        different chunks.
+        stream = Stream.new chunk
+        events = stream.parse
+        events.each do |event|
+          @message_blocks.each { |block| block.call event }
+        end
       end
     end
+
+    def should_fail?(response)
+      return false if Servent::REDIRECT_STATUSES.include?(response.code.to_i)
+      (response["Content-Type"] != "text/event-stream") ||
+        !Servent::KNOWN_STATUSES.include?(response.code.to_i)
+    end
+
+    def fail_connection(response)
+      @ready_state = Servent::CLOSED
+      @error_blocks.each { |block| block.call response, :wrong_mime_type }
+    end
+
+    def should_reconnect?(response)
+      Servent::RECONNECTION_STATUSES.include? response.code.to_i
+    end
+
+    def schedule_reconnection
+      start
+    end
+
+    def store_new_parmanent_url(response)
+      return unless response.code.to_i == 301
+      @original_uri = @uri
+      @uri = URI(response["Location"])
+    end
   end
 
   class ProxyConfig

data/lib/servent/version.rb

@@ -1,3 +1,3 @@
 module Servent
-  VERSION = "0.0.1".freeze
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servent
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ricardo Valeriano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,6 +107,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -115,8 +116,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- hypotesis/consumer.rb
-- hypotesis/emitter.ru
+- examples/config.ru
+- examples/consumer.rb
 - lib/servent.rb
 - lib/servent/event.rb
 - lib/servent/event_source.rb

data/hypotesis/consumer.rb

@@ -1,38 +0,0 @@
-require "net/http"
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "servent"
-require "pp"
-
-#q = Queue.new
-#
-#trap :INT do
-#  q << nil
-#end
-
-#Thread.new do
-#  uri = URI("http://localhost:9292/omg")
-#
-#  Net::HTTP.start(uri.host, uri.port, read_timeout: 600) do |http|
-#    get = Net::HTTP::Get.new uri
-#    get["Accept"] = "text/event-stream"
-#    http.request(get) do |response|
-#      response.read_body do |chunk|
-#        q.push chunk
-#      end
-#    end
-#    q.push nil
-#  end
-#end
-
-event_source = Servent::EventSource.new("http://localhost:9292/omg")
-event_source.on_message do |message|
-  #q.push message
-  pp message
-end
-event_source.start.join
-
-#while (chunk = q.pop)
-#  puts chunk
-#end
-
-puts "bye"