blather 0.5.10 → 0.5.11

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.5.11
+  Feature(benlangfeld): Allow specifying a connection timeout
+    * Raise Blather::Stream::ConnectionTimeout if timeout is exceeded
+    * Default to 180 seconds
+
 v0.5.10
   Feature(juandebravo): Allow configuring the wire log level
   Bugfix(benlangfeld): Checking connection status before the stream is established

data/lib/blather/client/client.rb

@@ -45,8 +45,8 @@ module Blather
     # @param [Fixnum, String] port the port to connect to.
     #
     # @return [Blather::Client]
-    def self.setup(jid, password, host = nil, port = nil, certs = nil)
-      self.new.setup(jid, password, host, port, certs)
+    def self.setup(jid, password, host = nil, port = nil, certs = nil, connect_timeout = nil)
+      self.new.setup(jid, password, host, port, certs, connect_timeout)
     end
 
     def initialize  # @private
@@ -194,12 +194,13 @@ module Blather
     end
 
     # @private
-    def setup(jid, password, host = nil, port = nil, certs = nil)
+    def setup(jid, password, host = nil, port = nil, certs = nil, connect_timeout = nil)
       @jid = JID.new(jid)
       @setup = [@jid, password]
-      @setup << host if host
-      @setup << port if port
-      @setup << certs if certs
+      @setup << host
+      @setup << port
+      @setup << certs
+      @setup << connect_timeout
       self
     end
 

data/lib/blather/stream.rb

@@ -51,6 +51,7 @@ module Blather
     # Connection not found
     class NoConnection < RuntimeError; end
     class ConnectionFailed < RuntimeError; end
+    class ConnectionTimeout < RuntimeError; end
 
     # @private
     STREAM_NS = 'http://etherx.jabber.org/streams'
@@ -70,13 +71,15 @@ module Blather
     # default of 5222
     # @param [String, nil] certs the trusted cert store in pem format to verify 
     # communication with the server is trusted.
-    def self.start(client, jid, pass, host = nil, port = 5222, certs_directory = nil)
+    # @param [Fixnum, nil] connect_timeout the number of seconds for which to wait for a successful connection
+    def self.start(client, jid, pass, host = nil, port = nil, certs_directory = nil, connect_timeout = nil)
       jid = JID.new jid
+      port ||= 5222
       if certs_directory
         @@store = CertStore.new(certs_directory)
       end
       if host
-        connect host, port, self, client, jid, pass
+        connect host, port, self, client, jid, pass, connect_timeout
       else
         require 'resolv'
         srv = []
@@ -88,7 +91,7 @@ module Blather
         end
 
         if srv.empty?
-          connect jid.domain, port, self, client, jid, pass
+          connect jid.domain, port, self, client, jid, pass, connect_timeout
         else
           srv.sort! do |a,b|
             (a.priority != b.priority) ? (a.priority <=> b.priority) :
@@ -96,7 +99,7 @@ module Blather
           end
 
           srv.detect do |r|
-            not connect(r.target.to_s, r.port, self, client, jid, pass) === false
+            not connect(r.target.to_s, r.port, self, client, jid, pass, connect_timeout) === false
           end
         end
       end
@@ -106,8 +109,8 @@ module Blather
     # Stream will raise +NoConnection+ if it receives #unbind before #post_init
     # this catches that and returns false prompting for another attempt
     # @private
-    def self.connect(host, port, conn, client, jid, pass)
-      EM.connect host, port, conn, client, jid, pass
+    def self.connect(host, port, conn, client, jid, pass, connect_timeout = nil)
+      EM.connect host, port, conn, client, jid, pass, connect_timeout
     rescue NoConnection
       false
     end
@@ -129,7 +132,7 @@ module Blather
 
     # Called by EM.connect to initialize stream variables
     # @private
-    def initialize(client, jid, pass)
+    def initialize(client, jid, pass, connect_timeout = nil)
       super()
 
       @error = nil
@@ -138,12 +141,18 @@ module Blather
       self.jid = jid
       @to = self.jid.domain
       @password = pass
+      @connect_timeout = connect_timeout || 180
     end
 
     # Called when EM completes the connection to the server
     # this kicks off the starttls/authorize/bind process
     # @private
     def connection_completed
+      if @connect_timeout
+        EM::Timer.new @connect_timeout do
+          raise ConnectionTimeout, "Stream timed out after #{@connect_timeout} seconds." unless started?
+        end
+      end
       @connected = true
 #      @keepalive = EM::PeriodicTimer.new(60) { send_data ' ' }
       start

data/lib/blather/version.rb

@@ -1,4 +1,4 @@
 module Blather
   # Blather version number
-  VERSION = '0.5.10'
+  VERSION = '0.5.11'
 end

data/spec/blather/client/client_spec.rb

@@ -51,14 +51,14 @@ describe Blather::Client do
   it 'starts up a Component connection when setup without a node' do
     setup = 'pubsub.jabber.local', 'secret'
     @client.setup *setup
-    Blather::Stream::Component.expects(:start).with @client, *setup
+    Blather::Stream::Component.expects(:start).with @client, *setup + [nil, nil, nil, nil]
     @client.run
   end
 
   it 'starts up a Client connection when setup with a node' do
     setup = 'test@jabber.local', 'secret'
     @client.setup *setup
-    Blather::Stream::Client.expects(:start).with @client, *setup
+    Blather::Stream::Client.expects(:start).with @client, *setup + [nil, nil, nil, nil]
     @client.run
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blather
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-02 00:00:00.000000000 Z
+date: 2012-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2152201300 !ruby/object:Gem::Requirement
+  requirement: &2156508820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.12.6
   type: :runtime
   prerelease: false
-  version_requirements: *2152201300
+  version_requirements: *2156508820
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152228020 !ruby/object:Gem::Requirement
+  requirement: &2156506260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152228020
+  version_requirements: *2156506260
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2152227220 !ruby/object:Gem::Requirement
+  requirement: &2156518800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152227220
+  version_requirements: *2156518800
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152226520 !ruby/object:Gem::Requirement
+  requirement: &2156517580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2152226520
+  version_requirements: *2156517580
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2152225740 !ruby/object:Gem::Requirement
+  requirement: &2156515520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.7.1
   type: :development
   prerelease: false
-  version_requirements: *2152225740
+  version_requirements: *2156515520
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152224800 !ruby/object:Gem::Requirement
+  requirement: &2156514000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *2152224800
+  version_requirements: *2156514000
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2152224280 !ruby/object:Gem::Requirement
+  requirement: &2156526940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2152224280
+  version_requirements: *2156526940
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2152223400 !ruby/object:Gem::Requirement
+  requirement: &2156526080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.9.9
   type: :development
   prerelease: false
-  version_requirements: *2152223400
+  version_requirements: *2156526080
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152222880 !ruby/object:Gem::Requirement
+  requirement: &2156524880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *2152222880
+  version_requirements: *2156524880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152222460 !ruby/object:Gem::Requirement
+  requirement: &2156524380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152222460
+  version_requirements: *2156524380
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &2152221960 !ruby/object:Gem::Requirement
+  requirement: &2156523580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152221960
+  version_requirements: *2156523580
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &2152221420 !ruby/object:Gem::Requirement
+  requirement: &2156519740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152221420
+  version_requirements: *2156519740
 - !ruby/object:Gem::Dependency
   name: growl_notify
-  requirement: &2152220860 !ruby/object:Gem::Requirement
+  requirement: &2156535160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152220860
+  version_requirements: *2156535160
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &2152282580 !ruby/object:Gem::Requirement
+  requirement: &2156531800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152282580
+  version_requirements: *2156531800
 description: An XMPP DSL for Ruby written on top of EventMachine and Nokogiri
 email: sprsquish@gmail.com
 executables: []