tinyscrobbler 0.1

data/LICENSE

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,42 @@
+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.
+
+Tinyscrobbler is still under constant heavy changes but here's some early usage examples:
+
+	require 'tinyscrobbler.rb'
+
+	ls = Tinyscrobbler::Client.new(lastfm_username, lasftfm_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)
+
+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.
+
+	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)
+	
+	ls.now_playing(current_track)
+	
+	# after track played
+	
+	ls.played(current_track)
+	
+
+More info soon...

data/lib/audiometa.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'mp3info'
+
+module Audiometa
+  
+  # This class parses metadata from audio files.
+  # It currently supports only mp3 files.
+  
+  class Parser
+    
+    # Checks if given file exists and if is supported,
+    # and calls the parser method, if not
+    # raises exception.
+    
+    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)
+      raise 'Not a valid audio file.' unless @extension == '.mp3'
+      
+      parse_metadata
+    end
+    
+    private
+    
+    # Returns the file metadata in a hash
+    
+    def parse_metadata
+      track = Mp3Info.new(@path)
+      tag = track.hastag2? ? track.tag2 : track.tag1
+      
+      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['secs'] = track.length.round.to_s
+      track_meta['time'] = Time.now.to_s
+      track_meta['source'] = 'P'
+      track_meta['mbtrackid'] = ''
+      track_meta['rating'] = ''
+      
+      track_meta
+    end
+  
+  end
+  
+end

data/lib/tinyscrobbler.rb

@@ -0,0 +1,175 @@
+# Tinyscrobbler is a lightweight library for scrobbling tracks
+# to the LastFM submissions API.
+# For more info on the submissions API visit:
+# http://www.last.fm/api/submissions
+# 
+# Author:: Rogerio Vicente (http://rogeriopvl.com)
+# Copyright:: Copyright (c) 2009 Rogerio Vicente
+# License:: GPLv3
+
+require 'net/http'
+require 'Digest/md5'
+
+module Tinyscrobbler
+  
+  # Exception classes
+
+  class BadFormatedResponseError < Exception; end
+  class BadTimeError < Exception; end
+  class RequestFailedError < Exception; end
+  class BannedError < Exception; end
+  class BadAuthError < Exception; end
+  class BadSessionError < Exception; end
+
+  # This is the lastfm submission api client class.
+  # It contains necessary methods for full
+  # interaction with LastFM submissions API.
+
+  class Client
+
+    CLIENT_ID = 'tst'
+    CLIENT_VERSION = '1.0'
+
+    HANDSHAKE_BASE_URL = "http://post.audioscrobbler.com/?hs=true&p=1.2.1&c=#{CLIENT_ID}&v=#{CLIENT_VERSION}"
+
+    # Starts handshake and initializes instance attributes
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+      @queue = []
+
+      response = handshake()
+
+      raise BadFormatedResponseError, 'Bad formated server response' if response.length != 4
+
+      @session_id = response[1]
+      @now_playing_url = response[2]
+      @submission_url = response[3]
+    end
+
+    # Adds a new track to the queue
+    # and submits the queue.
+    # * artistname => the name of the artist
+    # * track => the title of the track (song)
+    # * album => the album name
+    # * secs => the length of the track (seconds)
+    # * tracknumber => the number of the track in album
+    # * mbtrackid => the track's musicbrainz id
+    # * time => the time the track started playing
+    # * source => always 'P'
+    # * rating => the track rating: L, B or S (love, ban, skip)
+
+    def played(track)
+      @queue << track
+      submit_queue
+    end
+
+    # Sends a now playing track.
+    # track is a hash containing the following keys => values:
+    # * artistname => the name of the artist
+    # * track => the title of the track (song)
+    # * album => the album name
+    # * secs => the length of the track (seconds)
+    # * tracknumber => the number of the track in album
+    # * mbtrackid => the track's musicbrainz id
+
+    def now_playing(track)
+      params = "s=#{@session_id}"
+      params << "&a=#{URI.escape(track['artistname'])}"
+      params << "&t=#{URI.escape(track['track'])}"
+      params << "&b=#{URI.escape(track['album'])}"
+      params << "&l=#{URI.escape(track['secs'])}"
+      params << "&n=#{URI.escape(track['tracknumber'])}"
+      params << "&m=#{URI.escape(track['mbtrackid'])}"
+
+      send_submission(@now_playing_url, params)
+    end
+
+    private
+
+    # Executes the handshake with the API.
+    # If handshake returned OK then the entire
+    # response is returned in a array, where
+    # * index 0 is the handshake result
+    # * index 1 is the session id
+    # * index 2 is the now playing url
+    # * index 3 is the submissions url
+
+    def handshake
+      timestamp = Time.now.to_i.to_s
+      token = generate_token(timestamp)
+
+      url = URI.parse(HANDSHAKE_BASE_URL+"&u=#{@username}&t=#{timestamp}&a=#{token}")
+      response = Net::HTTP.get(url)
+
+      case response
+      when /OK/
+        response.split("\n")
+      when /BADTIME/
+        raise BadTimeError
+      when /FAILED/
+        raise RequestFailedError, response
+      when /BANNED/
+        raise BannedError
+      when /BADAUTH/
+        raise BadAuthError
+      else
+        raise RequestFailedError
+      end
+    end
+
+    # Generates the handshake token.
+    # This token is generated according to:
+    # md5(md5(password)+timestamp)
+
+    def generate_token(timestamp)
+      Digest::MD5.hexdigest(Digest::MD5.hexdigest(@password)+timestamp)
+    end
+
+    # Prepares the POST data to submit the track queue.
+    # After the submission the queue is emptied.
+
+    def submit_queue
+      params = "s=#{@session_id}"
+      i = 0
+      @queue.each do |item|
+        params << "&a[#{i}]=#{URI.escape(item['artistname'])}"
+        params << "&t[#{i}]=#{URI.escape(item['track'])}"
+        params << "&i[#{i}]=#{URI.escape(item['time'])}"
+        params << "&o[#{i}]=#{URI.escape(item['source'])}"
+        params << "&r[#{i}]=#{URI.escape(item['rating'])}"
+        params << "&l[#{i}]=#{URI.escape(item['secs'])}"
+        params << "&b[#{i}]=#{URI.escape(item['album'])}"
+        params << "&n[#{i}]=#{URI.escape(item['tracknumber'])}"
+        params << "&m[#{i}]=#{URI.escape(item['mbtrackid'])}"
+        i+=1
+      end
+
+      send_submission(@submission_url, params)
+      @queue = [] # clean it
+    end
+
+    # Submits the track queue POST data to the API.
+    # If any error occurs it raises exception.
+
+    def send_submission(url, params)
+
+      url = URI.parse(url)
+      http = Net::HTTP.new(url.host)
+      response = http.post(url.path, params).body
+
+      case response
+      when /OK/
+        # nice
+      when /BADSESSION/
+        raise BadSessionError
+      else
+        puts response.inspect
+        raise RequestFailedError, response
+      end
+      response
+    end
+
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: tinyscrobbler
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Rogerio Vicente
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-10 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-mp3info
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.13
+    version: 
+description: 
+email: rogerpvl@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- Changelog
+- example.rb
+- lib/audiometa.rb
+- lib/tinyscrobbler.rb
+has_rdoc: true
+homepage: http://github.com/rogeriopvl/tinyscrobbler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tinyscrobbler
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A very lightweight last.fm scrobbler library written in ruby.
+test_files: []
+