glutton_lastfm 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,16 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+For more information, please refer to <http://unlicense.org/>

data/README.rdoc

@@ -0,0 +1,135 @@
+= glutton_lastfm
+
+Ruby last.fm API wrapper written using HTTParty. A last.fm API key is required.
+
+See: http://last.fm/api & http://httparty.rubyforge.org
+
+== Implemented Methods
+
+<tt>[method invocation]</tt> => [api docs url]:
+
+* <tt>artist_search( artist_name )</tt> => http://www.last.fm/api/show/?service=272
+* <tt>artist_info( artist_name )</tt> => http://www.last.fm/api/show/?service=267
+* <tt>artist_info_by_mbid( artist_musicbrainz_id )</tt> => http://www.last.fm/api/show/?service=267
+* <tt>artist_top_albums( artist_name )</tt> => http://www.last.fm/api/show/?service=287
+* <tt>artist_top_tracks( artist_name )</tt> => http://www.last.fm/api/show/?service=277
+* <tt>atrist_top_tags( artist_name )</tt> => http://www.last.fm/api/show/?service=288
+* <tt>artist_events( artist_name )</tt> => http://www.last.fm/api/show/?service=117
+* <tt>album_search( album_name, artist_name )</tt> => http://www.last.fm/api/show?service=357
+* <tt>album_info( album_name )</tt> => http://www.last.fm/api/show?service=290
+* <tt>album_info_by_mbid( album_musicbrainz_id )</tt> => http://www.last.fm/api/show?service=290
+
+<b>Note:</b> Not all of the last.fm API methods have been implemented. Fork this gem to implement your own using the provided <tt>q</tt> method.
+
+== Example
+
+    require 'rubygems'
+    require 'glutton_lastfm'
+    require 'pp'
+    
+    last = GluttonLastfm.new '<your last.fm API key>'
+    
+    artist = 'Green Day'
+    
+    artist_search       = last.artist_search artist
+    artist_info         = last.artist_info artist
+    artist_info_by_mbid = last.artist_info_by_mbid '084308bd-1654-436f-ba03-df6697104e19'
+    artist_top_albums   = last.artist_top_albums artist
+    artist_top_tracks   = last.artist_top_tracks artist
+    artist_top_tags     = last.artist_top_tags artist
+    artist_events       = last.artist_events artist
+    
+    album = 'Dookie'
+    
+    album_search       = last.album_search album
+    album_info         = last.album_info artist, album
+    album_info_by_mbid = last.album_info_by_mbid '17ca17ed-f061-4d5b-97e2-848d85e47d95'
+    
+    # Inspect any of the returned structures using pp (pretty print):
+    
+    pp album_info
+    
+== Query Responses
+
+Queries to glutton_lastfm methods return hierarchical hash / array strucutres. As shown above, it is best to familarize yourself with the returned data using the <tt>pp</tt> (pretty print) inspector.
+
+Here's a look at the returned data in a pseudo-structure. In reality all hash keys are strings.
+
+* artist_info & artist_info_by_mbid
+      artist info{
+        name
+        mbid
+        url
+        image[]
+        similar{ artist }[]{ name url image[] }
+        tags{ tag }[]{ name url }
+        bio{ published summary content }
+      }
+* album_info & album_info_by_mbid
+      album_info{
+        name
+        artist
+        releasedate
+        url
+        id
+        mbid
+        toptags{ tag }[]{ name url }
+        image[]
+        wiki{ published content summary}
+      }
+* artist_search
+      artist_search[]{
+        name
+        url
+        mbid
+        image[]
+      }
+* album_search
+      album_search[]{
+        name
+        url
+        mbid
+        image[]
+      }
+* artist_top_albums
+      artist_top_albums[]{
+        name
+        mbid
+        rank
+        image[]
+        artist{ name url mbid }
+        url
+      }
+* artist_top_tracks
+      artist_top_tracks[]{
+        name
+        artist{ name url mbid }
+        url
+        rank
+        mbid
+        image[]
+      }
+* atrist_top_tags
+      artist_top_tags[]{
+        name
+        url
+        count
+      }
+* artist_events
+      artist_events[]{
+        artists{ artist headliner }
+        title
+        url
+        startDate
+        id
+        tags{ tag }[]
+        website
+        tickets
+        venue{ name website location{ city country postalcode street geo:point } }
+        description
+        image[]
+      }
+
+== License
+
+This is free and unencumbered software released into the public domain. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "glutton_lastfm"
+    gem.summary = %Q{Ruby last.fm API wrapper.}
+    gem.description = %Q{Simple last.fm API wrapper written using HTTParty in Ruby.}
+    gem.email = "stungeye@gmail.com"
+    gem.homepage = "http://github.com/stungeye/glutton_lastfm"
+    gem.authors = ["Wally Glutton"]
+    gem.add_dependency("httparty", ">= 0.5.0")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "glutton_lastfm #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/glutton_lastfm.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{glutton_lastfm}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Wally Glutton"]
+  s.date = %q{2010-05-09}
+  s.description = %q{Simple last.fm API wrapper written using HTTParty in Ruby.}
+  s.email = %q{stungeye@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "glutton_lastfm.gemspec",
+     "lib/glutton_lastfm.rb",
+     "test/helper.rb",
+     "test/test_glutton_lastfm.rb"
+  ]
+  s.homepage = %q{http://github.com/stungeye/glutton_lastfm}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby last.fm API wrapper.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_glutton_lastfm.rb"
+  ]
+
+  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
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.5.0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.5.0"])
+  end
+end
+

data/lib/glutton_lastfm.rb

@@ -0,0 +1,95 @@
+# glutton_lastfm
+#
+# A last.fm Ruby API Wrapper
+#
+# Author         : Wally Glutton - http://stungeye.com
+# Required       : Last.fm API Key - http://www.last.fm/api
+# Gem Dependence : HTTParty - Installed by gem along with glutton_lastfm.
+# Ruby Version   : Written and tested using Ruby 1.8.7.
+# License        : This is free and unencumbered software released into the public domain. See LICENSE for details.
+
+require 'httparty'
+
+class GluttonLastfm
+  include HTTParty
+  API_VERSION = "2.0".freeze
+  base_uri "http://ws.audioscrobbler.com/#{API_VERSION}/"
+  format :xml
+  
+  class QueryStatusFail < StandardError; end
+  class QueryArgumentFail < StandardError; end
+  class Unauthorized < StandardError; end
+  class NotFound < StandardError; end
+  class UnknownFail < StandardError; end
+  
+  def initialize( key )
+    self.class.default_params :api_key => key
+  end
+  
+  def q( options )
+    response = self.class.get( '', :query => options )
+    raise_errors(response, options)
+    response['lfm']
+  end
+  
+  def artist_search( artist )
+    q( :method => 'artist.search', :artist => artist )['results']['artistmatches']['artist']
+  end
+  
+  def album_search( album )
+    q( :method => 'album.search', :album => album )['results']['albummatches']['album']
+  end
+   
+  def artist_top_albums( artist )
+    q( :method => 'artist.gettopalbums', :artist => artist )['topalbums']['album']
+  end
+  
+  def artist_top_tracks( artist )
+    q( :method => 'artist.gettoptracks', :artist => artist )['toptracks']['track']
+  end
+  
+  def artist_top_tags( artist )
+    q( :method => 'artist.gettoptags', :artist => artist )['toptags']['tag']
+  end
+  
+  def artist_events( artist )
+    response = q( :method => 'artist.getevents', :artist => artist )['events']
+    (response['total'].to_i == 0) ? [] : response['event']
+  end
+  
+  def album_info( artist, album )
+    q( :method => 'album.getinfo', :artist => artist, :album => album )['album']
+  end
+  
+  def album_info_by_mbid( mbid )
+    q( :method => 'album.getinfo', :mbid => mbid )['album']
+  end
+  
+  def artist_info( artist )
+    q( :method => 'artist.getinfo', :artist => artist )['artist']
+  end
+  
+  def artist_info_by_mbid( mbid )
+    q( :method => 'artist.getinfo', :mbid => mbid )['artist']
+  end
+  
+  private
+
+  def raise_errors(response, options)
+    case response.code.to_i
+      when 400
+        raise QueryArgumentFail, "#{response['lfm']['error'] if response['lfm']} #{options.inspect}"
+      when 403
+        raise Unauthorized,  "#{response['lfm']['error'] if response['lfm']} #{options.inspect}"
+      when 404
+        raise NotFound, options.inspect
+      when 200 # Is it overkill to test all successfully received requests like this?
+        if response['lfm']
+          raise QueryStatusFail, "#{response['lfm']['error']} #{options.inspect}" if response['lfm']['status'] != 'ok'
+        else
+          raise UnknownFail, "Successfully received an HTTP response but could not correctly parse data. #{options.inspect}"
+        end
+    end
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'glutton_lastfm'
+
+class Test::Unit::TestCase
+end

data/test/test_glutton_lastfm.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGluttonLastfm < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "Nothing to see here. Wally hasn't added any tests yet."
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: glutton_lastfm
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wally Glutton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id001
+description: Simple last.fm API wrapper written using HTTParty in Ruby.
+email: stungeye@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- glutton_lastfm.gemspec
+- lib/glutton_lastfm.rb
+- test/helper.rb
+- test/test_glutton_lastfm.rb
+has_rdoc: true
+homepage: http://github.com/stungeye/glutton_lastfm
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby last.fm API wrapper.
+test_files: 
+- test/helper.rb
+- test/test_glutton_lastfm.rb