last_fm 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Panagiotis Papadopoulos
+
+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,15 @@
+MIT-LICENSE
+Manifest
+README.textile
+Rakefile
+init.rb
+lastfm.gemspec
+lib/last_fm.rb
+lib/last_fm/models/album.rb
+lib/last_fm/models/artist.rb
+lib/last_fm/models/base.rb
+lib/last_fm/models/chart.rb
+lib/last_fm/models/event.rb
+lib/last_fm/models/tag.rb
+lib/last_fm/models/track.rb
+lib/last_fm/models/user.rb

data/README.textile

@@ -0,0 +1,75 @@
+h1. LastFm
+
+This library provides some a Ruby interface to interact with the  LastFM API. For the time being you can only get data from LastFm. 
+
+First of all I would like to thank ("gordonbisnor":http://github.com/gordonbisnor/) for his "Rails plugin":http://github.com/gordonbisnor/lastfm on which I started building. I started writing this library as I was not satisfied with existing Ruby clients for LastFm. This project is far from being complete and it is not well tested but works quite well for my current project. The reason for writing this library is that most of the existing clients were not Rubyish enough and were tightly attached to Rails. In order to start using this library be sure you have a "LastFm API":http://www.last.fm/api api and secret key.
+
+h2. Installation
+
+h4. Gem install
+
+@sudo gem install lastfm@
+
+Then in your code require it as 
+
+@require 'last_fm'@
+
+h2. Example
+
+Load your configuration
+
+@LastFm.load_configuration(your_api_key, your_secret+key)@
+
+Get information for an artist
+
+@artist = LastFm::Artist.new('Pink Floyd')@
+
+See the attributes for the artist object
+
+@artist.methods@
+
+Get an album of this artist
+
+@artist.album('The Wall')@
+
+Get a track of this artist
+
+@a.track('High Hopes')@
+
+Get an album
+
+@LastFm::Album.new('Bonobo','Animal Magic')@
+
+@LastFm::Album.search('Bonobo','Animal Magic')@
+
+@LastFm::Artist.search('Bonobo').album('Animal Magic')@
+
+Get a track
+
+@LastFm::Track.new('Bonobo','Silver')@
+
+@LastFm::Track.search('Bonobo','Silver')@
+
+@LastFm::Track.search('Bonobo').album('Silver')@
+
+Get user information
+
+@LastFm::User.new('p3010010').top_albums@
+
+h2. Dependencies
+
+The only requirement is ActiveSupport
+
+h2. Notes
+
+LastFm gem was developed in a hurry and is not a full blown LastFm client neither extensively tested. Feel free to fork it :)
+
+h1. License (The MIT License)
+
+Copyright (c) 2009 Panagiotis Papadopoulos.
+
+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,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('last_fm', '0.1.0') do |p|
+  p.description    = "A Ruby client for LastFm that feels like Ruby."
+  p.url            = "http://github.com/PanosJee/LastFm"
+  p.author         = "Panagiotis Papadopoulos (PanosJee)"
+  p.email          = "panosjee@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/init.rb

@@ -0,0 +1 @@
+require 'lib/last_fm.rb'

data/last_fm.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{last_fm}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Panagiotis Papadopoulos (PanosJee)"]
+  s.date = %q{2009-12-08}
+  s.description = %q{A Ruby client for LastFm that feels like Ruby.}
+  s.email = %q{panosjee@gmail.com}
+  s.extra_rdoc_files = ["README.textile", "lib/last_fm.rb", "lib/last_fm/models/album.rb", "lib/last_fm/models/artist.rb", "lib/last_fm/models/base.rb", "lib/last_fm/models/chart.rb", "lib/last_fm/models/event.rb", "lib/last_fm/models/tag.rb", "lib/last_fm/models/track.rb", "lib/last_fm/models/user.rb"]
+  s.files = ["MIT-LICENSE", "Manifest", "README.textile", "Rakefile", "init.rb", "lastfm.gemspec", "lib/last_fm.rb", "lib/last_fm/models/album.rb", "lib/last_fm/models/artist.rb", "lib/last_fm/models/base.rb", "lib/last_fm/models/chart.rb", "lib/last_fm/models/event.rb", "lib/last_fm/models/tag.rb", "lib/last_fm/models/track.rb", "lib/last_fm/models/user.rb", "last_fm.gemspec"]
+  s.homepage = %q{http://github.com/PanosJee/LastFm}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Last_fm", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{last_fm}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Ruby client for LastFm that feels like Ruby.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lastfm.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{lastfm}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Panagiotis Papadopoulos (PanosJee)"]
+  s.date = %q{2009-12-08}
+  s.description = %q{A Ruby client for LastFm that feels like Ruby.}
+  s.email = %q{panosjee@gmail.com}
+  s.extra_rdoc_files = ["README.textile", "lib/last_fm.rb", "lib/last_fm/models/album.rb", "lib/last_fm/models/artist.rb", "lib/last_fm/models/base.rb", "lib/last_fm/models/chart.rb", "lib/last_fm/models/event.rb", "lib/last_fm/models/tag.rb", "lib/last_fm/models/track.rb", "lib/last_fm/models/user.rb"]
+  s.files = ["MIT-LICENSE", "Manifest", "README.textile", "Rakefile", "init.rb", "lastfm.gemspec", "lib/last_fm.rb", "lib/last_fm/models/album.rb", "lib/last_fm/models/artist.rb", "lib/last_fm/models/base.rb", "lib/last_fm/models/chart.rb", "lib/last_fm/models/event.rb", "lib/last_fm/models/tag.rb", "lib/last_fm/models/track.rb", "lib/last_fm/models/user.rb"]
+  s.homepage = %q{http://github.com/PanosJee/LastFm}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Lastfm", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{lastfm}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Ruby client for LastFm that feels like Ruby.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/last_fm.rb

@@ -0,0 +1,120 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'activesupport'
+require 'net/http'
+require 'digest'
+require 'uri'
+
+# The models
+require 'last_fm/models/base.rb'
+require 'last_fm/models/tag.rb'
+require 'last_fm/models/user.rb'
+require 'last_fm/models/event.rb'
+require 'last_fm/models/chart.rb'
+require 'last_fm/models/track.rb'
+require 'last_fm/models/artist.rb'
+require 'last_fm/models/album.rb'
+
+module LastFm
+  
+  class << self
+    
+    def load_configuration(key, secret = nil, prefix = nil)
+      @key    = key
+      @secret = secret
+      @prefix = prefix || "/2.0/?api_key=#{@key}&method="
+      return true
+    end
+
+    def get_signature(method,params)
+      signature = []
+      signature << 'method' + method
+      params.each_pair do |key,value|
+          signature << key.to_s + value
+      end 
+      signature = signature.sort.join + @secret
+      return Digest::MD5.hexdigest(signature)
+    end
+    
+    # fetch lastfm
+    def fetch_data(path)
+      http       = Net::HTTP.new("ws.audioscrobbler.com",80)
+      resp, data = http.get(urlize(@prefix+path+"&api_key="+@key))
+      return resp.code == "200" ? data : false	
+    end
+
+    def urlize(string)
+      return string.gsub(/\ +/, '%20')
+    end
+
+    def get_session(token)
+      signature = get_signature('auth.getsession',{:api_key => @key, :token => token}) 
+      if @session = connect_with_auth('auth.getsession',{ :api_key => @ey, :token => token, :signature => signature })
+        session[:lastfm_name] = @session['session']['name']
+        session[:lastfm_key]  = @session['session']['key']
+      else 
+        return false
+      end 
+    end
+    
+    #get_lastfm
+    def request(method,params,type='hash')
+      http = Net::HTTP.new("ws.audioscrobbler.com",80)
+      path = @prefix + method
+      params.each_pair do |key,value|
+        path << "&#{key}=#{value}"
+      end
+      resp, data = http.get(urlize(path))
+      if resp.code == "200"
+        if type == 'hash'
+          hash = Hash.from_xml(data)['lfm']
+          hash.shift
+          return hash
+        else
+          return data
+        end
+      else 
+        return resp.body
+      end 
+    end
+ 
+    def authenticated_request(method, params,type = 'hash')
+      http = Net::HTTP.new("ws.audioscrobbler.com",80)
+      path = @prefix + method
+      params.each_pair do |key,value|
+        path << "&#{key}=#{value}"
+      end
+      path << '&api_sig=' + get_signature(method,params)
+      resp, data = http.get(urlize(path))
+      if resp.code == "200"
+        if type == 'hash'
+          hash = Hash.from_xml(data)['lfm']
+          hash.shift
+          return hash
+        else 
+          return data
+        end 
+      else 
+        return false
+      end
+    end
+
+    def post(method,posted)
+      posted[:api_key] = @key
+      posted[:sk]      = session[:lastfm_key]
+      signature        = get_signature(method,posted)
+      posted[:api_sig] = get_signature(method,posted)
+      posted[:method]  = method
+      resp = Net::HTTP.post_form(URI.parse('http://ws.audioscrobbler.com/2.0/'),posted)
+      case resp
+        when Net::HTTPSuccess, Net::HTTPRedirection
+          return true
+        else
+          return false
+      end
+    end
+
+  end
+
+end

data/lib/last_fm/models/album.rb

@@ -0,0 +1,27 @@
+module LastFm
+  class Album < Base
+    
+     def initialize(artist,name)
+       super(name)
+       @attributes = self.info(artist) if @attributes == {} and !artist.blank?
+       _process_attributes
+     end
+    
+     def info(artist, options = {})
+       params = ""
+       options.each_pair { |key,value| params += "&#{key}=#{value}" }
+       lfm_path = "album.getinfo&artist=#{artist}&album=#{@name}#{params}"
+       lfm_data = LastFm::fetch_data(lfm_path)
+       return Hash.from_xml(lfm_data)['lfm']['album']
+     end
+     
+     def self.search(artist,album)
+       self.new(artist,album)
+     end
+     
+     private
+     
+     def _process_attributes; end
+  
+  end
+end

data/lib/last_fm/models/artist.rb

@@ -0,0 +1,58 @@
+module LastFm
+  class Artist < Base
+    
+    def initialize(name)
+      super(name)
+      @attributes = self.info if @attributes == {}
+    end
+    
+    def info
+      lfm_path = "artist.getinfo&artist=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return Hash.from_xml(lfm_data)['lfm']['artist']
+    end
+    
+    # Work on tag object
+    def top_tags
+      lfm_path = "artist.getTopTags&artist=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return  Tag.create_from_hash(Hash.from_xml(lfm_data)['lfm']['toptags']['tag']) 
+    end
+    
+    # Work on event object
+    def events
+      lfm_path = "artist.getevents&artist=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return Event.create_from_hash(Hash.from_xml(lfm_data)['lfm']['events']['event'])  
+    end
+    
+    def similar(limit = 7)
+      lfm_path = "artist.getsimilar&artist=#{@name}&limit=#{limit}"
+      lfm_data = LastFm::fetch_data(lfm_path)   
+      return Event.create_from_hash(Hash.from_xml(lfm_data)['lfm']['similarartists']['artist'])   
+    end
+    
+    # Work on album object
+    def top_albums       
+      lfm_path = "artist.topAlbums&artist=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return Album.create_from_hash(Hash.from_xml(lfm_data)['lfm']['topalbums']['album'])
+    end
+    
+    # work on track object
+    def top_tracks
+      lfm_path = "artist.topTracks&artist=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return Track.create_from_hash(Hash.from_xml(lfm_data)['lfm']['toptracks']['track'])
+    end
+    
+    def track(track_name)
+      Track.search(@name, track_name)
+    end
+    
+    def album(album_name)
+      Album.search(@name, album_name)
+    end
+    
+  end
+end

data/lib/last_fm/models/base.rb

@@ -0,0 +1,67 @@
+module LastFm
+  class Base
+    
+    class << self
+      def search(name)
+        self.new(name)
+      end
+      
+      def create_from_hash(data)
+        if data.class == Array
+          models = []
+          data.each do |d|
+            if d.class == Hash
+              name         = (d['name'] || d['title']) || d['id']
+              n            = self.new(name) rescue self.new(nil, name)
+              n.attributes = d
+              models.push(n)
+            end
+          end 
+          return models 
+        else
+          name         = (data['name'] || data['title']) || data['id']
+          n            = self.new(name) 
+          n.attributes = data
+          return n          
+        end
+      end
+    end
+    
+    
+    def initialize(name)
+      @name       = name
+      @attributes = Hash.new
+    end
+    
+    def name
+      @name
+    end
+    
+    def name=(n)
+      @name = n
+    end
+    
+    def attributes=(h)
+      @attributes = h
+    end
+    
+    def get_xml_attributes(elements)
+      h = Hash.new
+      elements.each { |e| 
+        # do somethings about nested and cdata !
+        name    = e.name == "image" ? 'image_'+e.attributes['size'] : e.name
+        h[name] = e.text
+      }
+      return h
+    end
+    
+    
+    def method_missing(sym, *args, &block)
+      return @attributes[sym.to_s] if @attributes.has_key?(sym.to_s)
+    end
+    
+    def methods
+      @attributes.keys
+    end
+  end
+end

data/lib/last_fm/models/chart.rb

@@ -0,0 +1,4 @@
+module LastFm
+  class Chart < Base
+  end
+end

data/lib/last_fm/models/event.rb

@@ -0,0 +1,5 @@
+module LastFm
+  class Event < Base
+    
+  end
+end

data/lib/last_fm/models/tag.rb

@@ -0,0 +1,4 @@
+module LastFm
+  class Tag < Base
+  end
+end

data/lib/last_fm/models/track.rb

@@ -0,0 +1,27 @@
+module LastFm
+  class Track < Base
+    
+    def initialize(artist,name)
+      super(name)
+      @attributes = self.info(artist) if @attributes == {} and !artist.blank?
+      _process_attributes
+    end
+    
+     def info(artist, options = {})
+       params = ""
+       options.each_pair { |key,value| params += "&#{key}=#{value}" }
+       lfm_path = "track.getinfo&artist=#{artist}&track=#{@name}#{params}"
+       lfm_data = LastFm::fetch_data(lfm_path)
+       return Hash.from_xml(lfm_data)['lfm']['track']
+     end
+     
+     def self.search(artist,track)
+       self.new(artist,track)
+     end
+     
+     private
+     
+     def _process_attributes; end
+    
+  end
+end

data/lib/last_fm/models/user.rb

@@ -0,0 +1,34 @@
+module LastFm
+  class User < Base
+    
+    def initialize(name)
+      super(name)
+    end
+    
+    def weekly_album_chart
+      lfm_path = "user.weeklyalbumchart&user=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return Album.create_from_hash(Hash.from_xml(lfm_data)['lfm']['weeklyalbumchart']['album'])
+    end
+    
+    def top_albums
+      lfm_path = "user.gettopalbums&user=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return Album.create_from_hash(Hash.from_xml(lfm_data)['lfm']['topalbums']['album'])
+    end
+    
+    
+    def weekly_artists_chart
+      lfm_path = "user.getweeklyartistchart&user=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return Artist.create_from_hash(Hash.from_xml(lfm_data)['lfm']['weeklyartistchart']['artist'])
+    end
+    
+    def top_artists
+      lfm_path = "user.gettopartists&user=#{@name}"
+      lfm_data = LastFm::fetch_data(lfm_path)
+      return Artist.create_from_hash(Hash.from_xml(lfm_data)['lfm']['topartists']['artist'])
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: last_fm
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Panagiotis Papadopoulos (PanosJee)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-08 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A Ruby client for LastFm that feels like Ruby.
+email: panosjee@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- lib/last_fm.rb
+- lib/last_fm/models/album.rb
+- lib/last_fm/models/artist.rb
+- lib/last_fm/models/base.rb
+- lib/last_fm/models/chart.rb
+- lib/last_fm/models/event.rb
+- lib/last_fm/models/tag.rb
+- lib/last_fm/models/track.rb
+- lib/last_fm/models/user.rb
+files: 
+- MIT-LICENSE
+- Manifest
+- README.textile
+- Rakefile
+- init.rb
+- lastfm.gemspec
+- lib/last_fm.rb
+- lib/last_fm/models/album.rb
+- lib/last_fm/models/artist.rb
+- lib/last_fm/models/base.rb
+- lib/last_fm/models/chart.rb
+- lib/last_fm/models/event.rb
+- lib/last_fm/models/tag.rb
+- lib/last_fm/models/track.rb
+- lib/last_fm/models/user.rb
+- last_fm.gemspec
+has_rdoc: true
+homepage: http://github.com/PanosJee/LastFm
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Last_fm
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: last_fm
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby client for LastFm that feels like Ruby.
+test_files: []
+