turntabler 0.0.1 → 0.1.0

data/lib/turntabler/room.rb

@@ -3,8 +3,7 @@ require 'em-synchrony/em-http'
 require 'turntabler/resource'
 
 module Turntabler
-  # Represents an individual room in Turntable.  The room must be explicitly
-  # entered before being able to DJ.
+  # Represents an individual room in Turntable
   class Room < Resource
     # Allow the id to be set via the "roomid" attribute
     # @return [String]
@@ -55,8 +54,8 @@ module Turntabler
 
     # The host to connect to for joining this room
     # @return [String]
-    attribute :host, :chatserver do |value|
-      value[0]
+    attribute :host, :chatserver do |(host, *)|
+      host
     end
 
     # Whether this room is being featured by Turntable
@@ -86,7 +85,7 @@ module Turntabler
     attribute :moderators, :moderator_id do |ids|
       Set.new(ids.map {|id| build_user(:_id => id)})
     end
-    
+
     # The current user's friends who are also known to be in the room.  These
     # friends must be connected through a separate network like Facebook or Twitter.
     # 
@@ -127,10 +126,11 @@ module Turntabler
     # @return [String]
     # @raise [Turntabler::Error] if the host lookup fails
     def host
-      @host ||= begin
+      begin
         response = EventMachine::HttpRequest.new("http://turntable.fm/api/room.which_chatserver?roomid=#{id}").get.response
-        JSON.parse(response)[1]['chatserver'][0]
-      end
+        self.attributes = JSON.parse(response)[1]
+      end unless @host
+      @host
     end
 
     # Gets the configured chat url
@@ -147,6 +147,7 @@ module Turntabler
     # @param [Hash] options The configuration options
     # @option options [Boolean] :song_log (false) Whether to include the song log
     # @return [true]
+    # @raise [ArgumentError] if an invalid option is specified
     # @raise [Turntabler::Error] if the command fails
     # @example
     #   room.load                       # => true
@@ -168,11 +169,12 @@ module Turntabler
       end
     end
 
-    # Sets the current attributes for this room, ensures that the full list of
+    # Sets the current attributes for this room, ensuring that the full list of
     # listeners gets set first so that we can use those built users to then fill
     # out the collection of djs, moderators, etc.
     # 
     # @api private
+    # @param [Hash] attrs The attributes to set
     def attributes=(attrs)
       if attrs
         super('users' => attrs.delete('users')) if attrs['users']
@@ -189,6 +191,7 @@ module Turntabler
     # @param [Hash] attributes The attributes to update
     # @option attributes [String] :description
     # @return [true]
+    # @raise [ArgumentError] if an invalid attribute is specified
     # @raise [Turntabler::Error] if the command fails
     # @example
     #   room.update(:description => '...')    # => true
@@ -202,6 +205,7 @@ module Turntabler
 
     # Enters the current room.
     # 
+    # @note This will leave any room the user is already currently in (unless the same room is being entered)
     # @return [true]
     # @raise [Turntabler::Error] if the command fails
     # @example
@@ -210,7 +214,7 @@ module Turntabler
       if client.room != self
         # Leave the old room
         client.room.leave if client.room
-        
+
         # Connect and register with this room
         client.connect(url)
         begin
@@ -222,11 +226,11 @@ module Turntabler
           raise
         end
       end
-      
+
       true
     end
 
-    # Leaves from the current room.
+    # Leaves from the room.
     # 
     # @return [true]
     # @raise [Turntabler::Error] if the command fails
@@ -270,6 +274,8 @@ module Turntabler
     # get created.
     # 
     # @api private
+    # @param [Hash] attrs The attributes representing the user
+    # @return [Turntabler::User]
     def build_user(attrs)
       user = User.new(client, attrs)
       user = if client.user == user
@@ -365,7 +371,7 @@ module Turntabler
       api('room.report', :roomid => id, :section => section, :reason => reason)
       true
     end
-    
+
     private
     # Sets the sticker placements for each dj
     def sticker_placements=(user_placements)

data/lib/turntabler/room_directory.rb

@@ -46,12 +46,12 @@ module Turntabler
     # @option options [Fixnum] :limit (20) The total number of rooms to list
     # @option options [Fixnum] :skip (0) The number of rooms to skip when loading the list
     # @option options [Fixnum] :favorites (false) Whether to only include rooms marked as favorites
-    # @option options [Fixnum] :available_djs (false) Whether to only include rooms that have dj spots available
-    # @option options [Fixnum] :genre The genre of music being played in the room, .  Possible values are +:rock+, +:electronica+, +:indie+, +:hiphop+, +:pop+, and +:dubstep+.
+    # @option options [Boolean] :available_djs (false) Whether to only include rooms that have dj spots available
+    # @option options [Symbol] :genre The genre of music being played in the room, .  Possible values are +:rock+, +:electronica+, +:indie+, +:hiphop+, +:pop+, and +:dubstep+.
     # @option options [Fixnum] :minimum_listeners (1) The minimum number of listeners in the room
-    # @option options [Fixnum] :sort (:listeners) The order to list rooms in.  Possible values are +:created+, +:listeners+, and +:random+.
+    # @option options [Symbol] :sort (:listeners) The order to list rooms in.  Possible values are +:created+, +:listeners+, and +:random+.
     # @return [Array<Turntabler::Room>]
-    # @raise [ArgumentError] if an invalid option is specified
+    # @raise [ArgumentError] if an invalid option or value is specified
     # @raise [Turntabler::Error] if the command fails
     # @example
     #   rooms.list                                          # => [#<Turntabler::Room ...>, ...]
@@ -70,7 +70,7 @@ module Turntabler
         :minimum_listeners => 1,
         :sort => :listeners
       }.merge(options)
-      
+
       constraints = []
       constraints << :favorites if options[:favorites]
       constraints << :available_djs if options[:available_djs]
@@ -90,7 +90,7 @@ module Turntabler
       data['rooms'].map {|attrs| Room.new(client, attrs)}
     end
 
-    # Get the rooms where your friends are currently in.
+    # Gets the rooms where the current user's friends are currently listening.
     # 
     # @return [Array<Turntabler::Room>]
     # @raise [Turntabler::Error] if the command fails

data/lib/turntabler/song.rb

@@ -67,7 +67,7 @@ module Turntabler
     attribute :votes, :votelog, :load => false do |votes|
       votes.each do |(user_id, direction)|
         self.votes.delete_if {|vote| vote.user.id == user_id}
-        self.votes << Vote.new(client, :userid => user_id, :direction => direction)
+        self.votes << Vote.new(client, :userid => user_id, :direction => direction) if user_id && !user_id.empty?
       end
       self.votes
     end

data/lib/turntabler/sticker.rb

@@ -19,7 +19,7 @@ module Turntabler
     # @return [String]
     attribute :category
 
-    # How much it costs to purchase this sticker for use
+    # The cost to purchase this sticker for use
     # @return [Fixnum]
     attribute :price
 
@@ -35,7 +35,7 @@ module Turntabler
     # 
     # @param [Fixnum] top The y-coordinate of the sticker
     # @param [Fixnum] left The x-coordinate of the sticker
-    # @param [Fixnum] angle The degree at which the sticker is angled
+    # @param [Float] angle The degree at which the sticker is angled
     # @return [true]
     # @raise [Turntabler::Error] if the command fails
     # @example

data/lib/turntabler/sticker_placement.rb

@@ -19,7 +19,7 @@ module Turntabler
     attribute :left
 
     # The degree at which the sticker is tilted
-    # @return [Fixnum]
+    # @return [Float]
     attribute :angle
   end
 end

data/lib/turntabler/user.rb

@@ -34,13 +34,13 @@ module Turntabler
     # @return [Fixnum]
     attribute :fans_count, :fans
 
-    # The user's unique identifier on Facebook (only available if the user is
-    # connected to the authorized user through Facebook)
+    # The user's unique identifier on Facebook
+    # @note This is only available if the user is connected to the authorized user through Facebook
     # @return [String]
     attribute :facebook_url, :facebook
     
-    # The user's unique identifier on Twitter (only available if the user is
-    # connected to the authorized user through Twitter)
+    # The user's unique identifier on Twitter
+    # @note This is only available if the user is connected to the authorized user through Twitter
     # @return [String]
     attribute :twitter_id, :twitter, :twitterid_lower
 
@@ -56,7 +56,7 @@ module Turntabler
     # @return [String]
     attribute :top_artists, :topartists
 
-    # Whether on Turntable the user likes to hang out
+    # A description of the rooms on Turntable the user likes to hang out
     # @return [String]
     attribute :hangout
 
@@ -85,7 +85,7 @@ module Turntabler
       self.attributes = data
       super
     end
-    
+
     # Gets the availability status for this user.
     # 
     # @return [String] "available" / "unavailable"
@@ -97,7 +97,7 @@ module Turntabler
       data['presence']['status']
     end
 
-    # Gets the stickers that are currently placed on the user.
+    # Gets the stickers that are currently placed on the user's laptop.
     # 
     # @param [Boolean] reload Whether to forcefully reload the user's list of sticker placements
     # @return [Array<Turntabler::StickerPlacement>]
@@ -213,12 +213,11 @@ module Turntabler
     # Gets the location of the user.
     # 
     # @note This will make the current user a fan of this user
-    # @param [Boolean] all_info Whether full detailed information should be provided about the room and user
-    # @return [Array<Turntabler::Room>]
+    # @return [Turntabler::Room]
     # @raise [Turntabler::Error] if the command fails
     # @example
-    #   user.stalk    # => #<Turntabler::User ...>
-    def stalk(all_info = false)
+    #   user.stalk    # => #<Turntabler::Room ...>
+    def stalk
       become_fan unless client.user.fan_of.include?(self)
       client.rooms.with_friends.detect do |room|
         room.listener(id)

data/lib/turntabler/version.rb

@@ -2,8 +2,8 @@ module Turntabler
   # The current version of the library
   module Version
     MAJOR = 0
-    MINOR = 0
-    PATCH = 1
+    MINOR = 1
+    PATCH = 0
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end
 end

data/lib/turntabler.rb

@@ -50,8 +50,12 @@ module Turntabler
     #   end
     #   
     #   # Interactive, not in reactor / fiber
+    #   Turntabler.interactive
     #   Turntabler.run do
-    #     client.room.become_dj
+    #     @client = ...
+    #   end
+    #   Turntabler.run do
+    #     @client.room.become_dj
     #     # ...
     #   end
     #   
@@ -61,7 +65,7 @@ module Turntabler
     # 
     # @example DSL
     #   # Takes the same arguments as Turntabler::Client
-    #   Turntabler.run(USER, AUTH, :room => ROOM) do
+    #   Turntabler.run(EMAIL, PASSWORD, :room => ROOM) do
     #     room.become_dj
     #     on :user_enter do
     #       # ...
@@ -84,7 +88,7 @@ module Turntabler
                 # Just run the block within a fiber
                 block.call
               end
-            rescue Exception => ex
+            rescue StandardError => ex
               logger.error(([ex.message] + ex.backtrace) * "\n")
             end
           end
@@ -99,4 +103,4 @@ module Turntabler
 end
 
 # Provide a simple alias (akin to EM / EventMachine)
-TT = Turntabler
+TT = Turntabler unless defined?(TT)

metadata

@@ -2,7 +2,7 @@
 name: turntabler
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-20 00:00:00 Z
+date: 2012-11-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: em-synchrony