grooveshark 0.2.8.1 → 0.2.8.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d353bdcd6c8de12ac82635d8cf21b4aff0a0398
+  data.tar.gz: 23702348073546abd32c472875a36b6b427fa9bb
+SHA512:
+  metadata.gz: ac645b069fd9956049d8c982c7b2cf74d275d40c50c64f56095a7132c4ab1e038fe7ec31d53d622e2305110a1ff0a1ef7ac8a1e0f9af9d3df3ec3434a87778a1
+  data.tar.gz: a5d38d2e45caa98a721eaf6142a75cbc458e9862ade9310a170e04a4168be09a7eecab3e848007561ac657b58e9e75ed696cd2665b28e941c5c8f077fe3a0f5f

data/README.md

@@ -0,0 +1,252 @@
+# 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
+
+Install gem from rubygems:
+
+```
+gem install grooveshark
+```
+
+Or add this line to your `Gemfile`:
+
+```
+gem "grooveshark"
+```
+
+And install bundle:
+
+```
+bundle install
+```
+  
+## Usage
+
+First, you'll need to create a session. Grooveshark's session is a 
+regular PHP session with expiration date of 7 days.
+
+```ruby
+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
+  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
+
+```ruby
+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.
+
+```ruby
+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:
+
+```ruby
+user.playlists.each do |p|
+  p.id          # Playlist ID
+  p.name        # Playlist name
+  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
+songs = playlist.songs
+```
+
+Rename existing playlist:
+
+```ruby
+playlist = user.get_playlist(ID)
+playlist.rename('NEW NAME', 'NEW DESCRIPTION')
+```
+
+Delete existing user playlist
+
+```ruby
+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 
+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
+user.add_favorite(song) # Song object or song ID
+```
+
+Remove song from favorites:
+
+```ruby
+user.remove_favorite(song) # Song object or song ID
+```
+  
+### User library
+
+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. 
+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:
+
+```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
+
+Run test suite:
+
+```
+rake test
+```
+
+## Contact
+
+- Dan Sosedoff
+- dan.sosedoff@gmail.com
+- http://twitter.com/dan_sosedoff
+
+## License
+
+MIT License
+
+Copyright (c) 2011-2013 Dan Sosedoff.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/grooveshark.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   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")

data/lib/grooveshark/playlist.rb

@@ -20,7 +20,7 @@ module Grooveshark
 
     # Fetch playlist songs
     def load_songs
-      @songs = @client.request('playlistGetSongs', :playlistID => @id)['songs']
+      @songs = @client.request('getPlaylistByID', :playlistID => @id)['songs']
       @songs.map! { |s| Song.new(s) }
     end
     
@@ -41,4 +41,4 @@ module Grooveshark
       @client.request('deletePlaylist', {:playlistID => @id, :name => @name})
     end
   end
-end
+end

data/lib/grooveshark/version.rb

@@ -1,3 +1,3 @@
 module Grooveshark
-  VERSION = '0.2.8.1'
+  VERSION = "0.2.8.2"
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: grooveshark
 version: !ruby/object:Gem::Version
-  version: 0.2.8.1
-  prerelease: 
+  version: 0.2.8.2
 platform: ruby
 authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,39 +41,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -101,7 +90,7 @@ files:
 - .rspec
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - grooveshark.gemspec
 - lib/grooveshark.rb
@@ -116,34 +105,28 @@ files:
 - spec/helper.rb
 - spec/utils_spec.rb
 homepage: http://github.com/sosedoff/grooveshark
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2904794095928449912
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2904794095928449912
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Grooveshark API
 test_files:
 - spec/client_spec.rb

data/README.rdoc

@@ -1,159 +0,0 @@
-= 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