twitter-stream 0.1.15 → 0.1.16

data/README.markdown

@@ -32,6 +32,11 @@ JSON format only.
       stream.on_max_reconnects do |timeout, retries|
         # Something is wrong on your side. Send yourself an email.
       end
+
+      stream.on_no_data do
+        # Twitter has stopped sending any data on the currently active
+        # connection, reconnecting is probably in order
+      end
     }
 
 

data/lib/twitter/json_stream.rb

@@ -20,6 +20,8 @@ module Twitter
     RECONNECT_MAX   = 320
     RETRIES_MAX     = 10
 
+    NO_DATA_TIMEOUT = 90
+
     DEFAULT_OPTIONS = {
       :method         => 'GET',
       :path           => '/',
@@ -44,6 +46,7 @@ module Twitter
     attr_accessor :nf_last_reconnect
     attr_accessor :af_last_reconnect
     attr_accessor :reconnect_retries
+    attr_accessor :last_data_received_at
     attr_accessor :proxy
 
     def self.connect options = {}
@@ -72,6 +75,7 @@ module Twitter
       @immediate_reconnect = false
       @on_inited_callback = options.delete(:on_inited)
       @proxy = URI.parse(options[:proxy]) if options[:proxy]
+      @last_data_received_at = nil
     end
 
     def each_item &block
@@ -86,6 +90,12 @@ module Twitter
       @reconnect_callback = block
     end
 
+    # Called when no data has been received for NO_DATA_TIMEOUT seconds.
+    # Reconnecting is probably in order as per the Twitter recommendations
+    def on_no_data &block
+      @no_data_callback = block
+    end
+
     def on_max_reconnects &block
       @max_reconnects_callback = block
     end
@@ -111,12 +121,13 @@ module Twitter
       end
       schedule_reconnect if @options[:auto_reconnect] && !@gracefully_closed
       @close_callback.call if @close_callback
-
+      @state = :init
     end
 
     # Receives raw data from the HTTP connection and pushes it into the
     # HTTP parser which then drives subsequent callbacks.
     def receive_data(data)
+      @last_data_received_at = Time.now
       @parser << data
     end
 
@@ -128,9 +139,20 @@ module Twitter
     def post_init
       reset_state
       @on_inited_callback.call if @on_inited_callback
+      @reconnect_timer = EventMachine.add_periodic_timer(5) do
+        if @gracefully_closed
+          @reconnect_timer.cancel
+        elsif @last_data_received_at && Time.now - @last_data_received_at > NO_DATA_TIMEOUT
+          no_data
+        end
+      end
     end
 
   protected
+    def no_data
+      @no_data_callback.call if @no_data_callback
+    end
+
     def schedule_reconnect
       timeout = reconnect_timeout
       @reconnect_retries += 1
@@ -208,7 +230,7 @@ module Twitter
           parse_stream_line(line)
         end
         @stream  = ''
-      rescue Exception => e
+      rescue => e
         receive_error("#{e.class}: " + [e.message, e.backtrace].flatten.join("\n\t"))
         close_connection
         return

data/spec/twitter/json_stream_spec.rb

@@ -134,6 +134,23 @@ describe JSONStream do
       end
     end
 
+    it "should swallow StandardError exceptions when delivering items" do
+      expect do
+        connect_stream :ssl => false do
+          stream.each_item { |item| raise StandardError, 'error message' }
+        end
+      end.to_not raise_error
+    end
+
+
+    it "propagates out runtime errors when delivering items" do
+      expect do
+        connect_stream :ssl => false do
+          stream.each_item { |item| raise Exception, 'error message' }
+        end
+      end.to raise_error(Exception, 'error message')
+    end
+
     it "should send correct user agent" do
       connect_stream
     end
@@ -213,6 +230,22 @@ describe JSONStream do
     it_should_behave_like "network failure"
   end
 
+  context "on no data received" do
+    attr_reader :stream
+    before :each do
+      $data_to_send = ''
+      $close_connection = false
+    end
+
+    it "should call no data callback after no data received for 90 seconds" do
+      connect_stream :stop_in => 6 do
+        stream.last_data_received_at = Time.now - 88
+        stream.should_receive(:no_data).once
+      end
+    end
+
+  end
+
   context "on server unavailable" do
 
     attr_reader :stream

data/twitter-stream.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twitter-stream}
-  s.version = "0.1.15"
+  s.version = "0.1.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Vladimir Kolesnikov"]

metadata

@@ -1,74 +1,93 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: twitter-stream
-version: !ruby/object:Gem::Version
-  version: 0.1.15
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 16
+  version: 0.1.16
 platform: ruby
-authors:
+authors: 
 - Vladimir Kolesnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-04-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: eventmachine
-  requirement: &70312242841020 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 8
         version: 0.12.8
   type: :runtime
-  prerelease: false
-  version_requirements: *70312242841020
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: simple_oauth
-  requirement: &70312242839900 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 4
         version: 0.1.4
   type: :runtime
-  prerelease: false
-  version_requirements: *70312242839900
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: http_parser.rb
-  requirement: &70312242838600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 1
         version: 0.5.1
   type: :runtime
-  prerelease: false
-  version_requirements: *70312242838600
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &70312242837520 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
         version: 2.5.0
   type: :development
-  prerelease: false
-  version_requirements: *70312242837520
-description: Simple Ruby client library for twitter streaming API. Uses EventMachine
-  for connection handling. Adheres to twitter's reconnection guidline. JSON format
-  only.
+  version_requirements: *id004
+description: Simple Ruby client library for twitter streaming API. Uses EventMachine for connection handling. Adheres to twitter's reconnection guidline. JSON format only.
 email: voloko@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.markdown
 - LICENSE
-files:
+files: 
 - .gemtest
 - .gitignore
 - .rspec
 - Gemfile
+- LICENSE
 - README.markdown
 - Rakefile
 - VERSION
@@ -78,32 +97,38 @@ files:
 - spec/spec_helper.rb
 - spec/twitter/json_stream_spec.rb
 - twitter-stream.gemspec
-- LICENSE
+has_rdoc: true
 homepage: http://github.com/voloko/twitter-stream
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --charset=UTF-8
-require_paths:
+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
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Twitter realtime API client
-test_files:
+test_files: 
 - spec/spec_helper.rb
 - spec/twitter/json_stream_spec.rb