splattael-shoutcast_api 0.0.2 → 0.1.0

data/Manifest

@@ -1,4 +1,6 @@
 Rakefile
+bin/shoutcast_search
+lib/delegator.rb
 lib/shoutcast_api.rb
 README.rdoc
 Manifest
@@ -9,4 +11,5 @@ test/fixtures/genrelist.plain
 test/fixtures/search_death.plain
 test/fixtures/empty.plain
 test/test_basic.rb
+test/test_delegator.rb
 shoutcast_api.gemspec

data/README.rdoc

@@ -8,7 +8,7 @@ Uses httparty and roxml for fetch and parsing data from http://yp.shoutcast.com/
   require 'shoutcast_api'
 
   # Stations
-  Shoutcast.search(:name => "Chronix").stations.each do |station|
+  Shoutcast.search(:name => "Chronix").each do |station|
     p station
     puts station.tunein
   end
@@ -17,7 +17,6 @@ Uses httparty and roxml for fetch and parsing data from http://yp.shoutcast.com/
 
   # Genres
   Shoutcast.genres # => all genres
-  Shoutcast.genres /op/ # => genres which match "op"
 
 == Command line
 
@@ -28,7 +27,5 @@ Uses httparty and roxml for fetch and parsing data from http://yp.shoutcast.com/
 
 == TODO
 
-* Tests!
 * Docs!
-* command line options transformations 
-* handle empty responses like search(:search => "")
+* command line options transformations

data/Rakefile

@@ -6,12 +6,23 @@ desc 'Default: run unit tests.'
 task :default => :test
 
 require 'echoe'
-
 Echoe.new('shoutcast_api') do |gem|
-  gem.version = '0.0.2'
+  gem.version = '0.1.0'
   gem.author = 'Peter Suschlik'
   gem.summary = 'Simple Shoutcast.com API.'
   gem.email = 'peter-scapi@suschlik.de'
   gem.url = %q{http://github.com/splattael/shoutcast_api}
   gem.runtime_dependencies = [ "httparty ~>0.4", "roxml ~>2.5" ]
+  gem.ignore_pattern = ["tags"]
+end
+
+desc "Tag files for vim"
+task :ctags do
+  dirs = $LOAD_PATH.select {|path| File.directory?(path) }
+  system "ctags -R #{dirs.join(" ")}"
+end
+
+desc "Find whitespace at line ends"
+task :eol do
+  system "grep -nrE ' +$' *"
 end

data/bin/shoutcast_search

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+require 'shoutcast_api'
+
+if ARGV.size > 0
+  options = ARGV.inject({}) do |hash, arg|
+    key, value = arg.split(/=/)
+    hash[key.intern] = value
+    hash
+  end
+  # TODO do more transformations
+  # br -> bitrate
+  # ct -> current_title
+  # can ROXML help us?
+  options[:search] = options.delete(:name) if options[:name]
+
+  puts Shoutcast::Station.header
+  Shoutcast.search(options).sort.reverse.each do |station|
+    puts station
+  end
+else
+  puts "Genres: ", Shoutcast.genres.map { |g| g.name }.join(", ")
+end
+

data/lib/delegator.rb

@@ -0,0 +1,36 @@
+module Shoutcast
+
+  # Delegates methods via Forwardable.
+  module Delegator
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Delegates all methods defined +klass+ to +object+.
+      #
+      # === Usage
+      #   class ArrayMimic < SomeInheritance
+      #
+      #     delegate_all :@array, Array
+      #
+      #   end
+      #
+      #   array = ArrayMimic.new
+      #   array.push 1, 2, 3
+      #   array.each do |item|
+      #     p item
+      #   end
+      #
+      def delegate_all(object, klass)
+        class_eval <<-EVAL
+          extend Forwardable
+
+          def_delegators :#{object}, *(#{klass}.instance_methods - instance_methods)
+        EVAL
+      end
+    end
+
+  end
+
+end

data/lib/shoutcast_api.rb

@@ -2,46 +2,58 @@ require 'httparty'
 require 'roxml'
 require 'forwardable'
 
+require 'delegator'
+
 module Shoutcast
   extend Forwardable
   extend self
 
-  def_delegators :Fetcher, :genre, :search
+  def_delegators :Fetcher, :genres, :search
 
   class Fetcher
     include HTTParty
-    base_uri 'http://yp.shoutcast.com/sbin/newxml.phtml'
+    base_uri "http://yp.shoutcast.com"
     format :plain
 
-    def self.genres(filter=nil)
-      list = Genrelist.from_xml fetch
-
-      list.filter(filter)
+    def self.genres
+      fetch do |xml|
+        Genrelist.from_xml xml
+      end
     end
 
     def self.search(options={})
-      Stationlist.from_xml fetch(options)
+      fetch(options) do |xml|
+        Stationlist.from_xml xml
+      end
     end
 
     private
 
-    def self.fetch(options={})
-      options.update(:nocache => Time.now.to_f)
-      get('', :query => options).body
+    def self.fetch(options={}, &block)
+      options.update(:nocache => Time.now.to_f)  if options
+      data = get("/sbin/newxml.phtml", :query => options).body
+
+      block.call(data)  unless data.empty?
     end
   end
 
   # XML
 
-  class Base
-    include ROXML
+  module Xml
+    def self.included(base)
+      base.send(:include, ROXML)
+      base.extend ClassMethods
+    end
 
-    def self.trim
-      proc { |v| v.to_s.strip }
+    module ClassMethods
+      def trim
+        proc { |v| v.to_s.strip.squeeze(" ") }
+      end
     end
   end
 
-  class Station < Base
+  class Station
+    include Xml
     # <station
     #   id="423873"
     #   name="www.deathmetal.at"
@@ -79,26 +91,36 @@ module Shoutcast
     end
   end
 
-  class Stationlist < Base
+  class Stationlist
+    include Xml
+    include Delegator
+
+    delegate_all :@stations, Array
+
     # <tunein base="/sbin/tunein-station.pls"/>
     # <station... /> <station .../>
-    BASE_URL = "http://yp.shoutcast.com"
 
     xml_reader :tunein_base_path, :from => '@base', :in => 'tunein'
-    xml_reader :stations, :as => [ Station ]
+    xml_attr :stations, :as => [ Station ]
+
+    class << self
+      attr_accessor :base_uri
+    end
+    self.base_uri = Fetcher.base_uri
 
     def tunein(station)
-      "#{BASE_URL}#{tunein_base_path}?id=#{station.id}"
+      "#{self.class.base_uri}#{tunein_base_path}?id=#{station.id}"
     end
 
     private
 
     def after_parse
-      stations.each { |station| station.tunein = tunein(station) }
+      each { |station| station.tunein = tunein(station) }
     end
   end
 
-  class Genre < Base
+  class Genre
+    include Xml
     # <genre name="24h"/>
     xml_reader :name, :from => :attr
 
@@ -107,44 +129,14 @@ module Shoutcast
     end
   end
 
-  class Genrelist < Base
-    xml_reader :genres, :as => [ Genre ]
-
-    def filter(option=nil)
-      case option
-      when String
-        genres.select { |genre| genre.name == option }
-      when Regexp
-        genres.select { |genre| genre.name =~ option }
-      else
-        genres
-      end
-    end
-  end
+  class Genrelist
+    include Xml
+    include Delegator
 
-end
+    delegate_all :@genres, Array
 
-if $0 == __FILE__
-  require 'pp'
+    xml_attr :genres, :as => [ Genre ]
 
-  if ARGV.size > 0
-    options = ARGV.inject({}) do |hash, arg|
-      key, value = arg.split(/=/)
-      hash[key.intern] = value
-      hash
-    end
-    # TODO do more transformations
-    # br -> bitrate
-    # ct -> current_title
-    # can ROXML help us?
-    options[:search] = options.delete(:name) if options[:name]
-
-    puts Shoutcast::Station.header
-    Shoutcast.search(options).stations.sort.reverse.each do |station|
-      puts station
-    end
-  else
-    pp Shoutcast.genres
   end
 
 end

data/shoutcast_api.gemspec

@@ -2,15 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shoutcast_api}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Suschlik"]
   s.date = %q{2009-05-14}
+  s.default_executable = %q{shoutcast_search}
   s.description = %q{Simple Shoutcast.com API.}
   s.email = %q{peter-scapi@suschlik.de}
-  s.extra_rdoc_files = ["lib/shoutcast_api.rb", "README.rdoc"]
-  s.files = ["Rakefile", "lib/shoutcast_api.rb", "README.rdoc", "Manifest", "test/test_xml.rb", "test/helper.rb", "test/test_fetcher.rb", "test/fixtures/genrelist.plain", "test/fixtures/search_death.plain", "test/fixtures/empty.plain", "test/test_basic.rb", "shoutcast_api.gemspec"]
+  s.executables = ["shoutcast_search"]
+  s.extra_rdoc_files = ["bin/shoutcast_search", "lib/delegator.rb", "lib/shoutcast_api.rb", "README.rdoc"]
+  s.files = ["Rakefile", "bin/shoutcast_search", "lib/delegator.rb", "lib/shoutcast_api.rb", "README.rdoc", "Manifest", "test/test_xml.rb", "test/helper.rb", "test/test_fetcher.rb", "test/fixtures/genrelist.plain", "test/fixtures/search_death.plain", "test/fixtures/empty.plain", "test/test_basic.rb", "test/test_delegator.rb", "shoutcast_api.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/splattael/shoutcast_api}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Shoutcast_api", "--main", "README.rdoc"]
@@ -18,7 +20,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{shoutcast_api}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{Simple Shoutcast.com API.}
-  s.test_files = ["test/test_xml.rb", "test/test_fetcher.rb", "test/test_basic.rb"]
+  s.test_files = ["test/test_xml.rb", "test/test_fetcher.rb", "test/test_basic.rb", "test/test_delegator.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/test/test_basic.rb

@@ -1,5 +1,14 @@
 require File.join(File.dirname(__FILE__), 'helper')
 
+class ShoutcastTest < Test::Unit::TestCase
+
+  def test_delegators
+    assert_respond_to Shoutcast, :genres
+    assert_respond_to Shoutcast, :search
+  end
+
+end
+
 class ExtensionsTest < Test::Unit::TestCase
 
   def test_file_fixture

data/test/test_delegator.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class ArrayMimic
+  include Shoutcast::Delegator
+
+  delegate_all :@array, Array
+
+  def initialize
+    @array = []
+  end
+
+end
+
+class DelegatorTest < Test::Unit::TestCase
+
+  def test_method_delegation
+    ary = ArrayMimic.new
+    ary.push 1, 2, 3
+
+    assert_equal 3, ary.size
+    assert_equal 1, ary.first
+    assert_equal 3, ary.last
+    assert_respond_to ary, :each
+    assert_equal [].methods.sort, ary.methods.sort
+  end
+
+end

data/test/test_fetcher.rb

@@ -1,3 +1,41 @@
 require File.join(File.dirname(__FILE__), 'helper')
 
-# TODO integeration tests with fetcher.
+class FetcherTest < Test::Unit::TestCase
+  include Shoutcast
+
+  def test_base_uri
+    assert_equal "http://yp.shoutcast.com", Stationlist.base_uri
+  end
+
+  def test_genres_list
+    stub_http_response_with("genrelist.plain")
+
+    list = Fetcher.genres
+    # DRY test/text_xml.rb GenrelistTest
+    assert_instance_of Genrelist, list
+    assert_instance_of Genre, list.first
+  end
+
+  def test_genres_empty_response
+    stub_http_response_with("empty.plain")
+
+    assert_nil Fetcher.genres
+  end
+
+  def test_search_with_invalid_option
+    stub_http_response_with("search_death.plain")
+
+    list = Fetcher.search
+    # DRY test/text_xml.rb StationlistTest
+    assert_instance_of Stationlist, list
+    assert_equal "/sbin/tunein-station.pls", list.tunein_base_path
+    assert_instance_of Station, list.first
+  end
+
+  def test_search_empty_response
+    stub_http_response_with("empty.plain")
+
+    assert_nil Fetcher.genres
+  end
+
+end

data/test/test_xml.rb

@@ -64,6 +64,7 @@ class StationTest < Test::Unit::TestCase
 
 end
 
+
 class StationlistTest < Test::Unit::TestCase
   include Shoutcast
 
@@ -74,19 +75,22 @@ class StationlistTest < Test::Unit::TestCase
   def test_attributes
     assert_instance_of Stationlist, @list
     assert_equal "/sbin/tunein-station.pls", @list.tunein_base_path
-    assert_instance_of Array, @list.stations
-    assert_equal 49, @list.stations.size
-    assert_instance_of Station, @list.stations.first
+    assert_equal 49, @list.size
+    assert_instance_of Station, @list.first
+  end
+
+  def test_base_uri
+    assert_equal "http://yp.shoutcast.com", Stationlist.base_uri
   end
 
   def test_tunein
-    station = @list.stations.first
+    station = @list.first
 
     assert_equal "http://yp.shoutcast.com/sbin/tunein-station.pls?id=#{station.id}", @list.tunein(station)
   end
 
   def test_tunein_propagtion_after_parse
-    station = @list.stations.first
+    station = @list.first
 
     assert_equal @list.tunein(station), station.tunein
   end
@@ -101,28 +105,35 @@ class GenrelistTest < Test::Unit::TestCase
     @list = Genrelist.from_xml file_fixture("genrelist.plain")
   end
 
-  def test_parsing
+  def test_array_mimic
     assert_instance_of Genrelist, @list
-    assert_instance_of Array, @list.genres
-    assert_equal 434, @list.genres.size
-    assert_instance_of Genre, @list.genres.first
-  end
-
-  def test_filter
-    assert_equal @list.genres, @list.filter
-
-    assert_equal 1, @list.filter("Rock").size
-    assert_equal "Rock", @list.filter("Rock").first.name
-
-    assert_equal 13, @list.filter(/op/).size
-    assert_equal "Autopilot", @list.filter(/op/).first.name
+    assert_equal 434, @list.size
+    assert_instance_of Genre, @list.first
+    assert_respond_to @list, :each
+    assert_raise(NoMethodError) { @list.nothing_found }
   end
 
   def test_genre_name
-    sorted = @list.genres.sort
+    sorted = @list.sort
 
     assert_equal "24h", sorted.first.name
     assert_equal "Zouk", sorted.last.name
   end
 
 end
+
+
+class MyClass
+  include Shoutcast::Xml
+end
+
+class XmlTest < Test::Unit::TestCase
+
+  def test_trim
+    assert_respond_to MyClass, :trim
+
+    string = "  test mee   "
+    assert_equal "test mee", MyClass.trim.call(string)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: splattael-shoutcast_api
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Peter Suschlik
@@ -10,7 +10,7 @@ bindir: bin
 cert_chain: []
 
 date: 2009-05-14 00:00:00 -07:00
-default_executable: 
+default_executable: shoutcast_search
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
@@ -34,15 +34,19 @@ dependencies:
     version: 
 description: Simple Shoutcast.com API.
 email: peter-scapi@suschlik.de
-executables: []
-
+executables: 
+- shoutcast_search
 extensions: []
 
 extra_rdoc_files: 
+- bin/shoutcast_search
+- lib/delegator.rb
 - lib/shoutcast_api.rb
 - README.rdoc
 files: 
 - Rakefile
+- bin/shoutcast_search
+- lib/delegator.rb
 - lib/shoutcast_api.rb
 - README.rdoc
 - Manifest
@@ -53,6 +57,7 @@ files:
 - test/fixtures/search_death.plain
 - test/fixtures/empty.plain
 - test/test_basic.rb
+- test/test_delegator.rb
 - shoutcast_api.gemspec
 has_rdoc: true
 homepage: http://github.com/splattael/shoutcast_api
@@ -89,3 +94,4 @@ test_files:
 - test/test_xml.rb
 - test/test_fetcher.rb
 - test/test_basic.rb
+- test/test_delegator.rb