shuffler_fm 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+0.1.0
+-----
+
+Added track streaming URI acquisition (Tracks#stream)
+
+0.0.2
+-----
+
+Added the per_page parameter & corrected pagination threshold
+
+0.0.1
+-----
+
+1st release

data/README.md

@@ -59,6 +59,7 @@ track.metadata.artist.name
 
 ### Search for an artist
 ```ruby
+
 api.search_artists('radiohead').map(&:name)
 => ["Radiohead", "Radiohead at Lollapalooza 2008", "REM & Radiohead", "Radiohead 6. Permanent Daylight live", "Radiohead @ Optimus Alive'12", "I Can't Take The Hurt (Johnny Cash vs Tegan and Sarah and Radiohead)"]
 ```
@@ -67,7 +68,7 @@ api.search_artists('radiohead').map(&:name)
 ```ruby
 
 activity = []
-api.genre_channels('punk', 'rock').each do |act|
+api.genre_channels('punk', 'rock', page: 1, per_page: 10).each do |act|
   activity << "#{act.verb.capitalize} on #{act.actor.title} refering music track #{act.object.metadata.title}"
 end
 

data/lib/shuffler_fm/api/channels.rb

@@ -13,7 +13,7 @@ module ShufflerFM
       # @return [Array] an array with the channel's activity stream
       #
       # @example
-      #   api.media_channels('youtube', page: 2)
+      #   api.media_channels('soundcloud')
       #
       def media_channels(key, options = {})
         channel(:media, key, options)
@@ -21,7 +21,7 @@ module ShufflerFM
 
       # Reads the blog channels activity stream
       #
-      # @param [String] key The channel key.
+      # @param [Integer] key The blog id
       # @param [Hash] options
       # @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
       # @option options [Integer] :per_page The page size. Default is 50, maximum is 100.
@@ -37,7 +37,6 @@ module ShufflerFM
 
       # Reads the artist channels activity stream
       #
-      # @param key The channel key.
       # @param [Hash] options
       # @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
       # @option options [Integer] :per_page The page size. Default is 50, maximum is 100.
@@ -53,13 +52,22 @@ module ShufflerFM
 
       # Reads the genere channels activity stream.
       #
-      # @param [Array] keys The channel keys.
+      # @overload genre_channels(*keys)
+      #   @param [Array] keys The channel keys.
       #
-      # @return [Array] an array with the channel's activity stream
+      #   @example
+      #      api.genre_channels('punk')
+      #      api.genre_channels('punk', 'rock')
       #
-      # @example
-      #    api.genre_channels('rock')
-      #    api.genre_channels('punk', 'rock', page: 2)
+      # @overload genre_channels(*keys, options)
+      #   @param [Hash] options
+      #   @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
+      #   @option options [Integer] :per_page The page size. Default is 50, maximum is 100.
+      #
+      #   @example
+      #      api.genre_channels('punk', 'rock', page: 1, per_page: 10)
+      #
+      # @return [Array] an array with the channel's activity stream
       #
       def genre_channels(*keys)
         channel(:genre, *keys)

data/lib/shuffler_fm/api/tracks.rb

@@ -29,6 +29,18 @@ module ShufflerFM
       rescue ShufflerFM::NotFound
         nil
       end
+
+      # Streaming URI for a track.
+      #
+      # NOTE: This operation requires a specific authorization form shuffler.fm
+      #
+      # @param [Integer] id The track id
+      #
+      # @return [URI] the track streaming URI if avaliable
+      #
+      def stream(id)
+        URI(get("/tracks/#{Integer(id)}/stream", {}, false).headers['location'])
+      end
     end
   end
 end

data/lib/shuffler_fm/http.rb

@@ -6,13 +6,15 @@ module ShufflerFM
   # @private
   module HTTP
     private
-    def connection
+    def connection(managed = true)
       options = {:url => ShufflerFM::API.base_uri,
                  :params => {'api-key' => key}}.merge(ShufflerFM.configuration.values)
 
       Faraday.new(options) do |builder|
-        builder.use FaradayMiddleware::Rashify
-        builder.use FaradayMiddleware::ParseJson
+        if managed
+          builder.use FaradayMiddleware::Rashify
+          builder.use FaradayMiddleware::ParseJson
+        end
 
         builder.use ShufflerFM::Middleware::ErrorHandler
 

data/lib/shuffler_fm/request.rb

@@ -7,19 +7,23 @@ module ShufflerFM
     # @param [String] path The request path
     # @param [Hash] options The operation options
     #
+    # @param [Boolean] managed true for a custom middleware mangaed connection,
+    #                    false to overide the middleware and recive the raw http response
+    #
     # @return The HTTP response
     #
-    def get(path, options = {})
-      request(:get, path, options)
+    def get(path, options = {}, managed = true)
+      request(:get, path, options, managed)
     end
 
     private
-    def request(method, path, options = {})
-      response = http_connection.send(method) do |request|
+    def request(method, path, options = {}, managed = true)
+      response = http_connection(managed).send(method) do |request|
         request.url("#{API.version}/#{path}", process_options(options))
       end
 
-      response.body
+      return response.body if managed
+      response
     end
 
     def process_options(options)

data/lib/shuffler_fm/version.rb

@@ -1,3 +1,3 @@
 module ShufflerFM
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/fixtures/vcr_cassettes/tracks.yml

@@ -92,4 +92,33 @@ http_interactions:
       string: ""
     http_version: 
   recorded_at: Thu, 04 Oct 2012 20:57:56 GMT
+- request: 
+    method: get
+    uri: http://api.shuffler.fm/v1/tracks/1/stream?api-key=<api-key>&page=0
+    body: 
+      string: ""
+    headers: 
+      Accept: 
+      - "*/*"
+  response: 
+    status: 
+      code: 302
+      message: FOUND
+    headers: 
+      Content-Type: 
+      - text/html; charset=utf-8
+      Server: 
+      - TornadoServer/2.4
+      Location: 
+      - http://api.soundcloud.com/tracks/9598274/stream?consumer_key=WFhMwGBRy2BnBBB7IK7WiQ
+      Content-Length: 
+      - "373"
+    body: 
+      string: |-
+        <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+        <title>Redirecting...</title>
+        <h1>Redirecting...</h1>
+        <p>You should be redirected automatically to target URL: <a href="http://api.soundcloud.com/tracks/9598274/stream?consumer_key=WFhMwGBRy2BnBBB7IK7WiQ">http://api.soundcloud.com/tracks/9598274/stream?consumer_key=WFhMwGBRy2BnBBB7IK7WiQ</a>.  If not click the link.
+    http_version: 
+  recorded_at: Mon, 08 Oct 2012 21:55:01 GMT
 recorded_with: VCR 2.2.5

data/spec/helper.rb

@@ -24,7 +24,7 @@ end
 # setup VCR
 VCR.configure do |cfg|
   cfg.filter_sensitive_data('<api-key>') { KEY }
-  cfg.default_cassette_options = { :record => :new_episodes, :serialize_with => :syck }
+  cfg.default_cassette_options = { :record => :new_episodes }
   cfg.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   cfg.hook_into :webmock
 end

data/spec/shuffler_fm/api/tracks_spec.rb

@@ -12,4 +12,8 @@ describe ShufflerFM::API::Tracks do
     api.track(1).should be_a(Hashie::Mash)
     api.track(0).should be_nil
   end
+
+  it 'requests a track stream' do
+    api.stream(1).should be_a(URI)
+  end
 end

metadata

@@ -1,222 +1,236 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: shuffler_fm
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Miguel Guinada
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: faraday
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 8
-        version: "0.8"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: faraday_middleware
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 8
-        version: "0.8"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rash
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 3
-        version: "0.3"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: multi_json
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: pry
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: vcr
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: maruku
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id013
-description: " shuffler_fm wraps shuffler.fm's REST api on a thin layer of ruby. "
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' shuffler_fm wraps shuffler.fm''s REST api on a thin layer of ruby. '
+email:
 - mguinada@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
 - .yardopts
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -257,38 +271,29 @@ files:
 - spec/shufflerfm_spec.rb
 homepage: https://github.com/mguinada/shuffler_fm
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby API wrapper for http://shuffler.fm
-test_files: 
+test_files:
 - spec/config.yml.sample
 - spec/fixtures/vcr_cassettes/api.yml
 - spec/fixtures/vcr_cassettes/artists.yml