lastfm12 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-28
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/lastfm12.rb
+lib/lastfm12/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_lastfm12.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on lastfm12, see http://lastfm12.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= lastfm12
+
+* http://lastfm12.rubyforge.org/
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,77 @@
+require 'lastfm12/version'
+
+AUTHOR = 'Keiichiro Ui'  # can also be an array of Authors
+EMAIL = "keiichiro.ui@gmail.com"
+DESCRIPTION = "lastfm12 is a wrapper around the Last.fm protocol version 1.2. This library can manipulate the last.fm radio streams. So, you can implement easily the last.fm radio."
+GEM_NAME = 'lastfm12' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'lastfm12' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+EXTRA_DEV_DEPENDENCIES = [
+#  ['rspec', '>= 1.1.5']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "kui"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Lastfm12::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'lastfm12 documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description    = DESCRIPTION
+  p.summary        = DESCRIPTION
+  p.url            = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs     = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes        = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps     = EXTRA_DEPENDENCIES
+  p.extra_dev_deps = EXTRA_DEV_DEPENDENCIES
+
+    p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/lastfm12/version.rb

@@ -0,0 +1,10 @@
+module Lastfm12
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+    self
+  end
+end

data/lib/lastfm12.rb

@@ -0,0 +1,491 @@
+#
+#=lastfm12
+#
+#Author:: {Keiichiro Ui}[http://k-ui.jp] (keiichiro.ui[at]gmail.com)
+#Version:: 0.1
+#License:: MIT License
+#
+#==Simplest Example
+#
+#Playing Queen's similar tracks with mpg123
+#
+# require "lastfm12"
+# hash = {
+#   :user_name => "username",
+#   :password => "password",
+#   :station => ["artist", "queen"]
+# }
+# loop do
+#   LastFM12.get_tracks(hash).each do |t|
+#     `mpg123 #{t.location}`
+#   end
+# end
+#
+#==Basic Example
+#
+#Downloading tracks tagged as "electoronic"
+#
+# require "lastfm12"
+#
+# lastfm = LastFM12.new("username", "password")
+#
+# # Adjusting the electoronic tag radio station 
+# lastfm.adjust_station("tag", "electoronic")
+#
+# # Downloading tracks
+# loop do
+#   lastfm.get_tracks.each do |track|
+#     puts "-------------------------------------------"
+#     puts "artist: #{track.artist}"
+#     puts "title:  #{track.title}"
+#     puts "album:  #{track.album}"
+#     puts "length: #{track.length/1000}[sec]"
+#     `wget #{track.location}`
+#   end
+# end
+#
+#
+#==Reference
+#
+#* {LastFM12UnofficialDocumentation}[http://code.google.com/p/thelastripper/wiki/LastFM12UnofficialDocumentation]
+#
+#==Change Log
+#
+#- Ver.0.1 Sun Oct 19 2008
+#  - Create lastfm12.rb
+#
+
+require "net/http"
+require "uri"
+require "cgi"
+require "digest/md5"
+require "rexml/document"
+
+#main class
+class LastFM12
+
+  HANDSHAKE_HOST='ws.audioscrobbler.com'
+  HANDSHAKE_PATH='/radio'
+  HANDSHAKE_SCRIPT='handshake.php'
+  ADJUST_SCRIPT='adjust.php'
+  PLAYLIST_SCRIPT='xspf.php'
+
+  DEFAULT_USER_AGENT='Ruby-Lastfm12'
+  
+  #Handshake with ws.audioscrobbler.com
+  #[_username_]
+  # an account name on last.fm
+  #[_password_]
+  # an password for the account
+  #[_opt_]
+  # a hash as Fig.A
+  #
+  #===Fig.A
+  #_key_:: _value_
+  #:user_agent or "user_agent":: an string used as an user agent name for handshake, ajusting radio station and playlist requests
+  #:station or "staion":: an array of strings such as ["tag","electoro"]. refer _adjust_station_ method
+  #:verbose or "verbose":: true: output oparations, false: no output
+
+  def initialize(username,password,opt=nil)
+    
+    @user_name = username.to_s
+    @password = password.to_s
+    
+    @user_agent=DEFAULT_USER_AGENT
+    @station = nil
+    @verbose = $DEBUG
+    if opt.class == Hash
+      opt.each do |k,v|
+        case k
+        when "user_agent",:user_agent
+          @user_agent = v.to_s
+        when "station", :station
+          @station = _make_lastfm_url(*(v.to_a))
+        when "verbose", :verbose
+          @verbose = true
+        end
+      end
+    end
+
+    @session = nil
+    @base_url = nil
+    @base_path = nil
+    _handshake
+
+    if @station
+      _adjust_station(@station)
+    end
+
+    @@instance=self
+
+  end
+  attr_reader :user_name, :user_agent, :station, :verbose
+
+  #Adjusting a station specified as arguments
+  #===Arguments
+  #These argments class should be Symbol class or String class.
+  #_param_name_:: Discription
+  #personal:: _param_'s personal radio station
+  #artist:: _param_'s similar radio station
+  #tag or globaltags:: a radio station having tracks tagged as _param_
+  #group:: a radio statio for _param_ group
+  #neighbours:: _param_'s neighbours radio station
+  #recommended:: _param_'s recommended radio station
+  def adjust_station(param_name,param)
+
+    station = _make_lastfm_url(param_name, param)
+
+    if @station == station
+      puts "Already Adjusted The Station" if @verbose
+      return station
+    else
+      @station = station
+    end
+
+    _adjust_station(@station)
+
+  end
+
+  #Getting tracks
+  #Return a array of tracks.
+  #[_num_] the minimun number of tracks
+  #===Note
+  #The length of the returned array is vary. So, sometime, _get_tracks_ get no track.
+  #Give _min_num_tracks_, if you want to get tracks more than _min_num_tracks_.
+  def get_tracks(min_num_tracks=nil)
+
+    ret = []
+    count = 0
+
+    if min_num_tracks
+
+      while ret.length < min_num_tracks
+
+        ret = ret + _get_tracks
+        
+        if @verbose
+          z = ret.length.zero?
+          puts "#{z ? '' : 'Success'} Getting #{z ? 'No' : ret.length } Tracks"
+        end
+
+      end
+
+    else
+      ret = _get_tracks
+    end
+
+    ret
+
+  end
+
+  def play_loop(&block)
+
+    loop do
+      self.get_tracks(1).each(&block)
+    end
+
+  end
+
+  def LastFM12.play_loop(*args,&block)
+
+    if args.length == 1 and args[0].kind_of?(Hash)
+      hash = args[0]
+    elsif args.length == 3 and args[2].kind_of?(Hash)
+      hash = args[2]
+      hash[:user_name] = args[0]
+      hash[:password] = args[1]
+    end
+
+    new_hash = Hash.new
+    hash.each{|k,v|new_hash[k.to_sym]=new_hash[k.to_s]=v}
+    hash = new_hash
+
+    if @@instance.nil? or @@instance.user_name != hash[:user_name]
+      @@instance = LastFM12.new(hash[:user_name],hash[:password],hash)
+    else
+      puts "Skip Handshake" if @@instance.verbose
+    end
+
+    @@instance.play_loop(&block)
+
+  end
+  @@instance=nil
+
+  #a class for tracks
+  class Track
+    
+    def initialize(hash)
+      if hash.class != Hash
+        raise ArgumentError
+      end
+      @hash = hash
+    end
+
+    def [](key)
+      @hash[key]
+    end
+
+    #A redirection URL to another URL
+    #* Cannot make multi-connetion with the URL.
+    #* Cannot make a connection after second  with the URL.
+    def location
+      @hash[:location]
+    end
+
+    # a title of the track
+    def title
+      @hash[:title]
+    end
+    #alias _title_
+    def name
+      title
+    end
+
+    # a album name of the track
+    def album
+      @hash[:album]
+    end
+
+    # a creator name of the track
+    def creator
+      @hash[:creator]
+    end
+    # alias _creator_ 
+    def artist
+      creator
+    end
+
+    # seconds of the track
+    def duration
+      @hash[:duration].to_i
+    end
+
+    # alias _duration_ 
+    def length
+      duration
+    end
+
+    # an URL of the track image
+    def image_url
+      @hash[:image]
+    end
+
+    # a station name
+    def station
+      @hash[:station]
+    end
+
+    #execute a given block against the mp3 stream
+    #the block is given a segument data of mp3
+    def play(&block)
+      
+      uri = URI(@hash[:location])
+      ret = nil
+      redirect_flag = true
+      
+      while redirect_flag
+
+        host = uri.host
+        path = uri.path
+        path = path + "?" + uri.query if uri.query
+        redirect_flag = false
+      
+        header = {
+          'Host' => host,
+          'User-Agent' => @hash[:user_agent],
+        }
+        Net::HTTP.new(host).request_get(path,header) do |res|
+
+          if res.code.match(/^30[0-3]$/)
+            uri = URI(res['location'])
+            redirect_flag = true
+            next
+          end
+
+          res.read_body(&block)
+
+        end
+      end # of "begin"
+
+      ret
+      
+    end # of "def play(&block)"
+
+
+  end # of "class Track"
+
+  #General exception for Lastfm12
+  class Error < Exception; end
+
+  #Exception class for errors of handshake
+  class HandshakeError < Error; end
+
+  #Exception class for errors of adjusting radion station
+  #There ar 9 exception messages:
+  #* There is not enough content to play the station. Due to restrictions imposed by the music labels, a radio station must have more than 15 tracks; each by different artists.
+  #* The group does not have enough members to have a radio station.
+  #* The stream has stopped. Please try again later, or try another station.
+  #* The user does not have enough neighbors to have a radio station.
+  #* The station is available to subscribers only.
+  #* The station is not available for streaming.
+  #* The artist does not have enough fans to have a radio station.
+  #* An unknown error occurred.
+  #referred to on {adjust.php error codes}[http://www.lastfm.de/forum/21716/_/380495/1#f5829616]
+  class AdjustingError < Error;
+    Messages = ['There is not enough content to play the station. Due to restrictions imposed by the music labels, a radio station must have more than 15 tracks; each by different artists.',
+                'The group does not have enough members to have a radio station.',
+                'The artist does not have enough fans to have a radio station.',
+                'The station is not available for streaming.',
+                'The station is available to subscribers only.',
+                'The user does not have enough neighbors to have a radio station.',
+                'An unknown error occurred.']
+  end
+
+  #Exception class of getting tracks
+  class GettingTracksError < Error; end
+
+  private
+
+  def _handshake
+
+    ret = nil
+
+    h = {
+      'version' => '1.3.1.1',
+      'platform' => 'linux',
+      'username' => @user_name,
+      'passwordmd5' => Digest::MD5.hexdigest(@password),
+    }
+    query = _make_http_query(h)
+    path = "%s/%s?%s" % [HANDSHAKE_PATH,HANDSHAKE_SCRIPT,query]
+    header = {
+      'Host' => HANDSHAKE_HOST,
+      'User-Agent' => @user_agent,
+    }
+    Net::HTTP.new(HANDSHAKE_HOST).request_get(path,header) do |res|
+      #ph res
+      ret = Hash[*res.body.split("\n").map{|i|i.split('=',2)}.flatten]
+      #ph ret
+      @session = ret['session']
+      @base_url = ret['base_url']
+      @base_path = ret['base_path']
+      if @session.nil? or @base_url.nil? or @base_path.nil?
+        raise HandshakeError, "handshake error(session: #{@session}, base_url#{@base_url}, base_path: #{@base_path})"
+      else
+        puts "Success Handshake" if @verbose
+      end
+    end
+
+    ret
+
+  end
+
+  def _adjust_station(url)
+
+    ret = nil
+
+    h = {
+      'session' => @session,
+      'url' => @station,
+      'lang' => 'en'
+    }
+    query = _make_http_query(h)
+    path = "%s/%s?%s" % [@base_path,ADJUST_SCRIPT,query]
+    header = {
+      'Host' => @base_url,
+      'User-Agent' => @user_agent,
+    }
+    Net::HTTP.new(@base_url).request_get(path,header) do |res|
+      #ph res
+      ret = Hash[*res.body.split("\n").map{|i|i.split('=',2)}.flatten]
+      #ph ret
+      if ret['response'] == 'FAILED'
+        raise AdjustingError, AdjustingError::Messages[ret['error'].to_i-1]
+      else
+        puts "Success Adjusting #{ret[%[stationname]]} Station" if @verbose
+      end
+    end
+
+    ret['stationname']
+
+  end
+
+  def _get_tracks
+
+    ret = nil
+
+    h = {
+      'sk' => @session,
+      'desktop' => '1.4.2.58376',
+    }
+    query = _make_http_query(h)
+    path = "%s/%s?%s" % [@base_path,PLAYLIST_SCRIPT,query]
+    header = {
+      'Host' => @base_url,
+      'User-Agent' => @user_agent,
+    }
+    tracks = Array.new
+
+    xpath = '/playlist/trackList/track'
+    Net::HTTP.new(@base_url).request_get(path+query) do |res|
+
+      xspf = REXML::Document.new(res.body)
+      station = xspf.elements['/playlist/title']
+      if station.nil? or station.text.nil?
+        puts "Failure of Getting the Playlist Title" if @verbose
+        return []
+      end
+
+      station = station.text
+      station = CGI.unescape(station)
+      xspf.each_element(xpath) do |ele|
+        tr = Hash.new
+        ele.each_element do |child|
+          tr[child.name.to_sym] = child.text
+        end
+        tr[:station] = station
+        tr[:user_agent] = @user_agent
+        tracks << Track.new(tr)
+      end
+    end # End of "Net::HTTP.new(@base_url).request_get(..."
+
+    tracks
+  end
+
+  def _make_http_query(hash)
+    hash.to_a.map{|a|a.join('=')}.join('&')
+  end
+
+  def ph(h)
+    puts "-"*20 + h.class.to_s + "-"*20
+    h.each{|k,v|puts " #{k}\t=> #{v}"}
+  end
+
+  # make a last.fm url
+  def _make_lastfm_url(param_name,param)
+    tmp = "lastfm://%s/%s"
+    param_name = param_name.to_sym
+    param = URI.encode(param.to_s)
+    case param_name
+    when :personal
+      tmp % ["user", "#{param}/personal"]
+    when :tag, :tags, :globaltags
+      tmp % ["globaltags", param]
+    when :creator, :artist
+      tmp % ["artist", param]
+    when :group
+      tmp % ["group", param]
+    when :neighbours
+      tmp % ["user", "#{param}/neighbours"]
+    when :recommended
+      tmp % ["user", "#{param}/recommended/100"]
+    end
+  end
+
+end
+
+if $0 == __FILE__
+  Lastfm12.new("daftbeats","iamcrz4b",:station => ["tag","bossa"]).get_tracks.each do |tr|
+    puts tr
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/lastfm12.rb'}"
+puts "Loading lastfm12 gem"
+exec "#{irb} #{libs} --simple-prompt"