hornairs-scrobbler 0.2.3

data/.gitignore

@@ -0,0 +1,13 @@
+rdoc
+doc/*
+pkg/*
+nbproject
+scrobbler-*.gem
+*.rb~
+*.rake~
+coverage
+spec.html
+catalog.xml
+.yardoc
+.project
+.settings

data/.loadpath

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<loadpath>
+	<pathentry path="" type="src"/>
+	<pathentry path="org.rubypeople.rdt.launching.RUBY_CONTAINER" type="con"/>
+</loadpath>

data/History.txt

@@ -0,0 +1,5 @@
+* v 0.2.13: Nearly all API calls are now done via version 2.0 of the API
+* v 0.2.10: Upgraded to using the 2.0 API for parts of the code and added in the ability to search
+* v 0.2.2: a bunch of changes from titanous, mostly refactoring
+* v 0.2.0: added support for scrobbling tracks and now playing submission (Titanous)
+* v 0.1.0: initial release

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007-2009 John Nunemaker, Kurt Schrader, Uwe L. Korn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest

@@ -0,0 +1,75 @@
+lib/scrobbler/geo.rb
+lib/scrobbler/search.rb
+lib/scrobbler/rest.rb
+lib/scrobbler/track.rb
+lib/scrobbler/simpleauth.rb
+lib/scrobbler/base.rb
+lib/scrobbler/version.rb
+lib/scrobbler/event.rb
+lib/scrobbler/playing.rb
+lib/scrobbler/artist.rb
+lib/scrobbler/scrobble.rb
+lib/scrobbler/user.rb
+lib/scrobbler/album.rb
+lib/scrobbler/tag.rb
+lib/scrobbler/playlist.rb
+lib/scrobbler.rb
+scrobbler.gemspec
+MIT-LICENSE
+Rakefile
+History.txt
+setup.rb
+README.rdoc
+examples/track.rb
+examples/artist.rb
+examples/scrobble.rb
+examples/user.rb
+examples/album.rb
+examples/tag.rb
+examples/playlist.rb
+test/unit/album_test.rb
+test/unit/playing_test.rb
+test/unit/scrobble_test.rb
+test/unit/artist_test.rb
+test/unit/chart_test.rb
+test/unit/track_test.rb
+test/unit/tag_test.rb
+test/unit/geo_test.rb
+test/unit/search_test.rb
+test/unit/simpleauth_test.rb
+test/unit/user_test.rb
+test/test_helper.rb
+test/mocks/rest.rb
+test/fixtures/xml/geo/top_artists.xml
+test/fixtures/xml/geo/events.xml
+test/fixtures/xml/album/info.xml
+test/fixtures/xml/track/toptags.xml
+test/fixtures/xml/track/fans.xml
+test/fixtures/xml/artist/toptags.xml
+test/fixtures/xml/artist/similar.xml
+test/fixtures/xml/artist/topalbums.xml
+test/fixtures/xml/artist/toptracks.xml
+test/fixtures/xml/artist/fans.xml
+test/fixtures/xml/tag/toptags.xml
+test/fixtures/xml/tag/topalbums.xml
+test/fixtures/xml/tag/toptracks.xml
+test/fixtures/xml/tag/topartists.xml
+test/fixtures/xml/search/track.xml
+test/fixtures/xml/search/artist.xml
+test/fixtures/xml/search/album.xml
+test/fixtures/xml/user/toptags.xml
+test/fixtures/xml/user/recentbannedtracks.xml
+test/fixtures/xml/user/topalbums.xml
+test/fixtures/xml/user/toptracks.xml
+test/fixtures/xml/user/recentlovedtracks.xml
+test/fixtures/xml/user/weeklytrackchart.xml
+test/fixtures/xml/user/weeklyalbumchart.xml
+test/fixtures/xml/user/recenttracks.xml
+test/fixtures/xml/user/friends.xml
+test/fixtures/xml/user/profile.xml
+test/fixtures/xml/user/weeklyartistchart.xml
+test/fixtures/xml/user/topartists.xml
+test/fixtures/xml/user/systemrecs.xml
+test/fixtures/xml/user/neighbours.xml
+test/fixtures/xml/user/lovedtracks.xml
+Manifest

data/README.rdoc

@@ -0,0 +1,104 @@
+=Scrobbler
+
+Scrobbler is a wrapper for the audioscrobbler web services (http://www.audioscrobbler.net/data/webservices/). 
+
+Currently updating to use the 2.0 API. It is very much a work in progress.
+
+Below is just a sampling of how easy this lib is to use, full documentation of
+all functions is available at http://rdoc.info/projects/xhochy/scrobbler
+
+== Initialization
+
+  Scrobbler::Base.api_key = 'foo123'
+
+== Users
+
+  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}" }
+	
+== Albums
+	
+  album = Scrobbler::Album.new('Some Hearts', :artist => 'Carrie Underwood', :include_info => true)
+
+  puts "Album: #{album.name}"
+  puts "Artist: #{album.artist}"
+  puts "Playcount: #{album.playcount}"
+  puts "URL: #{album.url}"
+  puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
+	
+==Artists
+	
+  artist = Scrobbler::Artist.new('Carrie Underwood')  
+  
+  puts 'Top Tracks'
+  puts "=" * 10
+  artist.top_tracks.each { |t| puts "(#{t.playcount}) #{t.name}" }
+
+  puts
+
+  puts 'Similar Artists'
+  puts "=" * 15
+  artist.similar.each { |a| puts "(#{a.match}%) #{a.name}" }
+
+==Geo
+
+  geo = Scrobbler::Geo.new()
+
+  puts 'Events'
+  puts "=" * 10
+  geo.events(:location => 'Manchester').each { |e| puts "(#{e.id}) #{e.title}" }
+
+  puts
+
+  puts 'Top Artists'
+  puts "=" * 10
+  geo.top_artists(:location => 'Manchester').each { |a| puts "(#{a.name}) #{a.playcount}" }
+
+  puts
+
+  puts 'Top Tracks'
+  puts "=" * 10
+  geo.top_tracks(:location => 'Manchester').each { |t| puts "(#{a.name}) #{a.playcount}" }
+
+	
+==Tags	
+	
+  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}" }
+	
+==Tracks
+	
+  track = Scrobbler::Track.new('Carrie Underwood', 'Before He Cheats')
+  puts 'Fans'
+  puts "=" * 4
+  track.top_fans.each { |u| puts "(#{u.weight}) #{u.username}" }
+	
+== Simple Authentication (for Scrobbling)
+
+  work in progress...
+    
+== Scrobbling
+
+  work in progress...
+
+== Now Playing Submission
+
+  work in progress...
+

data/Rakefile

@@ -0,0 +1,10 @@
+# Rakefile
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+ 
+task :default => 'test:unit'

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:patch: 3
+:major: 0
+:minor: 2
+:build: 

data/examples/album.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+Scrobbler::Base::api_key = "cc85b6d4313e40450230872430b4d631";
+
+album = Scrobbler::Album.new('Carrie Underwood', 'Some Hearts', :include_all_info => true)
+
+puts "Album: #{album.name}"
+puts "Album ID: #{album.album_id}"
+puts "Artist: #{album.artist}"
+puts "Playcount: #{album.playcount}"
+puts "URL: #{album.url}"
+puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
+
+puts
+puts
+
+# puts "Tracks"
+# longest_track_name = album.tracks.collect(&:name).sort { |x, y| y.length <=> x.length }.first.length
+# puts "=" * longest_track_name
+# album.tracks.each { |t| puts t.name }

data/examples/artist.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+artist = Scrobbler::Artist.new('Carrie Underwood')
+
+puts 'Top Tracks'
+puts "=" * 10
+artist.top_tracks.each { |t| puts "(#{t.reach}) #{t.name}" }
+
+puts
+
+puts 'Similar Artists'
+puts "=" * 15
+artist.similar.each { |a| puts "(#{a.match}%) #{a.name}" }

data/examples/playlist.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+require 'pp'
+
+Scrobbler::Base::api_key = "cc85b6d4313e40450230872430b4d631";
+
+playlist = Scrobbler::Playlist.new('lastfm://playlist/album/2317937')
+pp playlist

data/examples/scrobble.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+auth = Scrobbler::SimpleAuth.new(:user => 'chunky', :password => 'bacon')
+auth.handshake!
+
+puts "Auth Status: #{auth.status}"
+puts "Session ID: #{auth.session_id}"
+puts "Now Playing URL: #{auth.now_playing_url}"
+puts "Submission URL: #{auth.submission_url}"
+
+scrobble = Scrobbler::Scrobble.new(:session_id => auth.session_id,
+                                   :submission_url => auth.submission_url,
+                                   :artist => 'Coldplay',
+                                   :track => 'Viva La Vida',
+                                   :album => 'Viva La Vida',
+                                   :time => Time.new,
+                                   :length => 244,
+                                   :track_number => 7)
+scrobble.submit!
+puts "Scrobbler Submission Status: #{scrobble.status}"
+
+playing = Scrobbler::Playing.new(:session_id => auth.session_id,
+                                 :now_playing_url => auth.now_playing_url,
+                                 :artist => 'Anberlin',
+                                 :track => 'A Day Late',
+                                 :album => 'Never Take Friendship Personal',
+                                 :length => 214,
+                                 :track_number => 5)
+                                 
+playing.submit!         
+puts "Playing Submission Status: #{playing.status}"      

data/examples/tag.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+
+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}" }

data/examples/track.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+require 'pp'
+
+Scrobbler::Base::api_key = "cc85b6d4313e40450230872430b4d631";
+
+track = Scrobbler::Track.new('Carrie Underwood', :name => 'Before He Cheats', :include_info => true)
+puts "Name: #{track.name}"
+puts "Album: #{track.album.name}"
+puts "Artist: #{track.artist.name}"
+puts "Playcount: #{track.playcount}"
+puts "URL: #{track.url}"
+

data/examples/user.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'scrobbler'))
+require 'pp'
+user = Scrobbler::User.new('hornairs')
+pp user
+# 
+# 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}" }

data/lib/scrobbler.rb

@@ -0,0 +1,33 @@
+%w{uri rubygems libxml active_support pp}.each { |x| require x }
+require 'digest/md5'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+# Load base class
+require 'scrobbler/base'
+
+# Load helper modules
+require 'scrobbler/helper/image'
+require 'scrobbler/helper/streamable'
+
+require 'scrobbler/album'
+require 'scrobbler/artist'
+require 'scrobbler/event'
+require 'scrobbler/shout'
+require 'scrobbler/venue'
+require 'scrobbler/geo'
+require 'scrobbler/user'
+require 'scrobbler/session'
+require 'scrobbler/tag'
+require 'scrobbler/track'
+
+require 'scrobbler/auth'
+require 'scrobbler/library'
+require 'scrobbler/playlist'
+require 'scrobbler/radio'
+
+require 'scrobbler/simpleauth'
+require 'scrobbler/scrobble'
+require 'scrobbler/playing'
+
+require 'scrobbler/rest'

data/lib/scrobbler/album.rb

@@ -0,0 +1,181 @@
+# Getting information about an album such as release date and the tracks on it is very easy.
+# 
+#   album = Scrobbler::Album.new('Carrie Underwood', 'Some Hearts', :include_info => true)
+# 
+#   puts "Album: #{album.name}"
+#   puts "Artist: #{album.artist}"
+#   puts "Reach: #{album.reach}"
+#   puts "URL: #{album.url}"
+#   puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
+# 
+#   puts
+#   puts
+# 
+#   puts "Tracks"
+#   longest_track_name = album.tracks.collect(&:name).sort { |x, y| y.length <=> x.length }.first.length
+#   puts "=" * longest_track_name
+#   album.tracks.each { |t| puts t.name }
+#
+# Would output:
+#
+#   Album: Some Hearts
+#   Artist: Carrie Underwood
+#   Reach: 18729
+#   URL: http://www.last.fm/music/Carrie+Underwood/Some+Hearts
+#   Release Date: 11/15/2005
+# 
+# 
+#   Tracks
+#   ===============================
+#   Wasted
+#   Don't Forget to Remember Me
+#   Some Hearts
+#   Jesus, Take the Wheel
+#   The Night Before (Life Goes On)
+#   Lessons Learned
+#   Before He Cheats
+#   Starts With Goodbye
+#   I Just Can't Live a Lie
+#   We're Young and Beautiful
+#   That's Where It Is
+#   Whenever You Remember
+#   I Ain't in Checotah Anymore
+#   Inside Your Heaven
+#
+module Scrobbler
+  # @todo Add missing functions that require authentication
+  class Album < Base
+    mixins :image
+    
+    attr_reader :artist, :album_id, :artist_mbid, :name, :mbid, :playcount, :rank, :url
+    attr_reader :reach, :release_date, :listeners, :playcount, :top_tags
+    attr_reader :image_large, :image_medium, :image_small, :tagcount
+    
+    # needed on top albums for tag
+    attr_reader :count, :playlist
+    
+    # needed for weekly album charts
+    attr_reader :chartposition, :position
+    
+    class << self
+      
+      def new_from_xml(xml, o = {})
+        data = self.data_from_xml(xml)
+        return nil if data[:name].empty?
+        Album.new(data[:artist], data[:name], data)
+      end
+      
+      def data_from_xml(xml, o = {})
+        data = {}
+        o = {:include_artist_info => true}.merge(o) 
+        xml.children.each do |child|
+          data[:name] = child.content if ['name', 'title'].include?(child.name)
+          data[:album_id] = child.content.to_i if child.name == 'id'
+          data[:playcount] = child.content.to_i if child.name == 'playcount'
+          data[:tagcount] = child.content.to_i if child.name == 'tagcount'
+          data[:release_date] = Time.parse(child.content.strip) if child.name == 'releasedate'
+          data[:listeners] = child.content.to_i if child.name == 'listeners'
+          data[:mbid] = child.content if child.name == 'mbid'
+          data[:url] = child.content if child.name == 'url'
+          data[:artist] = Artist.new_from_xml(child) if (child.name == 'artist' || child.name == 'creator') && o[:include_artist_info]
+          maybe_image_node(data, child)
+          if child.name == 'toptags'
+            data[:top_tags] = []
+            child.children.each do |grandchild|
+              next unless grandchild.name == 'tag'
+              data[:top_tags] << Tag.new_from_xml(grandchild)
+            end
+          end  
+        end
+                
+        # If we have not found anything in the content of this node yet then
+        # this must be a simple artist node which has the name of the artist
+        # as its content
+        data[:name] = xml.content if data == {}
+        
+        # Get all information from the root's attributes
+        data[:mbid] = xml['mbid'] if xml['mbid']
+        data[:rank] = xml['rank'].to_i if xml['rank']
+        data[:position] = xml['position'].to_i if xml['position']
+        
+        # If there is no name defined, than this was an empty album tag
+        return nil if data[:name].empty?
+        data
+      end
+    end
+      
+    # If the additional parameter :include_info is set to true, additional 
+    # information is loaded
+    #
+    # @todo Albums should be able to be created via a MusicBrainz id too
+    def initialize(artist, name, data={})    
+      super()
+      raise ArgumentError, "Artist or MBID is required" if artist.blank?
+      
+      #check for old style parameter arguments, infer MBID if only an artist is given
+      if artist.class == String && name.blank? && data == {}
+        raise ArgumentError, "MBID is required for an MBID query" if input.blank?
+        @mbid = input
+        load_album_info() # data must be fetched since all we have is an mbid, nothing else useful
+      else
+        raise ArgumentError, "Artist is required" if artist.blank?
+        raise ArgumentError, "Album Name is required" if name.blank?
+        @artist = Artist.new(artist)
+        @name = name
+        load_album_info() if data[:include_info] || data[:include_all_info]
+        load_track_info() if data[:include_all_info]
+      end
+    end
+    
+    # Indicates if the album info was already loaded
+    @album_info_loaded = false 
+    
+    # Load additional information about this album
+    #
+    # Calls "album.getinfo" REST method
+    #
+    # @todo Parse wiki content
+    # @todo Add language code for wiki translation
+     def load_album_info
+      return nil if @album_info_loaded
+      params = @mbid ? {'mbid' => @mbid} : {'artist' => @artist.name, 'album' => @name}
+      xml = Base.request('album.getinfo', params)
+      unless xml.root['status'] == 'failed'
+        xml.root.children.each do |child|
+          next unless child.name == 'album'
+          data = self.class.data_from_xml(child)
+          populate_data(data)
+          @album_info_loaded = true
+          break
+        end # xml.children.each do |child|
+      end
+    end
+    
+    # Indicates if the album info was already loaded
+    @track_info_loaded = false
+    def load_track_info
+       return nil if @track_info_loaded
+       load_album_info() if !@album_info_loaded
+       @playlist = Playlist.new_from_album(self)
+       @tracks = @playlist.tracks
+    end
+    
+    # Tag an album using a list of user supplied tags. 
+    def add_tags(tags)
+        # This function require authentication, but SimpleAuth is not yet 2.0
+        raise NotImplementedError
+    end
+
+    # Get the tags applied by an individual user to an album on Last.fm.
+    def tags()
+        # This function require authentication, but SimpleAuth is not yet 2.0
+        raise NotImplementedError
+    end
+
+    # Remove a user's tag from an album.
+    def remove_tag()
+        # This function require authentication, but SimpleAuth is not yet 2.0
+        raise NotImplementedError
+    end
+  end
+end