soundcloud 0.3.2 → 0.3.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6fc3d7e7da0596a6223c2a6c2f322ed4d4892f3e66e431eba20f36e59abad83
+  data.tar.gz: 4fed15f8d7d7cf2d4a95146e28943356a29c10266f2e4ca74d218026b54e7fc4
+SHA512:
+  metadata.gz: 989b6e4dd91accff9bd05fbd1c614906447f87e1f21ced987f888c74c73a26611d6f9351ead6b29fb44fc035368a516169aaf189b2c0231c01add4bbf6c5916b
+  data.tar.gz: 71181c248240bcab145ab5f9d127266a3b2aa1ce252c6bfe92fa5accf490f2cdd41e1d772268859f2125c8e8d1b971d9daca54ede2ddead8a915a6e4b2c0dc5e

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2015 SoundCloud Ltd., Johannes Wagener, Erik Michaels-Ober
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,3 +1,10 @@
+# ⚠️⚠️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 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 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  
+
+---
+
 # SoundCloud API Wrapper
 
 [![Build Status](https://travis-ci.org/soundcloud/soundcloud-ruby.png?branch=master)](https://travis-ci.org/soundcloud/soundcloud-ruby)
@@ -12,36 +19,26 @@ gem install soundcloud
 ```
 
 ## Examples
-#### Print links of the 10 hottest tracks
+
+The following examples are for the [latest gem version](https://rubygems.org/gems/soundcloud).
+
 ```ruby
-# register a client with YOUR_CLIENT_ID as client_id_
-client = SoundCloud.new(:client_id => YOUR_CLIENT_ID)
-# get 10 hottest tracks
-tracks = client.get('/tracks', :limit => 10, :order => 'hotness')
-# print each link
-tracks.each do |track|
-  puts track.permalink_url
-end
+SoundCloud::VERSION
+# => "0.3.6"
 ```
 
-#### 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,
@@ -50,21 +47,24 @@ 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,
   :refresh_token => SOME_REFRESH_TOKEN
 })
 
-# upload a new track with track.mp3 as audio and image.jpg as artwork
+# upload a new track with audio.mp3 as audio and image.jpg as artwork
 track = client.post('/tracks', :track => {
   :title      => 'a new track',
   :asset_data => File.new('audio.mp3')
@@ -74,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")
 
@@ -89,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"})
@@ -97,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
 
@@ -122,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.
 
@@ -168,3 +175,7 @@ Will return true or false depending on if `expires_at` is in the past.
 In case a request was not successful a SoundCloud::ResponseError will be
 raised. The original HTTParty response is available through
 `SoundCloud::ResponseError#response`.
+
+## Documentation
+
+For more code examples, please visit the [SoundCloud API Documentation](http://developers.soundcloud.com/docs).

data/lib/soundcloud/client.rb

@@ -1,7 +1,9 @@
+require 'soundcloud/version'
+
 module SoundCloud
   class Client
     include HTTMultiParty
-    USER_AGENT            = "SoundCloud Ruby Wrapper #{VERSION}"
+    USER_AGENT            = "SoundCloud Ruby Wrapper #{SoundCloud::VERSION}"
     CLIENT_ID_PARAM_NAME  = :client_id
     API_SUBHOST           = 'api'
     AUTHORIZE_PATH        = '/connect'
@@ -16,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?)
+      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={})
@@ -100,37 +102,39 @@ 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?
-      client_params = {:client_id => client_id, :client_secret => client_secret}
-      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?
         {
-          :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'
         }
       end
-      params.merge!(client_params)
+
+      params.merge!(:client_id => client_id, :client_secret => client_secret)
+
       response = handle_response(false) {
         self.class.post("https://#{api_host}#{TOKEN_PATH}", :query => params)
       }
+
       @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
@@ -151,9 +155,9 @@ module SoundCloud
         else
           raise ResponseError.new(response)
         end
-      elsif response.is_a?(Hash)
+      elsif response_is_a?(response, Hash)
         HashResponseWrapper.new(response)
-      elsif response.is_a?(Array)
+      elsif response_is_a?(response, Array)
         ArrayResponseWrapper.new(response)
       elsif response && response.success?
         response
@@ -165,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?
@@ -185,8 +189,9 @@ module SoundCloud
       options[body_or_query] ||= {}
       options[body_or_query][:format] = "json"
       if access_token
-        options[body_or_query][:oauth_token] = access_token
+        options[:headers] = { 'Authorization' => "OAuth #{access_token}" }
       else
+        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
       [
@@ -195,5 +200,8 @@ module SoundCloud
       ]
     end
 
+    def response_is_a?(response, type)
+      response.is_a?(type) || (response.respond_to?(:parsed_response) && response.parsed_response.is_a?(type))
+    end
   end
 end

data/lib/soundcloud/version.rb

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

metadata

@@ -1,102 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: soundcloud
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.3.7
 platform: ruby
 authors:
 - Johannes Wagener
-autorequire: 
+- Erik Michaels-Ober
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: The official SoundCloud API wrapper. It provides simple methods to handle
   authorization and to execute HTTP calls.
 email:
-- johannes@soundcloud.com
+- api@soundcloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.md
+- README.md
+- lib/soundcloud.rb
 - lib/soundcloud/array_response_wrapper.rb
 - lib/soundcloud/client.rb
 - lib/soundcloud/hash_response_wrapper.rb
 - lib/soundcloud/response_error.rb
 - lib/soundcloud/version.rb
-- lib/soundcloud.rb
-- README.md
-homepage: http://dev.soundcloud.com
+homepage: https://dev.soundcloud.com
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
 summary: The official SoundCloud API wrapper.
 test_files: []
-has_rdoc: