soundcloud 0.3.2 → 0.3.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df5b0cab01fdc8985e0059c4fbaebbb29672f58c17c33ce1cce2765861eeee3c
+  data.tar.gz: 730fc7f919b60e2aa582e755560284ebc07957d51054115da4093adfa71ced0c
+SHA512:
+  metadata.gz: 93d8a10bd11b13c43b18e6c5449a3e640f0f43e93eb40473869f3326d84e4f6c4c347929acf9e93ddb0e4f1fa6cf8df75f68d25818636f6738efbe2a2dfafd54
+  data.tar.gz: 71e706b85e323052f13bd39c1f32368c4cbaaccb41ceaf5e2eed65438502dc025e8adf30191af06ae9ea35efad492faad3a85443ef2cb0d57b4ad0a0b29c6e66

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, at the time of updating this, the repo is already 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  
+
+---
+
 # SoundCloud API Wrapper
 
 [![Build Status](https://travis-ci.org/soundcloud/soundcloud-ruby.png?branch=master)](https://travis-ci.org/soundcloud/soundcloud-ruby)
@@ -12,12 +19,20 @@ 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
+SoundCloud::VERSION
+# => "0.3.4"
+```
+
+#### 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 10 hottest tracks
-tracks = client.get('/tracks', :limit => 10, :order => 'hotness')
+# get newest tracks
+tracks = client.get('/tracks', :limit => 10)
 # print each link
 tracks.each do |track|
   puts track.permalink_url
@@ -64,7 +79,7 @@ client = SoundCloud.new({
   :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')
@@ -168,3 +183,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,7 +18,7 @@ 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_credentials_flow_present? || options_for_code_flow_present? || client_secret)
         exchange_token
       end
       raise ArgumentError, "At least a client_id or an access_token must be present" if client_id.nil? && access_token.nil?
@@ -106,13 +108,14 @@ module SoundCloud
     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?
         {
           :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],
@@ -124,11 +127,16 @@ module SoundCloud
           :redirect_uri => @options[:redirect_uri],
           :code => @options[:code],
         }
+      elsif client_secret
+        { :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[:on_exchange_token].call(*[(self if @options[:on_exchange_token].arity == 1)].compact)
@@ -151,9 +159,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
@@ -185,8 +193,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 ClientId is deprecated, see https://developers.soundcloud.com/blog/security-updates-api"
         options[body_or_query][CLIENT_ID_PARAM_NAME] = client_id
       end
       [
@@ -195,5 +204,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.5'
 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.5
 platform: ruby
 authors:
 - Johannes Wagener
-autorequire: 
+- Erik Michaels-Ober
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2021-09-24 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: