titanous-scrobbler 0.2.2

data/lib/scrobbler/playing.rb

@@ -0,0 +1,49 @@
+module Scrobbler
+  class Playing
+    # you should read last.fm/api/submissions#np first!
+
+    attr_accessor :session_id, :now_playing_url, :artist, :track,
+                  :album, :length, :track_number, :mb_track_id
+    attr_reader :status
+
+    def initialize(args = {})
+      @session_id = args[:session_id] # from Scrobbler::SimpleAuth
+      @now_playing_url = args[:now_playing_url] # from Scrobbler::SimpleAuth (can change)
+      @artist = args[:artist] # track artist
+      @track = args[:track] # track name
+      @album = args[:album] || '' # track album (optional)
+      @length = args[:length] || '' # track length in seconds (optional)
+      @track_number = args[:track_number] || '' # track number (optional)
+      @mb_track_id = args[:mb_track_id] || '' # MusicBrainz track ID (optional)
+
+      if [@session_id, @now_playing_url, @artist, @track].any?(&:blank?)
+        raise ArgumentError, 'Missing required argument'
+      elsif !@length.to_s.empty? && @length.to_i <= 30 # see last.fm/api
+        raise ArgumentError, 'Length must be greater than 30 seconds'
+      end 
+
+      @connection = REST::Connection.new(@now_playing_url)
+    end
+
+    def submit!
+      query = { :s => @session_id,
+                :a => @artist,
+                :t => @track,
+                :b => @album,
+                :l => @length,
+                :n => @track_number,
+                :m => @mb_track_id }
+
+      @status = @connection.post('', query)
+
+      case @status
+      when /OK/
+
+      when /BADSESSION/
+        raise BadSessionError # rerun Scrobbler::SimpleAuth#handshake!
+      else
+        raise RequestFailedError
+      end
+    end
+  end
+end

data/lib/scrobbler/rest.rb

@@ -0,0 +1,47 @@
+require 'net/https'
+
+module Scrobbler
+  module REST
+  	class Connection
+  		def initialize(base_url, args = {})
+  			@base_url = base_url
+  			@username = args[:username]
+  			@password = args[:password]
+  		end
+
+  		def get(resource, args = nil)
+  			request(resource, "get", args)
+  		end
+
+  		def post(resource, args = nil)
+  			request(resource, "post", args)
+  		end
+
+  		def request(resource, method = "get", args = nil)
+  			url = URI.join(@base_url, resource)
+
+  			if args
+  				# TODO: What about keys without value?
+  				url.query = args.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(v.to_s)] }.join("&")
+  			end
+
+  			case method
+  			when "get"
+  				req = Net::HTTP::Get.new(url.request_uri)
+  			when "post"
+  				req = Net::HTTP::Post.new(url.request_uri)
+  			end
+
+  			if @username and @password
+  				req.basic_auth(@username, @password)
+  			end
+
+  			http = Net::HTTP.new(url.host, url.port)
+  			http.use_ssl = (url.port == 443)
+
+  			res = http.start() { |conn| conn.request(req) }
+  			res.body
+  		end
+  	end
+  end
+end

data/lib/scrobbler/scrobble.rb

@@ -0,0 +1,66 @@
+# exception definitions
+class BadSessionError < StandardError; end
+class RequestFailedError < StandardError; end
+
+module Scrobbler
+  class Scrobble
+    # you need to read last.fm/api/submissions#subs first!
+
+    attr_accessor :session_id, :submission_url, :artist, :track, :time,
+                  :source, :length, :album, :track_number, :mb_track_id
+    attr_reader :status
+
+    def initialize(args = {})
+      @session_id = args[:session_id] # from Scrobbler::SimpleAuth
+      @submission_url = args[:submission_url] # from Scrobbler::SimpleAuth (can change)
+      @artist = args[:artist] # track artist
+      @track = args[:track] # track name
+      @time = args[:time] # a Time object set to the time the track started playing
+      @source = args[:source] || 'P' # track source, see last.fm/api/submissions#subs
+      @length = args[:length].to_s || '' # track length in seconds
+      @album = args[:album] || '' # track album name (optional)
+      @track_number = args[:track_number] || '' # track number (optional)
+      @mb_track_id = args[:mb_track_id] || '' # MusicBrainz track ID (optional)
+
+      if [@session_id, @submission_url, @artist, @track].any?(&:blank?)
+        raise ArgumentError, 'Missing required argument'
+      elsif @time.class.to_s != 'Time'
+        raise ArgumentError, ":time must be a Time object"
+      elsif !['P','R','E','U'].include?(@source) # see last.fm/api/submissions#subs
+        raise ArgumentError, "Invalid source"
+      elsif @source == 'P' && @length.blank? # length is not optional if source is P
+        raise ArgumentError, 'Length must be set'
+      elsif !@length.blank? && @length.to_i <= 30 # see last.fm/api/submissions#subs
+        raise ArgumentError, 'Length must be greater than 30 seconds'
+      end
+
+      @connection = REST::Connection.new(@submission_url)
+    end
+
+    def submit!
+      query = { :s => @session_id,
+                'a[0]' => @artist,
+                't[0]' => @track,
+                'i[0]' => @time.utc.to_i,
+                'o[0]' => @source,
+                'r[0]' => '',
+                'l[0]' => @length,
+                'b[0]' => @album,
+                'n[0]' => @track_number,
+                'm[0]' => @mb_track_id }
+                
+      @status = @connection.post('', query)
+
+      case @status
+      when /OK/
+
+      when /BADSESSION/
+        raise BadSessionError # rerun Scrobbler::SimpleAuth#handshake!
+      when /FAILED/
+        raise RequestFailedError, @status
+      else
+        raise RequestFailedError
+      end
+    end
+  end
+end

data/lib/scrobbler/simpleauth.rb

@@ -0,0 +1,59 @@
+require 'digest/md5'
+
+# exception definitions
+class BadAuthError < StandardError; end
+class BannedError < StandardError; end
+class BadTimeError < StandardError; end
+module Scrobbler
+  AUTH_URL = 'http://post.audioscrobbler.com'
+  AUTH_VER = '1.2.1'
+  
+  class SimpleAuth
+    # you should read last.fm/api/submissions#handshake
+
+    attr_accessor :user, :password, :client_id, :client_ver
+    attr_reader :status, :session_id, :now_playing_url, :submission_url
+
+    def initialize(args = {})
+      @user = args[:user] # last.fm username
+      @password = args[:password] # last.fm password
+      @client_id = 'rbs' # Client ID assigned by last.fm; Don't change this!
+      @client_ver = Scrobbler::Version
+
+      raise ArgumentError, 'Missing required argument' if @user.blank? || @password.blank?
+
+      @connection = REST::Connection.new(AUTH_URL)
+    end
+
+    def handshake!
+      password_hash = Digest::MD5.hexdigest(@password)
+      timestamp = Time.now.to_i.to_s
+      token = Digest::MD5.hexdigest(password_hash + timestamp)
+
+      query = { :hs => 'true',
+                :p => AUTH_VER,
+                :c => @client_id,
+                :v => @client_ver,
+                :u => @user,
+                :t => timestamp,
+                :a => token }
+      result = @connection.get('/', query)
+
+      @status = result.split(/\n/)[0]
+      case @status
+      when /OK/
+        @session_id, @now_playing_url, @submission_url = result.split(/\n/)[1,3]
+      when /BANNED/
+        raise BannedError # something is wrong with the gem, check for an update
+      when /BADAUTH/
+        raise BadAuthError # invalid user/password
+      when /FAILED/
+        raise RequestFailedError, @status
+      when /BADTIME/
+        raise BadTimeError # system time is way off
+      else
+        raise RequestFailedError
+      end  
+    end
+  end
+end

data/lib/scrobbler/tag.rb

@@ -0,0 +1,104 @@
+# Below is code samples for how to find the top albums and tracks for a tag.
+# 
+#   tag = Scrobbler::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
+#   (13) Hapless by Flowers From The Man Who Shot Your Cousin
+#   (9) Taking The Long Way by Dixie Chicks
+#   (8) Unchained by Johnny Cash
+#   (8) American III: Solitary Man by Johnny Cash
+#   (8) Wide Open Spaces by Dixie Chicks
+#   (7) It's Now or Later by Tangled Star
+#   (7) Greatest Hits by Hank Williams
+#   (7) American Recordings by Johnny Cash
+#   (6) Forgotten Landscape by theNoLifeKing
+#   (6) At Folsom Prison by Johnny Cash
+#   (6) Fox Confessor Brings the Flood by Neko Case
+#   (6) Murder by Johnny Cash
+#   (5) Gloom by theNoLifeKing
+#   (5) Set This Circus Down by Tim McGraw
+#   (5) Blacklisted by Neko Case
+#   (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
+#   (147) Ring of Fire by Johnny Cash
+#   (125) Folsom Prison Blues by Johnny Cash
+#   (77) The Man Comes Around by Johnny Cash
+#   (67) Personal Jesus by Johnny Cash
+#   (65) Not Ready To Make Nice by Dixie Chicks
+#   (63) Before He Cheats by Carrie Underwood
+#   (62) Give My Love to Rose by Johnny Cash
+#   (49) Jackson by Johnny Cash
+#   (49) What Hurts The Most by Rascal Flatts
+#   (48) Big River by Johnny Cash
+#   (46) Man in Black by Johnny Cash
+#   (46) Jolene by Dolly Parton
+#   (46) Friends in Low Places by Garth Brooks
+#   (46) One by Johnny Cash
+#   (44) Cocaine Blues by Johnny Cash
+#   (41) Get Rhythm by Johnny Cash
+#   (41) I Still Miss Someone by Johnny Cash
+#   (40) The Devil Went Down to Georgia by Charlie Daniels Band
+module Scrobbler
+  class Tag < Base
+    attr_accessor :name, :count, :url
+    
+    class << self
+      def new_from_xml(xml, doc=nil)
+        name    = (xml).at(:name).inner_html
+        t       = Tag.new(name)
+        t.count = (xml).at(:count).inner_html
+        t.url   = (xml).at(:url).inner_html
+        t
+      end
+      
+      def top_tags
+        doc = fetch_and_parse("/#{API_VERSION}/tag/toptags.xml")
+        @top_tags = (doc/:tag).inject([]) do |tags, tag|
+          t       = Tag.new(tag['name'])
+          t.count = tag['count']
+          t.url   = tag['url']
+          tags << t
+          tags
+        end
+      end
+    end
+    
+    def initialize(name)
+      raise ArgumentError, "Name is required" if name.blank?
+      @name = name
+    end
+    
+    def api_path
+      "/#{API_VERSION}/tag/#{CGI::escape(name)}"
+    end
+    
+    def top_artists(force=false)
+      get_instance(:topartists, :top_artists, :artist, force)
+    end
+    
+    def top_albums(force=false)
+      get_instance(:topalbums, :top_albums, :album, force)
+    end
+
+    def top_tracks(force=false)
+      get_instance(:toptracks, :top_tracks, :track, force)
+    end
+  end
+end

data/lib/scrobbler/track.rb

@@ -0,0 +1,96 @@
+# Below is an example of how to get the top fans for a track.
+# 
+#   track = Scrobbler::Track.new('Carrie Underwood', 'Before He Cheats')
+#   puts 'Fans'
+#   puts "=" * 4
+#   track.fans.each { |u| puts u.username }
+#   
+# Which would output something like:
+# 
+#   track = Scrobbler::Track.new('Carrie Underwood', 'Before He Cheats')
+#   puts 'Fans'
+#   puts "=" * 4
+#   track.fans.each { |u| puts "(#{u.weight}) #{u.username}" }
+# 
+#   Fans
+#   ====
+#   (69163) PimpinRose
+#   (7225) selene204
+#   (7000) CelestiaLegends
+#   (6817) muehllr
+#   (5387) Mudley
+#   (5368) ilovejohnny1984
+#   (5232) MeganIAD
+#   (5132) Veric
+#   (5097) aeVnar
+#   (3390) kristaaan
+#   (3239) kelseaowns
+#   (2780) syndication
+#   (2735) mkumm
+#   (2706) Kimmybeebee
+#   (2648) skorpcroze
+#   (2549) mistergreg
+#   (2449) mlmjcace
+#   (2302) tiNEey
+#   (2169) ajsbabiegirl
+module Scrobbler
+  class Track < Base
+    attr_accessor :artist, :artist_mbid, :name, :mbid, :playcount, :rank, :url, :reach
+    attr_accessor :streamable, :album, :album_mbid, :date, :date_uts
+    
+    # only seems to be used on top tracks for tag
+    attr_accessor :count, :thumbnail, :image
+    
+    # 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']
+        artist          = (xml).at(:artist).inner_html            if artist.nil? && (xml).at(:artist)
+        artist          = doc.root['artist']                      if artist.nil? && doc.root['artist']
+        name            = (xml).at(:name).inner_html              if (xml).at(:name)
+        name            = xml['name']                             if name.nil? && xml['name']
+        t               = Track.new(artist, name)
+        t.artist_mbid   = (xml).at(:artist)['mbid']               if (xml).at(:artist) && (xml).at(:artist)['mbid']
+        t.artist_mbid   = (xml).at(:artist).at(:mbid).inner_html  if t.artist_mbid.nil? && (xml).at(:artist) && (xml).at(:artist).at(:mbid)
+        t.mbid          = (xml).at(:mbid).inner_html              if (xml).at(:mbid)
+        t.playcount     = (xml).at(:playcount).inner_html         if (xml).at(:playcount)
+        t.chartposition = (xml).at(:chartposition).inner_html     if (xml).at(:chartposition)
+        t.rank          = (xml).at(:rank).inner_html              if (xml).at(:rank)
+        t.url           = (xml/:url).last.inner_html              if (xml/:url).size > 1
+        t.url           = (xml).at(:url).inner_html               if t.url.nil? && (xml).at(:url)
+        t.streamable    = (xml).at(:track)['streamable']          if (xml).at(:track) && (xml).at(:track)['streamable']
+        t.streamable    = xml['streamable']                       if t.streamable.nil? && xml['streamable']
+        t.count         = xml['count']                            if xml['count']
+        t.album         = (xml).at(:album).inner_html             if (xml).at(:album)
+        t.album_mbid    = (xml).at(:album)['mbid']                if (xml).at(:album) && (xml).at(:album)['mbid']
+        t.date          = Time.parse((xml).at(:date).inner_html)  if (xml).at(:date)
+        t.date_uts      = (xml).at(:date)['uts']                  if (xml).at(:date) && (xml).at(:date)['uts']
+        t.thumbnail     = (xml).at(:thumbnail).inner_html         if (xml).at(:thumbnail)
+        t.image         = (xml).at(:image).inner_html             if (xml).at(:image)
+        t.reach         = (xml).at(:reach).inner_html             if (xml).at(:reach)
+        t
+      end
+    end
+    
+    def initialize(artist, name)
+      raise ArgumentError, "Artist is required" if artist.blank?
+      raise ArgumentError, "Name is required" if name.blank?
+      @artist = artist
+      @name = name
+    end
+    
+    def api_path
+      "/#{API_VERSION}/track/#{CGI::escape(artist)}/#{CGI::escape(name)}"
+    end
+    
+    def fans(force=false)
+      get_instance(:fans, :fans, :user, force)
+    end
+    
+    def tags(force=false)
+      get_instance(:toptags, :tags, :tag, force)
+    end
+  end
+end

data/lib/scrobbler/user.rb

@@ -0,0 +1,192 @@
+# 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 = Scrobbler::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
+#   ==========================
+#   Everything You Want
+#   You're a God
+#   Bitter Sweet Symphony [Original Version]
+#   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
+#   (55) Not Ready To Make Nice
+#   (45) Easy Silence
+#   (43) Song 2
+#   (40) Everybody Knows
+#   (39) Before He Cheats
+#   (39) Something's Gotta Give
+#   (38) Hips Don't Lie (featuring Wyclef Jean)
+#   (37) Unwritten
+#   (37) Move Along
+#   (37) Dance, Dance
+#   (36) We Belong Together
+#   (36) Jesus, Take the Wheel
+#   (36) Black Horse and the Cherry Tree (radio version)
+#   (35) Photograph
+#   (35) You're Beautiful
+#   (35) Walk Away
+#   (34) Stickwitu
+module Scrobbler  
+  class User < Base
+    # attributes needed to initialize
+    attr_reader :username
+    
+    # profile attributes
+    attr_accessor :id, :cluster, :url, :realname, :mbox_sha1sum, :registered
+    attr_accessor :registered_unixtime, :age, :gender, :country, :playcount, :avatar
+    
+    # neighbor attributes
+    attr_accessor :match
+    
+    # track fans attributes
+    attr_accessor :weight
+    
+    class << self
+      def new_from_xml(xml, doc=nil)
+        u        = User.new((xml)['username'])
+        u.url    = (xml).at(:url).inner_html    if (xml).at(:url)
+        u.avatar = (xml).at(:image).inner_html  if (xml).at(:image)
+        u.weight = (xml).at(:weight).inner_html if (xml).at(:weight)
+        u.match  = (xml).at(:match).inner_html  if (xml).at(:match)
+        u
+      end
+      
+      def find(*args)
+        options = {:include_profile => false}
+        options.merge!(args.pop) if args.last.is_a?(Hash)
+        users = args.flatten.inject([]) { |users, u| users << User.new(u, options); users }
+        users.length == 1 ? users.pop : users
+      end
+    end
+    
+    def initialize(username, o={})
+      options = {:include_profile => false}.merge(o)
+      raise ArgumentError if username.blank?
+      @username = username
+      load_profile() if options[:include_profile]
+    end
+    
+    def api_path
+      "/#{API_VERSION}/user/#{CGI::escape(username)}"
+    end
+    
+    def current_events(format=:ics)
+      format = :ics if format.to_s == 'ical'
+      raise ArgumentError unless ['ics', 'rss'].include?(format.to_s)
+      "#{API_URL.chop}#{api_path}/events.#{format}"
+    end
+    
+    def friends_events(format=:ics)
+      format = :ics if format.to_s == 'ical'
+      raise ArgumentError unless ['ics', 'rss'].include?(format.to_s)
+      "#{API_URL.chop}#{api_path}/friendevents.#{format}"
+    end
+    
+    def recommended_events(format=:ics)
+      format = :ics if format.to_s == 'ical'
+      raise ArgumentError unless ['ics', 'rss'].include?(format.to_s)
+      "#{API_URL.chop}#{api_path}/eventsysrecs.#{format}"
+    end
+    
+    def load_profile
+      doc                  = self.class.fetch_and_parse("#{api_path}/profile.xml")
+      @id                  = (doc).at(:profile)['id']
+      @cluster             = (doc).at(:profile)['cluster']
+      @url                 = (doc).at(:url).inner_html
+      @realname            = (doc).at(:realname).inner_html
+      @mbox_sha1sum        = (doc).at(:mbox_sha1sum).inner_html
+      @registered          = (doc).at(:registered).inner_html
+      @registered_unixtime = (doc).at(:registered)['unixtime']
+      @age                 = (doc).at(:age).inner_html
+      @gender              = (doc).at(:gender).inner_html
+      @country             = (doc).at(:country).inner_html
+      @playcount           = (doc).at(:playcount).inner_html
+      @avatar              = (doc).at(:avatar).inner_html
+    end
+    
+    def top_artists(force=false)
+      get_instance(:topartists, :top_artists, :artist, force)
+    end
+    
+    def top_albums(force=false)
+      get_instance(:topalbums, :top_albums, :album, force)
+    end
+    
+    def top_tracks(force=false)
+      get_instance(:toptracks, :top_tracks, :track, force)
+    end
+    
+    def top_tags(force=false)
+      get_instance(:toptags, :top_tags, :tag, force)
+    end
+    
+    def friends(force=false)
+      get_instance(:friends, :friends, :user, force)
+    end
+    
+    def neighbours(force=false)
+      get_instance(:neighbours, :neighbours, :user, force)
+    end
+    
+    def recent_tracks(force=false)
+      get_instance(:recenttracks, :recent_tracks, :track, force)
+    end
+    
+    def recent_banned_tracks(force=false)
+      get_instance(:recentbannedtracks, :recent_banned_tracks, :track, force)
+    end
+    
+    def recent_loved_tracks(force=false)
+      get_instance(:recentlovedtracks, :recent_loved_tracks, :track, force)
+    end
+    
+    def recommendations(force=false)
+      get_instance(:systemrecs, :recommendations, :artist, force)
+    end
+    
+    def charts(force=false)
+      get_instance(:weeklychartlist, :charts, :chart, force)
+    end
+    
+    def weekly_artist_chart(from=nil, to=nil)
+      qs  = create_query_string_from_timestamps(from, to)
+      doc = self.class.fetch_and_parse("#{api_path}/weeklyartistchart.xml#{qs}")
+      (doc/:artist).inject([]) { |elements, el| elements << Artist.new_from_xml(el); elements }
+    end
+    
+    def weekly_album_chart(from=nil, to=nil)
+      qs  = create_query_string_from_timestamps(from, to)
+      doc = self.class.fetch_and_parse("#{api_path}/weeklyalbumchart.xml#{qs}")
+      (doc/:album).inject([]) { |elements, el| elements << Album.new_from_xml(el); elements }
+    end
+    
+    def weekly_track_chart(from=nil, to=nil)
+      qs  = create_query_string_from_timestamps(from, to)
+      doc = self.class.fetch_and_parse("#{api_path}/weeklytrackchart.xml#{qs}")
+      (doc/:track).inject([]) { |elements, el| elements << Track.new_from_xml(el); elements }
+    end
+    
+    private
+      def create_query_string_from_timestamps(from, to)
+        (from && to) ? "?from=#{from.to_i}&to=#{to.to_i}" : ''
+      end
+  end
+end

data/lib/scrobbler/version.rb

@@ -0,0 +1,3 @@
+module Scrobbler
+  Version = '0.2.2'
+end

data/lib/scrobbler.rb

@@ -0,0 +1,20 @@
+%w{cgi rubygems hpricot active_support}.each { |x| require x }
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'scrobbler/base'
+require 'scrobbler/version'
+
+
+require 'scrobbler/album'
+require 'scrobbler/artist'
+require 'scrobbler/chart'
+require 'scrobbler/user'
+require 'scrobbler/tag'
+require 'scrobbler/track'
+
+require 'scrobbler/simpleauth'
+require 'scrobbler/scrobble'
+require 'scrobbler/playing'
+
+require 'scrobbler/rest'