rockstar 0.6.3 → 0.6.4

data/lib/rockstar/playing.rb

@@ -1,50 +0,0 @@
-module Rockstar
-  class Playing
-    # you should read last.fm/api/submissions#np first!
-
-    attr_accessor :session_id, :now_playing_url, :artist, :track,
-                  :album, :length, :track_number, :mb_track_id
-    attr_reader :status
-
-    def initialize(args = {})
-      @session_id = args[:session_id] # from Rockstar::SimpleAuth
-      @now_playing_url = args[:now_playing_url] # from Rockstar::SimpleAuth (can change)
-      @artist = args[:artist] # track artist
-      @track = args[:track] # track name
-      @album = args[:album] || '' # track album (optional)
-      @length = args[:length] || '' # track length in seconds (optional)
-      @track_number = args[:track_number] || '' # track number (optional)
-      @mb_track_id = args[:mb_track_id] || '' # MusicBrainz track ID (optional)
-
-      if [@session_id, @now_playing_url, @artist, @track].any?(&:blank?)
-        raise ArgumentError, 'Missing required argument'
-      elsif !@length.to_s.empty? && @length.to_i <= 30 # see last.fm/api
-        raise ArgumentError, 'Length must be greater than 30 seconds'
-      end 
-
-      @connection = REST::Connection.new(@now_playing_url)
-    end
-
-    def submit!
-       warn "[DEPRECATION] the `playing` class is deprecated. Please use track.updateNowPlaying"
-       query = { :s => @session_id,
-                :a => @artist,
-                :t => @track,
-                :b => @album,
-                :l => @length,
-                :n => @track_number,
-                :m => @mb_track_id }
-
-      @status = @connection.post('', false, query)
-
-      case @status
-      when /OK/
-
-      when /BADSESSION/
-        raise BadSessionError # rerun Rockstar::SimpleAuth#handshake!
-      else
-        raise RequestFailedError
-      end
-    end
-  end
-end

data/lib/rockstar/scrobble.rb

@@ -1,68 +0,0 @@
-# exception definitions
-class BadSessionError < StandardError; end
-class RequestFailedError < StandardError; end
-
-module Rockstar
-  class Scrobble
-    # you need to read last.fm/api/submissions#subs first!
-
-    attr_accessor :session_id, :submission_url, :artist, :track, :time,
-                  :source, :length, :album, :track_number, :mb_track_id, :rating
-    attr_reader :status
-
-    def initialize(args = {})
-      @session_id = args[:session_id] # from Rockstar::TokenAuth
-      @submission_url = args[:submission_url] # from Rockstar::TokenAuth (can change)
-      @artist = args[:artist] # track artist
-      @track = args[:track] # track name
-      @time = args[:time] # a Time object set to the time the track started playing
-      @source = args[:source] || 'P' # track source, see last.fm/api/submissions#subs
-      @length = args[:length].to_s || '' # track length in seconds
-      @album = args[:album] || '' # track album name (optional)
-      @track_number = args[:track_number] || '' # track number (optional)
-      @mb_track_id = args[:mb_track_id] || '' # MusicBrainz track ID (optional)
-      @rating = args[:rating] || '' # Rating for clip (optional L=Love, B=Ban (if source=L), S=Skip (if source=L))
-      
-      if [@session_id, @submission_url, @artist, @track].any?(&:blank?)
-        raise ArgumentError, 'Missing required argument'
-      elsif @time.class.to_s != 'Time'
-        raise ArgumentError, ":time must be a Time object"
-      elsif !['P','R','E','U'].include?(@source) # see last.fm/api/submissions#subs
-        raise ArgumentError, "Invalid source"
-      elsif @source == 'P' && @length.blank? # length is not optional if source is P
-        raise ArgumentError, 'Length must be set'
-      elsif !@length.blank? && @length.to_i <= 30 # see last.fm/api/submissions#subs
-        raise ArgumentError, 'Length must be greater than 30 seconds'
-      end
-
-      @connection = REST::Connection.new(@submission_url)
-    end
-
-    def submit!
-       warn "[DEPRECATION] the `scrobble` class is deprecated. Please use track.scrobble"
-       query = { :s => @session_id,
-                'a[0]' => @artist,
-                't[0]' => @track,
-                'i[0]' => @time.utc.to_i,
-                'o[0]' => @source,
-                'r[0]' => @rating,
-                'l[0]' => @length,
-                'b[0]' => @album,
-                'n[0]' => @track_number,
-                'm[0]' => @mb_track_id }
-                
-      @status = @connection.post('', false, query)
-
-      case @status
-      when /OK/
-
-      when /BADSESSION/
-        raise BadSessionError # rerun Rockstar::SimpleAuth#handshake!
-      when /FAILED/
-        raise RequestFailedError, @status
-      else
-        raise RequestFailedError
-      end
-    end
-  end
-end

data/lib/rockstar/simpleauth.rb

@@ -1,62 +0,0 @@
-require 'digest/md5'
-
-# exception definitions
-class BadAuthError < StandardError; end
-class BannedError < StandardError; end
-class BadTimeError < StandardError; end
-module Rockstar
-  AUTH_URL = 'http://post.audioscrobbler.com'
-  AUTH_VER = '1.2.1'
-  
-  # This class is deprecated. Please use TokenAuth instead.
-  class SimpleAuth
-    # you should read last.fm/api/submissions#handshake
-
-    attr_accessor :user, :password, :client_id, :client_ver
-    attr_reader :status, :session_id, :now_playing_url, :submission_url
-
-    def initialize(args = {})
-      warn "[DEPRECATION] This class is deprecated. Please use TokenAuth instead!"
-      
-      @user = args[:user] # last.fm username
-      @password = args[:password] # last.fm password
-      @client_id = 'rck' # Client ID assigned by last.fm; Don't change this!
-      @client_ver = Rockstar::Version
-
-      raise ArgumentError, 'Missing required argument' if @user.blank? || @password.blank?
-
-      @connection = REST::Connection.new(AUTH_URL)
-    end
-
-    def handshake!
-      password_hash = Digest::MD5.hexdigest(@password)
-      timestamp = Time.now.to_i.to_s
-      token = Digest::MD5.hexdigest(password_hash + timestamp)
-
-      query = { :hs => 'true',
-                :p => AUTH_VER,
-                :c => @client_id,
-                :v => @client_ver,
-                :u => @user,
-                :t => timestamp,
-                :a => token }
-      result = @connection.get('/', false, query)
-
-      @status = result.split(/\n/)[0]
-      case @status
-      when /OK/
-        @session_id, @now_playing_url, @submission_url = result.split(/\n/)[1,3]
-      when /BANNED/
-        raise BannedError # something is wrong with the gem, check for an update
-      when /BADAUTH/
-        raise BadAuthError # invalid user/password
-      when /FAILED/
-        raise RequestFailedError, @status
-      when /BADTIME/
-        raise BadTimeError # system time is way off
-      else
-        raise RequestFailedError
-      end  
-    end
-  end
-end

data/lib/rockstar/tokenauth.rb

@@ -1,84 +0,0 @@
-require 'digest/md5'
-
-# exception definitions
-class BadAuthError < StandardError; end
-class BannedError < StandardError; end
-class BadTimeError < StandardError; end
-module Rockstar
-  
-  # = Token Authentification
-  #
-  # There are 2 ways to get an auth token : 
-  # 
-  # = Desktop-App
-  # 1. Get a new token to request authorisation:
-  #     token = Rockstar::Auth.new.token
-  # 2. Open a webbrowser with http://www.last.fm/api/auth/?api_key=xxxxxxxxxxx&token=xxxxxxxx
-  # 3. Wait for the User to confirm that he accepted your request. 
-  # 4. Continue with "Get the session token"
-  #
-  # = Web-App
-  # 1. Redirect the user to http://www.last.fm/api/auth/?api_key={YOUR_API_KEY}&amp;cb={YOUR_RETURN_URL}
-  # 2. If the user accepts, lastfm will redirect to YOUR_RETURN_URL?token=TOKEN
-  #     token = params[:token]
-  # 3. Continue with "Get the session token"
-  #
-  # = Get the session token
-  # 1. Use the previous token and call 
-  #     session = Rockstar::Auth.new.session(token) 
-  # 2. Store the session.key and session.username returned. The session.key will not
-  #    expire. It is save to store it into your database.
-  # 3. Use this session.key as token to authentificate with this class :
-  #     auth = Rockstar::TokenAuth.new({:username => 'chunky', :token => 'bacon'})
-  #     auth.handshake!
-  # 
-  class TokenAuth
-    # you should read last.fm/api/submissions#handshake
-
-    attr_accessor :user, :token, :client_id, :client_ver
-    attr_reader :status, :session_id, :now_playing_url, :submission_url
-
-    def initialize(args = {})
-      @user = args[:username] # last.fm user
-      @token = args[:token] # last.fm token
-      @client_id = 'rck' # Client ID assigned by last.fm; Don't change this!
-      @client_ver = Rockstar::Version
-
-      raise ArgumentError, 'Missing required argument' if @user.blank? || @token.blank?
-      
-      @connection = REST::Connection.new(Rockstar::AUTH_URL)
-    end
-
-    def handshake!
-      timestamp = Time.now.to_i.to_s
-      auth = Digest::MD5.hexdigest("#{Rockstar.lastfm_api_secret}#{timestamp}")
-
-      query = { :hs => 'true',
-                :p => AUTH_VER,
-                :c => @client_id,
-                :v => @client_ver,
-                :u => @user,
-                :t => timestamp,
-                :a => auth,
-                :api_key=>Rockstar.lastfm_api_key,
-                :sk => @token }
-      result = @connection.get('/', true, query)
-
-      @status = result.split(/\n/)[0]
-      case @status
-      when /OK/
-        @session_id, @now_playing_url, @submission_url = result.split(/\n/)[1,3]
-      when /BANNED/
-        raise BannedError # something is wrong with the gem, check for an update
-      when /BADAUTH/
-        raise BadAuthError # invalid user/password
-      when /FAILED/
-        raise RequestFailedError, @status
-      when /BADTIME/
-        raise BadTimeError # system time is way off
-      else
-        raise RequestFailedError
-      end  
-    end
-  end
-end

data/test/unit/test_playing.rb

@@ -1,53 +0,0 @@
-require File.expand_path('../../test_helper.rb', __FILE__)
-
-class TestPlaying < Test::Unit::TestCase
-
-  def setup
-    @session_id = '17E61E13454CDD8B68E8D7DEEEDF6170'
-    @now_playing_url = 'http://62.216.251.203:80/nowplaying'
-    @artist = 'Anberlin'
-    @track = 'A Day Late'
-    @album = 'Never Take Friendship Personal'
-    
-    @playing = Rockstar::Playing.new(:session_id => @session_id, :now_playing_url => @now_playing_url,
-                                      :artist => @artist, :track => @track, :album => @album, :length => 214,
-                                      :track_number => 5)
-  end
-  
-  test 'should require a session id' do
-    assert_raises(ArgumentError) { Rockstar::Playing.new(
-                                      :now_playing_url => @now_playing_url, :artist => @artist, :track => @track,
-                                      :album => @album, :length => 214, :track_number => 5) }
-  end
-  
-  test 'should require a now playing url' do
-    assert_raises(ArgumentError) { Rockstar::Playing.new(
-                                      :session_id => @session_id, :artist => @artist, :track => @track,
-                                      :album => @album, :length => 214, :track_number => 5) }
-  end
-  
-  test 'should require an artist' do
-    assert_raises(ArgumentError) { Rockstar::Playing.new(
-                                      :session_id => @session_id, :now_playing_url => @now_playing_url,
-                                      :track => @track, :album => @album, :length => 214, :track_number => 5) }
-  end
-  
-  test 'should require a track' do
-    assert_raises(ArgumentError) { Rockstar::Playing.new(
-                                      :session_id => @session_id, :now_playing_url => @now_playing_url,
-                                      :artist => @artist, :album => @album, :length => 214, :track_number => 5) }
-  end
-  
-  test 'should require a length greater than 30 seconds' do
-    assert_raises(ArgumentError) { Rockstar::Playing.new(
-                                      :session_id => @session_id, :now_playing_url => @now_playing_url,
-                                      :artist => @artist, :track => @track, :album => @album, :length => 29,
-                                      :track_number => 5) }
-  end
-  
-  test 'should submit successfully' do
-    @playing.submit!
-    assert_equal('OK', @playing.status)
-  end
-
-end

data/test/unit/test_scrobble.rb

@@ -1,69 +0,0 @@
-require File.expand_path('../../test_helper.rb', __FILE__)
-
-class TestScrobble < Test::Unit::TestCase
-  
-  def setup
-    @session_id = '17E61E13454CDD8B68E8D7DEEEDF6170'
-    @submission_url = 'http://62.216.251.205:80/protocol_1.2'
-    @artist = 'Coldplay'
-    @name = 'Viva La Vida'
-    
-    @scrobble = Rockstar::Scrobble.new(:session_id => @session_id, :submission_url => @submission_url,
-                                        :artist => @artist, :track => @name, :album => @name, :time => Time.new,
-                                        :length => 244, :track_number => 7)
-  end
-  
-  test 'should require a session id' do
-    assert_raises(ArgumentError) { Rockstar::Scrobble.new(:submission_url => @submission_url,
-                                        :artist => @artist, :track => @name, :album => @name, :time => Time.new,
-                                        :length => 244, :track_number => 7) }
-  end
-  
-  test 'should require a submission url' do
-    assert_raises(ArgumentError) { Rockstar::Scrobble.new(:session_id => @session_id,
-                                        :artist => @artist, :track => @name, :album => @name, :time => Time.new,
-                                        :length => 244, :track_number => 7) }
-  end
-  
-  test 'should require an artist' do
-    assert_raises(ArgumentError) { Rockstar::Scrobble.new(:session_id => @session_id, :submission_url => @submission_url,
-                                        :track => @name, :album => @name, :time => Time.new,
-                                        :length => 244, :track_number => 7) }
-  end
-  
-  test 'should require a track' do
-    assert_raises(ArgumentError) { Rockstar::Scrobble.new(:session_id => @session_id, :submission_url => @submission_url,
-                                        :artist => @artist, :album => @name, :time => Time.new,
-                                        :length => 244, :track_number => 7) }
-  end
-  
-  test 'should require a Time object' do
-    assert_raises(ArgumentError) { Rockstar::Scrobble.new(:session_id => @session_id, :submission_url => @submission_url,
-                                        :artist => @artist, :track => @name, :album => @name, :time => 'chunky_bacon',
-                                        :length => 244, :track_number => 7) }
-  end
-  
-  test 'should require a valid source' do
-    assert_raises(ArgumentError) { Rockstar::Scrobble.new(:session_id => @session_id, :submission_url => @submission_url,
-                                        :artist => @artist, :track => @name, :album => @name, :time => Time.new,
-                                        :length => 244, :track_number => 7, :source => 'Z') }
-  end
-  
-  test 'should require a length if source is set to P' do
-    assert_raises(ArgumentError) { Rockstar::Scrobble.new(:session_id => @session_id, :submission_url => @submission_url,
-                                        :artist => @artist, :track => @name, :album => @name, :time => Time.new,
-                                        :track_number => 7, :source => 'P') }
-  end
-  
-  test 'should require a length greater than 30 if source is set to P' do
-    assert_raises(ArgumentError) { Rockstar::Scrobble.new(:session_id => @session_id, :submission_url => @submission_url,
-                                        :artist => @artist, :track => @name, :album => @name, :time => Time.new,
-                                        :length => 29, :track_number => 7, :source => 'P') }
-  end
-  
-  test 'should submit successfully' do
-    @scrobble.submit!
-    assert_equal('OK', @scrobble.status)
-  end
-  
-end

data/test/unit/test_simpleauth.rb

@@ -1,45 +0,0 @@
-require File.expand_path('../../test_helper.rb', __FILE__)
-
-class TestSimpleAuth < Test::Unit::TestCase
-
-  def setup
-    @auth = Rockstar::SimpleAuth.new(:user => 'chunky', :password => 'bacon')
-  end
-  
-  test 'should require a user' do
-    assert_raises(ArgumentError) { Rockstar::SimpleAuth.new(:password => 'bacon') }
-  end
-  
-  test 'should require a password' do
-    assert_raises(ArgumentError) { Rockstar::SimpleAuth.new(:user => 'chunky') }
-  end
-  
-  test 'should have the right client id' do
-    assert_equal('rck', @auth.client_id)
-  end
-  
-  test 'should have the right version' do
-    assert_equal(Rockstar::Version, @auth.client_ver)
-  end
-  
-  test 'should handshake successfully' do
-    @auth.handshake!
-    assert_equal('OK', @auth.status)
-  end
-  
-  test 'should get a session id' do
-    @auth.handshake!
-    assert_equal('17E61E13454CDD8B68E8D7DEEEDF6170', @auth.session_id)
-  end
-  
-  test 'should get a now playing url' do
-    @auth.handshake!
-    assert_equal('http://62.216.251.203:80/nowplaying', @auth.now_playing_url)
-  end
-  
-  test 'should get a submission url' do
-    @auth.handshake!
-    assert_equal('http://62.216.251.205:80/protocol_1.2', @auth.submission_url)
-  end
-
-end

data/test/unit/test_tokenauth.rb

@@ -1,45 +0,0 @@
-require File.expand_path('../../test_helper.rb', __FILE__)
-
-class TestTokenAuth < Test::Unit::TestCase
-
-  def setup
-    Rockstar.lastfm = {"api_secret" => 'secret', "api_key" => 'api'}
-    @auth = Rockstar::TokenAuth.new(:username => 'chunky', :token => 'bacon')
-  end
-  
-  test 'should require a user' do
-    assert_raises(ArgumentError) { Rockstar::SimpleAuth.new(:token => 'bacon') }
-  end
-  
-  test 'should require a password' do
-    assert_raises(ArgumentError) { Rockstar::SimpleAuth.new(:user => 'chunky') }
-  end
-  
-  test 'should have the right client id' do
-    assert_equal('rck', @auth.client_id)
-  end
-  
-  test 'should have the right version' do
-    assert_equal(Rockstar::Version, @auth.client_ver)
-  end
-  
-  test 'should handshake successfully' do
-    @auth.handshake!
-    assert_equal('OK', @auth.status)
-  end
-  
-  test 'should get a session id' do
-    @auth.handshake!
-    assert_equal('17E61E13454CDD8B68E8D7DEEEDF6170', @auth.session_id)
-  end
-  
-  test 'should get a now playing url' do
-    @auth.handshake!
-    assert_equal('http://62.216.251.203:80/nowplaying', @auth.now_playing_url)
-  end
-  
-  test 'should get a submission url' do
-    @auth.handshake!
-    assert_equal('http://62.216.251.205:80/protocol_1.2', @auth.submission_url)
-  end
-end