shoutout 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,4 @@
-# shoutout
+# shoutout [![Build Status](https://travis-ci.org/DouweM/shoutout.png?branch=master)](https://travis-ci.org/DouweM/shoutout)
 
 A Ruby library for easily getting metadata from Shoutcast-compatible audio streaming servers.
 
@@ -19,60 +19,68 @@ gem "shoutout"
 ```ruby
 require "shoutout"
 
-shoutout = Shoutout.new("http://82.201.100.5:8000/radio538")
+# You can open a connection to the stream that will live for the duration of the block using `.open`:
+Shoutout::Stream.open("http://82.201.100.5:8000/radio538") do |stream|
+  # Use `stream` as described below.
+end
+
+# If you want a little more control over opening and closing the connection, just use `.new`: 
+stream = Shoutout::Stream.new("http://82.201.100.5:8000/radio538")
 
-# Explicitly open a connection with the server. You're responsible for closing this connection using `#disconnect`.
-shoutout.connect
+# You can then explicitly open a connection to the stream. 
+# You're responsible for closing it using `#disconnect` when you're done.
+stream.connect
 
-# If you call any of the reader methods below without having explicitly opened a connection, 
-# one will be opened and closed around reading the information implicitly.
+# If you call any of the reader methods below without having opened a connection using `#connect` 
+# or `.open`, one will be opened and closed around reading the information implicitly.
 # This is convenient if you're only looking for one piece of information, but it is of course 
 # very inefficient if you're going to do multiple reads.
 
 # Stream info
-shoutout.name         # => "RADIO538" 
-shoutout.description  # => "ARE YOU IN"
-shoutout.genre        # => "Various"
-shoutout.notice       # => nil in this case, but this could very well have a value for your stream
-shoutout.content_type # => "audio/mpeg"
-shoutout.bitrate      # => 128
-shoutout.public?      # => true
-shoutout.audio_info   # => { :samplerate => 44100, :bitrate => 128, :channels => 2 }
+stream.name         # => "RADIO538" 
+stream.description  # => "ARE YOU IN"
+stream.genre        # => "Various"
+stream.notice       # => nil in this case, but this could very well have a value for your stream
+stream.content_type # => "audio/mpeg"
+stream.bitrate      # => 128
+stream.public?      # => true
+stream.audio_info   # => { :samplerate => 44100, :bitrate => 128, :channels => 2 }
 
 # Current metadata
-shoutout.metadata # => { "StreamTitle" => "ARMIN VAN BUUREN - THIS IS WHAT IT FEELS LIKE", "StreamUrl" => "http://www.radio538.nl" }
+stream.metadata # => { "StreamTitle" => "Armin van Buuren - This Is What It Feels Like", "StreamUrl" => "http://www.radio538.nl" }
 
 # The Metadata object is a Hash that has been extended with the following features:
-shoutout.metadata[:stream_title]  # => "ARMIN VAN BUUREN - THIS IS WHAT IT FEELS LIKE"
-shoutout.metadata[:stream_url]    # => "http://www.radio538.nl"
-shoutout.metadata.now_playing     # => "ARMIN VAN BUUREN - THIS IS WHAT IT FEELS LIKE"
-shoutout.metadata.website         # => "http://www.radio538.nl"
-shoutout.metadata.artist          # => "ARMIN VAN BUUREN"
-shoutout.metadata.song            # => "THIS IS WHAT IT FEELS LIKE"
+stream.metadata[:stream_title]  # => "Armin van Buuren - This Is What It Feels Like"
+stream.metadata[:stream_url]    # => "http://www.radio538.nl"
+stream.metadata.now_playing     # => "Armin van Buuren - This Is What It Feels Like"
+stream.metadata.website         # => "http://www.radio538.nl"
+stream.metadata.artist          # => "Armin van Buuren"
+stream.metadata.song            # => "This Is What It Feels Like"
 
-# Conveniently, `#now_playing` and `#website` are also available on the Shoutout instance:
-shoutout.now_playing  # => "ARMIN VAN BUUREN - THIS IS WHAT IT FEELS LIKE"
-shoutout.website      # => "http://www.radio538.nl"
+# Conveniently, `#now_playing` and `#website` are also available on the stream object:
+stream.now_playing  # => "Armin van Buuren - This Is What It Feels Like"
+stream.website      # => "http://www.radio538.nl"
 
 # For convenience, all of the reader methods above are also available as class methods:
-Shoutout.now_playing("http://82.201.100.5:8000/radio538") # => "ARMIN VAN BUUREN - THIS IS WHAT IT FEELS LIKE"
-# Just like the equivalent `Shoutout.new("http://82.201.100.5:8000/radio538").now_playing`,
+Shoutout::Stream.now_playing("http://82.201.100.5:8000/radio538") # => "Armin van Buuren - This Is What It Feels Like"
+# Just like the equivalent `Shoutout::Stream.new("http://82.201.100.5:8000/radio538").now_playing`,
 # this will automatically open and close a connection around reading the information.
 
-# You can have a block called every time the metadata changes:
-shoutout.metadata_change do |metadata|
+# You can be notified every time the metadata changes:
+stream.metadata_change do |metadata|
   puts "Now playing: #{metadata.song} by #{metadata.artist}"
+  # => Now playing: This Is What It Feels Like by Armin van Buuren
 end
 # Of course, this only works with an explicitly opened connection.
 
 # If you're done setting up but want the program to keep listening for metadata, say so:
-shoutout.listen
+stream.listen
 # Note that listening will only end when the connection is lost or the end of file is reached, 
 # so anything that comes after this call will only then be executed. 
 # This will generally be the last call in your program.
 
 # If we don't want to wait around and listen, just let the program exit or disconnect explicitly:
-shoutout.disconnect
+stream.disconnect
 ```
 
 ## Examples

data/lib/shoutout.rb

@@ -6,173 +6,4 @@ require "shoutout/util"
 require "shoutout/metadata"
 require "shoutout/headers"
 require "shoutout/quick_access"
-
-class Shoutout
-  include QuickAccess
-
-  attr_reader :url
-
-  class << self
-    def open(url)
-      shoutcast = new(url)
-
-      begin
-        shoutcast.connect
-        yield shoutcast
-      ensure
-        shoutcast.disconnect
-      end
-    end
-
-    def metadata(url)
-      new(url).metadata
-    end
-  end
-
-  def initialize(url)
-    @url = url
-  end
-
-  def connected?
-    @connected
-  end
-
-  def connect
-    return false if @connected
-
-    uri = URI.parse(@url)
-    @socket = TCPSocket.new(uri.host, uri.port)
-    @socket.puts "GET #{uri.path} HTTP/1.0"
-    @socket.puts "Icy-MetaData: 1"
-    @socket.puts
-
-    # Read status line
-    status_line = @socket.gets
-    status_code = status_line.match(/\AHTTP\/([0-9]\.[0-9]) ([0-9]{3})/)[2].to_i
-
-    @connected = true
-
-    read_headers
-
-    if status_code >= 300 && status_code < 400 && headers[:location]
-      disconnect
-
-      @url = URI.join(uri, headers[:location]).to_s
-
-      return connect
-    end
-
-    unless status_code >= 200 && status_code < 300
-      disconnect
-
-      return false
-    end
-
-    unless metadata_interval
-      disconnect
-
-      return false
-    end
-
-    @read_metadata_thread = Thread.new(&method(:read_metadata))
-
-    true
-  end
-
-  def disconnect
-    return false unless @connected
-
-    @connected = false
-
-    @socket.close if @socket && !@socket.closed?
-    @socket = nil
-
-    true
-  end
-
-  def listen
-    return unless @connected
-
-    @read_metadata_thread.join
-    @last_metadata_change_thread.join if @last_metadata_change_thread
-  end
-
-  def metadata
-    return @metadata if defined?(@metadata)
-
-    original_metadata_change_block = @metadata_change_block
-
-    received = false
-    metadata_change do |new_metadata|
-      received = true
-    end
-
-    already_connected = @connected
-    connect unless already_connected
-
-    sleep 0.015 until received
-
-    disconnect unless already_connected
-
-    metadata_change(&original_metadata_change_block) if original_metadata_change_block
-
-    @metadata
-  end
-
-  def metadata_change(&block)
-    @metadata_change_block = block
-
-    report_metadata_change(@metadata) if defined?(@metadata)
-
-    true
-  end
-
-  private
-    def read_headers
-      raw_headers = ""
-      while line = @socket.gets
-        break if line.chomp == ""
-        raw_headers << line
-      end
-      @headers = Headers.parse(raw_headers)
-    end
-
-    def read_metadata
-      while @connected
-        # Skip audio data
-        data = @socket.read(metadata_interval) || raise(EOFError)
-
-        data = @socket.read(1) || raise(EOFError)
-        metadata_length = data.unpack("c")[0] * 16
-        next if metadata_length == 0
-
-        data = @socket.read(metadata_length) || raise(EOFError)
-        raw_metadata = data.unpack("A*")[0]
-        @metadata = Metadata.parse(raw_metadata)
-
-        report_metadata_change(@metadata)
-      end
-    rescue Errno::EBADF, IOError => e
-      # Connection lost
-      disconnect
-    end
-
-    def report_metadata_change(metadata)
-      @last_metadata_change_thread = Thread.new(metadata, @last_metadata_change_thread) do |metadata, last_metadata_change_thread|
-        last_metadata_change_thread.join if last_metadata_change_thread
-
-        @metadata_change_block.call(metadata) if @metadata_change_block
-      end
-    end
-
-    def headers
-      return @headers if defined?(@headers)
-
-      # Connected but no headers? I give up.
-      return [] if @connected
-
-      connect && disconnect
-
-      @headers
-    end
-end
+require "shoutout/stream"

data/lib/shoutout/headers.rb

@@ -1,4 +1,4 @@
-class Shoutout
+module Shoutout
   class Headers < Hash
     def self.parse(raw_headers)
       headers = {}

data/lib/shoutout/metadata.rb

@@ -1,4 +1,4 @@
-class Shoutout
+module Shoutout
   class Metadata < Hash
     def self.parse(raw_metadata)
       metadata = {}
@@ -51,12 +51,17 @@ class Shoutout
       end
 
       def artist
-        now_playing.split(" - ")[0]
+        artist_and_song[0]
       end
 
       def song
-        now_playing.split(" - ")[1]
+        artist_and_song[1]
       end
+
+      private
+        def artist_and_song
+          @artist_and_song ||= now_playing.split(" - ", 2)
+        end
     end
 
     include QuickAccess

data/lib/shoutout/quick_access.rb

@@ -1,4 +1,4 @@
-class Shoutout
+module Shoutout
   module QuickAccess
     def self.included(base)
       base.extend(ClassMethods)

data/lib/shoutout/stream.rb

@@ -0,0 +1,171 @@
+module Shoutout
+  class Stream
+    include QuickAccess
+
+    attr_reader :url
+
+    class << self
+      def open(url)
+        stream = new(url)
+
+        begin
+          stream.connect
+          yield stream
+        ensure
+          stream.disconnect
+        end
+      end
+
+      def metadata(url)
+        new(url).metadata
+      end
+    end
+
+    def initialize(url)
+      @url = url
+    end
+
+    def connected?
+      @connected
+    end
+
+    def connect
+      return false if @connected
+
+      uri = URI.parse(@url)
+      @socket = TCPSocket.new(uri.host, uri.port)
+      @socket.puts "GET #{uri.path} HTTP/1.0"
+      @socket.puts "Icy-MetaData: 1"
+      @socket.puts
+
+      # Read status line
+      status_line = @socket.gets
+      status_code = status_line.match(/\AHTTP\/([0-9]\.[0-9]) ([0-9]{3})/)[2].to_i
+
+      @connected = true
+
+      read_headers
+
+      if status_code >= 300 && status_code < 400 && headers[:location]
+        disconnect
+
+        @url = URI.join(uri, headers[:location]).to_s
+
+        return connect
+      end
+
+      unless status_code >= 200 && status_code < 300
+        disconnect
+
+        return false
+      end
+
+      unless metadata_interval
+        disconnect
+
+        return false
+      end
+
+      @read_metadata_thread = Thread.new(&method(:read_metadata))
+
+      true
+    end
+
+    def disconnect
+      return false unless @connected
+
+      @connected = false
+
+      @socket.close if @socket && !@socket.closed?
+      @socket = nil
+
+      true
+    end
+
+    def listen
+      return unless @connected
+
+      @read_metadata_thread.join
+      @last_metadata_change_thread.join if @last_metadata_change_thread
+    end
+
+    def metadata
+      return @metadata if defined?(@metadata)
+
+      original_metadata_change_block = @metadata_change_block
+
+      received = false
+      metadata_change do |new_metadata|
+        received = true
+      end
+
+      already_connected = @connected
+      connect unless already_connected
+
+      sleep 0.015 until received
+
+      disconnect unless already_connected
+
+      metadata_change(&original_metadata_change_block) if original_metadata_change_block
+
+      @metadata
+    end
+
+    def metadata_change(&block)
+      @metadata_change_block = block
+
+      report_metadata_change(@metadata) if defined?(@metadata)
+
+      true
+    end
+
+    private
+      def read_headers
+        raw_headers = ""
+        while line = @socket.gets
+          break if line.chomp == ""
+          raw_headers << line
+        end
+        @headers = Headers.parse(raw_headers)
+      end
+
+      def read_metadata
+        while @connected
+          # Skip audio data
+          data = @socket.read(metadata_interval) || raise(EOFError)
+
+          data = @socket.read(1) || raise(EOFError)
+          metadata_length = data.unpack("c")[0] * 16
+          next if metadata_length == 0
+
+          data = @socket.read(metadata_length) || raise(EOFError)
+          raw_metadata = data.unpack("A*")[0]
+          @metadata = Metadata.parse(raw_metadata)
+
+          report_metadata_change(@metadata)
+        end
+      rescue Errno::EBADF, IOError => e
+        # Connection lost
+        disconnect
+      end
+
+      def report_metadata_change(metadata)
+        @last_metadata_change_thread = Thread.new(metadata, @last_metadata_change_thread) do |metadata, last_metadata_change_thread|
+          last_metadata_change_thread.join if last_metadata_change_thread
+
+          @metadata_change_block.call(metadata) if @metadata_change_block
+        end
+      end
+
+      def headers
+        return @headers if defined?(@headers)
+
+        # Connected but no headers? I give up.
+        return [] if @connected
+
+        connect && disconnect
+
+        @headers
+      end
+  end
+end

data/lib/shoutout/util.rb

@@ -1,4 +1,4 @@
-class Shoutout
+module Shoutout
   module Util
     def self.camelize(term)
       term = term.sub(/^[a-z\d]*/) { $&.capitalize }

data/lib/shoutout/version.rb

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

data/spec/shoutout/quick_access_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Shoutout::QuickAccess do
 
   let(:url) { "http://82.201.100.5:8000/radio538" }
-  subject   { Shoutout.new(url) }
+  subject   { Shoutout::Stream.new(url) }
 
   describe "#audio_info" do
 
@@ -28,15 +28,15 @@ describe Shoutout::QuickAccess do
   describe ".name" do
 
     it "creates a new instance" do
-      Shoutout.should_receive(:new).with(url).and_return(double("shoutout").as_null_object)
+      Shoutout::Stream.should_receive(:new).with(url).and_return(double("stream").as_null_object)
 
-      Shoutout.name(url)
+      Shoutout::Stream.name(url)
     end
 
     it "calls #name on the opened connection" do
-      Shoutout.any_instance.should_receive(:name)
+      Shoutout::Stream.any_instance.should_receive(:name)
 
-      Shoutout.name(url)
+      Shoutout::Stream.name(url)
     end
   end
 end

data/spec/{shoutout_spec.rb → shoutout/stream_spec.rb}

@@ -1,11 +1,10 @@
 require "spec_helper"
 
-describe Shoutout do
-
+describe Shoutout::Stream do
   let(:url)           { "http://82.201.100.5:8000/radio538" }
   let(:uri)           { URI.parse(url) }
   subject!            { described_class.new(url) }
-  let(:response_data) { File.read(File.expand_path("../fixtures/ok_response", __FILE__)) }
+  let(:response_data) { File.read(File.expand_path("../../fixtures/ok_response", __FILE__)) }
   let(:socket)        { FakeTCPSocket.new(response_data) }
 
   before(:each) do
@@ -105,7 +104,7 @@ describe Shoutout do
 
       context "when the response indicates a redirect" do
 
-        let(:redirect_response_data)  { File.read(File.expand_path("../fixtures/redirect_response", __FILE__)) }
+        let(:redirect_response_data)  { File.read(File.expand_path("../../fixtures/redirect_response", __FILE__)) }
         let(:redirect_socket)         { FakeTCPSocket.new(redirect_response_data) }
 
         before(:each) do
@@ -138,7 +137,7 @@ describe Shoutout do
 
       context "when the response indicates an error" do
 
-        let(:response_data) { File.read(File.expand_path("../fixtures/error_response", __FILE__)) }
+        let(:response_data) { File.read(File.expand_path("../../fixtures/error_response", __FILE__)) }
 
         it "closes the connection" do
           subject.should_receive(:disconnect).twice.and_call_original
@@ -155,7 +154,7 @@ describe Shoutout do
 
         context "when the response is unsupported" do
 
-          let(:response_data) { File.read(File.expand_path("../fixtures/unsupported_response", __FILE__)) }
+          let(:response_data) { File.read(File.expand_path("../../fixtures/unsupported_response", __FILE__)) }
 
           it "closes the connection" do
             subject.should_receive(:disconnect).twice.and_call_original

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shoutout
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70299652575840 !ruby/object:Gem::Requirement
+  requirement: &70322661963000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299652575840
+  version_requirements: *70322661963000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70299652591920 !ruby/object:Gem::Requirement
+  requirement: &70322661962580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299652591920
+  version_requirements: *70322661962580
 description: A Ruby library for easily getting metadata from Shoutcast-compatible
   audio streaming servers
 email: douwe@selenight.nl
@@ -43,6 +43,7 @@ files:
 - lib/shoutout/headers.rb
 - lib/shoutout/metadata.rb
 - lib/shoutout/quick_access.rb
+- lib/shoutout/stream.rb
 - lib/shoutout/util.rb
 - lib/shoutout/version.rb
 - lib/shoutout.rb
@@ -57,8 +58,8 @@ files:
 - spec/shoutout/headers_spec.rb
 - spec/shoutout/metadata_spec.rb
 - spec/shoutout/quick_access_spec.rb
+- spec/shoutout/stream_spec.rb
 - spec/shoutout/util_spec.rb
-- spec/shoutout_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_tcp_socket.rb
 homepage: https://github.com/DouweM/shoutout
@@ -76,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 848854510650494207
+      hash: 401984402802077394
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 848854510650494207
+      hash: 401984402802077394
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6
@@ -100,7 +101,7 @@ test_files:
 - spec/shoutout/headers_spec.rb
 - spec/shoutout/metadata_spec.rb
 - spec/shoutout/quick_access_spec.rb
+- spec/shoutout/stream_spec.rb
 - spec/shoutout/util_spec.rb
-- spec/shoutout_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_tcp_socket.rb