grooveshark 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d602ca3fbcfdc5d9812fb69bd45e890f25f5b36
-  data.tar.gz: fd049697921040644c38404c77374c2b625622fe
+  metadata.gz: 8b22e2adb61445f3b5c0253a93cd2a8e012a6c8b
+  data.tar.gz: f93bd8afcc2b20b0de542127067226228b5a1014
 SHA512:
-  metadata.gz: e6d345fbb7bf7e58eaf8ceb38c9c2b32d604f8e5e60be3461acacb4dc1028d9f23c31b46f766d64b6ca2b2501dcd4e904a2940f727163841991ef03a0dfdca84
-  data.tar.gz: 5c1a411ae739e3c352ab7c0df69eff39e7234644860619cce1221edf0aa1b19cb48616adf90f194c50540b64fc67bf21452346437699838d26401f985d99d44c
+  metadata.gz: c0538198b0cf8a836731ca3c467a9ad455d68d7a3c61368fd768c6cd5080d0b6490e79156ba4341b7027c1a132c82e0e28fc6596393eb24e393b615b2129358b
+  data.tar.gz: b1fecfb1371885c65b9bb0a09c641b1a6e1fc217074de4f44a5fa88f7c14b973c9a322dd84996acc82506ab4303111baabd6de0cfdf6241456a5ccb841436f12

data/README.md

@@ -1,6 +1,6 @@
 # Grooveshark API
 
-Unofficial grooveshark API ruby library gives your ability to search and stream songs, 
+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.
 
@@ -23,10 +23,10 @@ And install bundle:
 ```
 bundle install
 ```
-  
+
 ## Usage
 
-First, you'll need to create a session. Grooveshark's session is a 
+First, you'll need to create a session. Grooveshark's session is a
 regular PHP session with expiration date of 7 days.
 
 ```ruby
@@ -34,24 +34,24 @@ 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:
-  
+
 ```ruby
 songs = client.search_songs('Nirvana')
-  
+
 songs.each do |s|
   s.id          # Song ID
   s.name        # Song name
@@ -60,7 +60,7 @@ songs.each do |s|
   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
 
@@ -71,7 +71,7 @@ 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.
@@ -79,7 +79,7 @@ If username or password is not valid InvalidAuthentication exception will be rai
 
 ```ruby
 client = Grooveshark::Client.new
-  
+
 begin
   user = client.login('username', 'password')
 rescue InvalidAuthentication
@@ -98,15 +98,15 @@ user.playlists.each do |p|
   p.about       # Playlist description (empty by default)
 end
 ```
-  
+
 Get user playlist:
 
 ```ruby
 playlist = user.get_playlist(PLAYLIST_ID)
 ```
-  
+
 Get all playlist songs:
-  
+
 ```ruby
 playlist = user.get_playlist(ID)
 playlist.load_songs
@@ -126,21 +126,21 @@ 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.
- 
-```ruby 
+
+```ruby
 songs = client.search_songs('Joe Satriani')
 p = user.create_playlist('NAME', 'DESCRIPTION', songs)
 ```
-  
+
 Get user favorite songs:
 
 ```ruby
 songs = user.favorites
 ```
-  
+
 Add song to favorites:
 
 ```ruby
@@ -152,7 +152,40 @@ Remove song from favorites:
 ```ruby
 user.remove_favorite(song) # Song object or song ID
 ```
-  
+
+### Broadcasts
+
+Get top broadcasts:
+
+```ruby
+client.top_broadcasts.each do |b|
+  b.id                # Broadcast ID
+  b.name              # Broadcast Name
+end
+```
+
+To reload the current status of the broadcast (e.g. currently playing song,
+next song, etc.), call `reload_status` method:
+
+```ruby
+broadcast.reload_status
+```
+
+Get the current and next song for a broadcast:
+
+```ruby
+current_song = broadcast.active_song
+next_song = broadcast.next_song
+```
+
+Check whether the broadcast is currently playing:
+
+```ruby
+if broadcast.is_playing
+  # Do something e.g. get the currently playing song.
+end
+```
+
 ### User library
 
 Get all songs from library as a collection of Song objects
@@ -160,23 +193,23 @@ Get all songs from library as a collection of Song objects
 ```ruby
 songs = user.library
 ```
-  
+
 Add songs to library:
 
 ```ruby
 songs = client.search_songs('The Beatles')
 user.library_add(songs)
 ```
-  
-Remove selected songs from library. 
-Unfortunately mass-deletion is not supported by Grooveshark API. 
+
+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.
 
 ```ruby
 song = user.library.first # Lest pick a first song in the library
 user.library_remove(song)
 ```
-  
+
 ### Explore community
 
 Get all recently active users:
@@ -184,35 +217,25 @@ Get all recently active users:
 ```ruby
 client.recent_users
 ```
-  
+
 Find user by ID:
 
 ```ruby
 client.get_user_by_id('ID')
 ```
-  
+
 Find user by username:
 
 ```ruby
 client.get_user_by_username('username')
 ```
-  
+
 Fetch recent user activity:
 
 ```ruby
 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
 
 ## Testing
 

data/grooveshark.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/grooveshark/version', __FILE__)
+require File.expand_path("../lib/grooveshark/version", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "grooveshark"
@@ -14,12 +14,12 @@ Gem::Specification.new do |s|
   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.require_paths = ["lib"]
   
-  s.add_development_dependency 'rspec',       '~> 2.12'
-  s.add_development_dependency 'rake',        '~> 10.0'
+  s.add_development_dependency "rspec",       "~> 2.12"
+  s.add_development_dependency "rake",        "~> 10.0"
   
-  s.add_runtime_dependency     'json',        '>= 1.4.6'
-  s.add_runtime_dependency     'rest-client', '>= 1.5.1'
-  s.add_runtime_dependency     'uuid',        '~> 2.0'
+  s.add_runtime_dependency     "json",        ">= 1.4.6"
+  s.add_runtime_dependency     "rest-client", ">= 1.5.1"
+  s.add_runtime_dependency     "uuid",        "~> 2.0"
 end

data/lib/grooveshark.rb

@@ -3,9 +3,11 @@ require 'json'
 require 'rest-client'
 require 'uuid'
 
+require 'grooveshark/version'
 require 'grooveshark/utils'
 require 'grooveshark/errors'
 require 'grooveshark/client'
 require 'grooveshark/user'
 require 'grooveshark/playlist'
 require 'grooveshark/song'
+require 'grooveshark/broadcast'

data/lib/grooveshark/broadcast.rb

@@ -0,0 +1,38 @@
+module Grooveshark
+  class Broadcast
+    attr_reader :id, :user_ids
+    attr_reader :is_active, :is_playing
+    attr_reader :name, :usernames
+    attr_reader :active_song, :next_song
+
+    def initialize(client, broadcast_id=nil, data=nil)
+      @client = client
+
+      if broadcast_id
+        @id = broadcast_id
+        reload_status()
+      elsif data
+        @id          = data['broadcast_id'] || broadcast_id
+        @name        = data['name']
+        @is_playing  = data['is_playing'] == 1 ? true : false
+        @is_active   = data['is_active']
+        @active_song = Song.new(data['active_song'])
+        @next_song   = Song.new(data['next_song'])
+        @usernames   = data['usernames']
+        @user_ids    = data['owner_user_i_ds']
+      end
+    end
+
+    # Reload broadcast status
+    # Returns true on success. Otherwise false.
+    def reload_status
+      initialize(
+        @client, nil,
+        @client.request('broadcastStatusPoll', {:broadcastID => id})
+      )
+      true
+    rescue
+      false
+    end
+  end
+end

data/lib/grooveshark/client.rb

@@ -2,13 +2,13 @@ module Grooveshark
   class Client
     attr_accessor :session, :comm_token
     attr_reader :user, :comm_token_ttl, :country
-  
+
     def initialize(params = {})
       @ttl = params[:ttl] || 120 # 2 minutes
       @uuid = UUID.new.generate.upcase
       get_token_data
     end
-    
+
     # Authenticate user
     def login(user, password)
       data = request('authenticateUser', {:username => user, :password => password}, true)
@@ -16,47 +16,62 @@ module Grooveshark
       raise InvalidAuthentication, 'Wrong username or password!' if @user.id == 0
       return @user
     end
-    
+
     # Find user by ID
     def get_user_by_id(id)
       resp = request('getUserByID', {:userID => id})['user']
       resp['username'].empty? ? nil : User.new(self, resp)
     end
-    
+
     # Find user by username
     def get_user_by_username(name)
       resp = request('getUserByUsername', {:username => name})['user']
       resp['username'].empty? ? nil : User.new(self, resp)
     end
-    
+
     # Get recently active users
     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
-      
+
+    # Get top broadcasts
+    # count => specifies how many broadcasts to get
+    def top_broadcasts(count=10)
+      top_broadcasts = []
+      request('getTopBroadcastsCombined').each do |key,val|
+        broadcast_id = key.split(':')[1]
+        top_broadcasts.push(Broadcast.new(self, broadcast_id))
+        count -= 1
+        if count == 0
+          break
+        end
+      end
+      return top_broadcasts
+    end
+
     # Perform search request for query
     def search(type, query)
       results = request('getResultsFromSearch', {:type => type, :query => query})['result']
       results.map { |song| Song.new song }
     end
-    
+
     # Perform songs search request for query
     def search_songs(query)
       search('Songs', query)
     end
-    
+
     # Return raw response for songs search request
     def search_songs_pure(query)
       request('getSearchResultsEx', {:type => 'Songs', :query => query})
     end
-    
+
     # Get stream authentication by song ID
     def get_stream_auth_by_songid(song_id)
       result = request('getStreamKeyFromSongIDEx', {
@@ -71,7 +86,7 @@ module Grooveshark
       end
       result
     end
-  
+
     # Get stream authentication for song object
     def get_stream_auth(song)
       get_stream_auth_by_songid(song.id)
@@ -82,7 +97,7 @@ module Grooveshark
       resp = get_stream_auth_by_songid(id)
       "http://#{resp['ip']}/stream.php?streamKey=#{resp['stream_key']}"
     end
-    
+
     # Get song stream
     def get_song_url(song)
       get_song_url_by_id(song.id)
@@ -105,7 +120,7 @@ module Grooveshark
       @country = config['country']
       @session = config['sessionID']
     end
-    
+
     # Sign method
     def create_token(method)
       rnd = get_random_hex_chars(6)
@@ -153,7 +168,7 @@ module Grooveshark
         data['result']
       end
     end
-    
+
     # Refresh communications token on ttl
     def refresh_token
       get_token_data if Time.now.to_i - @comm_token_ttl > @ttl

data/lib/grooveshark/errors.rb

@@ -2,15 +2,15 @@ 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

data/lib/grooveshark/playlist.rb

@@ -3,11 +3,11 @@ module Grooveshark
     attr_reader :id, :user_id
     attr_reader :name, :about, :picture, :username
     attr_reader :songs
-    
+
     def initialize(client, data=nil, user_id=nil)
       @client = client
       @songs = []
-    
+
       if data
         @id       = data['playlist_id']
         @name     = data['name']
@@ -23,7 +23,7 @@ module Grooveshark
       @songs = @client.request('getPlaylistByID', :playlistID => @id)['songs']
       @songs.map! { |s| Song.new(s) }
     end
-    
+
     # Rename playlist
     def rename(name, description)
       begin
@@ -35,7 +35,7 @@ module Grooveshark
         return false
       end
     end
-    
+
     # Delete existing playlist
     def delete
       @client.request('deletePlaylist', {:playlistID => @id, :name => @name})

data/lib/grooveshark/song.rb

@@ -4,7 +4,7 @@ module Grooveshark
     attr_reader :id, :artist_id, :album_id
     attr_reader :name, :artist, :album, :track, :year
     attr_reader :duration, :artwork, :playcount
-  
+
     def initialize(data=nil)
       unless data.nil?
         @data       = data
@@ -21,12 +21,12 @@ module Grooveshark
         @year       = data['year']
       end
     end
-    
+
     # Presentable format
     def to_s
       [@id, @name, @artist].join(' - ')
     end
-    
+
     # Hash export for API usage
     def to_hash
       {

data/lib/grooveshark/user.rb

@@ -18,64 +18,64 @@ module Grooveshark
       end
       @client     = client
     end
-    
+
     # Get user avatar URL
     def avatar
       "http://images.grooveshark.com/static/userimages/#{@id}.jpg"
     end
-    
+
     # Get user activity for the date (COMES AS RAW RESPONSE)
     def feed(date=nil)
       date = Time.now if date.nil?
       @client.request('getProcessedUserFeedData', {:userID => @id, :day => date.strftime("%Y%m%d")})
     end
-    
+
     # --------------------------------------------------------------------------
     # User Library
     # --------------------------------------------------------------------------
-    
-    # Fetch songs from library 
+
+    # Fetch songs from library
     def library(page=0)
       resp = @client.request('userGetSongsInLibrary', {:userID => @id, :page => page.to_s})['songs']
       resp.map { |s| Song.new(s) }
     end
-    
+
     # Add songs to user's library
     def library_add(songs=[])
       @client.request('userAddSongsToLibrary', {:songs => songs.map { |s| s.to_hash }})
     end
-    
+
     # Remove song from user library
     def library_remove(song)
       raise ArgumentError, 'Song object required' unless song.kind_of?(Song)
       req = {:userID => @id, :songID => song.id, :albumID => song.album_id, :artistID => song.artist_id}
       @client.request('userRemoveSongFromLibrary', req)
     end
-    
+
     # Get library modification time
     def library_ts_modified
       @client.request('userGetLibraryTSModified', {:userID => @id})
     end
-    
+
     # --------------------------------------------------------------------------
     # User Playlists
     # --------------------------------------------------------------------------
-    
+
     # Fetch user playlists
     def playlists
       return @playlists if @playlists
       results = @client.request('userGetPlaylists', :userID => @id)
       @playlists = results['playlists'].map { |list| Playlist.new(@client, list, @id) }
     end
-    
+
     # Get playlist by ID
     def get_playlist(id)
       result = playlists.select { |p| p.id == id }
       result.nil? ? nil : result.first
     end
-    
+
     alias :playlist :get_playlist
-    
+
     # Create new user playlist
     def create_playlist(name, description='', songs=[])
       @client.request('createPlaylist', {
@@ -84,24 +84,24 @@ module Grooveshark
         'songIDs' => songs.map { |s| s.kind_of?(Song) ? s.id : s.to_s }
       })
     end
-    
+
     # --------------------------------------------------------------------------
     # User Favorites
     # --------------------------------------------------------------------------
-    
+
     # Get user favorites
     def favorites
       return @favorites if @favorites
       resp = @client.request('getFavorites', :ofWhat => 'Songs', :userID => @id)
       @favorites = resp.map { |s| Song.new(s) }
     end
-    
+
     # Add song to favorites
     def add_favorite(song)
       song_id = song.kind_of?(Song) ? song.id : song
       @client.request('favorite', {:what => 'Song', :ID => song_id})
     end
-    
+
     # Remove song from favorites
     def remove_favorite(song)
       song_id = song.kind_of?(Song) ? song.id : song

data/lib/grooveshark/version.rb

@@ -1,3 +1,3 @@
 module Grooveshark
-  VERSION = "0.2.10"
+  VERSION = "0.2.11"
 end

data/spec/broadcast_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path("./helper", File.dirname(__FILE__))
+
+describe Grooveshark::Broadcast do
+  let(:client) { Grooveshark::Client.new }
+
+  describe "search" do
+    let(:result) { client.top_broadcasts(10) }
+
+    it "returns an array" do
+      expect(result).to be_an Array
+      expect(result.size).to eq 10
+    end
+
+    it "includes brodcasts" do
+      all = result.all? { |item| item.kind_of?(Grooveshark::Broadcast) }
+      expect(all).to be_true
+    end
+  end
+  
+  describe "broadcast" do
+    let(:broadcast) { client.top_broadcasts.first }
+
+    it "has a valid id" do
+      expect(broadcast.id).to match /^[abcdef\d]{24}$/i
+    end
+
+    describe "#active_song" do
+      it "is a song instance" do
+        expect(broadcast.active_song).to be_a Grooveshark::Song
+      end
+    end
+
+    describe "#next_song" do
+      it "is a song instance" do
+        expect(broadcast.active_song).to be_a Grooveshark::Song
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grooveshark
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,6 +94,7 @@ files:
 - Rakefile
 - grooveshark.gemspec
 - lib/grooveshark.rb
+- lib/grooveshark/broadcast.rb
 - lib/grooveshark/client.rb
 - lib/grooveshark/errors.rb
 - lib/grooveshark/playlist.rb
@@ -101,6 +102,7 @@ files:
 - lib/grooveshark/user.rb
 - lib/grooveshark/utils.rb
 - lib/grooveshark/version.rb
+- spec/broadcast_spec.rb
 - spec/client_spec.rb
 - spec/helper.rb
 - spec/utils_spec.rb
@@ -129,6 +131,7 @@ signing_key:
 specification_version: 4
 summary: Grooveshark API
 test_files:
+- spec/broadcast_spec.rb
 - spec/client_spec.rb
 - spec/helper.rb
 - spec/utils_spec.rb