ruby-shout 2.1 → 2.2.0.pre2

data/README.textile

@@ -0,0 +1,84 @@
+h1. Ruby-Shout
+
+h2. Purpose
+
+ruby-shout lets you send compressed audio over the network to an "Icecast":http://www.icecast.org/ streaming media server.
+
+h2. Requirements
+
+libshout 2.0, available from "icecast.org":http://www.icecast.org/download.php. libshout 2 requires the ogg and vorbis libraries.
+
+h2. Summary of usage
+
+This extension follows python-shout fairly closely. You make a Shout object with Shout.new, set its properties, tell it to connect, then send blocks of data, sync and repeat. Disconnect when done.
+
+h2. Usage
+
+See example.rb. Run it like
+
+  ./example.rb test/test.mp3
+
+h2. Todo
+
+* proper unit tests (blush)
+
+h2. History & Credits
+
+* 2001 Jared Jenning built the initial version for libshout 1
+* 2003 Jared Jenning rebuilt ruby-shout for libshout 2 and maintained it to until 2005
+* Yauhen Kharuzhy helped with bugfixes and initial metadata support
+* 2010 "Overlay" (real name unknown to me) patched ruby-shout for ruby 1.9 support, Diego Elio "Flameeyes" Pettenò "incorporated patch into the gentoo package":http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/dev-ruby/ruby-shout/files/ruby-shout-2.1%2Bruby-1.9.patch?revision=1.1&view=markup. It got removed later on due to "some issues":http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/dev-ruby/ruby-shout/files/ruby-shout-2.1%2Bruby-1.9.patch?view=markup.
+* 2010 Niko Dittman re-added the patch and fixed the issues. See "Recent Changes" for details.
+
+h2. Recent Changes
+
+* Included the "ruby 1.9 patch":http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/dev-ruby/ruby-shout/files/ruby-shout-2.1%2Bruby-1.9.patch?revision=1.1&view=markup although it seems to have "some issues":http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/dev-ruby/ruby-shout/files/ruby-shout-2.1%2Bruby-1.9.patch?view=log. I hope to have fixed the issues with this:
+* Replaced STR2CSTR for StringValuePtr as STR2CSTR doesn't work for 1.9 any more
+* Added format = Shout::MP3 to the example as this is absolutely needed by the latest versions of libshout.
+* Added an integration test which builds and installs the gem and plays some sound on a local icecast server. I mainly did that because the old version of ruby-shout didn't even compile for ruby 1.9. Run with:
+
+  rake test:integration
+
+h2. State
+
+I tested this version of ruby-shout to build and run on
+
+* ruby-1.8.7-p174 [x86_64] OSX 10.6
+* ruby-1.9.1-p378 [x86_64] OSX 10.6
+* ruby-1.9.2-rc1  [x86_64] OSX 10.6
+* ruby-1.9.2-p0   [x86_64] OSX 10.6
+* ruby-1.8.7-p299 [i386]   ubuntu 2.6.32
+* ruby-1.9.2-rc2  [i386]   ubuntu 2.6.32
+
+h2. License
+This is a BSD license.
+
+Copyright (c) 2003-2005, Jared Jennings
+Copyright (c) 2010, Niko Dittmann
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the names of the authors nor the names of contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+task :default => [:test]
+
+namespace :test do
+  desc "run the build integration test"
+  task :integration do
+    ruby "test/integration-test.rb"
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = "ruby-shout"
+    s.summary     = "Send audio over the network to an Icecast server"
+    s.description = %q{Ruby bindings for libshout 2, a "Library which can be used to write a source client like ices" for Icecast (http://www.icecast.org/download.php).}
+    s.email       = "mail@niko-dittmann.com"
+    s.homepage    = "http://github.com/niko/ruby-shout"
+    s.authors     = ["Jared Jennings", "Niko Dittmann"]
+    s.require_paths = ["lib"]
+    s.rubyforge_project = 'ruby-shout'
+    s.files       = FileList["[A-Z]*", "{ext}/*"]
+    
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+2.2.0.pre2

data/ext/shout.c

@@ -5,6 +5,7 @@
    redone for libshout2 18 jul 2003
 
    Copyright (c) 2003-2005, Jared Jennings
+   Copyright (c) 2010 Niko Dittmann
    All rights reserved.
 
    Redistribution and use in source and binary forms, with or without
@@ -17,7 +18,7 @@
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
 
-    * Neither the name of Jared Jennings nor the names of contributors may
+    * Neither the names of the authors nor the names of contributors may
       be used to endorse or promote products derived from this software without
       specific prior written permission.
 
@@ -40,6 +41,11 @@
 
 #define DEFAULT_MOUNTPOINT "/default"
 
+#ifndef RSTRING_LEN
+#define RSTRING_LEN(str)	RSTRING(str)->len
+#define RSTRING_PTR(str)	RSTRING(str)->ptr
+#endif
+
 /*
 ----------------- ShoutError --------------------
  */
@@ -108,7 +114,7 @@ static VALUE _sh_metadata_add(VALUE self, VALUE name, VALUE value) {
         int err;
 
         Data_Get_Struct(self, shout_metadata_t, m);
-        err = shout_metadata_add(m, STR2CSTR(name), STR2CSTR(value));
+        err = shout_metadata_add(m, StringValuePtr(name), StringValuePtr(value));
 
         if(err != SHOUTERR_SUCCESS) {
 		raise_nonspecific_shout_error(err);
@@ -233,8 +239,8 @@ static VALUE _sh_send(VALUE self, VALUE to_send) {
         GET_SC(self, s);
 
         Check_SafeStr(to_send);
-        err = shout_send(s->conn, (unsigned char *) (RSTRING(to_send)->ptr),
-                                  RSTRING(to_send)->len);
+        err = shout_send(s->conn, (unsigned char *) (RSTRING_PTR(to_send)),
+                                  RSTRING_LEN(to_send));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -409,7 +415,7 @@ VALUE _sh_host_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_host(s->conn, RSTRING(value)->ptr);
+        err = shout_set_host(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -435,7 +441,7 @@ VALUE _sh_user_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_user(s->conn, RSTRING(value)->ptr);
+        err = shout_set_user(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -448,7 +454,7 @@ VALUE _sh_pass_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_password(s->conn, RSTRING(value)->ptr);
+        err = shout_set_password(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -495,7 +501,7 @@ VALUE _sh_mount_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_mount(s->conn, RSTRING(value)->ptr);
+        err = shout_set_mount(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -509,7 +515,7 @@ VALUE _sh_dumpfile_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_dumpfile(s->conn, RSTRING(value)->ptr);
+        err = shout_set_dumpfile(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -523,7 +529,7 @@ VALUE _sh_agent_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_agent(s->conn, RSTRING(value)->ptr);
+        err = shout_set_agent(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -554,7 +560,7 @@ VALUE _sh_name_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_name(s->conn, RSTRING(value)->ptr);
+        err = shout_set_name(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -567,7 +573,7 @@ VALUE _sh_url_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_url(s->conn, RSTRING(value)->ptr);
+        err = shout_set_url(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -580,7 +586,7 @@ VALUE _sh_genre_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_genre(s->conn, RSTRING(value)->ptr);
+        err = shout_set_genre(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }
@@ -593,7 +599,7 @@ VALUE _sh_description_eq(VALUE self, VALUE value) {
         shout_connection *s; GET_SC(self, s);
 
         Check_Type(value, T_STRING);
-        err = shout_set_description(s->conn, RSTRING(value)->ptr);
+        err = shout_set_description(s->conn, RSTRING_PTR(value));
         if(err != SHOUTERR_SUCCESS) {
                 raise_shout_error(s->conn);
         }

data/test/integration-test.rb

@@ -0,0 +1,90 @@
+# This test builds the gem (there where build errors on 1.9 without the patch),
+# installs it and starts a station on mountpoint /test.
+# You should have an icecast-server listening on 8000 (that's the default)
+# for incoming source connections.
+# Point your radio client to http://localhost:8000/test.
+# Look for the metadata being correctly set ('gromozek - melange').
+
+# test.mp3 is 'melange' by 'gromozek' http://ccmixter.org/files/gromozek/20114
+# licensed CC Attribution Noncommercial (3.0) http://creativecommons.org/licenses/by-nc/3.0/
+
+def base_dir
+  File.expand_path File.join(File.dirname(__FILE__), '..')
+end
+
+def version
+  File.open(File.join(base_dir, 'VERSION')).readline.strip
+end
+
+def remove_pkg
+  puts '=> removing pkg/'
+  command = %Q{
+    cd #{base_dir}
+    rm -rf pkg
+  }
+  `#{command}`
+end
+
+def clean_test_gem
+  puts '=> removing test/test_gem_installation/'
+  command = %Q{
+    cd #{base_dir}
+    rm -rf test/test_gem_installation
+  }
+  `#{command}`
+end
+
+def install_gem
+  puts '=> building the gem into pkg/ and installing into test/test_gem_installation/'
+  command = %Q{
+    cd #{base_dir}
+    rake build
+    gem install --no-test --no-rdoc --no-ri --install-dir test/test_gem_installation --bindir test/test_gem_installation pkg/ruby-shout-#{version}.gem
+  }
+  `#{command}`
+end
+
+clean_test_gem
+install_gem
+remove_pkg
+
+$LOAD_PATH.clear
+$LOAD_PATH << File.join(base_dir, "test/test_gem_installation/gems/ruby-shout-#{version}/lib")
+require 'shout'
+
+def test_all
+  blocksize = 16384
+
+  s = Shout.new
+  s.host = "localhost"
+  s.port = 8000
+  s.mount = "/test"
+  s.user = "source"
+  s.pass = "hackme"
+  s.format = Shout::MP3
+
+  s.connect
+
+  filename = File.join(File.dirname(__FILE__), 'test.mp3')
+
+  File.open(filename) do |file|
+    puts "=> sending data from #{filename}...\n     go check http://localhost:8000/test"
+    m = ShoutMetadata.new
+    m.add 'filename', filename
+    m.add 'artist', 'gromozek'
+    m.add 'title', 'melange'
+    s.metadata = m
+
+    while data = file.read(blocksize)
+      s.send data
+      print '.'
+      s.sync
+    end
+  end
+
+  s.disconnect
+ensure
+  clean_test_gem
+end
+
+test_all

metadata

@@ -1,48 +1,73 @@
-!ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
-specification_version: 1
+--- !ruby/object:Gem::Specification 
 name: ruby-shout
 version: !ruby/object:Gem::Version 
-  version: "2.1"
-date: 2005-11-19 00:00:00 -06:00
-summary: Send audio over the network to an Icecast server
-require_paths: 
-- .
-email: jjenning@fastmail.fm
-homepage: http://www.dingoskidneys.com/~jaredj/
-rubyforge_project: 
-description: 
-autorequire: shout
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  prerelease: true
+  segments: 
+  - 2
+  - 2
+  - 0
+  - pre2
+  version: 2.2.0.pre2
 platform: ruby
-signing_key: 
-cert_chain: 
 authors: 
 - Jared Jennings
-files: 
-- ext/shout.c
-- ext/extconf.rb
-- example.rb
-- README
-test_files: []
+- Niko Dittmann
+autorequire: 
+bindir: bin
+cert_chain: []
 
-rdoc_options: []
+date: 2010-09-05 00:00:00 +02:00
+default_executable: 
+dependencies: []
 
-extra_rdoc_files: 
-- README
+description: Ruby bindings for libshout 2, a "Library which can be used to write a source client like ices" for Icecast (http://www.icecast.org/download.php).
+email: mail@niko-dittmann.com
 executables: []
 
 extensions: 
 - ext/extconf.rb
-requirements: []
+extra_rdoc_files: 
+- README.textile
+files: 
+- README.textile
+- Rakefile
+- VERSION
+- ext/extconf.rb
+- ext/shout.c
+- test/integration-test.rb
+has_rdoc: true
+homepage: http://github.com/niko/ruby-shout
+licenses: []
 
-dependencies: []
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
 
+rubyforge_project: ruby-shout
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Send audio over the network to an Icecast server
+test_files: 
+- test/integration-test.rb

data/README

@@ -1,52 +0,0 @@
-= Purpose
-
-ruby-shout lets you send compressed audio over the network to an Icecast
-streaming media server.
-
-= Requirements
-
-libshout 2.0, available from icecast.org. libshout 2 requires the ogg
-and vorbis libraries.
-
-= Summary of usage
-
-This extension follows python-shout fairly closely. You make a Shout
-object with Shout.new, set its properties, tell it to connect, then
-send blocks of data, sync and repeat. Disconnect when done. There is
-no #open that takes a block, as there is for a File or Socket: maybe later. 
-
-= Contributors
-
-* Yauhen Kharuzhy: bugfixes and initial metadata support
-
-= License
-This is a BSD license.
-
-Copyright (c) 2003-2005, Jared Jennings
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of Jared Jennings nor the names of contributors may
-  be used to endorse or promote products derived from this software without
-  specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

data/example.rb

@@ -1,34 +0,0 @@
-#!/usr/bin/ruby
-
-# Stream all the files given on the commandline to the Icecast server on
-# localhost. 
-
-require 'rubygems'
-require 'shout'
-
-BLOCKSIZE = 16384
-
-s = Shout.new
-s.host = "localhost"
-s.port = 8000
-s.mount = "/example.ogg"
-s.user = "source"
-s.pass = "hackme"
-
-s.connect
-
-ARGV.each do |filename|
-	File.open(filename) do |file|
-		puts "sending data from #{filename}"
-		m = ShoutMetadata.new
-		m.add 'filename', filename
-		s.metadata = m
-
-		while data = file.read(BLOCKSIZE)
-			s.send data
-			s.sync
-		end
-	end
-end
-
-s.disconnect