soundcloud-ruby-api-wrapper 0.4.5 → 0.4.6

data/README.html

@@ -6,6 +6,11 @@
 
 <h3>News</h3>
 
+<h4>May 18 2010</h4>
+<p>Appending consumer_key param to all requests to public resources.</p>
+
+<p>Removing Event model.</p>
+
 19. November 2009
 <p>With version 0.4.2 we switched back to the mojodna oauth gem, since the bug was finally fixed. We also had to switch to gemcutter.org to host our gems, since github doesn't support gem building and hosting anymore. By doing that we renamed jwagener-oauth-active-resource to oauth-active-resource.</p>
 

data/Rakefile

@@ -1,22 +1,22 @@
 require 'rubygems'
 require 'rake'
 
-begin  
+begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "soundcloud-ruby-api-wrapper"
-    gem.summary = "A ruby wrapper for the SoundCloud API"
-    gem.email = "johannes@wagener.cc"
+    gem.name     = "soundcloud-ruby-api-wrapper"
+    gem.summary  = "A ruby wrapper for the SoundCloud API"
+    gem.email    = "johannes@soundcloud.com"
     gem.homepage = "http://github.com/soundcloud/ruby-api-wrapper"
-    gem.authors = ["Johannes Wagener"]
-    gem.add_dependency "oauth-active-resource", ">= 0.4.4"   
-    gem.add_dependency "oauth", ">= 0.3.6"        
-  end  
+    gem.authors  = [ "Johannes Wagener", "Thor Kell", "Hannes Tyden" ]
+    
+    gem.add_dependency "oauth-active-resource", ">= 0.4.4"
+    gem.add_dependency "oauth", ">= 0.3.6"
+  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'

data/VERSION.yml

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

data/lib/soundcloud.rb

@@ -10,6 +10,7 @@ require 'oauth'
 gem 'oauth-active-resource'
 require 'oauth_active_resource'
 
+
 module Soundcloud  
    # Will create an OAuth Consumer for you.
    #
@@ -44,7 +45,10 @@ module Soundcloud
   #
   def self.register(options = {})
     options[:site] = options[:site] || 'http://api.soundcloud.com'
-    mod = OAuthActiveResource.register(self.ancestors.first, self.ancestors.first.const_get('Models'), options)
+    if options[:consumer_key].nil? && options[:access_token].nil?
+      raise "Error:  No consumer key or OAuth access token supplied."
+    end
+    mod = SCOAuthActiveResource.register(self.ancestors.first, self.ancestors.first.const_get('Models'),options)
     add_resolver_to_mod(mod)
   end
   
@@ -75,5 +79,4 @@ require 'soundcloud/models/event'
 require 'soundcloud/models/playlist'
 require 'soundcloud/models/track'
 require 'soundcloud/models/group'
-
-
+require File.expand_path('../soundcloud/sc_oauth_active_resource', __FILE__)

data/lib/soundcloud/public_oauth_access_token.rb

@@ -0,0 +1,36 @@
+module Soundcloud
+  
+  # Subclass to force API users to pass a consumer key with each request.
+  class PublicOAuthAccessToken < OAuthActiveResource::FakeOAuthAccessToken
+    
+    attr_accessor :token, :secret
+    def initialize(key)
+      @key    = key
+      @token = "public #{key}"
+      @secret = 'Anonymous'
+      
+      # ensure that keys are symbols
+      @options = @@default_options    
+    end
+    def request(http_method, path, token = nil, request_options = {}, *arguments)
+      # Force a relative path from an absolute path
+      if path !~ /^\//
+        @http = create_http(path)
+      end
+      _uri = URI.parse(path)
+      
+      # Append the consumer key to the request
+      if _uri.query.nil?
+        _uri.query = "consumer_key=#{@key}"
+      else
+        _uri.query += "&consumer_key=#{@key}"
+      end
+      
+      path = "#{_uri.path}#{_uri.query ? "?#{_uri.query}" : ""}"
+      rsp = http.request(create_http_request(http_method, path, token, request_options, *arguments, @key))
+      
+      rsp
+    end
+  end
+end
+

data/lib/soundcloud/sc_oauth_active_resource.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+
+gem 'activeresource'
+require 'active_resource'
+require 'digest/md5'
+require File.expand_path('../public_oauth_access_token', __FILE__)
+
+module SCOAuthActiveResource 
+  
+  # TODO check if klass has ancestor OAuthActiveResource
+  def self.register(add_to_module, model_module, options = {})
+      
+    oauth_connection = options[:access_token]
+    
+    if oauth_connection.nil?
+      oauth_connection = Soundcloud::PublicOAuthAccessToken.new(options[:consumer_key])
+    end
+
+    temp_hash = {:access_token => oauth_connection}
+    options.merge!(temp_hash)
+
+    mod = OAuthActiveResource.register(add_to_module, model_module, options)
+    return mod
+  end
+  
+end
+
+require 'oauth_active_resource/connection'
+require 'oauth_active_resource/resource'
+require 'oauth_active_resource/unique_resource_array'

data/soundcloud-ruby-api-wrapper.gemspec

@@ -1,13 +1,16 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{soundcloud-ruby-api-wrapper}
-  s.version = "0.4.5"
+  s.version = "0.4.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Johannes Wagener"]
-  s.date = %q{2009-11-21}
-  s.email = %q{johannes@wagener.cc}
+  s.authors = ["Johannes Wagener", "Thor Kell", "Hannes Tyden"]
+  s.date = %q{2010-05-18}
+  s.email = %q{johannes@soundcloud.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.html",
@@ -24,17 +27,16 @@ Gem::Specification.new do |s|
      "lib/soundcloud.rb",
      "lib/soundcloud/models/base.rb",
      "lib/soundcloud/models/comment.rb",
-     "lib/soundcloud/models/event.rb",
      "lib/soundcloud/models/group.rb",
      "lib/soundcloud/models/playlist.rb",
      "lib/soundcloud/models/track.rb",
      "lib/soundcloud/models/user.rb",
-     "ruby-api-wrapper.gemspec",
+     "lib/soundcloud/public_oauth_access_token.rb",
+     "lib/soundcloud/sc_oauth_active_resource.rb",
      "soundcloud-ruby-api-wrapper.gemspec",
      "spec/fixtures/test_artwork.gif",
      "spec/fixtures/test_track.mp3",
      "spec/soundcloud_comment_spec.rb",
-     "spec/soundcloud_event_spec.rb",
      "spec/soundcloud_group_spec.rb",
      "spec/soundcloud_playlist_spec.rb",
      "spec/soundcloud_spec.rb",
@@ -49,7 +51,6 @@ Gem::Specification.new do |s|
   s.summary = %q{A ruby wrapper for the SoundCloud API}
   s.test_files = [
     "spec/soundcloud_comment_spec.rb",
-     "spec/soundcloud_event_spec.rb",
      "spec/soundcloud_group_spec.rb",
      "spec/soundcloud_playlist_spec.rb",
      "spec/soundcloud_spec.rb",

data/spec/soundcloud_group_spec.rb

@@ -9,7 +9,7 @@ describe "Soundcloud::Models::Group" do
     @api_test_3 = @sc.User.find('api-test-3')
   end
   
-  # static-test-group id = 2937
+  # static-test-group id = 6635
   # api_test_1 - creator
   # api_test_3 - member
   # api_test_2 track1 should be contributied
@@ -19,14 +19,14 @@ describe "Soundcloud::Models::Group" do
   end
   
   it 'should get the fixture group' do
-    group = @sc.Group.find(2937)
+    group = @sc.Group.find(6635)
     group.name.should == "static-test-group"
   end
   
   
   describe 'users' do
     before do
-      @group = @sc.Group.find(2937)
+      @group = @sc.Group.find(6635)
     end
     
     it 'should have the right creatotr api_test_1' do
@@ -42,7 +42,7 @@ describe "Soundcloud::Models::Group" do
     end
     
     it 'should have a contributed track' do
-      @group.tracks.map(&:uri).should include('http://api.sandbox-soundcloud.com/tracks/875948')
+      @group.tracks.map(&:uri).should include('http://api.sandbox-soundcloud.com/tracks/2096547')
     end
     
   end

data/spec/soundcloud_spec.rb

@@ -16,27 +16,41 @@ require File.dirname(__FILE__) + '/spec_helper'
 # api-test-2 has 'static-test-playlist' with Track1, 2 and 3
 #
 # api-test-1 has Track "static-test-track" and user api-test-3 has not permissions for it
+# "static-test-track" has a comment on it.
 # api-test-1 has a playlist "my-static-playlist" with at least 2 tracks
 
-
-
 describe "Soundcloud" do  
-  before(:all) do
-  end
   
   it 'should create an oauth consumer' do
-    Soundcloud.consumer('consumer_token','consumer_secret').should be_an_instance_of OAuth::Consumer
+    Soundcloud.consumer(soundcloud_settings[:consumer_token], soundcloud_settings[:consumer_secret]).should be_an_instance_of OAuth::Consumer
+  end
+  
+  it 'should fail to register a client with no API key, and no OAuth' do
+    lambda { sc = Soundcloud.register({:site => soundcloud_site})}.should raise_error RuntimeError
+  end
+  
+  it 'should register a client with a bad API key, and no OAuth' do
+    sc = Soundcloud.register({:consumer_key=> soundcloud_settings[:bad_consumer_token], :site => soundcloud_site})
+    sc.to_s.should match(/Soundcloud::.+/)
+    lambda{ sc.Track.find(:all,:params => {:order => 'hotness', :limit => 1})}.should raise_error ActiveResource::UnauthorizedAccess
+  end
+  
+  it 'should register a client with a good API key, but no OAuth, and be able to access public resources' do
+    sc = Soundcloud.register({:consumer_key => soundcloud_settings[:consumer_token], :site => soundcloud_site})
+    sc.to_s.should match(/Soundcloud::.+/)
+    lambda{ sc.Track.find(:all,:params => {:order => 'hotness', :limit => 1})}.should_not raise_error ActiveResource::UnauthorizedAccess
   end
   
-  it 'should register a client without an oauth token' do
-    sc = Soundcloud.register({:site => soundcloud_site})
+  it 'should register a client with a good API key, but no OAuth, and fail to access private resources' do
+    sc = Soundcloud.register({:consumer_key=> soundcloud_settings[:consumer_token], :site => soundcloud_site})
     sc.to_s.should match(/Soundcloud::.+/)
     lambda{ sc.User.find(:one, :from => "/me")}.should raise_error ActiveResource::UnauthorizedAccess
   end
   
-  it 'should register a client with an oauth token' do
+  it 'should register a client with a valid oauth token, and be able to access public and private resources' do
     sc = Soundcloud.register({:access_token=> valid_oauth_access_token, :site => soundcloud_site})
     sc.to_s.should match(/Soundcloud::.+/)
+    lambda{ sc.Track.find(:all,:params => {:order => 'hotness', :limit => 1})}.should_not raise_error ActiveResource::UnauthorizedAccess
     lambda{ sc.User.find(:one, :from => "/me")}.should_not raise_error ActiveResource::UnauthorizedAccess
   end    
 end

data/spec/soundcloud_track_spec.rb

@@ -133,21 +133,24 @@ describe "Soundcloud::Models::Track" do
   #  #tags.include? 'bla
   #end
   
-  it 'should be able to add a user to permissions of a track and delete it again' do
-    track = @sc.Track.find(:one, :from => '/users/api-test-1/tracks/static-test-track')   
-    
-    old_count = track.permissions.length
+ 
+  # App was changed, which causes this implementation to
+  # it 'should be able to add a user to permissions of a track and delete it again' do
+  #   track = @sc.Track.find(:one, :from => '/users/api-test-1/tracks/static-test-track')   
+  #   
+  #   old_count = track.permissions.length
+  # 
+  #   track.permissions << @api_test_3    
+  #   track.permissions.save
+  #   
+  #   track.permissions.length.should be(old_count+1)    
+  #   
+  #   track.permissions.delete( @api_test_3 )
+  #   track.permissions.save
+  #   
+  #   track.permissions.length.should be(old_count)  
+  # end
 
-    track.permissions << @api_test_3    
-    track.permissions.save
-    
-    track.permissions.length.should be(old_count+1)    
-    
-    track.permissions.delete( @api_test_3 )
-    track.permissions.save
-    
-    track.permissions.length.should be(old_count)  
-  end
   
   it 'should add, check and remove a favorite to "me"' do
     @test_track_1.is_favorite?.should be false
@@ -158,13 +161,13 @@ describe "Soundcloud::Models::Track" do
   end  
   
   it 'should be able to download a private track' do
-    track = @sc.Track.find(:one, :from => '/users/api-test-2/tracks/track3-1')
+    track = @sc.Track.find(2096549)
     track.download_url
   end
   
   it 'should be able to download a public track (unauthenticated)' do 
-    usc = Soundcloud.register({:site => soundcloud_site})
-    track = usc.Track.find(:one, :from => '/users/api-test-2/tracks/track1-2')
+    usc = Soundcloud.register({:consumer_key => soundcloud_settings[:consumer_token], :site => soundcloud_site})
+    track = usc.Track.find(:one, :from => '/users/api-test-2/tracks/test-track')
     track.download_url
   end
   

data/spec/soundcloud_user_spec.rb

@@ -22,11 +22,14 @@ describe "Soundcloud::Models::User" do
     user.username.should == test_for
   end
   
+# Search index not updated? a SOLR issue;  
+=begin
   it 'should find all api-test users' do
     test_for = 'api-test'
     users = @sc.User.find(:all , :params => {:q => test_for})
     users.length.should be >= 3
   end
+=end
   
   it 'should check if a user has a contact' do 
     @api_test_2.has_contact?(@api_test_3).should be true
@@ -41,13 +44,16 @@ describe "Soundcloud::Models::User" do
     @api_test_3.remove_contact!    
   end
 
+# Favoriting not coming through - 
+
   it 'should check if a user has a favorite' do
-    track1 = @sc.Track.find(:one, :from => '/users/api-test-2/tracks/track3-1')
-    track2 = @sc.Track.find(:one, :from => '/users/api-test-2/tracks/track1-2')
+    track1 = @sc.Track.find(:one, :from => '/tracks/2096549')
+    track2 = @sc.Track.find(:one, :from => '/users/api-test-2/tracks/test-track')
     @api_test_2.has_favorite?(track1).should be true
     @api_test_2.has_favorite?(track1.id).should be true    
     @api_test_2.has_favorite?(track2).should be false
-  end      
+  end
+
   
   it 'should find the logged in user' do 
     my_user = @sc.User.find_me

data/spec/spec_helper.rb

@@ -14,11 +14,22 @@ def soundcloud_site
   'http://api.sandbox-soundcloud.com'
 end
 
+def soundcloud_settings
+  return  {
+          :access_token => 'your_access_token_here', 
+          :access_secret => 'your_access_secret_here',
+          :consumer_token => 'your_consumer_token_here',
+          :consumer_secret => 'your_consumer_secret_here', 
+          :bad_consumer_token => '98ydfg',
+          :bad_consumer_secret => 'Sp9p1FTU0hhLBNXY'
+          }
+end
+
 def valid_oauth_access_token
-  access_token = '2EXCRQykOLw7MPhzbndyg'
-  access_secret = 'rCAlWbPfjG7rFOIE7LwbQ1OVfhNmHTTbNrK9zjTY'
-  consumer_token = 'z9orRCWjmdrqWJZ0ly6lg'
-  consumer_secret = 'PjL4H3bnNiLtmXQaaAIRaJxI6OWE2Sr5xB8ANRbhfMk'
+  access_token = soundcloud_settings[:access_token]
+  access_secret = soundcloud_settings[:access_secret]
+  consumer_token = soundcloud_settings[:consumer_token]
+  consumer_secret = soundcloud_settings[:consumer_secret]
 
   sc_consumer = Soundcloud.consumer(consumer_token,consumer_secret,soundcloud_site)
   return OAuth::AccessToken.new(sc_consumer, access_token, access_secret)

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification 
 name: soundcloud-ruby-api-wrapper
 version: !ruby/object:Gem::Version 
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors: 
 - Johannes Wagener
+- Thor Kell
+- Hannes Tyden
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 -05:00
+date: 2010-05-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +35,7 @@ dependencies:
         version: 0.3.6
     version: 
 description: 
-email: johannes@wagener.cc
+email: johannes@soundcloud.com
 executables: []
 
 extensions: []
@@ -53,17 +55,16 @@ files:
 - lib/soundcloud.rb
 - lib/soundcloud/models/base.rb
 - lib/soundcloud/models/comment.rb
-- lib/soundcloud/models/event.rb
 - lib/soundcloud/models/group.rb
 - lib/soundcloud/models/playlist.rb
 - lib/soundcloud/models/track.rb
 - lib/soundcloud/models/user.rb
-- ruby-api-wrapper.gemspec
+- lib/soundcloud/public_oauth_access_token.rb
+- lib/soundcloud/sc_oauth_active_resource.rb
 - soundcloud-ruby-api-wrapper.gemspec
 - spec/fixtures/test_artwork.gif
 - spec/fixtures/test_track.mp3
 - spec/soundcloud_comment_spec.rb
-- spec/soundcloud_event_spec.rb
 - spec/soundcloud_group_spec.rb
 - spec/soundcloud_playlist_spec.rb
 - spec/soundcloud_spec.rb
@@ -100,7 +101,6 @@ specification_version: 3
 summary: A ruby wrapper for the SoundCloud API
 test_files: 
 - spec/soundcloud_comment_spec.rb
-- spec/soundcloud_event_spec.rb
 - spec/soundcloud_group_spec.rb
 - spec/soundcloud_playlist_spec.rb
 - spec/soundcloud_spec.rb

data/lib/soundcloud/models/event.rb

@@ -1,40 +0,0 @@
-module Soundcloud
-  module Models
-    #
-    # SC API Attributes (as of 26/05/09): 
-    # * type
-    # * id
-    # * created_at
-    # * 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
-    #
-    # Examples:
-    #
-    #   # find the last 50 (default soundcloud limit) dropbox events and display the titles of the dropped tracks
-    #   dropbox_events = sc_client.Event.find(:all,:params => {:filter => 'drop'})
-    #
-    #   dropbox_events.each do |event|
-    #     p event.track.title
-    #   end
-    #    
-    #   # find the last 50 (default soundcloud limit)  events    
-    #   sc_client.Event.find(:all)
-    #
-    class Event < Base    
-      cattr_accessor :element_name    
-      self.element_name = 'event'
-      
-      
-      def event_type 
-        return attributes['type']
-      end
-    end    
-  end
-end

data/ruby-api-wrapper.gemspec

@@ -1,72 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{ruby-api-wrapper}
-  s.version = "0.4.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Johannes Wagener"]
-  s.date = %q{2009-09-03}
-  s.email = %q{johannes@wagener.cc}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.html",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.html",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION.yml",
-     "lib/soundcloud.rb",
-     "lib/soundcloud/models/base.rb",
-     "lib/soundcloud/models/comment.rb",
-     "lib/soundcloud/models/event.rb",
-     "lib/soundcloud/models/playlist.rb",
-     "lib/soundcloud/models/track.rb",
-     "lib/soundcloud/models/user.rb",
-     "ruby-api-wrapper.gemspec",
-     "spec/fixtures/test_artwork.gif",
-     "spec/fixtures/test_track.mp3",
-     "spec/soundcloud_comment_spec.rb",
-     "spec/soundcloud_event_spec.rb",
-     "spec/soundcloud_playlist_spec.rb",
-     "spec/soundcloud_spec.rb",
-     "spec/soundcloud_track_spec.rb",
-     "spec/soundcloud_user_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/soundcloud/ruby-api-wrapper}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
-  s.summary = %q{TODO}
-  s.test_files = [
-    "spec/soundcloud_comment_spec.rb",
-     "spec/soundcloud_event_spec.rb",
-     "spec/soundcloud_playlist_spec.rb",
-     "spec/soundcloud_spec.rb",
-     "spec/soundcloud_track_spec.rb",
-     "spec/soundcloud_user_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<jwagener-oauth-active-resource>, [">= 0"])
-      s.add_runtime_dependency(%q<pelle-oauth>, [">= 0"])
-    else
-      s.add_dependency(%q<jwagener-oauth-active-resource>, [">= 0"])
-      s.add_dependency(%q<pelle-oauth>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<jwagener-oauth-active-resource>, [">= 0"])
-    s.add_dependency(%q<pelle-oauth>, [">= 0"])
-  end
-end

data/spec/soundcloud_event_spec.rb

@@ -1,34 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe 'Soundcloud::Models::Event' do
-   before(:all) do
-    @sc = Soundcloud.register({:access_token=> valid_oauth_access_token, :site => soundcloud_site})
-  #  @api_test_1 = @sc.User.find('api-test-1')    
- #   @api_test_2 = @sc.User.find('api-test-2')    
-#    @api_test_3 = @sc.User.find('api-test-3')  
-  end
-  
-  it 'should get the last events' do
-    events = @sc.Event.find(:all)
-  end
-  
-  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 == "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|
-      
-      #Temporary Fix because of the API
-      ["Track", "Playlist"].should include(event.event_type)
-      
-      #event.event_type.should == "Track"
-      #event.track.title.should_not be nil      
-    end    
-  end
-end