shuffler_fm 0.0.1 → 0.0.2

data/Rakefile

@@ -19,10 +19,12 @@ task :console do
   end
 end
 
-desc "Generate documentation"
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
-  t.options = ['--no-private', '--protected', '--markup', 'markdown']
+namespace :doc do
+  desc "Generate documentation"
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['--no-private', '--protected', '--markup', 'markdown']
+  end
 end
 
 #

data/lib/shuffler_fm/api/artists.rb

@@ -5,12 +5,13 @@ module ShufflerFM
       # Requests a list of artists
       #
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] a list of artists
       #
       def artists(options = {})
-        get("/artists", :page => page(options))
+        get("/artists", options)
       end
 
       # Requests a particular artist
@@ -29,24 +30,25 @@ module ShufflerFM
       #
       # @param [Integer] id the artist id
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] an array of results
       #
       def artist_blogs(id, options= {})
-        get("artists/#{Integer(id)}/blogs", :page => page(options))
+        get("artists/#{Integer(id)}/blogs", options)
       end
 
       # Search artists
       #
       # @param [String] q your query
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
       #
       # @return [Array] an array of results
       #
       def search_artists(q, options = {})
-        get("/artists?q=#{String(q)}", :page => page(options))
+        get("/artists?q=#{String(q)}", options)
       end
     end
   end

data/lib/shuffler_fm/api/blogs.rb

@@ -5,23 +5,25 @@ module ShufflerFM
       # Requests a list of blogs
       #
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] a list of blogs
       #
       def blogs(options = {})
-        get("/blogs", :page => page(options))
+        get("/blogs", options)
       end
 
       # Requests a list of featured blogs
       #
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] a list of featured blogs
       #
       def featured_blogs(options = {})
-        get("/blogs", :page => page(options), :filter => 'featured')
+        get("/blogs", options.merge(:filter => 'featured'))
       end
 
       # Requests a particular blog
@@ -40,12 +42,13 @@ module ShufflerFM
       #
       # @param [String] q your query
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] an array of results
       #
       def search_blogs(q, options = {})
-        get("/blogs?q=#{String(q)}", :page => page(options))
+        get("/blogs?q=#{String(q)}", options)
       end
     end
   end

data/lib/shuffler_fm/api/channels.rb

@@ -7,7 +7,8 @@ module ShufflerFM
       # @param [String] key The channel key.
       #    Can be on of the following: mp3, youtube, vimeo, soundcloud or officialfm
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] an array with the channel's activity stream
       #
@@ -22,7 +23,8 @@ module ShufflerFM
       #
       # @param [String] key The channel key.
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] an array with the channel's activity stream
       #
@@ -37,7 +39,8 @@ module ShufflerFM
       #
       # @param key The channel key.
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] an array with the channel's activity stream
       #
@@ -65,7 +68,7 @@ module ShufflerFM
       private
       def channel(*args)
         key, query, opts = process_args(args)
-        get((key == :genre ? "channels/" : "channels/#{key}:") << "#{String(query.join('+'))}", :page => page(opts))
+        get((key == :genre ? "channels/" : "channels/#{key}:") << "#{String(query.join('+'))}", opts)
       rescue ShufflerFM::NotFound
         []
       end

data/lib/shuffler_fm/api/charts.rb

@@ -5,23 +5,25 @@ module ShufflerFM
       # Lists popular tracks charts
       #
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] a list of tracks merged with chart metadata
       #
       def popular_charts(options = {})
-        get("/charts/popular", :page => page(options))
+        get("/charts/popular", options)
       end
 
       # Lists tracks that were recently added to the popular list
       #
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] a list of tracks merged with chart metadata
       #
       def popular_charts_newest(options = {})
-        get("/charts/new", :page => page(options))
+        get("/charts/new", options)
       end
     end
   end

data/lib/shuffler_fm/api/genres.rb

@@ -4,12 +4,12 @@ module ShufflerFM
       # Requests a list of genres
       #
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @option options [Integer] :page The page to request on paginated operation responses. First page is page 1.
       #
       # @return [Array] a list of genres
       #
       def genres(options = {})
-        get("/genres", :page => page(options))
+        get("/genres", options)
       end
 
       # Requests a particular genre

data/lib/shuffler_fm/api/tracks.rb

@@ -5,7 +5,8 @@ module ShufflerFM
       # Requests a list of tracks
       #
       # @param [Hash] options
-      # @option options [Integer] :page The page to request on paginated operation responses
+      # @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.
       #
       # @return [Array] a list of tracks
       #
@@ -15,7 +16,7 @@ module ShufflerFM
       #   tracks = api.tracks(page: 2)
       #
       def tracks(options = {})
-        get("/tracks", :page => page(options))
+        get("/tracks", options)
       end
 
       # Requests a particular track

data/lib/shuffler_fm/api.rb

@@ -45,10 +45,5 @@ module ShufflerFM
       raise ArgumentError, 'An API key must be provided' if key.nil?
       @key = key
     end
-
-    private
-    def page(options)
-      Integer(options.fetch(:page) { 1 })
-    end
   end
 end

data/lib/shuffler_fm/request.rb

@@ -16,10 +16,16 @@ module ShufflerFM
     private
     def request(method, path, options = {})
       response = http_connection.send(method) do |request|
-        request.url("#{API.version}/#{path}", options)
+        request.url("#{API.version}/#{path}", process_options(options))
       end
 
       response.body
     end
+
+    def process_options(options)
+      #shuffler.fm REST API v1 determins the the first page on a paginated resource is 0.
+      #We are abstracting that to start on page 1.
+      options.merge(:page => Integer(options.delete(:page) { 1 }) - 1)
+    end
   end
 end

data/lib/shuffler_fm/version.rb

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