soundcloud-ruby-api-wrapper 0.1.3 → 0.1.5

data/Rakefile

@@ -1,8 +1,10 @@
 require 'rubygems'
 require 'rake'
 
-begin
+begin  
   require 'jeweler'
+
+
   Jeweler::Tasks.new do |gem|
     gem.name = "ruby-api-wrapper"
     gem.summary = %Q{TODO}
@@ -11,12 +13,12 @@ begin
     gem.authors = ["Johannes Wagener"]
     gem.add_dependency "jwagener-oauth-active-resource"    
     gem.add_dependency "oauth"        
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
+  end  
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
 end
 
+
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
@@ -29,7 +31,6 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-
 task :default => :spec
 
 require 'rake/rdoctask'
@@ -46,4 +47,3 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch:	4 
+:patch: 5

data/lib/soundcloud.rb

@@ -12,8 +12,11 @@ require 'oauth_active_resource'
 
 module Soundcloud  
    # Will create an OAuth Consumer for you.
+   #
    # You have to register your application on soundcloud.com to get a consumer token and secret.
+   #
    # Optionally you can specify another provider site (i.e. http://api.sandbox-soundcloud.com)
+   #
    # Default provider site is http://api.soundcloud.com
    def self.consumer(consumer_token,consumer_secret, site = 'http://api.soundcloud.com')
     return OAuth::Consumer.new(consumer_token, consumer_secret, {
@@ -30,14 +33,15 @@ module Soundcloud
   # This module is bound to the given OAuth access token.
   # 
   # Options:
-  #  :access_token = your_oauth_access token
-  #  :site = soundcloud_api_site (i.e. "http://api.sandbox-soundcloud.com", defaults to "http://api.soundcloud.com")
+  #  :access_token = your oauth access token
+  #  :site = soundcloud api site (i.e. "http://api.sandbox-soundcloud.com", defaults to "http://api.soundcloud.com")
   # Examples:
   #
+  #   # unauthenticated to "http://api.soundcloud.com"  
   #   cl = Soundcloud.register()
-  #  => unauthenticated to "http://api.soundcloud.com"
+  #
+  #   # authenticated connection to soundcloud sandbox
   #   cl = Soundcloud.register({:access_token => your_access_token, :site => "http://api.sandbox-soundcloud.com"})
-  #  => authenticated connection to soundcloud sandbox
   #
   def self.register(options = {})
     options[:site] = options[:site] || 'http://api.soundcloud.com'

data/lib/soundcloud/models/comment.rb

@@ -1,16 +1,40 @@
 module Soundcloud
-  module Models
-    
+  module Models    
     # Soundcloud Comment resource
     #
+    # Look up the resource attributes and filtering usage here:
+    #    
     # http://wiki.github.com/soundcloud/api/documentation#comment
     #
-    # See Soundcloud::Models::Track
+    # Examples:
+    # 
+    #   # add a comment to a track
+    #   some_track = sc_client.Track.find('some-track')
+    #   sc_client.Comment.create({:track => some_track, :body => 'Nice Track!'})
+    #  
+    #   # optionally you can add a timestamp (in milliseconds)
+    #   sc_client.Comment.create({:track => some_track, :body => 'nice drums!', :timestamp => 5000})
+    #
+    #   # display all comments of some track
+    #   some_track.comments.each do |comment| 
+    #     p "#{comment.user.full_name} wrote: #{comment.body}"
+    #   end  
+
     class Comment < Base    
       cattr_accessor :element_name    
       belongs_to :user, :track
       self.site = "#{self.site}/tracks/:track_id/"
-      self.element_name = 'comment'      
-    end       
+      self.element_name = 'comment'   
+      
+      def initialize(options)   
+        if not options[:track].nil?
+          options[:track_id] = options[:track].id
+          options.delete(:track)
+        end
+        super(options)
+      end
+      
+    end   
+        
   end
 end

data/lib/soundcloud/models/event.rb

@@ -3,15 +3,17 @@ module Soundcloud
     
     # Soundcloud Event resource
     #
+    # Look up the resource attributes and filtering usage here:
+    #
     # http://wiki.github.com/soundcloud/api/documentation#event
     #
     # Examples:
     #
-    #   client.Event.find(:all,:params => {:filter => 'drop'})
-    #  => get all dropbox events
+    #   # find the last 50 (default soundcloud limit) dropbox events    
+    #   sc_client.Event.find(:all,:params => {:filter => 'drop'})
     #    
-    #   client.Event.find(:all)
-    #  => get all events
+    #   # find the last 50 (default soundcloud limit)  events    
+    #   sc_client.Event.find(:all)
     #
     class Event < Base    
       belongs_to :user, :track

data/lib/soundcloud/models/playlist.rb

@@ -2,9 +2,30 @@ module Soundcloud
   module Models
     # Soundcloud Playlist resource
     #
-    # http://wiki.github.com/soundcloud/api/documentation#playlist
+    # Note: At the moment, you cant create or delete playlists via Soundcloud API
+    #
+    # Look up the resource attributes and filtering usage here:
     #
+    # http://wiki.github.com/soundcloud/api/documentation#playlist
+    # 
     # Examples:
+    #
+    #   # Find a Playlist and add a track to it
+    #   playlist = sc_client.Playlist('my-playlist')   
+    #   track = sc_client.Track('my-track')
+    #   playlist.tracks << track
+    #   playlist.save   
+    #
+    #   # Allow a user to access this track
+    #   some_user = sc_client.User.find('some-user')
+    #   playlist.permissions << some_user
+    #   playlist.permissions.save
+    #
+    #   # Delete first song in playlist
+    #   playlist.tracks.delete playlist.tracks.first
+    #   playlist.save
+    #
+
     class Playlist < Base
       belongs_to :user
       has_many :permissions

data/lib/soundcloud/models/track.rb

@@ -3,16 +3,19 @@ module Soundcloud
     
     # Soundcloud Track resource
     #
+    # Look up the resource attributes and filtering usage here:
+    #    
     # http://wiki.github.com/soundcloud/api/documentation#track
     #
     # Examples:
     #
-    #   some_user_tracks = client.Track.find(:all, :from => '/users/some_user/tracks')
-    #  => gets the tracks from some_user
+    #   # gets the tracks from some_user
+    #   some_user_tracks = sc_client.Track.find(:all, :from => '/users/some_user/tracks')
     #
+    #   # gets the first song from some_user_tracks
     #   first_song = some_user_tracks.first
-    #  => gets the first song from some_user_tracks
     #
+    #   # prints all comments of first_song with username, timestamp (can be nil) and comment body
     #   first_song.comments.each do |comment| 
     #     if comment.timestamp.nil?
     #       timestamp = ""
@@ -21,26 +24,25 @@ module Soundcloud
     #     end
     #     p "#{comment.user.username} #{timestamp}: #{comment.body}"
     #   end
-    #  => Prints all comments of first_song with username, timestamp and  body
     #
     #
-    #   slow_tracks  = client.Track.find(:all, :params => { "bpm[to]" => "100"} )
-    #  => Gets tracks with a BPM <= 100
+    #   # gets tracks with a BPM <= 100    
+    #   slow_tracks  = sc_client.Track.find(:all, :params => { "bpm[to]" => "100"} )
     #
-    #   new_track = client.Track.new
+    #   # create a new Track on Soundcloud with some_sound_file.mp3 as asset data    
+    #   new_track = sc_client.Track.new
     #   new_track.title = 'New Track'
     #   new_track.sharing = 'private'
     #   new_track.set_asset_data(File.new('some_sound_file.wav')
     #   new_track.save
-    #  => Create a new Track on Soundcloud with some_sound_file.mp3 as asset data
     #   
+    #   # downloads the original soundfile. some_sound_file.wav and another_sound_file.wav should be equal
     #   File.open('another_sound_file.wav', 'w') {|f| f.write( new_track.download ) }
-    #  => Downloads the original soundfile. some_sound_file.wav and another_sound_file.wav should be equal
     #
-    #   some_user = client.User.find('some_user')
+    #   # gives some_user permission to access the new_track    
+    #   some_user = sc_client.User.find('some_user')
     #   new_track.permissions << some_user
     #   new_track.permissions.save
-    #  => Gives some_user permission to access the new_track
     #
     #  
     #

data/lib/soundcloud/models/user.rb

@@ -3,28 +3,38 @@ module Soundcloud
     
     # Soundcloud User resource
     #
+    # Look up the resource attributes and filtering usage here:
+    #    
     # http://wiki.github.com/soundcloud/api/documentation#user
     #
     # Examples:
-    #   user = client.User.find('userABC')
-    #  => gets the user with username userABC
-    #
-    #   erics = client.User.find(:all, :params=> {:q => "eric"})
-    #   erics.each do |user|
+    #   # gets the user with username userABC
+    #   user = sc_client.User.find('userABC')
+    #  
+    #   # finds all users named joe and print their usernames    
+    #   joes = sc_client.User.find(:all, :params=> {:q => "joe"})
+    #   joes.each do |user|
     #     p user.username
     #   end
-    #  => finds all users named eric and print their usernames    
     #   
-    #   me = client.User.find(:one, :from => '/me')
-    #  => gets the logged-in user
+    #   # gets the logged-in user
+    #   me = client.User.find_me
+    #
+    #   # checks if the first user named joe is following the second user named joe
+    #   joe1 = joes.first
+    #   joe2 = joes[1]
+    #   joe1.has_contact?(joe2)
+    #
+    #   # makes the loggedin user following joe2
+    #   joe2.add_contact!
     #
-    #   eric1 = erics.first
-    #   eric2 = erics[1]
-    #   eric1.has_contact?(eric2)
-    #  => checks if the first user named eric is following the second user named eric
     #
-    #   eric2.add_contact!
-    #  => makes the loggedin user following eric2
+    #   # Display all tracks of a user
+    #   user = sc_client.User.find('some-user')
+    #   user.tracks.each do |track|
+    #     p  track.title
+    #   end
+    
     
     class User < Base
       has_many :tracks, :contacts, :comments, :favorites, :playlists
@@ -33,6 +43,11 @@ module Soundcloud
       
       cattr_accessor :element_name      
       self.element_name = 'user'
+
+      # Convenience method to find the logged in user
+      def self.find_me
+        find(:one, :from => '/me')
+      end
     end
     
     class Permission < User #:nodoc: 

data/spec/soundcloud_comment_spec.rb

@@ -9,7 +9,7 @@ describe 'Soundcloud::Models::Comment' do
     @track = @sc.Track.find('static-test-track')
   end
   
-  it 'should be able to create and deleta a new comment for a track' do
+  it 'should be able to create and delete a new comment for a track' do
 
     old_count = @track.comments.count  
     comment = @sc.Comment.create({:track_id => @track.id, :body => "new API Test comment"})
@@ -27,5 +27,9 @@ describe 'Soundcloud::Models::Comment' do
     comment.track.id.should_not be nil
   end
   
+  it 'should create a new comment and associate the track_id' do
+    comment = @sc.Comment.new({:track => @track})
+    comment.track_id.should be @track.id
+  end
   
 end

data/spec/soundcloud_spec.rb

@@ -39,4 +39,5 @@ describe "Soundcloud" do
     sc.to_s.should match(/Soundcloud::.+/)
     lambda{ sc.User.find(:one, :from => "/me")}.should_not raise_error ActiveResource::UnauthorizedAccess
   end  
+  
 end

data/spec/soundcloud_track_spec.rb

@@ -84,4 +84,5 @@ describe "Soundcloud::Models::Track" do
     # check against online attribute, to make sure the complete user is loaded, not the nested user 
     @test_track_1.user.online.should_not be nil
   end
+
 end

data/spec/soundcloud_user_spec.rb

@@ -48,6 +48,11 @@ describe "Soundcloud::Models::User" do
     @api_test_2.has_favorite?(track1.id).should be true    
     @api_test_2.has_favorite?(track2).should be false
   end      
+  
+  it 'should find the logged in user' do 
+    my_user = @sc.User.find_me
+    my_user.username.should_not be nil
+  end
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: soundcloud-ruby-api-wrapper
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors: 
 - Johannes Wagener
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-22 00:00:00 -07:00
+date: 2009-05-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency