soundcloud 0.3.5 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df5b0cab01fdc8985e0059c4fbaebbb29672f58c17c33ce1cce2765861eeee3c
-  data.tar.gz: 730fc7f919b60e2aa582e755560284ebc07957d51054115da4093adfa71ced0c
+  metadata.gz: e6fc3d7e7da0596a6223c2a6c2f322ed4d4892f3e66e431eba20f36e59abad83
+  data.tar.gz: 4fed15f8d7d7cf2d4a95146e28943356a29c10266f2e4ca74d218026b54e7fc4
 SHA512:
-  metadata.gz: 93d8a10bd11b13c43b18e6c5449a3e640f0f43e93eb40473869f3326d84e4f6c4c347929acf9e93ddb0e4f1fa6cf8df75f68d25818636f6738efbe2a2dfafd54
-  data.tar.gz: 71e706b85e323052f13bd39c1f32368c4cbaaccb41ceaf5e2eed65438502dc025e8adf30191af06ae9ea35efad492faad3a85443ef2cb0d57b4ad0a0b29c6e66
+  metadata.gz: 989b6e4dd91accff9bd05fbd1c614906447f87e1f21ced987f888c74c73a26611d6f9351ead6b29fb44fc035368a516169aaf189b2c0231c01add4bbf6c5916b
+  data.tar.gz: 71181c248240bcab145ab5f9d127266a3b2aa1ce252c6bfe92fa5accf490f2cdd41e1d772268859f2125c8e8d1b971d9daca54ede2ddead8a915a6e4b2c0dc5e

data/README.md

@@ -1,7 +1,7 @@
 # ⚠️⚠️DEPRECATED - NO LONGER MAINTAINED⚠️⚠️
-This repository is no longer maintained by the SoundCloud team due to capacity constraints. We're instead focusing our efforts on improving the API & the developer platform. Please note, at the time of updating this, the repo is already not in sync with the latest API changes. 
+This repository is no longer maintained by the SoundCloud team due to capacity constraints. We're instead focusing our efforts on improving the API & the developer platform. Please note the repo might be not in sync with the latest API changes. 
 
-We recommend the community to fork this repo in order to maintain the SDK. We'd be more than happy to make a reference on our developer that the developers can use different SDKs build by the community. In case you need to reach out to us, please head over to https://github.com/soundcloud/api/issues  
+We recommend the community to fork this repo in order to maintain the SDK. We'd be more than happy to make a reference on our developer portal that the developers can use different SDKs build by the community. In case you need to reach out to us, please head over to https://github.com/soundcloud/api/issues  
 
 ---
 
@@ -24,39 +24,21 @@ The following examples are for the [latest gem version](https://rubygems.org/gem
 
 ```ruby
 SoundCloud::VERSION
-# => "0.3.4"
+# => "0.3.6"
 ```
 
-#### Print links of the 10 most recent tracks
-```ruby
-# register a client with YOUR_CLIENT_ID as client_id_
-client = SoundCloud.new(:client_id => YOUR_CLIENT_ID)
-# get newest tracks
-tracks = client.get('/tracks', :limit => 10)
-# print each link
-tracks.each do |track|
-  puts track.permalink_url
-end
-```
-
-#### OAuth2 user credentials flow and print the username of the authenticated user
+#### OAuth2 client credentials flow
 ```ruby
-# register a new client, which will exchange the username, password for an access_token
-# NOTE: the SoundCloud API Docs advise not to use the user credentials flow in a web app.
-# In any case, never store the password of a user.
+# register a new client, which will exchange the client_id, client_secret for an access_token
 client = SoundCloud.new({
   :client_id     => YOUR_CLIENT_ID,
   :client_secret => YOUR_CLIENT_SECRET,
-  :username      => 'some@email.com',
-  :password      => 'userpass'
 })
-
-# print logged in username
-puts client.get('/me').username
 ```
 
 #### OAuth2 authorization code flow
 ```ruby
+# register a new client, providing the client_id, client_secret and redirect_uri
 client = SoundCloud.new({
   :client_id     => YOUR_CLIENT_ID,
   :client_secret => YOUR_CLIENT_SECRET,
@@ -65,14 +47,17 @@ client = SoundCloud.new({
 
 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
+# after granting access they will be redirected back to YOUR_REDIRECT_URI with an authorization code present
+# ex: <YOUR_REDIRECT_URI>?code=XXX
 # 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
 ```ruby
-# register a new client which will exchange an existing refresh_token for an access_token
+# register a new client and exchange an existing refresh_token for an access_token
+# note: refresh_token can also be acquired from authorization code/client_credentials flows.
+# use this flow to automatically update the token when it expires.
 client = SoundCloud.new({
   :client_id     => YOUR_CLIENT_ID,
   :client_secret => YOUR_CLIENT_SECRET,
@@ -89,11 +74,19 @@ track = client.post('/tracks', :track => {
 puts track.permalink_url
 ```
 
-#### Resolve a track url and print its id
+
+#### Print links of the 10 most recent tracks
 ```ruby
-# register the client
-client = SoundCloud.new(:client_id => YOUR_CLIENT_ID)
+# get newest tracks
+tracks = client.get('/tracks', :limit => 10)
+# print each link
+tracks.each do |track|
+  puts track.permalink_url
+end
+```
 
+#### Resolve a track url and print its id
+```ruby
 # call the resolve endpoint with a track url
 track = client.get('/resolve', :url => "http://soundcloud.com/forss/flickermood")
 
@@ -104,7 +97,7 @@ puts track.id
 ### Initializing a client with an access token and updating the users profile description
 ```ruby
 # initializing a client with an access token
-client = SoundCloud.new(:access_token => SOME_ACCESS_TOKEN)
+client = SoundCloud.new(:access_token => A_VALID_TOKEN)
 
 # updating the users profile description
 client.put("/me", :user => {:description => "a new description"})
@@ -112,8 +105,6 @@ client.put("/me", :user => {:description => "a new description"})
 
 ### Add a track to a playlist / set
 ```ruby
-client = SoundCloud.new(:access_token => "A_VALID_TOKEN")
-
 # get my last playlist
 playlist = client.get("/me/playlists").first
 
@@ -137,20 +128,21 @@ p playlist.tracks.map(&:id)
 
 ## Interface
 #### SoundCloud.new(options={})
-Stores the passed options and call exchange_token in case options are passed
+Stores the passed options and calls exchange_token in case all options are passed
 that allow an exchange of tokens.
 
 #### SoundCloud#exchange_token(options={})
-Stores the passed options and try to exchange tokens if no access_token is
+Stores the passed options and tries to exchange tokens if no access_token is
 present and:
 
-* `refresh_token`, `client_id` and `client_secret` is present.
-* `client_id`, `client_secret`, `username`, and `password` is present
-* `client_id`, `client_secret`, `redirect_uri`, and `code` is present
+* `client_id`, `client_secret` is present (client credentials flow).
+* `refresh_token`, `client_id` and `client_secret` is present (refresh token flow).
+* `client_id`, `client_secret`, `redirect_uri`, and `code` is present (authorization code flow).
 
 #### SoundCloud#authorize_url(options={})
-Stores the passed options except for `state` and `display` and return an
-authorize url. The `client_id` and `redirect_uri` options need to present to
+Stores the passed options except for `state` and `display` and returns an
+authorize url (a part of authorization code flow).
+The `client_id` and `redirect_uri` options has to be present to
 generate the authorize url. The `state` and `display` options can be used to
 set the parameters accordingly in the authorize url.
 

data/lib/soundcloud/client.rb

@@ -18,10 +18,10 @@ module SoundCloud
 
     def initialize(options={})
       store_options(options)
-      if access_token.nil? && (options_for_refresh_flow_present? || options_for_credentials_flow_present? || options_for_code_flow_present? || client_secret)
+      if access_token.nil? && (options_for_refresh_flow_present? || options_for_code_flow_present? || options_for_credentials_flow_present?)
         exchange_token
       end
-      raise ArgumentError, "At least a client_id or an access_token must be present" if client_id.nil? && access_token.nil?
+      raise ArgumentError, "At least a client_id, client_secret or an access_token must be present" if client_id.nil? && client_secret.nil? && access_token.nil?
     end
 
     def get(path, query={}, options={})
@@ -102,33 +102,28 @@ module SoundCloud
         "#{param_name}=#{CGI.escape value}" unless value.nil?
       end.compact.join("&")
       store_options(options)
-      "https://#{host}#{AUTHORIZE_PATH}?response_type=code_and_token&client_id=#{client_id}&redirect_uri=#{URI.escape(redirect_uri)}&#{additional_params}"
+      "https://#{api_host}#{AUTHORIZE_PATH}?response_type=code&client_id=#{client_id}&redirect_uri=#{URI.escape(redirect_uri)}&#{additional_params}"
     end
 
     def exchange_token(options={})
       store_options(options)
       raise ArgumentError, 'client_id and client_secret is required to retrieve an access_token' if client_id.nil? || client_secret.nil?
 
-      params = if options_for_refresh_flow_present?
+      params = if options_for_code_flow_present?
+        {
+          :grant_type => 'authorization_code',
+          :redirect_uri => redirect_uri,
+          :code => @options[:code],
+        }
+      elsif options_for_refresh_flow_present?
         {
           :grant_type => 'refresh_token',
           :refresh_token => refresh_token,
         }
       elsif options_for_credentials_flow_present?
-        puts "Warning: Password grant is deprecated, see https://developers.soundcloud.com/blog/security-updates-api"
         {
-          :grant_type => 'password',
-          :username => @options[:username],
-          :password => @options[:password],
-        }
-      elsif options_for_code_flow_present?
-        {
-          :grant_type => 'authorization_code',
-          :redirect_uri => @options[:redirect_uri],
-          :code => @options[:code],
+          :grant_type => 'client_credentials'
         }
-      elsif client_secret
-        { :grant_type => 'client_credentials' }
       end
 
       params.merge!(:client_id => client_id, :client_secret => client_secret)
@@ -139,6 +134,7 @@ module SoundCloud
 
       @options.merge!(:access_token => response.access_token, :refresh_token => response.refresh_token)
       @options[:expires_at] = Time.now + response.expires_in if response.expires_in
+      @options[:code] = nil
       @options[:on_exchange_token].call(*[(self if @options[:on_exchange_token].arity == 1)].compact)
       response
     end
@@ -173,7 +169,7 @@ module SoundCloud
     end
 
     def options_for_credentials_flow_present?
-      !!(@options[:username] && @options[:password])
+      !!@options[:client_secret]
     end
 
     def options_for_code_flow_present?
@@ -195,7 +191,7 @@ module SoundCloud
       if access_token
         options[:headers] = { 'Authorization' => "OAuth #{access_token}" }
       else
-        puts "Warning: Authorization via ClientId is deprecated, see https://developers.soundcloud.com/blog/security-updates-api"
+        puts "Warning: Authorization via client_id is deprecated, access_token is required. For details see https://developers.soundcloud.com/blog/security-updates-api"
         options[body_or_query][CLIENT_ID_PARAM_NAME] = client_id
       end
       [

data/lib/soundcloud/version.rb

@@ -1,3 +1,3 @@
 module SoundCloud
-  VERSION = '0.3.5'
+  VERSION = '0.3.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soundcloud
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.7
 platform: ruby
 authors:
 - Johannes Wagener
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-24 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty