grooveshark 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b22e2adb61445f3b5c0253a93cd2a8e012a6c8b
-  data.tar.gz: f93bd8afcc2b20b0de542127067226228b5a1014
+  metadata.gz: 265e469716c245b3c4421d9b1f4a97e9808c3371
+  data.tar.gz: 4e1d82a8c9b0c9e3c12f40d200052ad4d7398c43
 SHA512:
-  metadata.gz: c0538198b0cf8a836731ca3c467a9ad455d68d7a3c61368fd768c6cd5080d0b6490e79156ba4341b7027c1a132c82e0e28fc6596393eb24e393b615b2129358b
-  data.tar.gz: b1fecfb1371885c65b9bb0a09c641b1a6e1fc217074de4f44a5fa88f7c14b973c9a322dd84996acc82506ab4303111baabd6de0cfdf6241456a5ccb841436f12
+  metadata.gz: 8a9732cce0fdaf0edafd248efae89676f7003c1b4c6fa02fabbaadcb19d78cde55bb2fc69ab488abe124f5a3417f66cbec617b531782ca4177f8ce730b3a0a9f
+  data.tar.gz: b7d86f7a0ae7cc1170b3e62ad4bbadbaad2014472eca7c054abbcc56e5cb3db9f181e7e9d8b27ce1c9c66b230cf83243e96802ec2edf69b38bd44cf8e47f5448

data/.gitignore

@@ -1,3 +1,5 @@
+.ruby-version
+.ruby-gemset
 !.gitignore
 *.gem
 *.rbc
@@ -13,6 +15,7 @@
 .bundle
 .config
 .directory
+.project
 .elc
 .redcar
 .yardoc
@@ -38,4 +41,4 @@ test/tmp
 test/version_tmp
 tmp
 tmtags
-tramp
+tramp

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0
+  - 2.1
+
+script:
+  - bundle exec rake spec
+  - sh -c "if [ \"$TRAVIS_RUBY_VERSION\" != '1.9.2' ]; then bundle exec rake rubocop; fi"

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
-gemspec
+
+gemspec

data/README.md

@@ -1,9 +1,11 @@
-# Grooveshark API
+# Grooveshark API [![Build Status](https://travis-ci.org/sosedoff/grooveshark.svg?branch=master)](https://travis-ci.org/sosedoff/grooveshark)
 
 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.
 
+**Looking for maintainer. Submit a new issue if interested.**
+
 ## Installation
 
 Install gem from rubygems:
@@ -242,14 +244,14 @@ user.feed
 Run test suite:
 
 ```
-rake test
+bundle exec rake
 ```
 
 ## Contact
 
 - Dan Sosedoff
 - dan.sosedoff@gmail.com
-- http://twitter.com/dan_sosedoff
+- http://twitter.com/sosedoff
 
 ## License
 

data/Rakefile

@@ -1,10 +1,17 @@
 require 'bundler'
 require 'bundler/gem_tasks'
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:test) do |t|
-  t.pattern = 'spec/*_spec.rb'
+begin
+  require 'rubocop/rake_task'
+
+  RuboCop::RakeTask.new(:rubocop)
+rescue LoadError
+  puts 'Rubocop is needed to run this task.'
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
 end
 
-task :default => :test
+task default: [:rubocop, :spec]

data/grooveshark.gemspec

@@ -1,25 +1,32 @@
 # -*- 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"
+  s.name        = 'grooveshark'
   s.version     = Grooveshark::VERSION
-  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.license     = "MIT"
+  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.license     = 'MIT'
 
   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.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.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
+  s.require_paths = ['lib']
+
+  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_development_dependency 'rake', '~>10.0'
+  s.add_development_dependency 'rack-test', '~>0.6'
+  s.add_development_dependency 'rspec', '~>3.0'
+  s.add_development_dependency 'simplecov', '~>0.9'
+  s.add_development_dependency 'fakefs', '~>0.5'
+
+  s.add_development_dependency 'rubocop', '~>0.25' if RUBY_VERSION != '1.9.2'
 end

data/lib/grooveshark/broadcast.rb

@@ -1,16 +1,18 @@
+# Grooveshark module
 module Grooveshark
+  # Broadcast class
   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)
+    def initialize(client, broadcast_id = nil, data = nil)
       @client = client
 
       if broadcast_id
         @id = broadcast_id
-        reload_status()
+        reload_status
       elsif data
         @id          = data['broadcast_id'] || broadcast_id
         @name        = data['name']
@@ -28,7 +30,7 @@ module Grooveshark
     def reload_status
       initialize(
         @client, nil,
-        @client.request('broadcastStatusPoll', {:broadcastID => id})
+        @client.request('broadcastStatusPoll', broadcastID: @id)
       )
       true
     rescue

data/lib/grooveshark/client.rb

@@ -1,4 +1,6 @@
+# Grooveshark module
 module Grooveshark
+  # Client class
   class Client
     attr_accessor :session, :comm_token
     attr_reader :user, :comm_token_ttl, :country
@@ -6,60 +8,71 @@ module Grooveshark
     def initialize(params = {})
       @ttl = params[:ttl] || 120 # 2 minutes
       @uuid = UUID.new.generate.upcase
-      get_token_data
+      token_data
     end
 
     # Authenticate user
     def login(user, password)
-      data = request('authenticateUser', {:username => user, :password => password}, true)
+      data = request('authenticateUser',
+                     { username: user, password: password },
+                     true)
       @user = User.new(self, data)
-      raise InvalidAuthentication, 'Wrong username or password!' if @user.id == 0
-      return @user
+      fail InvalidAuthentication, 'Wrong username or password!' if @user.id == 0
+
+      @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)
+      resp = request('getUserByID', userID: id)['user']
+      resp['user_id'].nil? ? 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)
+      resp = request('getUserByUsername', username: name)['user']
+      resp['user_id'].nil? ? nil : User.new(self, resp)
     end
 
     # Get recently active users
     def recent_users
-      request('getRecentlyActiveUsers', {})['users'].map { |u| User.new(self, u) }
+      request('getRecentlyActiveUsers', {})['users']
+        .map do |u|
+        User.new(self, u)
+      end
     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) }
+    def popular_songs(type = 'daily')
+      fail ArgumentError, 'Invalid type' unless %w(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)
+    def top_broadcasts(count = 10)
       top_broadcasts = []
-      request('getTopBroadcastsCombined').each do |key,val|
+      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
+        break if count == 0
       end
-      return top_broadcasts
+
+      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 }
+      results = []
+      search = request('getResultsFromSearch', type: type, query: query)
+      results = search['result'].map do |data|
+        next Song.new data if type == 'Songs'
+        next Playlist.new data if type == 'Playlists'
+        data
+      end if search.key?('result')
+      results
     end
 
     # Perform songs search request for query
@@ -69,20 +82,20 @@ module Grooveshark
 
     # Return raw response for songs search request
     def search_songs_pure(query)
-      request('getSearchResultsEx', {:type => 'Songs', :query => 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', {
-        'type' => 0,
-        'prefetch' => false,
-        'songID' => song_id,
-        'country' => @country,
-        'mobile' => false,
-      })
-      if result == [] then
-        raise GeneralError, "No data for this song. Maybe Grooveshark banned your IP."
+      result = request('getStreamKeyFromSongIDEx',
+                       'type' => 0,
+                       'prefetch' => false,
+                       'songID' => song_id,
+                       'country' => @country,
+                       'mobile' => false)
+      if result == []
+        fail GeneralError, 'No data for this song. ' \
+             'Maybe Grooveshark banned your IP.'
       end
       result
     end
@@ -103,16 +116,18 @@ module Grooveshark
       get_song_url_by_id(song.id)
     end
 
-    def get_token_data
+    def token_data
       response = RestClient.get('http://grooveshark.com')
 
-      preload_regex = /gsPreloadAjax\(\{url: '\/preload.php\?(.*)&hash=' \+ clientPage\}\)/
+      preload_regex = /gsPreloadAjax\(\{url: '\/preload.php\?(.*)&hash=' \+ clientPage\}\)/ # rubocop:disable Metrics/LineLength
       preload_id = response.to_s.scan(preload_regex).flatten.first
-      preload_url = "http://grooveshark.com/preload.php?#{preload_id}&getCommunicationToken=1&hash=%2F"
+      preload_url = "http://grooveshark.com/preload.php?#{preload_id}" \
+                    '&getCommunicationToken=1&hash=%2F'
       preload_response = RestClient.get(preload_url)
 
-      token_data_json = preload_response.to_s.scan(/window.tokenData = (.*);/).flatten.first
-      raise GeneralError, "token data not found" if not token_data_json
+      token_data_json = preload_response.to_s
+                        .scan(/window.tokenData = (.*);/).flatten.first
+      fail GeneralError, 'token data not found' unless token_data_json
       token_data = JSON.parse(token_data_json)
       @comm_token = token_data['getCommunicationToken']
       @comm_token_ttl = Time.now.to_i
@@ -124,7 +139,7 @@ module Grooveshark
     # Sign method
     def create_token(method)
       rnd = get_random_hex_chars(6)
-      salt = "gooeyFlubber"
+      salt = 'gooeyFlubber'
       plain = [method, @comm_token, salt, rnd].join(':')
       hash = Digest::SHA1.hexdigest(plain)
       "#{rnd}#{hash}"
@@ -135,11 +150,7 @@ module Grooveshark
       (0...length).map { chars[rand(chars.length)] }.join
     end
 
-    # Perform API request
-    def request(method, params={}, secure=false)
-      refresh_token if @comm_token
-
-      url = "#{secure ? 'https' : 'http'}://grooveshark.com/more.php?#{method}"
+    def body(method, params)
       body = {
         'header' => {
           'client' => 'mobileshark',
@@ -153,17 +164,27 @@ module Grooveshark
         'parameters' => params
       }
       body['header']['token'] = create_token(method) if @comm_token
+      body
+    end
+
+    # Perform API request
+    def request(method, params = {}, secure = false)
+      refresh_token if @comm_token
+
+      url = "#{secure ? 'https' : 'http'}://grooveshark.com/more.php?#{method}"
       begin
-        data = RestClient.post(url, body.to_json, {'Content-Type' => 'application/json'})
-      rescue Exception => ex
+        data = RestClient.post(url,
+                               body(method, params).to_json,
+                               'Content-Type' => 'application/json')
+      rescue StandardError => ex
         raise GeneralError, ex.message
       end
 
       data = JSON.parse(data)
-      data = data.normalize if data.kind_of?(Hash)
+      data = data.normalize if data.is_a?(Hash)
 
       if data.key?('fault')
-        raise ApiError.new(data['fault'])
+        fail ApiError, data['fault']
       else
         data['result']
       end
@@ -171,7 +192,7 @@ module Grooveshark
 
     # Refresh communications token on ttl
     def refresh_token
-      get_token_data if Time.now.to_i - @comm_token_ttl > @ttl
+      token_data if Time.now.to_i - @comm_token_ttl > @ttl
     end
   end
 end

data/lib/grooveshark/errors.rb

@@ -1,8 +1,15 @@
+# Grooveshark module
 module Grooveshark
-  class InvalidAuthentication < Exception ; end
-  class ReadOnlyAccess < Exception ; end
-  class GeneralError < Exception ; end
+  class InvalidAuthentication < Exception
+  end
+
+  class ReadOnlyAccess < Exception
+  end
+
+  class GeneralError < Exception
+  end
 
+  # Api error
   class ApiError < Exception
     attr_reader :code
 
@@ -15,4 +22,4 @@ module Grooveshark
       "#{@code} - #{@message}"
     end
   end
-end
+end

data/lib/grooveshark/playlist.rb

@@ -1,44 +1,48 @@
+# Grooveshark module
 module Grooveshark
+  # Playlist class
   class Playlist
     attr_reader :id, :user_id
     attr_reader :name, :about, :picture, :username
     attr_reader :songs
 
-    def initialize(client, data=nil, user_id=nil)
+    def initialize(client, data = nil, user_id = nil)
       @client = client
       @songs = []
 
-      if data
-        @id       = data['playlist_id']
-        @name     = data['name']
-        @about    = data['about']
-        @picture  = data['picture']
-        @user_id  = data['user_id'] || user_id
-        @username = data['user_name']
-      end
+      return if data.nil?
+      @id       = data['playlist_id']
+      @name     = data['name']
+      @about    = data['about']
+      @picture  = data['picture']
+      @user_id  = data['user_id'] || user_id
+      @username = data['user_name']
     end
 
     # Fetch playlist songs
     def load_songs
-      @songs = @client.request('getPlaylistByID', :playlistID => @id)['songs']
-      @songs.map! { |s| Song.new(s) }
+      @songs = []
+      playlist = @client.request('getPlaylistByID', playlistID: @id)
+      @songs = playlist['songs'].map! do |s|
+        Song.new(s)
+      end if playlist.key?('songs')
+      @songs
     end
 
     # Rename playlist
     def rename(name, description)
-      begin
-        @client.request('renamePlaylist', :playlistID => @id, :playlistName => name)
-        @client.request('setPlaylistAbout', :playlistID => @id, :about => description)
-        @name = name ; @about = description
-        return true
-      rescue
-        return false
-      end
+      @client.request('renamePlaylist', playlistID: @id, playlistName: name)
+      @client.request('setPlaylistAbout', playlistID: @id, about: description)
+      @name = name
+      @about = description
+      true
+    rescue
+      false
     end
 
     # Delete existing playlist
     def delete
-      @client.request('deletePlaylist', {:playlistID => @id, :name => @name})
+      @client.request('deletePlaylist', playlistID: @id, name: @name)
     end
   end
 end