meta-spotify 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/HISTORY

@@ -0,0 +1,5 @@
+=== 0.1.0 / 2009-10-30
+
+* 1 major enhancement
+
+  * First release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 philnash
+
+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/README.rdoc

@@ -0,0 +1,61 @@
+= meta-spotify
+
+A ruby wrapper for the Spotify Metadata API. See here for usage: http://developer.spotify.com/en/metadata-api/overview/
+
+Use of the API is subject to the Terms and Conditions: http://developer.spotify.com/en/metadata-api/terms-of-use/
+
+== Usage
+
+The API has two services for the three types of data, artists, albums and tracks:
+
+=== Lookup
+
+To look up an artist, album or track, simply call:
+
+MetaSpotify::Artist.lookup(spotify_uri)
+MetaSpotify::Album.lookup(spotify_uri)
+or
+MetaSpotify::Track.lookup(spotify_uri)
+
+e.g.
+
+artist = MetaSpotify::Artist.lookup("spotify:artist:4YrKBkKSVeqDamzBPWVnSJ")
+#=> #<MetaSpotify::Artist:0x119764c @name="Basement Jaxx">
+
+artist.name
+#=> "Basement Jaxx"
+
+You can also call lookup with the extras parameter, but only the acceptable extras will yield results, e.g.
+
+artist = MetaSpotify::Artist.lookup('spotify:artist:4YrKBkKSVeqDamzBPWVnSJ', :extras => 'album')
+
+artist.albums.first.name
+#=> "Jaxx Unreleased"
+
+=== Search
+
+To search for an artist, album or track works the same way as lookup, simply call:
+
+MetaSpotify::Artist.search(search_term)
+MetaSpotify::Album.search(search_term)
+or
+MetaSpotify::Track.search(search_term)
+
+e.g.
+
+search = MetaSpotify::Artist.search('foo')
+
+search.artists.first.name
+#=> "Foo fighters"
+
+For searches with many results, the result also contains details on pages and you can return page 2 like this:
+
+MetaSpotify::Artist.search('foo', :page => 2)
+
+== Disclaimer
+
+This is very new, so please let me know of any problems or anything that is missing.
+
+== Copyright
+
+Copyright (c) 2009 Phil Nash. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "meta-spotify"
+    gem.summary = %Q{A ruby wrapper for the Spotify Metadata API}
+    gem.description = %Q{A ruby wrapper for the Spotify Metadata API}
+    gem.email = "philnash@gmail.com"
+    gem.homepage = "http://github.com/philnash/meta-spotify"
+    gem.authors = ["philnash"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 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: sudo 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 = "meta-spotify #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/meta-spotify.rb

@@ -0,0 +1,99 @@
+require 'rubygems'
+
+$:.unshift File.dirname(__FILE__)
+
+require 'httparty'
+
+module MetaSpotify
+  
+  API_VERSION = '1'
+  
+  class Base
+    include HTTParty
+    base_uri 'http://ws.spotify.com'
+    
+    attr_reader :name, :uri
+    
+    def self.search(string, opts={})
+      item_name = self.name.downcase.gsub(/^.*::/,'')
+      query = {:q => string}
+      query[:page] = opts[:page].to_s if opts.has_key? :page
+      result = get("/search/#{API_VERSION}/#{item_name}", :query => query, :format => :xml)
+      raise_errors(result)
+      result = result[item_name+'s']
+      items = []
+      unless result[item_name].nil?
+        result[item_name].each do |item|
+          items << self.new(item)
+        end
+      end
+      return { (item_name+'s').to_sym => items,
+               :query => {
+                 :start_page => result["opensearch:Query"]["startPage"].to_i,
+                 :role => result["opensearch:Query"]["role"],
+                 :search_terms => result["opensearch:Query"]["searchTerms"]
+               },
+               :items_per_page => result["opensearch:itemsPerPage"].to_i,
+               :start_index => result["opensearch:startIndex"].to_i,
+               :total_results => result["opensearch:totalResults"].to_i
+              }
+    end
+    
+    def self.lookup(uri, opts={})
+      uri = uri.strip
+      raise URIError.new("Spotify URI not in the correct syntax") unless self::URI_REGEX.match(uri)
+      query = {:uri => uri}
+      query[:extras] = opts[:extras] if opts.has_key? :extras
+      result = get("/lookup/#{API_VERSION}/",:query => query, :format => :xml)
+      raise_errors(result)
+      result.each do |k,v|
+        case k
+        when "artist"
+          return Artist.new(v)
+        when "album"
+          return Album.new(v)
+        when "track"
+          return Track.new(v)
+        end
+      end
+    end
+    
+    private
+    
+    def self.raise_errors(response)
+      case response.code
+      when 400
+        raise BadRequestError.new('400 - The request was not understood')
+      when 403
+        raise RateLimitError.new('403 - You are being rate limited, please wait 10 seconds before requesting again')
+      when 404
+        raise NotFoundError.new('404 - That resource could not be found.')
+      when 406
+        raise BadRequestError.new('406 - The requested format isn\'t available')
+      when 500
+        raise ServerError.new('500 - The server encountered an unexpected problem')
+      when 503
+        raise ServerError.new('503 - The API is temporarily unavailable')
+      end
+    end
+    
+  end
+  
+  class MetaSpotifyError < StandardError
+    attr_reader :data
+    
+    def initialize(data)
+      @data = data
+      super
+    end
+  end
+  class URIError < MetaSpotifyError; end
+  class RateLimitError < MetaSpotifyError; end
+  class NotFoundError < MetaSpotifyError; end
+  class BadRequestError < MetaSpotifyError; end
+  class ServerError < MetaSpotifyError; end
+end
+
+require 'meta-spotify/artist'
+require 'meta-spotify/track'
+require 'meta-spotify/album'

data/lib/meta-spotify/album.rb

@@ -0,0 +1,44 @@
+module MetaSpotify
+  class Album < MetaSpotify::Base
+    
+    URI_REGEX = /^spotify:album:[A-Za-z0-9]+$/
+    
+    attr_reader :released, :artists, :available_territories, :tracks
+    
+    def initialize(hash)
+      @name = hash['name']
+      if hash.has_key? 'artist'
+        @artists = []
+        if hash['artist'].is_a? Array
+          hash['artist'].each { |a| @artists << Artist.new(a) }
+        else
+          @artists << Artist.new(hash['artist'])
+        end
+      end
+      if hash.has_key? 'tracks'
+        @tracks = []
+        if hash['tracks']['track'].is_a? Array
+          hash['tracks']['track'].each { |a| @tracks << Track.new(a) }
+        else
+          @tracks << Track.new(hash['tracks']['track'])
+        end
+      end
+      @released = hash['released'] if hash.has_key? 'released'
+      @uri = hash['href'] if hash.has_key? 'href'
+      @available_territories = if hash.has_key?('availability') && !hash['availability']['territories'].nil?
+        hash['availability']['territories'].split(/\s+/).map {|t| t.downcase } || []
+      else
+        []
+      end
+    end
+    
+    def is_available_in?(territory)
+      return @available_territories.include?('worldwide') || @available_territories.include?(territory.downcase)
+    end
+    
+    def is_not_available_in?(territory)
+      return !is_available_in?(territory)
+    end
+    
+  end
+end

data/lib/meta-spotify/artist.rb

@@ -0,0 +1,21 @@
+module MetaSpotify
+  class Artist < MetaSpotify::Base
+    
+    URI_REGEX = /^spotify:artist:[A-Za-z0-9]+$/
+    
+    attr_reader :albums
+    
+    def initialize(hash)
+      @name = hash['name']
+      @uri = hash['href'] if hash.has_key? 'href'
+      if hash.has_key? 'albums'
+        @albums = []
+        if hash['albums']['album'].is_a? Array
+          hash['albums']['album'].each { |a| @albums << Album.new(a) }
+        else
+          @albums << Album.new(hash['albums']['album'])
+        end
+      end
+    end
+  end
+end

data/lib/meta-spotify/track.rb

@@ -0,0 +1,24 @@
+module MetaSpotify
+  class Track < MetaSpotify::Base
+    
+    URI_REGEX = /^spotify:track:[A-Za-z0-9]+$/
+  
+    attr_reader :album, :artists, :track_number, :length, :popularity
+    
+    def initialize(hash)
+      @name = hash['name']
+      if hash.has_key? 'artist'
+        @artists = []
+        if hash['artist'].is_a? Array
+          hash['artist'].each { |a| @artists << Artist.new(a) }
+        else
+          @artists << Artist.new(hash['artist'])
+        end
+      end
+      @album = Album.new(hash['album']) if hash.has_key? 'album'
+      @track_number = hash['track_number'].to_i if hash.has_key? 'track_number'
+      @popularity = hash['popularity'].to_f if hash.has_key? 'popularity'
+      @length = hash['length'].to_f if hash.has_key? 'length'
+    end
+  end
+end

data/meta-spotify.gemspec

@@ -0,0 +1,69 @@
+# 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{meta-spotify}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["philnash"]
+  s.date = %q{2009-10-30}
+  s.description = %q{A ruby wrapper for the Spotify Metadata API}
+  s.email = %q{philnash@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "HISTORY",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/meta-spotify.rb",
+     "lib/meta-spotify/album.rb",
+     "lib/meta-spotify/artist.rb",
+     "lib/meta-spotify/track.rb",
+     "meta-spotify.gemspec",
+     "test/fixtures/album.xml",
+     "test/fixtures/album_search.xml",
+     "test/fixtures/artist.xml",
+     "test/fixtures/artist_search.xml",
+     "test/fixtures/track.xml",
+     "test/fixtures/track_search.xml",
+     "test/fixtures/track_search_page_2.xml",
+     "test/helper.rb",
+     "test/test_album.rb",
+     "test/test_artist.rb",
+     "test/test_track.rb"
+  ]
+  s.homepage = %q{http://github.com/philnash/meta-spotify}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A ruby wrapper for the Spotify Metadata API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_album.rb",
+     "test/test_artist.rb",
+     "test/test_track.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_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/fixtures/album.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<album xmlns="http://www.spotify.com/ns/music/1">
+  <name>Remedy</name>
+  <artist href="spotify:artist:4YrKBkKSVeqDamzBPWVnSJ">
+    <name>Basement Jaxx</name>
+  </artist>
+  <released>1999</released>
+  <id type="amgid" href="http://www.allmusic.com/cg/amg.dll?p=amg&amp;sql=10:dpfixqtkld0e">R   426481</id>
+
+  <id type="mbid" href="http://musicbrainz.org/release/3a3685aa-9c4d-42f8-a401-e34a89494041.html">3a3685aa-9c4d-42f8-a401-e34a89494041</id>
+  <id type="upc">634904012922</id>
+  <availability>
+    <territories>AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW ZZ</territories>
+  </availability>
+</album>