Project

soundcloud2

0.0
No commit activity in last 3 years
No release in over 3 years
soundcloud2amanelis/soundcloud2HomepageDocumentationSource CodeBug TrackerWiki
A wrapper for the Soundcloud API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
13,086
Stars
2
Forks
1
Watchers
4
 Releases
Current version
0.3.5
Total releases
4
First release
2011-08-15
Latest release
2013-11-11
 Issues
Open Issues
1
Closed Issues
0
Total Issues
1
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
1
Merged Pull Requests
0
Pull Request Acceptance Rate
0%
 Development
Primary Language
Ruby
Average date of last 50 commits
2012-05-27
Reverse Dependencies
0

 Dependencies

Development

maruku
>= 0
rake
>= 0
rspec
>= 0
simplecov
>= 0
yard
>= 0

Runtime

faraday
>= 0
faraday_middleware
>= 0
hashie
>= 0
multi_json
>= 0
yajl-ruby
>= 0
 Project Readme

Soundcloud2 API Client

Build Status

Dependency Status

Simple Ruby wrapper for the Soundcloud API.

Overview

This library contains two types of consumption. First there is the Soundcloud::Client (Simple Client), which offers the four basic methods to search the Soundcloud API via GROUPS, PLAYLISTS, TRACKS, and USERS. Then there are the subclass modules that extend more of the advanced API calls on the main 4 resources that Soundcloud offers. Here is a quick example of the Soundcloud::Client module notation:

client.users(:q => 'skrillex').first.city
=> "melbourne"
client.tracks(:q => 'A new world').first.permalink
=> "a-new-world"

Quick Simple Client Usage

Instantiate the simple Client

The client should be instantiated with a single api_key that you can obtain from this url: http://soundcloud.com/you/apps/new Note the client is a quick way to consume and search the soundcloud API. More advanced methods can be found in the other subclassed modules.

client = Soundcloud::Client.new('YOUR_SOUNDCLOUD_API_KEY')

GROUPS

client.groups(:name => 'Field Recordings')
client.groups(:description => 'field recordings from across the world')
client.groups(:q => 'dubstep')

PLAYLISTS

client.playlists(:title => 'Summer of 69', :sharing => 'public', :downloadable => 'false')
client.playlists(:q => 'crunk house')

TRACKS

client.tracks(:q => 'A New World', :bpm => 120)
client.tracks(:id => 1647583)
client.tracks(:genre => 'dubstep', :downloadable => true)
client.tracks(:genre => 'dubstep', :order => 'hotness')

USERS

client.users(:id => 47194613)
client.users(:city => 'greece', :description => 'badass')
client.users(:username => 'djzaxx')

More Advanced Modules

Soundcloud::Comments Module

c = Soundcloud::Comments.new('YOUR_SOUNDCLOUD_API_KEY')
c.comments('23145109')

Soundcloud::Groups Module

g = Soundcloud::Groups.new('YOUR_SOUNDCLOUD_API_KEY')
g.groups('11440')
g.groups_moderators('11440')
g.groups_members('11440')
g.groups_contributors('11440')
g.groups_users('11440')
g.groups_tracks('11440')

Soundcloud::Playlists Module

p = Soundcloud::Playlists.new('YOUR_SOUNDCLOUD_API_KEY')
p.playlists('920731')
p.playlists_shared_to_users('4201929')
p.playlists_shared_to_emails('amanelis@gmail.com')

Soundcloud::Tracks Module

t = Soundcloud::Tracks.new('YOUR_SOUNDCLOUD_API_KEY')
t.tracks('20296934')
t.tracks_comments('20296934')
t.tracks_comments('20296934', '23145109')
t.tracks_favoriters('20296934')
t.tracks_favoriters('20296934', '2769794')
t.tracks_shared_to_users('20296934')
t.tracks_shared_to_emails('20296934')

Soundcloud::Users Module

u = Soundcloud::Users.new('YOUR_SOUNDCLOUD_API_KEY')
u.user('4201929')
u.user_tracks('4201929')
u.user_playlists('4201929')
u.user_followings('4201929')
u.user_followings('4201929', '1931470')
u.user_followers('4201929')
u.user_followers('4201929', '1931470')
u.user_comments('4201929')
u.user_favorites('4201929')
u.user_favorites('4201929', '1931470')
u.user_groups('4201929')

Dependencies

Install dependencies using bundler

$ bundle

Run rSpec

$ rspec spec

Issues

None.

Changelog

0.0.1 - Aug 6th, 2011

  • Initial version

0.3.3 - April 4th, 2012

  • Rebuilt the specs to test for nil objects

Under the hood

How to contribute

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright (c) 2011 Alex Manelis.