ld-celluloid-eventsource 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 436ffbb975c4f324a9f3589984e6bc9344884319
-  data.tar.gz: 4396b0535c22dadff98bc1760642318157630451
+  metadata.gz: 8be57755b8e9109f162424b0bfc717494646820b
+  data.tar.gz: 4e99b0dfcca684ffc8b7f5404834c76dbf2bbc60
 SHA512:
-  metadata.gz: 22c0dc786d05848a98ec0633c9c866a0d1375c33314c6b55664fac478e88f1c49bf8de53d5611f8ec17a0477b4f60aa2216b98b8085859ca0b48be547b5855d2
-  data.tar.gz: b1de7d025ded3b794ad2a866dce4362b82b631708b0ddfa06c27ea48950973fdb02ab7fc4d64f2928cda4941f8e800a56ede50f54963c315893b6a63d073c372
+  metadata.gz: 7ba0c333067e2bcb0eda60c5df2d73bf75112bbc80f776f09cc33febd7700d977c034552c3fafad7daa4f7fb35b8277d8ffaf3f4f5238dc7b5644d6fc5d093dc
+  data.tar.gz: 3066e8834456d81e6f3a8191d922331e313f18f21522b9a0bfc39560eeb372734b1f518aa13a641edacf0d3ace029649139cf55f611ddd3b11fecc06067ad7b3

data/ld-celluloid-eventsource.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'celluloid/eventsource/version'
+require 'ld_celluloid_eventsource/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "ld-celluloid-eventsource"
@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'celluloid-io', '~> 0.17.3'
   spec.add_dependency 'http_parser.rb', '~> 0.6.0'
+  spec.add_dependency 'concurrent-ruby', '~> 1.0.4'
+  spec.add_dependency 'retries', '~> 0.0.5'
 
-  spec.add_development_dependency 'atomic', '~> 1.1'
   spec.add_development_dependency "rspec", '~> 3.0'
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", '~> 10.1'

data/lib/{celluloid → ld_celluloid_eventsource}/eventsource.rb

@@ -2,19 +2,26 @@ require 'celluloid/current'
 require "celluloid/eventsource/version"
 require 'celluloid/io'
 require 'celluloid/eventsource/response_parser'
+require 'concurrent'
+require 'logger'
+require 'retries'
 require 'uri'
 
 module Celluloid
   class EventSource
     include Celluloid::IO
 
-    attr_reader :url, :with_credentials
+    attr_reader :url, :with_credentials, :heartbeat_timeout, :logger
     attr_reader :ready_state
 
     CONNECTING = 0
     OPEN = 1
     CLOSED = 2
 
+    # 2^31 since our retries library doesn't allow for unlimited retries.
+    # At an average of 1 second per retry, we'll still be retrying in 68 years.
+    MAX_RETRIES = 2147483648
+
     execute_block_on_receiver :initialize
 
     def initialize(uri, options = {})
@@ -22,6 +29,9 @@ module Celluloid
       options  = options.dup
       @ready_state = CONNECTING
       @with_credentials = options.delete(:with_credentials) { false }
+      @heartbeat_timeout = options.delete(:heartbeat_timeout) { 300 }
+      @logger = options.delete(:logger) { default_logger }
+      @logger.info("[EventSource] Starting client connecting to url: #{self.url} with heartbeat timeout: #{@heartbeat_timeout} seconds")
       @headers = default_request_headers.merge(options.fetch(:headers, {}))
 
       @event_type_buffer = ""
@@ -31,7 +41,7 @@ module Celluloid
       @last_event_id = String.new
 
       @reconnect_timeout = 1
-      @on = { open: ->{}, message: ->(_) {}, error: ->(_) {} }
+      @on = { open: ->{}, message: ->(_) {}}
       @parser = ResponseParser.new
 
       @chunked = false
@@ -58,14 +68,25 @@ module Celluloid
         begin
           establish_connection
           chunked? ? process_chunked_stream : process_stream
-        rescue
-          # Just reconnect
+        rescue Exception => e
+          logger.debug("[EventSource] Reconnecting after exception: #{e}")
         end
-        sleep @reconnect_timeout        
+        sleep @reconnect_timeout
       end
     end
 
+    def listen_for_heartbeats
+      @logger.debug("[EventSource] Starting listening for heartbeats. Reconnecting after #{@heartbeat_timeout} seconds if no comments are received")
+      @heartbeat_task.cancel if @heartbeat_task
+      @heartbeat_task = Concurrent::ScheduledTask.new(@heartbeat_timeout){
+        @logger.warn("[EventSource] Didn't get heartbeat after #{@heartbeat_timeout} seconds. Reconnecting.")
+        @socket.close if @socket
+      }.execute
+    end
+
     def close
+      @logger.info("[EventSource] Closing client")
+      @heartbeat_task.cancel if @heartbeat_task
       @socket.close if @socket
       @ready_state = CLOSED
     end
@@ -82,10 +103,6 @@ module Celluloid
       @on[:message] = action
     end
 
-    def on_error(&action)
-      @on[:error] = action
-    end
-
     private
 
     MessageEvent = Struct.new(:type, :data, :last_event_id)
@@ -95,31 +112,38 @@ module Celluloid
     end
 
     def establish_connection
-      @socket = Celluloid::IO::TCPSocket.new(@url.host, @url.port)
-
-      if ssl?
-        @socket = Celluloid::IO::SSLSocket.new(@socket)
-        @socket.connect
+      handler = Proc.new do |exception, attempt_number, total_delay|
+        logger.warn("[EventSource] Could not connect with exception: #{exception.class} #{exception.message}; retry attempt #{attempt_number}; #{total_delay} seconds have passed.")
       end
 
-      @socket.write(request_string)
+      with_retries(:max_tries => MAX_RETRIES,
+                   :base_sleep_seconds => 1.0,
+                   :max_sleep_seconds => 30.0,
+                   :handler => handler,
+                   :rescue => Exception) do
+        if !closed?
+          @logger.info("[EventSource] Connecting to url: #{@url}")
+          @socket = Celluloid::IO::TCPSocket.new(@url.host, @url.port)
 
-      until @parser.headers?
-        @parser << @socket.readline
-      end
+          if ssl?
+            @socket = Celluloid::IO::SSLSocket.new(@socket)
+            @socket.connect
+          end
+
+          @socket.write(request_string)
+
+          until @parser.headers?
+            @parser << @socket.readline
+          end
 
-      if @parser.status_code != 200
-        until @socket.eof?
-          @parser << @socket.readline
+          if @parser.status_code != 200
+            @socket.close if @socket
+            raise "[EventSource] Could not connect to stream. Got status code: #{@parser.status_code}"
+          end
+
+          handle_headers(@parser.headers)
         end
-        # If the server returns a non-200, we don't want to close-- we just want to
-        # report an error
-        # close
-        @on[:error].call({status_code: @parser.status_code, body: @parser.chunk})
-        return
       end
-
-      handle_headers(@parser.headers)
     end
 
     def default_request_headers
@@ -176,14 +200,16 @@ module Celluloid
 
     def parse_line(line)
       case line
-      when /^:.*$/
-      when /^(\w+): ?(.*)$/
-        process_field($1, $2)
-      else
-        if chunked? && !@data_buffer.empty?
-          @data_buffer.rstrip!
-          process_field("data", line.rstrip)
-        end
+        when /^: ?(.*)$/
+          @logger.debug("[EventSource] Got comment: #{$1}")
+          listen_for_heartbeats
+        when /^(\w+): ?(.*)$/
+          process_field($1, $2)
+        else
+          if chunked? && !@data_buffer.empty?
+            @data_buffer.rstrip!
+            process_field("data", line.rstrip)
+          end
       end
     end
 
@@ -196,6 +222,7 @@ module Celluloid
       event = MessageEvent.new(:message, @data_buffer, @last_event_id)
       event.type = @event_type_buffer.to_sym unless @event_type_buffer.empty?
 
+      @logger.debug("[EventSource] Dispatching event: #{event}")
       dispatch_event(event)
     ensure
       clear_buffers!
@@ -221,9 +248,11 @@ module Celluloid
         @chunked = !headers["Transfer-Encoding"].nil? && headers["Transfer-Encoding"].include?("chunked")
         @ready_state = OPEN
         @on[:open].call
+        @logger.info("[EventSource] Connected ok!")
+        listen_for_heartbeats
       else
-        close
-        @on[:error].call({status_code: @parser.status_code, body: "Invalid Content-Type #{headers['Content-Type']}. Expected text/event-stream"})
+        @socket.close if @socket
+        raise "Got invalid Content-Type header: #{headers['Content-Type']}. Expected text/event-stream"
       end
     end
 
@@ -233,6 +262,16 @@ module Celluloid
       ["GET #{url.request_uri} HTTP/1.1", headers].flatten.join("\r\n").concat("\r\n\r\n")
     end
 
+    def default_logger
+      if defined?(Rails) && Rails.respond_to?(:logger)
+        Rails.logger
+      else
+        log = ::Logger.new($stdout)
+        log.level = ::Logger::INFO
+        log
+      end
+    end
+
   end
 
 end

data/lib/{celluloid/eventsource → ld_celluloid_eventsource}/version.rb

@@ -1,5 +1,5 @@
 module Celluloid
   class EventSource
-    VERSION = "0.5.0"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: ld-celluloid-eventsource
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Leo Correa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.17.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.17.3
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: atomic
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: retries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Celluloid::IO based library to consume Server-Sent Events. This library
@@ -116,17 +130,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - ld-celluloid-eventsource.gemspec
-- lib/celluloid/eventsource.rb
-- lib/celluloid/eventsource/response_parser.rb
-- lib/celluloid/eventsource/version.rb
+- lib/ld_celluloid_eventsource/eventsource.rb
+- lib/ld_celluloid_eventsource/response_parser.rb
+- lib/ld_celluloid_eventsource/version.rb
 - log/.gitignore
 - spec/celluloid/eventsource/response_parser_spec.rb
 - spec/celluloid/eventsource_spec.rb
@@ -143,17 +157,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ld-celluloid-eventsource is a gem to consume SSE streaming API.