rockstar 0.6.3 → 0.6.4

data/lib/rockstar/chart.rb

@@ -11,19 +11,19 @@ module Rockstar
       @from = from
       @to = to
     end
-    
+
     def from=(value)
       @from = value.to_i
     end
-    
+
     def to=(value)
       @to = value.to_i
     end
-    
+
     def from
       @from.to_i
     end
-    
+
     def to
       @to.to_i
     end

data/lib/rockstar/event.rb

@@ -1,14 +1,14 @@
 module Rockstar
   class Event < Base
-    
+
     attr_accessor :eid, :title, :artists, :headliners, :start_date, :end_date,
-                  :description, :attendance, :reviews, :tag, :url, :website, :tickets, 
+                  :description, :attendance, :reviews, :tag, :url, :website, :tickets,
                   :cancelled, :tags, :images, :venue
-    
+
     class << self
       def new_from_xml(xml, doc)
         e = Event.new(
-          (xml).at(:id).inner_html, 
+          (xml).at(:id).inner_html,
           (xml).at(:title).inner_html
         )
 
@@ -52,20 +52,20 @@ module Rockstar
         e
       end
     end
-    
+
     def initialize(id, title)
       raise ArgumentError, "ID is required" if id.blank?
       raise ArgumentError, "Title is required" if title.blank?
       @eid   = id
       @title = title
     end
-    
+
     def image(which=:medium)
       which = which.to_s
-      raise ArgumentError unless ['small', 'medium', 'large', 'extralarge', 'mega'].include?(which)  
+      raise ArgumentError unless ['small', 'medium', 'large', 'extralarge', 'mega'].include?(which)
       if (self.images.nil?)
         load_info
-      end    
+      end
       self.images[which]
     end
   end

data/lib/rockstar/geo.rb

@@ -1,7 +1,5 @@
 module Rockstar
   class Geo < Base
-    
-      
     # Get events in a specific location. Opts can be
     #
     # * :location => 'madrid'  # A city name from geo.metros
@@ -9,9 +7,9 @@ module Rockstar
     #
     # Additionally you can set the distance from that point with
     #   :distance => 50 # 50 km from the given location
-    # 
+    #
     def events(opts = {}, force = false)
-      get_instance("geo.getEvents", :events, :event, opts, force) 
+      get_instance("geo.getEvents", :events, :event, opts, force)
     end
 
     def metros(country, force = false)

data/lib/rockstar/metro.rb

@@ -1,24 +1,24 @@
 module Rockstar
   class Metro < Base
-    
+
     attr_accessor :name, :country
 
     class << self
       def new_from_xml(xml, doc)
         Metro.new(
-          (xml).at(:name).inner_html, 
+          (xml).at(:name).inner_html,
           (xml).at(:country).inner_html
         )
       end
     end
-    
+
     def initialize(name, country)
       raise ArgumentError, "Name is required" if name.blank?
       raise ArgumentError, "Country is required" if country.blank?
       @name = name
       @country = country
     end
-    
+
   end
 end
 

data/lib/rockstar/rest.rb

@@ -20,19 +20,19 @@ module Rockstar
 
   		def request(resource, method = "get", args = {}, sign_request=false)
   		 	url = URI.parse(@base_url)
-        
+
         if (!resource.blank?)
           args[:method] = resource
           args[:api_key]= Rockstar.lastfm_api_key
         end
-        
+
   			if args
   			  sorted_keys = args.keys.sort_by{|k|k.to_s}
           query = sorted_keys.collect { |k| "%s=%s" % [escape(k.to_s), escape(args[k].to_s)] }.join("&")
 
           if !args[:sk].nil? ||sign_request # Session Key available => sign the request or sign_request = true?
             signed = sorted_keys.collect {|k| "%s%s" % [k.to_s, args[k].to_s]}.join()
-            
+
             auth = Digest::MD5.hexdigest("#{signed}#{Rockstar.lastfm_api_secret}")
             query += "&api_sig=#{auth}"
           end
@@ -56,7 +56,7 @@ module Rockstar
   			res = http.start() { |conn| conn.request(req) }
   			res.body
   		end
-  		
+
   		private
   		  def escape(str)
   		    URI.escape(str, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))

data/lib/rockstar/tag.rb

@@ -1,17 +1,17 @@
 # Below is code samples for how to find the top albums and tracks for a tag.
-# 
+#
 #   tag = Rockstar::Tag.new('country')
-# 
+#
 #   puts 'Top Albums'
 #   tag.top_albums.each { |a| puts "(#{a.count}) #{a.name} by #{a.artist}" }
-# 
+#
 #   puts
-# 
+#
 #   puts 'Top Tracks'
 #   tag.top_tracks.each { |t| puts "(#{t.count}) #{t.name} by #{t.artist}" }
-#   
+#
 # Which would output something similar to:
-# 
+#
 #   Top Albums
 #   (29) American IV: The Man Comes Around by Johnny Cash
 #   (14) Folks Pop In at the Waterhouse by Various Artists
@@ -33,7 +33,7 @@
 #   (5) Breathe by Faith Hill
 #   (5) Unearthed (disc 4: My Mother's Hymn Book) by Johnny Cash
 #   (4) Home by Dixie Chicks
-# 
+#
 #   Top Tracks
 #   (221) Hurt by Johnny Cash
 #   (152) I Walk the Line by Johnny Cash
@@ -58,7 +58,7 @@
 module Rockstar
   class Tag < Base
     attr_accessor :name, :count, :url
-    
+
     class << self
       def new_from_xml(xml, doc=nil)
         name    = (xml).at(:name).inner_html
@@ -67,7 +67,7 @@ module Rockstar
         t.url   = Base.fix_url((xml).at(:url).inner_html)
         t
       end
-      
+
       def top_tags
         doc = fetch_and_parse("tag.getTopTags")
         @top_tags = (doc/"toptags/tag").collect do |tag|
@@ -78,17 +78,17 @@ module Rockstar
         end
       end
     end
-    
+
     def initialize(name)
       raise ArgumentError, "Name is required" if name.blank?
       @name = name
     end
-    
-    
+
+
     def top_artists(force=false)
       get_instance("tag.getTopArtists", :top_artists, :artist, {:tag => @name}, force)
     end
-    
+
     def top_albums(force=false)
       get_instance("tag.getTopAlbums", :top_albums, :album, {:tag => @name}, force)
     end

data/lib/rockstar/track.rb

@@ -1,17 +1,17 @@
 # Below is an example of how to get the top fans for a track.
-# 
+#
 #   track = Rockstar::Track.new('Carrie Underwood', 'Before He Cheats')
 #   puts 'Fans'
 #   puts "=" * 4
 #   track.fans.each { |u| puts u.username }
-#   
+#
 # Which would output something like:
-# 
+#
 #   track = Rockstar::Track.new('Carrie Underwood', 'Before He Cheats')
 #   puts 'Fans'
 #   puts "=" * 4
 #   track.fans.each { |u| puts "(#{u.weight}) #{u.username}" }
-# 
+#
 #   Fans
 #   ====
 #   (69163) PimpinRose
@@ -43,13 +43,13 @@ module Rockstar
   class Track < Base
     attr_accessor :artist, :artist_mbid, :name, :mbid, :playcount, :rank, :url
     attr_accessor :summary, :content, :streamable, :album, :album_mbid, :date, :date_uts, :duration
-    
+
     # only seems to be used on top tracks for tag
     attr_accessor :count, :thumbnail, :image, :images
-    
+
     # for weekly top tracks
     attr_accessor :chartposition
-    
+
     class << self
       def new_from_xml(xml, doc=nil)
         artist          = (xml).at(:artist)['name']               if (xml).at(:artist) && !(xml).at(:artist)['name'].nil?
@@ -98,7 +98,7 @@ module Rockstar
         query["trackNumber[0]"] = params[:trackNumber] if !params[:trackNumber].blank?
         query["mbid[0]"]        = params[:mbid] if !params[:mbid].blank?
         query["duration[0]"]    = params[:duration] if !params[:duration].blank?
-        
+
         doc = Hpricot::XML(Track.connection.post("track.scrobble", true, query))
 
         if doc.at("lfm")["status"] == "failed"
@@ -111,7 +111,7 @@ module Rockstar
               raise RequestFailedError, doc.at("lfm").at("error").inner_html
            end
         end
- 
+
         doc.at("lfm")["status"]
        end
 
@@ -142,7 +142,7 @@ module Rockstar
         query["trackNumber"] = params[:trackNumber] if !params[:trackNumber].blank?
         query["mbid"]        = params[:mbid] if !params[:mbid].blank?
         query["duration"]    = params[:duration] if !params[:duration].blank?
-        
+
         doc = Hpricot::XML(Track.connection.post("track.updateNowPlaying", true, query))
 
         if doc.at("lfm")["status"] == "failed"
@@ -155,12 +155,12 @@ module Rockstar
               raise RequestFailedError, doc.at("lfm").at("error").inner_html
            end
         end
-        
+
         doc.at("lfm")["status"]
       end
- 
+
     end
-    
+
     def initialize(artist, name, o={})
       raise ArgumentError, "Artist is required" if artist.blank?
       raise ArgumentError, "Name is required" if name.blank?
@@ -188,7 +188,7 @@ module Rockstar
       self.streamable    = (xml).at(:track)['streamable']          if (xml).at(:track) && (xml).at(:track)['streamable']
       self.streamable    = (xml).at(:streamable).inner_html == '1' ? 'yes' : 'no' if streamable.nil? && (xml).at(:streamable)
       self.duration      = (xml).at(:duration).inner_html.to_i     if (xml).at(:duration)
-        
+
       self.count         = xml['count']                            if xml['count']
       self.album         = (xml).at(:album).inner_html             if (xml).at(:album)
       self.album_mbid    = (xml).at(:album)['mbid']                if (xml).at(:album) && (xml).at(:album)['mbid']
@@ -204,21 +204,21 @@ module Rockstar
       (xml/'image').each {|image|
         self.images[image['size']] = image.inner_html if self.images[image['size']].nil?
       }
-        
+
       self.thumbnail = images['small']
       self.image     = images['medium']
 
       self
     end
-      
+
     def albums(force=false)
       get_instance("track.getInfo", :albums, :album, {:track => @name, :artist => @artist}, force)
     end
-        
+
     def fans(force=false)
       get_instance("track.getTopFans", :fans, :user, {:track => @name, :artist => @artist}, force)
     end
-    
+
     def tags(force=false)
       get_instance("track.getTopTags", :tags, :tag, {:track => @name, :artist => @artist}, force)
     end
@@ -226,7 +226,7 @@ module Rockstar
     def similar(limit = 10, force = false)
       get_instance('track.getSimilar', :similar, :track, {:track => @name, :artist => @artist, :limit => limit}, force)
     end
-    
+
     # The session_key is returned by auth.session.key
     def love(session_key)
       Track.love(@artist, @name, session_key)

data/lib/rockstar/user.rb

@@ -1,17 +1,17 @@
 # Probably the most common use of this lib would be to get your most recent tracks or your top tracks. Below are some code samples.
 #   user = Rockstar::User.new('jnunemaker')
-# 
+#
 #   puts "#{user.username}'s Recent Tracks"
 #   puts "=" * (user.username.length + 16)
 #   user.recent_tracks.each { |t| puts t.name }
-# 
+#
 #   puts
 #   puts
-# 
+#
 #   puts "#{user.username}'s Top Tracks"
 #   puts "=" * (user.username.length + 13)
 #   user.top_tracks.each { |t| puts "(#{t.playcount}) #{t.name}" }
-#   
+#
 # Which would output something like:
 #
 #   jnunemaker's Recent Tracks
@@ -22,8 +22,8 @@
 #   Lord I Guess I'll Never Know
 #   Country Song
 #   Bitter Sweet Symphony (Radio Edit)
-# 
-# 
+#
+#
 #   jnunemaker's Top Tracks
 #   =======================
 #   (62) Probably Wouldn't Be This Way
@@ -44,39 +44,39 @@
 #   (35) You're Beautiful
 #   (35) Walk Away
 #   (34) Stickwitu
-module Rockstar  
+module Rockstar
   class User < Base
     # attributes needed to initialize
     attr_reader :username, :period
-    
+
     # profile attributes
     attr_accessor :id, :cluster, :url, :realname, :mbox_sha1sum, :registered
     attr_accessor :registered_unixtime, :age, :gender, :country, :playcount, :avatar, :realname, :images
 
     # neighbor attributes
     attr_accessor :match
-    
+
     # track fans attributes
     attr_accessor :weight
-    
+
     class << self
       def new_from_xml(xml, doc=nil)
         u        = User.new((xml).at(:name).inner_html)
         u.url    = Base.fix_url((xml).at(:url).inner_html)    if (xml).at(:url)
-        
+
         u.images = {}
         (xml/'image').each {|image|
           u.images[image['size']] = image.inner_html if u.images[image['size']].nil?
         }
-        
+
         u.avatar = u.images['small']
-        
+
         u.weight = (xml).at(:weight).inner_html if (xml).at(:weight)
         u.match  = (xml).at(:match).inner_html  if (xml).at(:match)
         u.realname= (xml).at(:realname).inner_html    if (xml).at(:realname)
         u
       end
-      
+
       def find(*args)
         options = {:include_profile => false}
         options.merge!(args.pop) if args.last.is_a?(Hash)
@@ -84,7 +84,7 @@ module Rockstar
         users.length == 1 ? users.pop : users
       end
     end
-    
+
     def initialize(username, o={})
       options = {:include_profile => false, :period => 'overall'}.merge(o)
       raise ArgumentError if username.blank?
@@ -92,19 +92,7 @@ module Rockstar
       @period = options[:period]
       load_profile() if options[:include_profile]
     end
-    
-    def current_events(format=:ics)
-      warn "[DEPRECATION] `current_events` is deprecated. The current api doesn't offer ics/ical formatted data."
-    end
-    
-    def friends_events(format=:ics)
-      warn "[DEPRECATION] `friends_events` is deprecated. The current api doesn't offer ics/ical formatted data."
-    end
-    
-    def recommended_events(format=:ics)
-      warn "[DEPRECATION] `recommended_events` is deprecated. The current api doesn't offer ics/ical formatted data."
-    end
-    
+
     def load_profile
       doc                  = self.class.fetch_and_parse("user.getInfo", {:user => @username})
       @id                  = (doc).at(:id).inner_html
@@ -116,82 +104,72 @@ module Rockstar
       @gender              = (doc).at(:gender).inner_html
       @country             = (doc).at(:country).inner_html
       @playcount           = (doc).at(:playcount).inner_html
-      
+
       @images = {}
       (doc/'image').each {|image|
         @images[image['size']] = image.inner_html
       }
-      
+
       @avatar              = @images["small"]
     end
-    
+
     def top_artists(force=false, options = {} )
       default_options = {
         :period => self.period
       }
       options = default_options.merge(options)
       options[:user] = @username
-      
+
       get_instance("user.getTopArtists", :top_artists, :artist, options, force)
     end
-    
+
     def top_albums(force=false)
       get_instance("user.getTopAlbums", :top_albums, :album, {:user => @username}, force)
     end
-    
+
     def top_tracks(force=false)
       get_instance("user.getTopTracks", :top_tracks, :track, {:user => @username}, force)
     end
-    
+
     def top_tags(force=false)
       get_instance("user.getTopTags", :top_tags, :tag, {:user => @username}, force)
     end
-    
+
     def friends(force=false)
       get_instance("user.getFriends", :friends, :user, {:user => @username}, force)
     end
-    
+
     def neighbours(force=false)
       get_instance("user.getNeighbours", :neighbours, :user, {:user => @username}, force)
     end
-    
+
     def recent_tracks(force=false)
       get_instance("user.getRecentTracks", :recent_tracks, :track, {:user => @username}, force)
     end
-    
-    def recent_banned_tracks(force=false)
-      warn "[DEPRECATION] `recent_banned_tracks` is deprecated. The current api doesn't offer this function"
-      []
-    end
-    
+
     def recent_loved_tracks(force=false)
       get_instance("user.getLovedTracks", :recent_loved_tracks, :track, {:user => @username}, force)
     end
-    
-    def recommendations(force=false)
-      warn "[DEPRECATION] `recommendations` is deprecated. Please use recommended_artists"
-      []
-    end
 
     # The session_key is returned by auth.session.key
     def recommended_artists(session_key, force=false)
       get_instance("user.getRecommendedArtists", :recommendations, :artist, {:user => @username, :sk => session_key}, force)
     end
-    
+
     def charts(force=false)
       get_instance("user.getWeeklyChartList", :charts, :chart, {:user => @username}, force)
     end
-    
+
     def weekly_artist_chart(from=nil, to=nil)
       doc = self.class.fetch_and_parse("user.getWeeklyArtistChart", {:user => @username, :from => from, :to => to})
       (doc/:artist).inject([]) { |elements, el| elements << Artist.new_from_xml(el); elements }
     end
-    
+
     def weekly_album_chart(from=nil, to=nil)
       doc = self.class.fetch_and_parse("user.getWeeklyAlbumChart", {:user => @username, :from => from, :to => to})
       (doc/:album).inject([]) { |elements, el| elements << Album.new_from_xml(el); elements }
     end
-    
+
     def weekly_track_chart(from=nil, to=nil)
       doc = self.class.fetch_and_parse("user.getWeeklyTrackChart", {:user => @username, :from => from, :to => to})
       (doc/:track).inject([]) { |elements, el| elements << Track.new_from_xml(el); elements }