tinyscrobbler 0.1 → 0.2

data/Changelog

@@ -0,0 +1 @@
+soon...

data/README.md

@@ -1,41 +1,74 @@
+# Tinyscrobbler
+
 Tinyscrobbler is a lightweight LastFM track scrobbler library that allows to quickly incorporate the track scrobbling feature in a ruby player app.
 
-I'm currently learning ruby, so it's very likely that some code is not written the ruby way.
+I'm currently learning ruby, so it's very likely that this is not the best ruby code you've ever seen. But it works and I'll be optimizing it as I learn more about the language.
+
+## Installation
+
+In order to install Tinyscrobbler you have to download the latest gem from [gemcutter.org](http://gemcutter.org). If you've never installed a gem from gemcutter you need to add it to your sources:
+
+	$ gem sources -a http://gemcutter.org
+
+Then install the gem just like any other:
+
+	$ gem install tinyscrobbler
+
+Depending on your system, you might need to use `sudo` to execute gem commands.
+
+## How to use
+
+Some code example on how to use tinyscrobbler:
 
-Tinyscrobbler is still under constant heavy changes but here's some early usage examples:
+### Without parsing metadata
 
-	require 'tinyscrobbler.rb'
+In this usage example you need to provide the track info (metadata), like artist name, album, song title etc. This is the recommended method, but you have to get the track info yourself.
+
+
+	require 'rubygems'
+	require 'tinyscrobbler'
 
 	ls = Tinyscrobbler::Client.new(lastfm_username, lasftfm_password)
 
 	# Currently listening to...
 
 	current_track = {'artistname' => 'Moonspell', 'track' => 'Alma Mater',
-	  'time' => '1262185646', 'source' => 'P', 'rating' => '',
+	  'time' => Time.now.to_s, 'source' => 'P', 'rating' => '',
 	  'secs' => '337', 'album' => 'Wolfheart', 'tracknumber' => '8', 'mbtrackid' => ''}
 
 	ls.now_playing(current_track)
 
 	# after track played
-
+	
+	# you need to submit this only after
+	# half of the track length has passed
+	# or lastfm may ignore the submission
+	
 	ls.played(current_track)
 
+### Parsing metadata
+
 If you prefer to have tinyscrobbler parse the audio metadata for you, here's an example on how to do it.
-Please notice that currently on mp3 files are supported, and this also requires the "mp3info" gem.
+Please notice that currently on mp3 files are supported (other formats are under development), this feature is the main reason why the "mp3info" gem is a dependency.
 
+	require 'rubygems'
 	require 'tinyscrobbler'
-	require 'audiometa.rb'
 	
 	ls = Tinyscrobbler::Client.new(lastfm_username, lasftfm_password)
 
 	# Currently listening to...
 	file_path = '/Users/rogeriopvl/Music/Moonspell/Wolfheart/08_Alma_Mater.mp3'
-	current_track = Audiometa::Parser.new(file_path)
+	parser = Tinyscrobbler::Parser.new(file_path)
+	current_track = parser.metadata
 	
 	ls.now_playing(current_track)
 	
 	# after track played
 	
+	# you need to submit this only after
+	# half of the track length has passed
+	# or lastfm may ignore the submission
+	
 	ls.played(current_track)
 	
 

data/example.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'tinyscrobbler.rb'
+
+ls = Tinyscrobbler::Client.new(lastfm_username, lastfm_password)
+
+# Currently listening to...
+
+current_track = {'artistname' => 'Moonspell', 'track' => 'Alma Mater',
+  'time' => '1262185646', 'source' => 'P', 'rating' => '',
+  'secs' => '337', 'album' => 'Wolfheart', 'tracknumber' => '8', 'mbtrackid' => ''}
+
+ls.now_playing(current_track)
+
+# after track played
+
+ls.played(current_track)
+
+

data/lib/{audiometa.rb → parser.rb}

@@ -1,12 +1,14 @@
 require 'rubygems'
 require 'mp3info'
 
-module Audiometa
+module Tinyscrobbler
   
   # This class parses metadata from audio files.
   # It currently supports only mp3 files.
   
   class Parser
+  
+    attr_accessor :metadata
     
     # Checks if given file exists and if is supported,
     # and calls the parser method, if not
@@ -15,10 +17,10 @@ module Audiometa
     def initialize(file_path)
       @path = file_path
       raise 'File not found or unreadable.' unless File.exists? @path and File.readable? @path
-      @extension = File.extname(file_path)
+      @extension = File.extname(file_path).downcase
       raise 'Not a valid audio file.' unless @extension == '.mp3'
       
-      parse_metadata
+      @metadata = parse_metadata
     end
     
     private
@@ -27,13 +29,13 @@ module Audiometa
     
     def parse_metadata
       track = Mp3Info.new(@path)
-      tag = track.hastag2? ? track.tag2 : track.tag1
-      
+      tag = track.hastag1? ? track.tag1 : track.tag2
+
       track_meta = {}
-      track_meta['track'] = tag.title
-      track_meta['artistname'] = tag.artist
-      track_meta['album'] = tag.album
-      track_meta['tracknumber'] = tag.tracknum.to_s
+      track_meta['track'] = track.hastag1? ? tag.title : tag.TIT2
+      track_meta['artistname'] = track.hastag1? ? tag.artist : tag.TPE1
+      track_meta['album'] = track.hastag1? ? tag.album : tag.TALB
+      track_meta['tracknumber'] = track.hastag1? ? tag.tracknum.to_s : tag.TRCK.to_s
       track_meta['secs'] = track.length.round.to_s
       track_meta['time'] = Time.now.to_s
       track_meta['source'] = 'P'

data/lib/tinyscrobbler.rb

@@ -9,6 +9,7 @@
 
 require 'net/http'
 require 'Digest/md5'
+require 'parser.rb'
 
 module Tinyscrobbler
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tinyscrobbler
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Rogerio Vicente
@@ -35,7 +35,7 @@ files:
 - README.md
 - Changelog
 - example.rb
-- lib/audiometa.rb
+- lib/parser.rb
 - lib/tinyscrobbler.rb
 has_rdoc: true
 homepage: http://github.com/rogeriopvl/tinyscrobbler
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: tinyscrobbler
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3