turntabler 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # master
 
+## 0.2.1 / 2013-02-16
+
+* Fix exceptions on initial connection not causing reconnection process to kick in
+* Fix exceptions in reconnects causing the reconnect process to halt retrying
+* Fix reconnects not occurring when socket is closed without a killdashnine event from Turntable
+* Fix exceptions in keepalive timer causing the EM reactor to be shut down
+
 ## 0.2.0 / 2013-02-16
 
 * Respect the keepalive update interval from API responses

data/examples/Gemfile.lock

@@ -17,7 +17,7 @@ GEM
     faye-websocket (0.4.6)
       eventmachine (>= 0.12.0)
     http_parser.rb (0.5.3)
-    turntabler (0.2.0)
+    turntabler (0.2.1)
       em-http-request
       em-synchrony
       faye-websocket

data/lib/turntabler/authorized_user.rb

@@ -77,9 +77,10 @@ module Turntabler
     # @raise [Turntabler::Error] if the command fails
     def login
       response = EventMachine::HttpRequest.new('https://turntable.fm/api/user.email_login').get(:query => {:email => email, :password => password, :client => client.id}).response
-      data = JSON.parse(response)
-      raise(Error, data[1]['err']) unless data[0]
-      self.attributes = data[1]
+      success, data = response.empty? ? [nil, {}] : JSON.parse(response)
+      raise(ConnectionError, data['err']) unless success
+
+      self.attributes = data
       true
     end
 

data/lib/turntabler/client.rb

@@ -71,14 +71,17 @@ module Turntabler
       # Setup default event handlers
       on(:heartbeat) { on_heartbeat }
       on(:session_missing) { on_session_missing }
+      on(:session_ended) { on_session_ended }
 
       # Connect to an initial room / server
-      if room_name = options[:room]
-        room(room_name).enter
-      elsif url = options[:url]
-        connect(url)
-      else
-        connect
+      reconnect_from(ConnectionError, APIError) do
+        if room_name = options[:room]
+          room(room_name).enter
+        elsif url = options[:url]
+          connect(url)
+        else
+          connect
+        end
       end
 
       instance_eval(&block) if block_given?
@@ -88,7 +91,7 @@ module Turntabler
     # this will also attempt to authenticate the user.
     # 
     # @api private
-    # @note This wil only open a new connection if the client isn't already connected to the given url
+    # @note This will only open a new connection if the client isn't already connected to the given url
     # @param [String] url The url to open a connection to
     # @return [true]
     # @raise [Turntabler::Error] if the connection cannot be opened
@@ -116,15 +119,20 @@ module Turntabler
     # @return [true]
     def close(allow_reconnect = false)
       if @connection
+        # Disable reconnects if specified
+        reconnect = @reconnect
+        @reconnect = reconnect && allow_reconnect
+
+        # Clean up timers / connections
         @keepalive_timer.cancel if @keepalive_timer
         @keepalive_timer = nil
         @connection.close
 
+        # Revert change to reconnect config once the final signal is received
         wait do |&resume|
           on(:session_ended, :once => true) { resume.call }
         end
-
-        on_session_ended(allow_reconnect)
+        @reconnect = reconnect
       end
       
       true
@@ -146,7 +154,7 @@ module Turntabler
     # @return [Hash] The data returned from the Turntable service
     # @raise [Turntabler::Error] if the connection is not open or the command fails to execute
     def api(command, params = {})
-      raise(Turntabler::Error, 'Connection is not open') unless @connection && @connection.connected?
+      raise(ConnectionError, 'Connection is not open') unless @connection && @connection.connected?
       
       message_id = @connection.publish(params.merge(:api => command))
 
@@ -159,7 +167,7 @@ module Turntabler
         data
       else
         error = data['error'] || data['err']
-        raise Error, "Command \"#{command}\" failed with message: \"#{error}\""
+        raise APIError, "Command \"#{command}\" failed with message: \"#{error}\""
       end
     end
 
@@ -420,7 +428,7 @@ module Turntabler
       assert_valid_keys(options, :artist, :duration, :page)
       options = {:page => 1}.merge(options)
 
-      raise(Turntabler::Error, 'User must be in a room to search for songs') unless room
+      raise(APIError, 'User must be in a room to search for songs') unless room
 
       if artist = options[:artist]
         query = "title: #{query}"
@@ -436,7 +444,7 @@ module Turntabler
         on(:search_failed, :once => true, :if => {'query' => query}) { resume.call }
       end
 
-      songs || raise(Error, 'Search failed to complete')
+      songs || raise(APIError, 'Search failed to complete')
     end
 
     # Triggers callback handlers for the given Turntable command.  This should
@@ -495,7 +503,9 @@ module Turntabler
 
         # Periodically update the user's status to remain available
         @keepalive_timer.cancel if @keepalive_timer
-        @keepalive_timer = EM::Synchrony.add_periodic_timer(interval) { user.update(:status => user.status) }
+        @keepalive_timer = EM::Synchrony.add_periodic_timer(interval) do
+          Turntabler.run { user.update(:status => user.status) }
+        end
       end
     end
     
@@ -518,20 +528,38 @@ module Turntabler
     
     # Callback when the session has ended.  This will automatically reconnect if
     # allowed to do so.
-    def on_session_ended(allow_reconnect)
+    def on_session_ended
       url = @connection.url
       room = @room
       @connection = nil
       @room = nil
 
       # Automatically reconnect to the room / server if allowed
-      if @reconnect && allow_reconnect
-        EM::Synchrony.add_timer(@reconnect_wait) do
+      if @reconnect
+        reconnect_from(Exception) do
           room ? room.enter : connect(url)
           trigger(:reconnected)
         end
       end
     end
+    
+    # Runs a given block and retries that block after a certain period of time
+    # if any of the specified exceptions are raised.  Note that there is no
+    # limit on the number of attempts to retry.
+    def reconnect_from(*exceptions)
+      begin
+        yield
+      rescue *exceptions => ex
+        if @reconnect
+          logger.debug "Connection failed: #{ex.message}"
+          EM::Synchrony.sleep(@reconnect_wait)
+          logger.debug 'Attempting to reconnect'
+          retry
+        else
+          raise
+        end
+      end
+    end
 
     # Pauses the current fiber until it is resumed with response data.  This
     # can only get resumed explicitly by the provided block.

data/lib/turntabler/error.rb

@@ -1,5 +1,13 @@
 module Turntabler
-  # Represents an error that occurred while interacting with the Turntable API
+  # Represents an error within the library
   class Error < StandardError
   end
+  
+  # Represents an error that occurred while connecting to the Turntable API
+  class ConnectionError < Error
+  end
+  
+  # Represents an error that occurred while interacting with the Turntable API
+  class APIError < Error
+  end
 end

data/lib/turntabler/resource.rb

@@ -1,6 +1,7 @@
 require 'pp'
 require 'turntabler/assertions'
 require 'turntabler/digest_helpers'
+require 'turntabler/error'
 
 module Turntabler
   # Represents an object that's been created using content from Turntable. This
@@ -185,7 +186,7 @@ module Turntabler
 
     # Gets the current room the user is in
     def room
-      client.room || raise(Turntabler::Error, 'User is not currently in a room')
+      client.room || raise(APIError, 'User is not currently in a room')
     end
     
     # Determines whether the user is currently in a room

data/lib/turntabler/room.rb

@@ -128,7 +128,10 @@ module Turntabler
     def host
       begin
         response = EventMachine::HttpRequest.new("http://turntable.fm/api/room.which_chatserver?roomid=#{id}").get.response
-        self.attributes = JSON.parse(response)[1]
+        success, data = response.empty? ? [nil, {}] : JSON.parse(response)
+        raise(ConnectionError, data['err']) unless success
+
+        self.attributes = data
       end unless @host
       @host
     end

data/lib/turntabler/song.rb

@@ -1,4 +1,3 @@
-require 'turntabler/error'
 require 'turntabler/resource'
 require 'turntabler/user'
 require 'turntabler/vote'
@@ -232,7 +231,7 @@ module Turntabler
     # Asserts that this is the song currently being played in the room the user
     # is in.  Raises Turntabler::Error if this is not the case.
     def assert_current_song
-      raise(Turntabler::Error, "Song \"#{id}\" is not currently playing") unless room.current_song == self
+      raise(APIError, "Song \"#{id}\" is not currently playing") unless room.current_song == self
     end
     
     # Gets the index of this song within the given playlist.  Raises Turntabler::Error
@@ -240,7 +239,7 @@ module Turntabler
     def index(playlist_id)
       playlist = client.user.playlist(playlist_id)
       index = playlist.songs.index(self)
-      raise(Turntabler::Error, "Song \"#{id}\" is not in playlist \"#{playlist.id}\"") unless index
+      raise(APIError, "Song \"#{id}\" is not in playlist \"#{playlist.id}\"") unless index
       return playlist, index
     end
   end

data/lib/turntabler/version.rb

@@ -3,7 +3,7 @@ module Turntabler
   module Version
     MAJOR = 0
     MINOR = 2
-    PATCH = 0
+    PATCH = 1
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: turntabler
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-16 00:00:00 Z
+date: 2013-02-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: em-synchrony