grooveshark 0.2.1 → 0.2.2

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/README.rdoc

@@ -0,0 +1,159 @@
+= Grooveshark API
+
+Unofficial grooveshark API ruby library gives your ability to search and stream songs, 
+manage playlists, media library and favorites.
+API was discovered using http proxy and does not pretend to be always valid due to website API changes.
+
+= Installation
+
+  gem install grooveshark
+  
+= Getting Started
+
+Lets first create a session. 
+Grooveshark session is a regular PHP session with expiration date of 7 days.
+
+  require 'rubygems'
+  require 'grooveshark'
+  
+  client = Grooveshark::Client.new
+  
+To get session key just call
+
+  session = client.session
+  
+You can store this key for 7 days after creation and use it like this:
+
+  client = Grooveshark::Client.new(SESSION_KEY)
+  
+Now we can find some songs:
+  
+  songs = client.search_songs('Nirvana')
+  
+  songs.each do |s|
+    s.id          # Song ID
+    s.name        # Song name
+    s.artist      # Song artist name
+    s.album       # Song album name
+    s.duration    # Song duration in seconds (not always present, 0 by default)
+  end
+  
+We got collection of songs. Check Song object for additional attributes.
+In order to stream song we need to get the authorization
+
+  song = songs.first
+  url = client.get_song_url(song)
+  
+Given url is valid only for current session and cannot be shared or stored permanently.
+Also, it probably violates terms of service.
+  
+= User Authentication
+
+To get your user account you need to provide username and password.
+If username or password is not valid InvalidAuthentication exception will be raised.
+
+  client = Grooveshark::Client.new
+  
+  begin
+    user = client.login('username', 'password')
+  rescue InvalidAuthentication
+    puts "Oooops! Wrong username or password"
+  end
+
+= Playlists and favorites
+
+Get all user playlists
+
+  user.playlists.each do |p|
+    p.id          # Playlist ID
+    p.name        # Playlist name
+    p.about       # Playlist description (empty by default)
+  end
+  
+Get user playlist
+
+  playlist = user.get_playlist(PLAYLIST_ID)
+  
+Get all playlist songs
+  
+  playlist = user.get_playlist(ID)
+  playlist.load_songs
+  songs = playlist.songs
+  
+Rename existing playlist
+
+  playlist = user.get_playlist(ID)
+  playlist.rename('NEW NAME', 'NEW DESCRIPTION')
+
+Delete existing user playlist
+
+  playlist = user.get_playlist(ID)
+  playlist.delete
+  
+Create a new playlist. First parameter is mandatory, description and songs are optional.
+For songs you can provide array of Song objects or array of IDs.
+  
+  songs = client.search_songs('Joe Satriani')
+  p = user.create_playlist('NAME', 'DESCRIPTION', songs)
+  
+Get user favorite songs
+
+  songs = user.favorites
+  
+Add song to favorites
+
+  user.add_favorite(song) # Song object or song ID
+  
+Remove song from favorites
+
+  user.remove_favorite(song) # Song object or song ID
+  
+= User library
+
+Get all songs from library as a collection of Song objects
+
+  songs = user.library
+  
+Add songs to library
+
+  songs = client.search_songs('The Beatles')
+  user.library_add(songs)
+  
+Remove selected songs from library. Unfortunately mass-deletion is not supported by Grooveshark API. You will have to delete each song via separate method call.
+
+  song = user.library.first # Lest pick a first song in the library
+  user.library_remove(song)
+  
+= Explore community
+
+Get all recently active users
+
+  client.recent_users
+  
+Find user by ID
+
+  client.get_user_by_id('ID')
+  
+Find user by username
+
+  client.get_user_by_username('username')
+  
+Fetch recent user activity
+
+  user = client.get_user_by_username('user')
+  user.feed
+  
+= Known issues
+
+* Communication token gets rejected after some time. This timeframe is always different. Additional research didnt show any results.
+
+= TODO
+
+* Testing
+* Library management coverage
+* More methods
+
+= Credits
+
+* Dan Sosedoff - http://github.com/sosedoff
+* Daniel Lamando - http://github.com/danopia

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+end

data/grooveshark.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grooveshark/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "grooveshark"
+  s.version     = Grooveshark::VERSION.dup
+  s.description = "Unofficial ruby library for consuming the Grooveshark API."
+  s.summary     = "Grooveshark API"
+  s.authors     = ["Dan Sosedoff"]
+  s.email       = "dan.sosedoff@gmail.com"
+  s.homepage    = "http://github.com/sosedoff/grooveshark"
+
+  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_development_dependency 'rspec',       '~> 2.6'
+  
+  s.add_runtime_dependency     'json',        '>= 1.4.6'
+  s.add_runtime_dependency     'rest-client', '>= 1.5.1'
+end

data/lib/grooveshark/client.rb

@@ -4,12 +4,20 @@ module Grooveshark
     
     attr_accessor :session, :comm_token
     attr_reader :user
+    attr_reader :comm_token_ttl
+  
+    SALT = 'backToTheScienceLab'
+    METHOD_SALTS = { 
+      'getStreamKeyFromSongIDEx' => 'bewareOfBearsharktopus'
+    }
   
     def initialize(session=nil)
       @session = session || get_session
       get_comm_token
     end
     
+    protected
+    
     # Obtain new session from Grooveshark
     def get_session
       resp = RestClient.get('http://listen.grooveshark.com')
@@ -18,18 +26,22 @@ module Grooveshark
     
     # Get communication token
     def get_comm_token
-      @comm_token = nil # so that it doesn't send a token
+      @comm_token = nil
       @comm_token = request('getCommunicationToken', {:secretKey => Digest::MD5.hexdigest(@session)}, true)
+      @comm_token_ttl = Time.now.to_i
     end
     
     # Sign method
     def create_token(method)
       rnd = rand(256**3).to_s(16).rjust(6, '0')
-      plain = [method, @comm_token, 'quitStealinMahShit', rnd].join(':')
+      salt = METHOD_SALTS.key?(method) ? METHOD_SALTS[method] : SALT
+      plain = [method, @comm_token, salt, rnd].join(':')
       hash = Digest::SHA1.hexdigest(plain)
       "#{rnd}#{hash}"
     end
     
+    public
+    
     # Authenticate user
     def login(user, password)
       data = request('authenticateUser', {:username => user, :password => password}, true)
@@ -54,6 +66,13 @@ module Grooveshark
     def recent_users
       request('getRecentlyActiveUsers', {})['users'].map { |u| User.new(self, u) }
     end
+    
+    # Get popular songs
+    # type => daily, monthly
+    def popular_songs(type='daily')
+      raise ArgumentError, 'Invalid type' unless ['daily', 'monthly'].include?(type)
+      request('popularGetSongs', {:type => type})['songs'].map { |s| Song.new(s) }
+    end
       
     # Perform search request for query
     def search(type, query)

data/lib/grooveshark/errors.rb

@@ -2,4 +2,17 @@ module Grooveshark
   class InvalidAuthentication < Exception ; end
   class ReadOnlyAccess < Exception ; end
   class GeneralError < Exception ; end
+  
+  class ApiError < Exception
+    attr_reader :code
+  
+    def initialize(fault)
+      @code = fault['code']
+      @message = fault['message']
+    end
+  
+    def to_s
+      "#{@code} - #{@message}"
+    end
+  end
 end

data/lib/grooveshark/request.rb

@@ -1,10 +1,11 @@
 module Grooveshark
   module Request
-    API_BASE = 'cowbell.grooveshark.com'
-    UUID = 'E2AB1A59-C6B7-480E-992A-55DE1699D7F8'
-    CLIENT = 'htmlshark'
-    CLIENT_REV = '20101012.37'
-    COUNTRY = {"CC2" => "0","IPR" => "1","CC1" => "0","ID" => "1","CC4" => "0","CC3" => "0"}
+    API_BASE        = 'cowbell.grooveshark.com'
+    UUID            = 'A3B724BA-14F5-4932-98B8-8D375F85F266'
+    CLIENT          = 'htmlshark'
+    CLIENT_REV      = '20110606.04'
+    COUNTRY         = {"CC2" => "0", "IPR" => "353", "CC4" => "1073741824", "CC3" => "0", "CC1" => "0", "ID" => "223"}
+    TOKEN_TTL       = 120 # 2 minutes
     
     # Client overrides for different methods
     METHOD_CLIENTS = {
@@ -13,6 +14,8 @@ module Grooveshark
     
     # Perform API request
     def request(method, params={}, secure=false)
+      refresh_token if @comm_token
+      
       agent = METHOD_CLIENTS.key?(method) ? METHOD_CLIENTS[method] : CLIENT
       url = "#{secure ? 'https' : 'http'}://#{API_BASE}/more.php?#{method}"
       body = {
@@ -41,7 +44,17 @@ module Grooveshark
       
       data = JSON.parse(data)
       data = data.normalize if data.kind_of?(Hash)
-      return data['result'] unless data['fault']
+      
+      if data.key?('fault')
+        raise ApiError.new(data['fault'])
+      else
+        data['result']
+      end
+    end
+    
+    # Refresh communications token on ttl
+    def refresh_token
+      get_comm_token if Time.now.to_i - @comm_token_ttl > TOKEN_TTL
     end
   end
 end

data/lib/grooveshark/song.rb

@@ -2,8 +2,8 @@ module Grooveshark
   class Song
     attr_reader :data
     attr_reader :id, :artist_id, :album_id
-    attr_reader :name, :artist, :album, :track
-    attr_reader :duraion, :artwork, :playcount
+    attr_reader :name, :artist, :album, :track, :year
+    attr_reader :duration, :artwork, :playcount
   
     def initialize(data=nil)
       unless data.nil?
@@ -18,6 +18,7 @@ module Grooveshark
         @duration   = data['estimate_duration']
         @artwork    = data['cover_art_filename']
         @playcount  = data['song_plays']
+        @year       = data['year']
       end
     end
     

data/lib/grooveshark/user.rb

@@ -52,6 +52,11 @@ module Grooveshark
       @client.request('userRemoveSongFromLibrary', req)
     end
     
+    # Get library modification time
+    def library_ts_modified
+      @client.request('userGetLibraryTSModified', {:userID => @id})
+    end
+    
     # --------------------------------------------------------------------------
     # User Playlists
     # --------------------------------------------------------------------------
@@ -69,6 +74,8 @@ module Grooveshark
       result.nil? ? nil : result.first
     end
     
+    alias :playlist :get_playlist
+    
     # Create new user playlist
     def create_playlist(name, description='', songs=[])
       @client.request('createPlaylist', {

data/lib/grooveshark/version.rb

@@ -1,3 +1,3 @@
 module Grooveshark
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/client_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path("./helper", File.dirname(__FILE__))
+
+describe 'Client' do
+  context 'initialization' do
+    it 'should have a valid session' do
+      @gs = Grooveshark::Client.new
+      @gs.session.should_not == nil
+      @gs.session.should match /^[abcdef\d]{32}$/i
+    end
+  end
+  
+  context 'authentication' do
+    it 'should raise InvalidAuthentication error for invalid credentials' do
+      @gs = Grooveshark::Client.new
+      lambda { @gs.login('invlid_user_name', 'invalid_password') }.should raise_error Grooveshark::InvalidAuthentication
+    end
+  end
+  
+  context 'search' do
+    before(:all) do
+      @gs = Grooveshark::Client.new
+    end
+    
+    it 'should return empty songs collection' do
+      songs = @gs.search_songs("@@@@@%%%%%%%@%@%%@")
+      songs.should be_a_kind_of Array
+      songs.size.should == 0
+    end
+    
+    it 'should return songs collection' do
+      songs = @gs.search_songs('Nirvana')
+      songs.should be_a_kind_of Array
+      songs.size.should_not == 0
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'grooveshark'

data/spec/request_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path("./helper", File.dirname(__FILE__))
+
+describe 'Request' do
+  module Grooveshark
+    module Request
+      TOKEN_TTL = 1 # override default ttl for tests
+    end
+  end
+  
+  it 'should obtain a new communication token on TTL expiration' do
+    @gs = Grooveshark::Client.new
+    @tokens = []
+    
+    3.times do |i|
+      @gs.search_songs('Muse')
+      @tokens << @gs.comm_token
+      sleep 3
+    end
+    
+    @tokens.uniq!
+    @tokens.size.should == 3
+  end
+end

data/spec/utils_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path("./helper", File.dirname(__FILE__))
+
+describe 'String' do
+  it 'should normalize attributes' do
+    vars = ['key_name', 'keyName', 'KeyName', 'KeyNAME']
+    target = 'key_name'
+    vars.each { |s| s.normalize_attribute.should == target }
+  end
+end
+
+describe 'Hash' do
+  it 'should normalize simple keys' do
+    h = {'KeyName' => 'Value'}.normalize
+    
+    h.key?('KeyName').should == false
+    h.key?('key_name').should == true
+  end
+  
+  it 'should normalize symbol keys' do
+    h = {:KeyName => 'Value'}.normalize
+    h.key?(:KeyName).should == false
+    h.key?('key_name').should == true
+  end
+  
+  it 'should normalize nested data' do
+    h = {
+      'keyA' => {'nestedKey' => 'Value'},
+      'keyB' => [{'arrKey' => 'Value'}]
+    }.normalize
+    
+    h['key_a'].key?('nested_key').should == true
+    h['key_b'].class.should == Array
+    h['key_b'].first.key?('arr_key').should == true
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: grooveshark
 version: !ruby/object:Gem::Version 
-  hash: 21
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Dan Sosedoff
@@ -15,41 +10,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 -06:00
+date: 2011-08-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 4
-        - 6
         version: 1.4.6
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
         version: 1.5.1
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 description: Unofficial ruby library for consuming the Grooveshark API.
 email: dan.sosedoff@gmail.com
 executables: []
@@ -59,15 +55,24 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- .rspec
+- README.rdoc
+- Rakefile
+- grooveshark.gemspec
 - lib/grooveshark.rb
-- lib/grooveshark/version.rb
-- lib/grooveshark/utils.rb
 - lib/grooveshark/client.rb
 - lib/grooveshark/errors.rb
 - lib/grooveshark/playlist.rb
 - lib/grooveshark/request.rb
 - lib/grooveshark/song.rb
 - lib/grooveshark/user.rb
+- lib/grooveshark/utils.rb
+- lib/grooveshark/version.rb
+- spec/client_spec.rb
+- spec/helper.rb
+- spec/request_spec.rb
+- spec/utils_spec.rb
 has_rdoc: true
 homepage: http://github.com/sosedoff/grooveshark
 licenses: []
@@ -82,25 +87,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Grooveshark API
-test_files: []
-
+test_files: 
+- spec/client_spec.rb
+- spec/helper.rb
+- spec/request_spec.rb
+- spec/utils_spec.rb