mostscrobbled 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+doc/*
+.yardoc/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mostplayed.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,33 @@
+= Mostscrobbled
+
+Extracts the artists from a {last.fm}[http://last.fm] user's music library and turns them into nice ruby objects.
+
+{Official Documentation}[http://rubydoc.info/github/paulsturgess/mostscrobbled/master/frames]
+
+== Usage
+
+Before you start you'll need:
+* {A last.fm account}[http://last.fm]
+* {A last.fm api key}[http://last.fm/api]
+
+Example:
+
+  require 'rubygems'
+  require 'mostscrobbled'
+
+  # The main method call returns an array of artists ordered by the number of scrobbles
+  artists = Mostscrobbled.find(:username => "foobar", :api_key => "123abc")
+
+  my_favourite_artist = artists.first
+  
+  # Artists have a number of methods to easily access the attributes returned by the last.fm api
+  # For example...
+  my_favourite_artist.name         # => "Bibio"
+  my_favourite_artist.playcount    # => "391"
+  my_favourite_artist.url          # => "http://www.last.fm/music/Bibio"
+  my_favourite_artist.mbid         # => "9f9953f0-68bb-4ce3-aace-2f44c87f0aa3"
+  my_favourite_artist.image_small  # => "http://userserve-ak.last.fm/serve/34/39790231.jpg"
+
+== Installation
+
+  gem install mostscrobbled

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/mostscrobbled.rb

@@ -0,0 +1,14 @@
+module Mostscrobbled
+
+	def self.find(opts = {})
+		begin
+			Mostscrobbled::LastFm::Connection.new(opts).artists
+		rescue Mostscrobbled::LastFm::Error => e
+			puts e
+		end
+	end
+
+end
+
+require 'mostscrobbled/last_fm'
+require 'mostscrobbled/artist'

data/lib/mostscrobbled/artist.rb

@@ -0,0 +1,25 @@
+module Mostscrobbled
+	class Artist
+		
+		attr_accessor :name, :playcount, :tagcount, :mbid, :url, :streamable, :image_small, :image_medium, :image_large, :image_extralarge, :image_mega
+		
+		def initialize(attrs = {}, *args) 
+	    super(*args)
+	    attrs.each do |k,v|
+	      self.send "#{k}=", v
+	    end
+	  end
+	
+		def self.build_artist(node)
+			(artist = Artist.new).tap do
+				[:name, :playcount, :tagcount, :mbid, :url, :streamable].each do |attribute|
+					artist.send("#{attribute}=", node.xpath(".//#{attribute}").first.content)
+				end
+				node.xpath(".//image").each do |image_node| # set :image_small, :image_medium, :image_large, :image_extralarge, :image_mega
+					artist.send("image_#{image_node.attributes["size"].value}=", image_node.children.first.content) if image_node.children.first
+				end
+			end
+		end
+		
+	end	
+end

data/lib/mostscrobbled/last_fm.rb

@@ -0,0 +1,62 @@
+require 'nokogiri'
+require 'open-uri'
+require 'net/http'
+
+module Mostscrobbled
+	module LastFm
+		class Error < StandardError; end
+		class ResponseError < Error; end
+		class ConfigError < Error; end
+		class Connection
+				
+			REQUIRED_ATTRIBUTES = :username, :api_key
+			attr_accessor *(REQUIRED_ATTRIBUTES)
+			
+			def initialize(opts = {})
+				raise ConfigError, missing_options(opts).map{ |argument| ":#{argument} argument missing" }.join(" and ") unless missing_options(opts).empty?
+				opts.keys.each{ |key| send("#{key}=", opts[key]) }
+			end
+			
+			# Returns an array of MostscrobbledArtist objects
+			def artists
+				(artists = []).tap do 
+					total_artist_pages.times do |page|
+						artists_xml(page).xpath('//artist').collect do |node|
+							artists << Mostscrobbled::Artist.build_artist(node)
+						end
+					end
+				end
+			end
+		
+			def artists_uri(page_number = nil)
+				URI.parse("http://ws.audioscrobbler.com/2.0/?method=library.getartists&api_key=#{api_key}&user=#{username}#{"&page=#{page_number + 1}" if page_number}")
+			end
+		
+			def artists_xml(page_number = nil)
+				uri = artists_uri(page_number)
+				http = Net::HTTP.new(uri.host)
+				request = Net::HTTP::Get.new(uri.request_uri)
+				response = http.request(request)
+				case response.code
+				when "200"
+					@artists_xml ||= {}
+					@artists_xml[page_number || 0] ||= Nokogiri::XML(response.body)
+				when "403"
+					raise ResponseError, Nokogiri::XML(response.body).xpath(".//error").first.content.inspect
+				end
+			end
+		
+			def total_artist_pages
+				artists_xml.xpath('//artists').first["totalPages"].to_i
+			end
+			
+			private
+
+			def missing_options(opts)
+				REQUIRED_ATTRIBUTES.select{ |argument| opts[argument].nil? }
+			end
+
+		end
+	
+	end
+end

data/lib/mostscrobbled/version.rb

@@ -0,0 +1,3 @@
+module Mostscrobbled
+  VERSION = "0.0.1"
+end

data/mostscrobbled.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mostscrobbled/version"
+
+Gem::Specification.new do |s|
+	s.name        = "mostscrobbled"
+	s.version     = Mostscrobbled::VERSION
+	s.platform    = Gem::Platform::RUBY
+	s.authors     = ["Paul Sturgess"]
+	s.email       = ["paulsturgess@gmail.com"]
+	s.homepage    = ""
+	s.summary     = "Extracts your most scrobbled artists from last.fm and turns them into nice ruby objects"
+	s.description = "Uses the last.fm api to analyse your scrobbles library and extracts the artists out in order of number of scrobbles"
+
+	s.rubyforge_project = "mostscrobbled"
+
+	s.files         = `git ls-files`.split("\n")
+	s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+	s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+	s.require_paths = ["lib"]
+	
+	s.add_runtime_dependency "nokogiri", "~> 1.4"
+	s.add_development_dependency "rspec", "~> 2.0.0.beta.22"
+	s.add_development_dependency "fakeweb", "~> 1.3.0"
+end

data/spec/artist_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper.rb'
+
+describe Mostscrobbled::Artist do
+	
+	context "when inititalizing an artist" do
+		let(:artist) {Mostscrobbled::Artist.new(:name => "Bibio", :mbid => "123", :playcount => 200)}
+		
+		it "should set the name" do
+			artist.name.should == "Bibio"
+		end
+		
+		it "should set the mbid" do
+			artist.mbid.should == "123"
+		end
+		
+		it "should set the scrobbles_count" do
+			artist.playcount.should == 200
+		end		
+	end
+	
+end

data/spec/fixtures/artists_failed.xml

@@ -0,0 +1,3 @@
+<lfm status="failed">
+	<error code="6">No user with that name</error>
+</lfm>

data/spec/fixtures/artists_ok.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<lfm status="ok">
+<artists user="timberford" page="1" perPage="50" totalPages="1" total="2">
+<artist>
+    <name>Bibio</name>
+    <playcount>391</playcount>
+    <tagcount>0</tagcount>
+    <mbid>9f9953f0-68bb-4ce3-aace-2f44c87f0aa3</mbid>
+    <url>http://www.last.fm/music/Bibio</url>
+    <streamable>1</streamable>
+    <image size="small">http://userserve-ak.last.fm/serve/34/27532381.jpg</image>
+    <image size="medium">http://userserve-ak.last.fm/serve/64/27532381.jpg</image>
+    <image size="large">http://userserve-ak.last.fm/serve/126/27532381.jpg</image>
+    <image size="extralarge">http://userserve-ak.last.fm/serve/252/27532381.jpg</image>
+    <image size="mega">http://userserve-ak.last.fm/serve/500/27532381/Bibio+flap+flap.jpg</image>
+</artist>
+<artist>
+    <name>Bonobo</name>
+    <playcount>387</playcount>
+    <tagcount>0</tagcount>
+    <mbid>9a709693-b4f8-4da9-8cc1-038c911a61be</mbid>
+    <url>http://www.last.fm/music/Bonobo</url>
+    <streamable>1</streamable>
+    <image size="small">http://userserve-ak.last.fm/serve/34/53939783.png</image>
+    <image size="medium">http://userserve-ak.last.fm/serve/64/53939783.png</image>
+    <image size="large">http://userserve-ak.last.fm/serve/126/53939783.png</image>
+    <image size="extralarge">http://userserve-ak.last.fm/serve/252/53939783.png</image>
+    <image size="mega"></image>
+</artist>
+</artists></lfm>

data/spec/last_fm_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper.rb'
+
+describe Mostscrobbled::LastFm::Connection do
+	
+	before { FakeWeb.allow_net_connect = false }
+	after  { FakeWeb.allow_net_connect = true }
+	
+	let(:connection) {Mostscrobbled::LastFm::Connection.new(:username => "johnsmith", :api_key => "023456789")}
+	
+	
+	context "when intializing a connection with valid argument" do
+		it "should set the username" do
+			connection.username.should == "johnsmith"
+		end
+		it "should set the api_key" do
+			connection.api_key.should == "023456789"
+		end	
+	end
+
+	context "when initializing a connection without the username argument" do
+		it "should raise an exception" do
+			lambda {Mostscrobbled::LastFm::Connection.new(:api_key => "123")}.should raise_exception(Mostscrobbled::LastFm::ConfigError)
+		end
+	end
+	
+	context "when initializing a connection without the api_key argument" do
+		it "should raise an exception" do
+			lambda {Mostscrobbled::LastFm::Connection.new(:username => "John")}.should raise_exception(Mostscrobbled::LastFm::ConfigError)
+		end
+	end
+	
+	describe "artists_uri" do
+		context "when not providing a page number" do
+			it "should set the artists uri without a page number" do
+				connection.artists_uri.should == URI.parse("http://ws.audioscrobbler.com/2.0/?method=library.getartists&api_key=023456789&user=johnsmith")
+			end
+		end
+		context "when providing a page number" do
+			it "should set the artists uri with a page number" do
+				connection.artists_uri(2).should == URI.parse("http://ws.audioscrobbler.com/2.0/?method=library.getartists&api_key=023456789&user=johnsmith&page=3")
+			end
+		end
+	end
+	
+	# Note that you cannot compare two Nokogiri documents that have been parsed, even if you are parsing the same document
+	# In any case we're not testing that Nokogiri works, we're testing that Nokogiri is called with the correct options
+	describe "artists_xml" do
+		context "when the result is ok" do
+			before do
+				FakeWeb.register_uri(:get, "http://example.com", :body => File.read("spec/fixtures/artists_ok.xml"))
+				connection.stub(:artists_uri){URI.parse("http://example.com")}
+			end
+			it "should call the artists url with Nokogiri parse to get the xml" do
+				Nokogiri::XML::Document.should_receive(:parse).with(Net::HTTP.get(URI.parse("http://example.com")), nil, nil, 1)
+				connection.artists_xml
+			end
+			it "should not raise the error message as an exception" do
+				lambda {connection.artists_xml}.should_not raise_exception(Mostscrobbled::LastFm::ResponseError)
+			end
+		end
+		context "when the result is failed" do
+			before do
+				FakeWeb.register_uri(:get, "http://example.com", :body => File.read("spec/fixtures/artists_failed.xml"), :status => ["403", "Forbidden"])
+				connection.stub(:artists_uri){URI.parse("http://example.com")}
+			end
+			it "should raise the a ResponseError exception" do
+				lambda {connection.artists_xml}.should raise_exception(Mostscrobbled::LastFm::ResponseError)
+			end
+		end
+	end
+	
+	describe "total_artist_pages" do
+		before { connection.stub(:artists_xml).and_return(Nokogiri::XML(File.read("spec/fixtures/artists_ok.xml"))) }
+		it "should return the correct number of pages" do
+			connection.total_artist_pages.should == 1
+		end
+	end
+
+	describe "artists" do
+		before do
+			connection.stub(:total_artist_pages){1}
+			connection.stub(:artists_xml).and_return(Nokogiri::XML(File.read("spec/fixtures/artists_ok.xml")))
+		end
+		it "should include the artists returned by artists_xml" do
+			connection.artists.map(&:name).should include("Bibio")
+			connection.artists.map(&:name).should include("Bonobo")
+			connection.artists.first.should be_kind_of(Mostscrobbled::Artist)
+			connection.artists.length.should == 2
+		end
+	end
+
+end

data/spec/most_scrobbled_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper.rb'
+
+describe Mostscrobbled do
+
+	context "when intializing Mostscrobbled" do
+		it "should create a lastfm connection and call artists on it" do
+			connection = mock(Mostscrobbled::LastFm::Connection)
+			Mostscrobbled::LastFm::Connection.should_receive(:new).with(:username => "john", :api_key => "123") {connection}
+			connection.should_receive(:artists)
+			Mostscrobbled.find(:username => "john", :api_key => "123")
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+Dir["#{File.dirname(__FILE__)}/../lib/**/*.rb"].each { |f| require f }
+require 'fakeweb'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: mostscrobbled
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Sturgess
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.beta.22
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: Uses the last.fm api to analyse your scrobbles library and extracts the artists out in order of number of scrobbles
+email: 
+- paulsturgess@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/mostscrobbled.rb
+- lib/mostscrobbled/artist.rb
+- lib/mostscrobbled/last_fm.rb
+- lib/mostscrobbled/version.rb
+- mostscrobbled.gemspec
+- spec/artist_spec.rb
+- spec/fixtures/artists_failed.xml
+- spec/fixtures/artists_ok.xml
+- spec/last_fm_spec.rb
+- spec/most_scrobbled_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: mostscrobbled
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Extracts your most scrobbled artists from last.fm and turns them into nice ruby objects
+test_files: 
+- spec/artist_spec.rb
+- spec/fixtures/artists_failed.xml
+- spec/fixtures/artists_ok.xml
+- spec/last_fm_spec.rb
+- spec/most_scrobbled_spec.rb
+- spec/spec_helper.rb