soundcloud2 0.3.3 → 0.3.5

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -1,2 +1 @@
-rvm 1.9.2
-rvm gemset use soundcloud
+rvm 1.9.2@soundcloud2 --create

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -1,2 +1,3 @@
 source "http://rubygems.org"
 gemspec
+

data/README.md

@@ -1,4 +1,7 @@
 # Soundcloud2 API Client
+[![Build Status](https://secure.travis-ci.org/amanelis/soundcloud2.png)](http://travis-ci.org/amanelis/soundcloud2)
+
+[![Dependency Status](https://gemnasium.com/amanelis/soundcloud2.png)](https://gemnasium.com/amanelis/soundcloud2)
 
 Simple Ruby wrapper for the Soundcloud API.  
 
@@ -90,7 +93,7 @@ be found in the other subclassed modules.
     $ bundle
   
 #### Run rSpec  
-    $ rspec -fp spec/client
+    $ rspec spec
 
 ## Issues
   None.
@@ -101,6 +104,9 @@ be found in the other subclassed modules.
 
 * Initial version
 
+### 0.3.3 - April 4th, 2012
+
+* Rebuilt the specs to test for nil objects
 
 ## Under the hood
 * [`Faraday`](https://github.com/technoweenie/faraday) REST client

data/lib/soundcloud2.rb

@@ -4,143 +4,215 @@ require 'core_ext/array'
 require 'yajl'
 
 module Soundcloud2
+  ### Client
+  #
+  # Brings together a default class we use to setup our connection
+  # to the Soundcloud API. Here is where we will configure any HTTP
+  # options using Faraday as our middle ware to communicate to the API
+  #
+  #
+  # @attr: @api_key - allows use to access the API_KEY globally
+  # @attr: @conn - here is the main method we use to call http methods from
   class Client
     attr_reader :api_key, :conn
+    
+    # Define a few helper methods that are not too important
+    #
 
-    def initialize(*args)
-      options = args.extract_options!
-      @api_key = args[0]
+    ## initialize
+    #
+    # @param: String[api_key] - required
+    # @return: 
+    #
+    # Setups up our attr readers and most importantly the Faraday connection
+    # to the API.
+    #
+    # OPTIMIZE: eventually take out Faraday and move to NetHTTP for a lower level of control
+    def initialize(api_key)
+      @api_key = api_key
       @conn = Faraday.new(:url => "https://api.soundcloud.com/") do |builder|
         builder.use Faraday::Response::Mashify
         builder.use Faraday::Response::ParseJson
         builder.adapter Faraday.default_adapter
       end
     end
-    
-    # PROPERTIES OF GROUPS API
-    # id	integer ID	123
-    # uri	API resource URL	http://api.soundcloud.com/comments/32562
-    # created_at	timestamp of creation	"2009/08/13 18:30:10 +0000"
-    # permalink	permalink of the resource	"summer-of-69"
-    # permalink_url	URL to the SoundCloud.com page	"http://soundcloud.com/bryan/summer-of-69"
-    # artwork_url	URL to a JPEG image	"http://i1.sndcdn.com/a....-large.jpg?142a848"
-    # name	name of the group	"Field Recordings"
-    # description	description of the group	"field recordings from across the world"
-    # short_description	short description of the group	"field recordings!"
-    # creator	mini user representation of the owner	{id: 343, username: "Doctor Wilson"...}
-    def groups(*args); super; end
-    
-    # PROPERTIES OF PLAYLISTS API
-    # id	integer ID	123
-    # created_at	timestamp of creation	"2009/08/13 18:30:10 +0000"
-    # user-id	user-id of the owner	343
-    # user	mini user representation of the owner	{id: 343, username: "Doctor Wilson"...}
-    # title	track title	"Summer of 69"
-    # permalink	permalink of the resource	"summer-of-69"
-    # permalink_url	URL to the SoundCloud.com page	"http://soundcloud.com/bryan/summer-of-69"
-    # uri	API resource URL	"http://api.soundcloud.com/tracks/123"
-    # sharing	public/private sharing	"public"
-    # purchase_url	external purchase link	"http://amazon.com/buy/a43aj0b03"
-    # artwork_url	URL to a JPEG image	"http://i1.sndcdn.com/a....-large.jpg?142a848"
-    # description	HTML description	"my first track"
-    # downloadable	downloadable (boolean)	false
-    # streamable	streamable via API (boolean)	true
-    # label	label mini user object	{id:123, username: "BeatLabel"...}
-    # duration	duration in milliseconds	1203400
-    # genre	genre	"HipHop"
-    # shared_to_count	number of sharings (if private)	45
-    # tag_list	list of tags	"tag1 \"hip hop\" geo:lat=32.444 geo:lon=55.33"
-    # label_id	id of the label user	54677
-    # label_name	label name	"BeatLabel"
-    # license	creative common license	"no-rights-reserved"
-    # release	release number	3234
-    # release_day	day of the release	21
-    # release_month	month of the release	5
-    # release_year	year of the release	2001
-    # ean	EAN identifier for the playlist	"123-4354345-43"
-    # playlist_type	playlist type	"recording"
-    def playlists(*args); super; end
-    
-    # PROPERTIES OF TRACKS API
-    # id	integer ID	123
-    # created_at	timestamp of creation	"2009/08/13 18:30:10 +0000"
-    # user-id	user-id of the owner	343
-    # user	mini user representation of the owner	{id: 343, username: "Doctor Wilson"...}
-    # title	track title	"Summer of 69"
-    # permalink	permalink of the resource	"summer-of-69"
-    # permalink_url	URL to the SoundCloud.com page	"http://soundcloud.com/bryan/summer-of-69"
-    # uri	API resource URL	"http://api.soundcloud.com/tracks/123"
-    # sharing	public/private sharing	"public"
-    # purchase_url	external purchase link	"http://amazon.com/buy/a43aj0b03"
-    # artwork_url	URL to a JPEG image	"http://i1.sndcdn.com/a....-large.jpg?142a848"
-    # description	HTML description	"my first track"
-    # downloadable	downloadable (boolean)	false
-    # streamable	streamable via API (boolean)	true
-    # label	label mini user object	{id:123, username: "BeatLabel"...}
-    # duration	duration in milliseconds	1203400
-    # genre	genre	"HipHop"
-    # shared_to_count	number of sharings (if private)	45
-    # tag_list	list of tags	"tag1 \"hip hop\" geo:lat=32.444 geo:lon=55.33"
-    # label_id	id of the label user	54677
-    # label_name	label name	"BeatLabel"
-    # license	creative common license	"no-rights-reserved"
-    # release	release number	3234
-    # release_day	day of the release	21
-    # release_month	month of the release	5
-    # release_year	year of the release	2001
-    # state	encoding state	"finished"
-    # track_type	track type	"recording"
-    # waveform_url	URL to PNG waveform image	"http://w1.sndcdn.com/fxguEjG4ax6B_m.png"
-    # download_url	URL to original file	"http://api.soundcloud.com/tracks/3/download"
-    # stream_url	link to 128kbs mp3 stream	"http://api.soundcloud.com/tracks/3/stream"
-    # bpm	beats per minute	120
-    # commentable	track commentable (boolean)	true
-    # isrc	track ISRC	"I123-545454"
-    # key_signature	track key	"Cmaj"
-    # comment_count	track comment count	12
-    # download_count	track download count	45
-    # playback_count	track play count	435
-    # favoritings_count	track favoriting count	6
-    # original_format	file format of the original file	"aiff"
-    # created_with	the app that the track created	{"id"=>3434, "..."=>nil}
-    # asset_data	binary data of the audio file	(only for uploading)
-    # artwork_data	binary data of the artwork image	(only for uploading)
-    # user_favorite	track favorite of current user (boolean, authenticated requests only)	1
-    def tracks(*args); super; end
-    
-    # PROPERTIES OF USERS API
-    # id	integer ID	123
-    # permalink	permalink of the resource	"summer-of-69"
-    # username	username	"Doctor Wilson"
-    # uri	API resource URL	http://api.soundcloud.com/comments/32562
-    # permalink_url	URL to the SoundCloud.com page	"http://soundcloud.com/bryan/summer-of-69"
-    # avatar_url	URL to a JPEG image	"http://i1.sndcdn.com/a....-large.jpg?142a848"
-    # country	country	"Germany"
-    # full_name	first and last name	"Tom Wilson"
-    # city	city	"Berlin"
-    # description	description	"Another brick in the wall"
-    # discogs-name	Discogs name	"myrandomband"
-    # myspace-name	MySpace name	"myrandomband"
-    # website	a URL to the website	"http://facebook.com/myrandomband"
-    # website-title	a custom title for the website	"myrandomband on Facebook"
-    # online	online status (boolean)	true
-    # track_count	number of public tracks	4
-    # playlist_count	number of public playlists	5
-    # followers_count	number of followers	54
-    # followings_count	number of followed users	75
-    # public_favorites_count	number of favorited public tracks	7
-    def users(*args); super; end
 
+    ## groups
+    #
+    # @param: Hash[:any number of parameters from list below]
+    # @return: Hash[Json response]
+    # 
+    # This is a direct endpoint method to the Soundcloud Groups API. You can pass any
+    # number of attributes to it that are available from the Soundcloud documentation.
+    # As well as documented below in the possible parameters list
+    #
+    # Optional parameters, ideally you should choose at least one:
+    #   id	              integer ID	123
+    #   uri	              API resource URL	http://api.soundcloud.com/comments/32562
+    #   created_at	      timestamp of creation	"2009/08/13 18:30:10 +0000"
+    #   permalink	        permalink of the resource	"summer-of-69"
+    #   permalink_url	    URL to the SoundCloud.com page	"http://soundcloud.com/bryan/summer-of-69"
+    #   artwork_url	      URL to a JPEG image	"http://i1.sndcdn.com/a....-large.jpg?142a848"
+    #   name	            name of the group	"Field Recordings"
+    #   description	      description of the group	"field recordings from across the world"
+    #   short_description	short description of the group	"field recordings!"
+    #   creator	          mini user representation of the owner	{id: 343, username: "Doctor Wilson"...}
+    def groups(*args)
+      super
+    end
+
+    ## playlists
+    #
+    # @param: Hash[:any number of parameters from list below]
+    # @return: Hash[Json response]
+    #
+    # This is a direct endpoint method to the Soundcloud Playlists API. You can pass any
+    # number of attributes to it that are available from the Soundcloud documentation.
+    # As well as documented below in the possible parameters list
+    #
+    # Optional parameters, ideally you should choose at least one:
+    #   id	              integer ID	123
+    #   created_at	      timestamp of creation	"2009/08/13 18:30:10 +0000"
+    #   user-id	          user-id of the owner	343
+    #   user	            mini user representation of the owner	{id: 343, username: "Doctor Wilson"...}
+    #   title	            track title	"Summer of 69"
+    #   permalink	        permalink of the resource	"summer-of-69"
+    #   permalink_url	    URL to the SoundCloud.com page	"http://soundcloud.com/bryan/summer-of-69"
+    #   uri	              API resource URL	"http://api.soundcloud.com/tracks/123"
+    #   sharing	          public/private sharing	"public"
+    #   purchase_url	    external purchase link	"http://amazon.com/buy/a43aj0b03"
+    #   artwork_url	      URL to a JPEG image	"http://i1.sndcdn.com/a....-large.jpg?142a848"
+    #   description	      HTML description	"my first track"
+    #   downloadable	    downloadable (boolean)	false
+    #   streamable	      streamable via API (boolean)	true
+    #   label	            label mini user object	{id:123, username: "BeatLabel"...}
+    #   duration	        duration in milliseconds	1203400
+    #   genre	            genre	"HipHop"
+    #   shared_to_count	  number of sharings (if private)	45
+    #   tag_list	        list of tags	"tag1 \"hip hop\" geo:lat=32.444 geo:lon=55.33"
+    #   label_id	        id of the label user	54677
+    #   label_name	      label name	"BeatLabel"
+    #   license	          creative common license	"no-rights-reserved"
+    #   release	          release number	3234
+    #   release_day	      day of the release	21
+    #   release_month	    month of the release	5
+    #   release_year	    year of the release	2001
+    #   ean	              EAN identifier for the playlist	"123-4354345-43"
+    #   playlist_type	    playlist type	"recording"
+    def playlists(*args)
+      super
+    end
+
+    ## tracks
+    #
+    # @param: Hash[:any number of parameters from list below]
+    # @return: Hash[Json response]
+    #
+    # This is a direct endpoint method to the Soundcloud Tracks API. You can pass any
+    # number of attributes to it that are available from the Soundcloud documentation.
+    # As well as documented below in the possible parameters list
+    #
+    # Optional parameters, ideally you should choose at least one:
+    #   id	                integer ID	123
+    #   created_at	        timestamp of creation	"2009/08/13 18:30:10 +0000"
+    #   user-id	            user-id of the owner	343
+    #   user	              mini user representation of the owner	{id: 343, username: "Doctor Wilson"...}
+    #   title	              track title	"Summer of 69"
+    #   permalink	          permalink of the resource	"summer-of-69"
+    #   permalink_url	      URL to the SoundCloud.com page	"http://soundcloud.com/bryan/summer-of-69"
+    #   uri	                API resource URL	"http://api.soundcloud.com/tracks/123"
+    #   sharing	            public/private sharing	"public"
+    #   purchase_url	      external purchase link	"http://amazon.com/buy/a43aj0b03"
+    #   artwork_url	        URL to a JPEG image	"http://i1.sndcdn.com/a....-large.jpg?142a848"
+    #   description	        HTML description	"my first track"
+    #   downloadable	      downloadable (boolean)	false
+    #   streamable	        streamable via API (boolean)	true
+    #   label	              label mini user object	{id:123, username: "BeatLabel"...}
+    #   duration	          duration in milliseconds	1203400
+    #   genre	              genre	"HipHop"
+    #   shared_to_count	    number of sharings (if private)	45
+    #   tag_list	          list of tags	"tag1 \"hip hop\" geo:lat=32.444 geo:lon=55.33"
+    #   label_id	          id of the label user	54677
+    #   label_name	        label name	"BeatLabel"
+    #   license	            creative common license	"no-rights-reserved"
+    #   release	            release number	3234
+    #   release_day	        day of the release	21
+    #   release_month	      month of the release	5
+    #   release_year	      year of the release	2001
+    #   state	              encoding state	"finished"
+    #   track_type	        track type	"recording"
+    #   waveform_url	      URL to PNG waveform image	"http://w1.sndcdn.com/fxguEjG4ax6B_m.png"
+    #   download_url	      URL to original file	"http://api.soundcloud.com/tracks/3/download"
+    #   stream_url	        link to 128kbs mp3 stream	"http://api.soundcloud.com/tracks/3/stream"
+    #   bpm	                beats per minute	120
+    #   commentable	        track commentable (boolean)	true
+    #   isrc	              track ISRC	"I123-545454"
+    #   key_signature	      track key	"Cmaj"
+    #   comment_count	      track comment count	12
+    #   download_count	    track download count	45
+    #   playback_count	    track play count	435
+    #   favoritings_count	  track favoriting count	6
+    #   original_format	    file format of the original file	"aiff"
+    #   created_with	      the app that the track created	{"id"=>3434, "..."=>nil}
+    #   asset_data	        binary data of the audio file	(only for uploading)
+    #   artwork_data	      binary data of the artwork image	(only for uploading)
+    #   user_favorite	      track favorite of current user (boolean, authenticated requests only)	1
+    def tracks(*args)
+      super
+    end
+
+    ## users
+    #
+    # @param: Hash[:any number of parameters from list below]
+    # @return: Hash[Json response]
+    #
+    # This is a direct endpoint method to the Soundcloud Users API. You can pass any
+    # number of attributes to it that are available from the Soundcloud documentation.
+    # As well as documented below in the possible parameters list
+    #
+    # Optional parameters, ideally you should choose at least one:
+    #   id	                    integer ID	123
+    #   permalink	              permalink of the resource	"summer-of-69"
+    #   username	              username	"Doctor Wilson"
+    #   uri	                    API resource URL	http://api.soundcloud.com/comments/32562
+    #   permalink_url	          URL to the SoundCloud.com page	"http://soundcloud.com/bryan/summer-of-69"
+    #   avatar_url	            URL to a JPEG image	"http://i1.sndcdn.com/a....-large.jpg?142a848"
+    #   country	                country	"Germany"
+    #   full_name	              first and last name	"Tom Wilson"
+    #   city	                  city	"Berlin"
+    #   description	            description	"Another brick in the wall"
+    #   discogs-name	          Discogs name	"myrandomband"
+    #   myspace-name	          MySpace name	"myrandomband"
+    #   website	                a URL to the website	"http://facebook.com/myrandomband"
+    #   website-title	          a custom title for the website	"myrandomband on Facebook"
+    #   online	                online status (boolean)	true
+    #   track_count	            number of public tracks	4
+    #   playlist_count	        number of public playlists	5
+    #   followers_count	        number of followers	54
+    #   followings_count	      number of followed users	75
+    #   public_favorites_count	number of favorited public tracks	7
+    def users(*args)
+      super
+    end
+
+    ## method_missing
+    #
+    # @param: Symbol[representation of the method name being called]
+    # @param: Hash[any parameter that is an option to be sent to the API]
+    # @param: Block[optional and not currently being used]
+    #
+    # We use this method to dynamically call the API to minimize code re writing. This method expects
+    # that you will be suitable to receive JSON only. Optionally could add support for other formats later
     def method_missing(sym, *args, &block)
-      options = args.extract_options!.merge(:client_id => api_key)
-      response = conn.get("/#{sym.to_s}.json") { |req| req.params = options }
+      options   = args.extract_options!.merge(:client_id => api_key)
+      response  = conn.get("/#{sym.to_s}.json") { |req| req.params = options }
       args.nil? ? response.body.send(sym) : response.body
     end
   end
-  
+
   autoload :Comments,   "soundcloud2/comments"
   autoload :Groups,     "soundcloud2/groups"
   autoload :Playlists,  "soundcloud2/playlists"
   autoload :Tracks,     "soundcloud2/tracks"
   autoload :Users,      "soundcloud2/users"
-end
+end

data/lib/soundcloud2/comments.rb

@@ -9,10 +9,13 @@ module Soundcloud2
     
     # GET	/comments/{id}	a group
     def comments(*args)
-      options = args.extract_options!.merge(:client_id => api_key)
-      response = conn.get("/comments/#{args[0]}.json") { |req| req.params = options }
-      args.nil? ? response.body.send(sym) : response.body
-    end
+    	super 
+		end
 
+		def method_missing(sym, *args, &block)
+	    options 	= args.extract_options!.merge(:client_id => api_key)
+      response 	= conn.get("/#{sym.to_s}/#{args[0]}.json") { |req| req.params = options }
+      args.nil? ? response.body.send(sym) : response.body
+		end
   end
-end
+end

data/lib/soundcloud2/groups.rb

@@ -48,5 +48,9 @@ module Soundcloud2
       response = conn.get("/groups/#{args[0]}/tracks.json") { |req| req.params = options }
       args.nil? ? response.body.send(sym) : response.body
     end
+
+		def method_missing(sym, *args, &block)
+      options = args.extract_options!.merge(:client_id => api_key)
+		end
   end
-end
+end

data/lib/soundcloud2/playlists.rb

@@ -28,4 +28,4 @@ module Soundcloud2
     end
 
   end
-end
+end

data/lib/soundcloud2/tracks.rb

@@ -38,4 +38,4 @@ module Soundcloud2
       args.nil? ? response.body.send(sym) : response.body
     end
   end
-end
+end

data/lib/soundcloud2/users.rb

@@ -61,22 +61,32 @@ module Soundcloud2
     
     # GET	/users/{id}/groups	list of joined groups
     def users_groups(*args)
-      options = args.extract_options!.merge(:client_id => api_key)
+			options = args.extract_options!.merge(:client_id => api_key)
       response = conn.get("/users/#{args[0]}/groups.json") { |req| req.params = options }
       args.nil? ? response.body.send(sym) : response.body
     end
 
-   # def method_missing(sym, *args, &block)
-   #   options = args.extract_options!.merge(:client_id => api_key)
-   #   if sym.to_s == "users"
-   #     response = conn.get("/users/#{args[0]}.json") { |req| req.params = options }
-   #   elsif args[1].nil?
-   #     response = conn.get("/users/#{args[0]}.json") { |req| req.params = options }
-   #   else
-   #     response = conn.get("/users/#{args[0]}/#{sym.to_s}/#{args[1]}.json") { |req| req.params = options }
-   #   end
-   #   args.nil? ? response.body.send(sym) : response.body
-   # end
-
+		#def method_missing(sym, *args, &block)
+		#	options 	= args.extrac_options!.merge(:client_id => api_key)
+		#	method 		= sym.to_s.gsub(/_(.*)$/, '')
+		#	action 		= sym.to_s.gsub(/^(.*)_/, '')
+		#	param1 		= args[0]
+		#	param2		= args.try(:[], 1).nil? ? ".json" : "/#{args[1]}.json" 
+		#	
+		#	response  = conn.get("/#{method}/#{param1}/#{action}#{param2}"
+		#	args.nil? ? response.body.send(sym) : response.body			
+		#end
+    
+		#def method_missing(sym, *args, &block)
+    #  options = args.extract_options!.merge(:client_id => api_key)
+    #  if sym.to_s == "users"
+    #    response = conn.get("/users/#{args[0]}.json") { |req| req.params = options }
+    #  elsif args[1].nil?
+    #    response = conn.get("/users/#{args[0]}.json") { |req| req.params = options }
+    #  else
+    #    response = conn.get("/users/#{args[0]}/#{sym.to_s}/#{args[1]}.json") { |req| req.params = options }
+    #  end
+    #  args.nil? ? response.body.send(sym) : response.body
+    #end
   end
-end
+end