soundcloud 0.2.7 → 0.2.8

data/README.md

@@ -42,11 +42,14 @@ It is providing simple methods to handle authorization and to execute HTTP calls
     client = Soundcloud.new({
       :client_id      => YOUR_CLIENT_ID,
       :client_secret  => YOUR_CLIENT_SECRET,
+      :redirect_uri  => YOUR_REDIRECT_URI,
     })
     
-    client.authorize_url(:redirect_uri => REDIRECT_URI)
-    # => "https://soundcloud.com/connect?client_id=YOUR_CLIENT_ID&response_type=code&redirect_uri=http://host/redirect"
-    client.exchange_token(:redirect_uri => uri, :code => 'CODE')
+    redirect client.authorize_url()
+    # the user should be redirected to "https://soundcloud.com/connect?client_id=YOUR_CLIENT_ID&response_type=code&redirect_uri=YOUR_REDIRECT_URI"
+    # after granting access he will be redirected back to YOUR_REDIRECT_URI
+    # in your respective handler you can build an exchange token from the transmitted code
+    client.exchange_token(:code => params[:code])
 
 #### OAuth2 refresh token flow, upload a track and print its link
     # register a new client which will exchange an existing refresh_token for an access_token
@@ -83,6 +86,13 @@ It is providing simple methods to handle authorization and to execute HTTP calls
     user_id_to_follow = 123
     client.put("/me/followings/#{user_id_to_follow}")
 
+### Initializing a client with an access token and updating the users profile description
+    # initializing a client with an access token
+    client = Soundcloud.new(:access_token => SOME_ACCESS_TOKEN)
+    
+    # updating the users profile description
+    client.put("/me", :user => {:description => "a new description"})
+
 ## Interface
 #### Soundcloud.new(options={})
 Stores the passed options and call exchange_token in case options are passed that allow an exchange of tokens.

data/lib/soundcloud.rb

@@ -1,6 +1,7 @@
 require 'httmultiparty'
 require 'hashie'
 require 'uri'
+require 'soundcloud/version'
 
 class Soundcloud
   class ResponseError < HTTParty::ResponseError
@@ -75,9 +76,9 @@ class Soundcloud
   end
   
   class UnauthorizedResponseError < ResponseError; end
+  USER_AGENT            = "SoundCloud Ruby Wrapper #{VERSION}"
 
   include HTTMultiParty
-  
   CLIENT_ID_PARAM_NAME  = :client_id
   API_SUBHOST           = 'api'
   AUTHORIZE_PATH        = '/connect'
@@ -88,6 +89,7 @@ class Soundcloud
   }
 
   attr_accessor :options
+  headers({"User-Agent" => USER_AGENT})
 
   def initialize(options={})
     store_options(options)
@@ -100,9 +102,9 @@ class Soundcloud
   end
 
   def get   (path, query={}, options={}); handle_response { self.class.get     *construct_query_arguments(path, options.merge(:query => query)) } end
-  def post  (path, body={}, options={});  handle_response { self.class.post    *construct_query_arguments(path, options.merge(:body => body), :body) } end
-  def put   (path, body={}, options={});  handle_response { self.class.put     *construct_query_arguments(path, options.merge(:body => body), :body) } end
-  def delete(path, query={}, options={}); handle_response { self.class.delete *construct_query_arguments(path, options.merge(:query => query)) } end
+  def post  (path, body={},  options={}); handle_response { self.class.post    *construct_query_arguments(path, options.merge(:body  => body), :body) } end
+  def put   (path, body={},  options={}); handle_response { self.class.put     *construct_query_arguments(path, options.merge(:body  => body), :body) } end
+  def delete(path, query={}, options={}); handle_response { self.class.delete  *construct_query_arguments(path, options.merge(:query => query)) } end
   def head  (path, query={}, options={}); handle_response { self.class.head    *construct_query_arguments(path, options.merge(:query => query)) } end
 
   # accessors for options
@@ -213,4 +215,3 @@ end
 
 require 'soundcloud/array_response_wrapper'
 require 'soundcloud/hash_response_wrapper'
-require 'soundcloud/version'

data/lib/soundcloud/version.rb

@@ -1,3 +1,3 @@
 class Soundcloud
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

metadata

@@ -2,7 +2,7 @@
 name: soundcloud
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Johannes Wagener
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-25 00:00:00 +02:00
+date: 2011-10-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency