sandro-rlastfm 0.0.2

data/History.txt

@@ -0,0 +1,5 @@
+== 0.0.2 / 2009-03-09
+* Birthday
+
+== 0.0.1 / 2009-03-09
+* Initial Release

data/README.txt

@@ -0,0 +1,63 @@
+rlastfm
+    by Sandro Turriate
+    http://turriate.com
+
+== DESCRIPTION:
+
+Extremely minimal Last.fm wrapper.
+This wrapper allows you to lookup an Artist by name, get their albums, and the tracks for each album.
+
+== SYNOPSIS:
+
+>> Rlastfm.api_key = "your lastfm api key"
+>> Rlastfm.debug = true # watch the requests you make
+
+>> artist = Rlastfm::Artist.new('radiohead')
+=> #<Rlastfm::Artist:0x115bed0 @initialized_name="radiohead">
+
+>> artist.name
+=> "Radiohead"
+
+>> artist.albums
+[#<Rlastfm::Album:0xd598>, #<Rlastfm::Album:0xd599>]
+
+>> artist.albums.first.name
+=> "In Rainbows"
+
+>> artist.albums.first.tracks
+[#<Rlastfm::Track:0x18f38f0>, #<Rlastfm::Track:0x18f38f1>]
+
+== REQUIREMENTS:
+
+* hpricot
+* httparty
+* fakeweb (to run specs)
+
+== INSTALL:
+
+  FIXME
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008
+
+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,35 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'rlastfm'
+
+task :default => 'spec:run'
+
+PROJ.name = 'rlastfm'
+PROJ.summary = "minimal Last.fm wrapper."
+PROJ.description = %Q(#{PROJ.summary}
+This wrapper allows you to lookup an Artist by name, get their albums, and the tracks for each album.)
+PROJ.authors = 'Sandro Turriate'
+PROJ.email = 'sandro.turriate@gmail.com'
+PROJ.url = 'http://turriate.com'
+PROJ.version = Rlastfm::VERSION
+PROJ.rubyforge.name = 'rlastfm'
+PROJ.gem.development_dependencies = []
+
+PROJ.spec.opts << '--color'
+PROJ.ignore_file = '.gitignore'
+
+# EOF

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), %w(lib rlastfm))

data/lib/core_extensions.rb

@@ -0,0 +1,30 @@
+class Hash
+  def stringify_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+
+  # Destructively convert all keys to strings.
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+
+  # Return a new hash with all keys converted to symbols.
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+  # Destructively convert all keys to symbols.
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+end
+

data/lib/rlastfm.rb

@@ -0,0 +1,83 @@
+module Rlastfm
+  # :stopdoc:
+  VERSION = '0.0.2'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+  class << self
+    attr_accessor :api_key, :debug
+  end
+
+  self.debug = false
+end  # module Rlastfm
+
+%w(rubygems hpricot open-uri httparty).each { |l| require l }
+
+module HTTParty
+  class Request
+    def perform_with_debug
+      if Rlastfm.debug
+        puts "Performing request to: #{uri.to_s}"
+      end
+      perform_without_debug
+    end
+
+    alias_method :perform_without_debug, :perform
+    alias_method :perform, :perform_with_debug
+
+    def query_string_with_sorting(uri)
+      unsorted = query_string_without_sorting(uri)
+      unsorted.split("&").sort.join("&") if unsorted
+    end
+
+    alias_method :query_string_without_sorting, :query_string
+    alias_method :query_string, :query_string_with_sorting
+  end
+end
+
+
+helper_libs = File.join(File.dirname(__FILE__), %w(rlastfm helpers *.rb))
+Dir.glob(helper_libs).each { |l| require l }
+
+require File.join(File.dirname(__FILE__), 'core_extensions')
+
+Rlastfm.require_all_libs_relative_to(__FILE__)
+
+# EOF

data/lib/rlastfm/album.rb

@@ -0,0 +1,42 @@
+module Rlastfm
+  class Album
+    include Helpers::Scraper
+
+    attr_reader :raw
+    attr_accessor :artist, :images, :name, :play_count, :rank, :url
+
+    def initialize(hash={})
+      @raw = hash.stringify_keys!
+      @images = hash['images'] || hash['image']
+      @name = hash['name']
+      @play_count = hash['play_count'] || hash['playcount']
+      @rank = hash['rank']
+      @url = hash['url']
+      if (a = hash['artist'])
+        @artist = a.is_a?(Hash) ? a['name'] : a
+      end
+    end
+
+    def tracks
+      @tracks ||= get_tracks
+    end
+
+    private
+
+    def get_tracks
+      doc = doc_for(url)
+      artist_container = doc.at(".albumHead h1")
+      artist = artist_container.at("a").inner_text
+      track_container = doc.at("#albumTracklist")
+
+      track_container.search("tbody tr").map do |row|
+        Track.new \
+          :artist => artist,
+          :album => name,
+          :number => row.at(".positionCell").to_plain_text,
+          :name => row.at(".subjectCell a").inner_text,
+          :duration => row.at(".durationCell").to_plain_text
+      end
+    end
+  end
+end

data/lib/rlastfm/artist.rb

@@ -0,0 +1,67 @@
+module Rlastfm
+  class Artist
+    extend Helpers::RemoteAccessor
+    include Helpers::Scraper
+    include HTTParty
+
+    base_uri "http://ws.audioscrobbler.com/2.0/"
+
+    remote_reader :name, :mbid, :stats, :url, :bio
+    remote_reader :from => :image, :to => :images
+
+    def self.top_twenty
+      doc = doc_for("/charts/artist")
+      top_twenty = doc.at('.mediumImageChart')
+      top_twenty.search('tr').map do |artist_row|
+        name =  artist_row.search('.subject < a').last
+        new name
+      end
+    end
+
+    def initialize(name)
+      self.class.default_params :api_key => Rlastfm.api_key
+      @initialized_name = name
+    end
+
+    def album_by_name(album_name)
+      albums.detect {|a| a.name == album_name}
+    end
+
+    def albums
+      @albums ||= begin
+        response = self.class.get('', :query => {:method => "artist.gettopalbums", :artist => name})
+        album_collection = response['lfm']['topalbums']['album']
+        album_collection.map{|album_attrs| Album.new album_attrs} if album_collection
+      end
+    end
+
+    def exists?
+      ! mbid.nil?
+    end
+
+    def raw
+      @raw ||= remote_sync!
+    end
+
+    def similar_artists
+      @similar_artists ||= begin
+        raw['similar']['artist'].map do |artist|
+          Artist.new artist['name']
+        end
+      end
+    end
+
+    private
+
+    def remote_sync!
+      response = self.class.get('', :query => {:method => 'artist.getinfo', :artist => @initialized_name})
+      @synced = true
+      @raw = response['lfm']['artist']
+    end
+
+    def synced?
+      @synced == true
+    end
+  end
+end
+

data/lib/rlastfm/helpers/remote_accessor.rb

@@ -0,0 +1,50 @@
+module Rlastfm
+  module Helpers
+    module RemoteAccessor
+      def remote_reader(*accessors)
+        accessors.each do |reader|
+          case reader
+          when Symbol
+            add_reader reader
+          when Hash
+            add_mapped_reader reader
+          else
+            raise "remote_reader requires a Hash or Symbol"
+          end
+        end
+      end
+
+      def add_mapped_reader(mapping)
+        remote_reader_name = mapping.delete(:from)
+        reader_name        = mapping.delete(:to)
+        raise "remote_accessor_mapping requires :from and :to arguments" unless remote_reader_name && reader_name
+
+        add_reader reader_name, remote_reader_name
+      end
+
+      def add_reader(reader_name, remote_reader_name=nil)
+        remote_reader_name ||= reader_name
+        define_method reader_name do
+          raw[remote_reader_name.to_s]
+        end
+
+        memoize_method reader_name
+      end
+
+      def memoize_method(method_name)
+        i_var_name = :"@#{method_name}"
+        method_without = :"#{method_name}_without_memoization"
+        method_with = :"#{method_name}_with_memoization"
+
+        class_eval do
+          define_method method_with do
+            instance_variable_get(i_var_name) || instance_variable_set(i_var_name, send(method_without))
+          end
+          alias_method method_without, method_name
+          alias_method method_name, method_with
+        end
+      end
+    end
+  end
+end
+

data/lib/rlastfm/helpers/scraper.rb

@@ -0,0 +1,38 @@
+module Rlastfm
+  module Helpers
+    module Scraper
+      def self.included(base)
+        base.class_eval do
+          protected
+
+          extend ProtectedClassMethods
+          include ProtectedInstanceMethods
+        end
+      end
+
+      module ProtectedClassMethods
+        def last_fm_uri(path)
+          URI::HTTP.build :host => "www.last.fm", :path => path
+        end
+
+        def doc_for(url_or_path)
+          url_or_path = URI.parse(url_or_path)
+          url = url_or_path.relative? ? last_fm_uri(url_or_path.to_s).to_s : url_or_path
+
+          if Rlastfm.debug
+            puts "Releasing scraper on: #{url}"
+          end
+
+          doc = Hpricot open(url)
+        end
+      end
+
+      module ProtectedInstanceMethods
+        def doc_for(url_or_path)
+          self.class.doc_for(url_or_path)
+        end
+      end
+    end
+  end
+end
+

data/lib/rlastfm/track.rb

@@ -0,0 +1,10 @@
+module Rlastfm
+  class Track
+    attr_accessor :album, :artist, :duration, :name, :number
+
+    def initialize(hash={})
+      hash.each {|k,v| instance_variable_set("@#{k}", v) }
+    end
+  end
+end
+

data/lib/rlastfm/venue.rb

@@ -0,0 +1,23 @@
+module Rlastfm
+  class Venue
+    include Helpers::Scraper
+
+    def initialize(id)
+      @venue_id = id
+    end
+
+    def id
+      @venue_id
+    end
+
+    def photo
+      @photo ||= begin
+        url = "/venue/#{id}"
+        doc = doc_for(url)
+        image = doc.at('#catalogueImage')
+        image.attributes['src']
+      end
+    end
+  end
+end
+