soundcloud-ruby-api-wrapper 0.1.8 → 0.1.9

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 8 
+:patch: 9 

data/lib/soundcloud/models/event.rb

@@ -8,6 +8,9 @@ module Soundcloud
     # * resource_id
     # * comment/track/user (embedded resource, depending on type)
     #
+    # Custom Wrapper Attribute:
+    # * event_type (access to type attribute, since 'type' is a ruby keyword)
+    #
     # Look up the resource attributes and filtering usage here:
     #    
     # http://wiki.github.com/soundcloud/api/documentation#event
@@ -25,9 +28,13 @@ module Soundcloud
     #   sc_client.Event.find(:all)
     #
     class Event < Base    
-      #belongs_to :user, :track, :comment # this is not right
       cattr_accessor :element_name    
       self.element_name = 'event'
+      
+      
+      def event_type 
+        return attributes['type']
+      end
     end    
   end
 end

data/lib/soundcloud/models/playlist.rb

@@ -1,6 +1,6 @@
 module Soundcloud
   module Models
-    # Note: At the moment, you can't create or delete playlists via Soundcloud API
+    # Note: At the moment, you can't create or delete playlists or change their permissions via Soundcloud API
     #
     # SC API Attributes (as of 26/05/09):
     # * created_at
@@ -20,7 +20,6 @@ module Soundcloud
     #
     # Custom Wrapper Attributes/Methods:
     # * user 
-    # * permissions
     #    
     # Look up the resource attributes and filtering usage here:
     #    
@@ -29,16 +28,11 @@ module Soundcloud
     # Examples:
     #
     #   # Find a Playlist and add a track to it
-    #   playlist = sc_client.Playlist('my-playlist')   
-    #   track = sc_client.Track('my-track')
+    #   playlist = sc_client.Playlist.find('my-playlist')   
+    #   track = sc_client.Track.find('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
@@ -46,7 +40,7 @@ module Soundcloud
 
     class Playlist < Base
       belongs_to :user
-      has_many :permissions
+      #      has_many :permissions
       cattr_accessor :element_name    
       self.element_name = 'playlist'    
       def initialize(*args)

data/lib/soundcloud/models/track.rb

@@ -42,6 +42,8 @@ module Soundcloud
     #
     # Examples:
     #
+    #   some_user = sc_client.User.find('some_user')
+    #    
     #   # gets 50 (Soundcloud API limit) tracks from some_user
     #   some_user_tracks = some_user.tracks
     #
@@ -58,6 +60,10 @@ module Soundcloud
     #     p "#{comment.user.username} #{timestamp}: #{comment.body}"
     #   end
     #
+    #   # downloads the original track file (track.downloadable must be true)
+    #   # (the open call requires the 'open-uri' gem)
+    #   downloaded_file = open first_song.download_url
+    #
     #
     #   # gets 50 (Soundcloud API limit) tracks with a BPM <= 100    
     #   slow_tracks  = sc_client.Track.find(:all, :params => { "bpm[to]" => "100"} )
@@ -69,19 +75,11 @@ module Soundcloud
     #   new_track.sharing = 'private'
     #   new_track.asset_data = File.new('some_sound_file.wav')
     #   new_track.save
-    #   
-    #   # downloads the original soundfile. 
-    #   #some_sound_file.wav and downloaded_file should be the same (the open call requires the 'open-uri' gem)
-    #   downloaded_file = open new_track.download_url
     #
     #   # 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
     #
-    #  
-    #
-    #
     
     class Track < Base
       belongs_to :user

data/spec/soundcloud_event_spec.rb

@@ -12,8 +12,19 @@ describe 'Soundcloud::Models::Event' do
     events = @sc.Event.find(:all)
   end
   
-  it 'should get a fan event and should provide the user resource' do
-    fan_events = @sc.Event.find(:all,:params => {:type => 'Fan'})
-    fan_events.first.user.username.should_not be nil
+  it 'should get fan events and they should provide the user resource' do
+    fan_events = @sc.Event.find(:all,:params => {:filter => 'fan'})
+    fan_events.each do |event|
+      event.event_type.should be == "Fan"
+      event.user.username.should_not be nil      
+    end
+  end
+  
+  it 'should get track events and they should provide the track resource' do
+    events = @sc.Event.find(:all,:params => {:filter => 'track'})
+    events.each do |event|
+      event.event_type.should be == "Track"
+      event.track.title.should_not be nil      
+    end    
   end
 end

data/spec/soundcloud_spec.rb

@@ -11,7 +11,7 @@ require 'spec_helper'
 # api-test-2 follows api-test-1 and api-test-3
 # api-test-3 follows api-test-2 but NOT api-test-1
 # 
-# api-test-2 has 3 Tracks [Track1 (downloadable),Track2,Track3]
+# api-test-2 has 3 Tracks [Track1 (public,downloadable),Track2,Track3(private,downloadable)]
 # api-test-2 has favorites: Track1 but NOT Track2
 # api-test-2 has 'static-test-playlist' with Track1, 2 and 3
 #

data/spec/soundcloud_user_spec.rb

@@ -62,7 +62,7 @@ describe "Soundcloud::Models::User" do
     @api_test_2.fans({:limit => 1}).count.should be == 1
     @api_test_2.fans({:limit => 2}).count.should be == 2
   end
-
+  
 end
 
 

metadata

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