mostscrobbled 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,7 +2,9 @@
 
 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]
+* {Official Documentation}[http://rubydoc.info/gems/mostscrobbled/frames]
+* {Ruby Gems}[https://rubygems.org/gems/mostscrobbled]
+* {Github}[https://github.com/paulsturgess/mostscrobbled]
 
 == Usage
 
@@ -28,6 +30,8 @@ Example:
   my_favourite_artist.mbid         # => "9f9953f0-68bb-4ce3-aace-2f44c87f0aa3"
   my_favourite_artist.image_small  # => "http://userserve-ak.last.fm/serve/34/39790231.jpg"
 
+	See the {documentation}[http://rubydoc.info/gems/mostscrobbled/0.0.1/Mostscrobbled/Artist] for the full list of methods
+
 == Installation
 
   gem install mostscrobbled

data/lib/mostscrobbled.rb

@@ -1,5 +1,11 @@
 module Mostscrobbled
-
+	
+	# The main call to find the artists for an account on last.fm
+	# 
+	# == Required paramaters
+	#  * :username - A last.fm username
+	#  * :api_key - A last.fm api key
+	#
 	def self.find(opts = {})
 		begin
 			Mostscrobbled::LastFm::Connection.new(opts).artists

data/lib/mostscrobbled/artist.rb

@@ -5,11 +5,10 @@ module Mostscrobbled
 		
 		def initialize(attrs = {}, *args) 
 	    super(*args)
-	    attrs.each do |k,v|
-	      self.send "#{k}=", v
-	    end
+	    attrs.each { |key,value| send("#{key}=", value) }
 	  end
-	
+		
+		# Creates an instance of Mostscrobbled::Artist from an xml node returned by the last.fm api
 		def self.build_artist(node)
 			(artist = Artist.new).tap do
 				[:name, :playcount, :tagcount, :mbid, :url, :streamable].each do |attribute|
@@ -21,5 +20,10 @@ module Mostscrobbled
 			end
 		end
 		
+		# Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
+		def attributes
+		  Hash[instance_variables.map { |name| [name[1..-1].to_sym, instance_variable_get(name)] }]
+		end
+		
 	end	
 end

data/lib/mostscrobbled/last_fm.rb

@@ -14,7 +14,7 @@ module Mostscrobbled
 			
 			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]) }
+				opts.each{ |key,value| send("#{key}=", value) }
 			end
 			
 			# Returns an array of MostscrobbledArtist objects
@@ -28,10 +28,12 @@ module Mostscrobbled
 				end
 			end
 		
+			# The uri used to call the last.fm api
 			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
 		
+		  # The parsed XML returned from the last.fm api
 			def artists_xml(page_number = nil)
 				uri = artists_uri(page_number)
 				http = Net::HTTP.new(uri.host)
@@ -46,6 +48,7 @@ module Mostscrobbled
 				end
 			end
 		
+		  # The total number of pages returned by the last.fm api
 			def total_artist_pages
 				artists_xml.xpath('//artists').first["totalPages"].to_i
 			end

data/lib/mostscrobbled/version.rb

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

data/license.txt

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (C) 2011 by Paul Sturgess
+
+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/mostscrobbled.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
 	s.platform    = Gem::Platform::RUBY
 	s.authors     = ["Paul Sturgess"]
 	s.email       = ["paulsturgess@gmail.com"]
-	s.homepage    = ""
+	s.homepage    = "https://github.com/paulsturgess/mostscrobbled"
 	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"
 

data/spec/artist_spec.rb

@@ -15,7 +15,11 @@ describe Mostscrobbled::Artist do
 		
 		it "should set the scrobbles_count" do
 			artist.playcount.should == 200
-		end		
+		end
+		
+		it "should be able to list the attributes as a hash" do
+		  artist.attributes.should == {:name => "Bibio", :mbid => "123", :playcount => 200}
+	  end
 	end
 	
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mostscrobbled
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.1
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  segments_generated: true
+  version: 0.0.2
 platform: ruby
 authors: 
 - Paul Sturgess
@@ -10,42 +15,55 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-13 00:00:00 +01:00
+date: 2011-12-04 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        segments_generated: true
         version: "1.4"
+  requirement: *id001
+  name: nokogiri
+  prerelease: false
   type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 22
+        segments_generated: true
         version: 2.0.0.beta.22
+  requirement: *id002
+  name: rspec
+  prerelease: false
   type: :development
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        segments_generated: true
         version: 1.3.0
+  requirement: *id003
+  name: fakeweb
+  prerelease: false
   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
@@ -65,6 +83,7 @@ files:
 - lib/mostscrobbled/artist.rb
 - lib/mostscrobbled/last_fm.rb
 - lib/mostscrobbled/version.rb
+- license.txt
 - mostscrobbled.gemspec
 - spec/artist_spec.rb
 - spec/fixtures/artists_failed.xml
@@ -73,7 +92,7 @@ files:
 - spec/most_scrobbled_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/paulsturgess/mostscrobbled
 licenses: []
 
 post_install_message: 
@@ -82,21 +101,25 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      segments_generated: true
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      segments_generated: true
       version: "0"
 requirements: []
 
 rubyforge_project: mostscrobbled
-rubygems_version: 1.6.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Extracts your most scrobbled artists from last.fm and turns them into nice ruby objects