shoutcast_status 0.1.0

data/lib/shoutcast_status.rb

@@ -0,0 +1,73 @@
+require "open-uri"
+require "johnson"
+
+class ShoutcastStatus
+  DEFAULT_INFO_URL = "http://%s/cast/js.php/%s/streaminfo"
+
+  DUMMY_CALLBACK = <<-END
+    function cc_streaminfo_get_callback(details){
+      return details;
+    }
+  END
+
+  # Create a ShoutcastStatus instance for a given station.
+  # If one parameter is given, it is taken as the url to the now playing JSONP
+  # callback. If two parameters are given, they are interpreted as the station
+  # host and station name; the information URL will be inferred from this.
+  #
+  def initialize(url_or_host, station=nil)
+    if station
+      @info_url = DEFAULT_INFO_URL % [url_or_host, station]
+    else
+      @info_url = url_or_host
+    end
+  end
+
+  # Return a StreamInfo object containing the current state of the stream.
+  #
+  def stream_info
+    open @info_url do |f|
+      js = f.read
+      return StreamInfo.new(Johnson.evaluate(DUMMY_CALLBACK + js))
+    end
+  end
+
+  class StreamInfo
+    def initialize(object)
+      @object = object
+    end
+
+    def artist
+      artist_and_title.first
+    end
+
+    def title
+      artist_and_title.last
+    end
+
+    def listeners
+      @object["listeners"]
+    end
+
+    def max_listeners
+      @object["maxlisteners"]
+    end
+
+    def station
+      @object["title"]
+    end
+
+    def bitrate
+      @object["bitrate"]
+    end
+
+    def url
+      @object["url"]
+    end
+
+  private
+    def artist_and_title
+      @object["song"].split(/ - /, 2)
+    end
+  end
+end

data/test/shoutcast_status_test.rb

@@ -0,0 +1,46 @@
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "test/unit"
+require "mocha"
+require "stringio"
+require "shoutcast_status"
+
+class ShoutcastStatusTest < Test::Unit::TestCase
+
+  def test_should_make_url_from_host_and_station_name
+    io = StringIO.new("cc_streaminfo_get_callback({});")
+    sc = ShoutcastStatus.new("example.com", "punkrock")
+    sc.expects(:open).
+       with("http://example.com/cast/js.php/punkrock/streaminfo").
+       yields(io)
+    sc.stream_info
+  end
+
+  def test_should_use_url_as_supplied
+    io = StringIO.new("cc_streaminfo_get_callback({});")
+    sc = ShoutcastStatus.new("http://example.com/some/path")
+    sc.expects(:open).
+       with("http://example.com/some/path").
+       yields(io)
+    sc.stream_info
+  end
+
+  def test_should_extract_details_from_sample
+    sample = <<'END'
+var arr952a05ca = { 'title': 'Radio Punk','song': 'Sex Pistols - Anarchy in the UK','bitrate': 128,'server': 'Online','source': 'Online','offline': '','summary': '\x3Ca href=\"http://example.com/cast/tunein.php/punkrock/tunein.pls\"\x3ERadio Punk - Sex Pistols - Anarchy in the UK\x3C/a\x3E','url': 'http://example.com/cast/js.php/punkrock/streaminfo','listeners': 2,'maxlisteners': 25,'reseller': 0 };
+
+  cc_streaminfo_get_callback(arr952a05ca);
+END
+
+    io = StringIO.new(sample)
+    sc = ShoutcastStatus.new("example.com", "punkrock")
+    sc.stubs(:open).yields(io)
+    info = sc.stream_info
+
+    assert_equal "Radio Punk",        info.station
+    assert_equal "Sex Pistols",       info.artist
+    assert_equal "Anarchy in the UK", info.title
+    assert_equal 128,                 info.bitrate
+    assert_equal 2,                   info.listeners
+    assert_equal 25,                  info.max_listeners
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: shoutcast_status
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Paul Battley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: johnson
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: pbattley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/shoutcast_status.rb
+- test/shoutcast_status_test.rb
+has_rdoc: true
+homepage: http://github.com/threedaymonk/shoutcast_status
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Get station info from a Shoutcast server
+test_files: []
+