podcast 0.0.2

data/README

@@ -0,0 +1,24 @@
+=begin rdoc
+
+Podcast is a simple library and command line utility for creating
+podcast files from a directory of mp3 files. Podcast will 
+examine mp3s, extract metadata from ID3 tags, and build an RSS
+file which can then be podcast clients to download the mp3s.
+
+You'll need to install the Ruby mp3info library installed before podcast
+will work. You can grab ruby-mp3info here:
+
+    http://rubyforge.org/projects/ruby-mp3info/
+
+Once you've got podcast installed you should be able to run the podcast
+command line utility by pointing it a directory of mp3s.
+
+    % podcast --dir=/home/john/mp3s --out=podcast.xml
+
+Please email the author with suggestions and questions.
+
+    Ed Summers <ehs@pobox.com>
+
+Happy podcasting.
+
+=end

data/bin/podcast

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+usage = <<-USAGE
+
+usage: podcast --dir=dir [ --base=http://www.example.org/music ]
+    [ --title="My Mp3s" ] [ --out=rss.xml ]
+
+    dir - the directory of mp3s
+    title - the title of the rss feed
+    base - the base URL where the mp3s are available from
+    out - where to write the rss (STDOUT if unspecified)
+
+example:
+
+    # write a podcast for all the files in /var/music/new that are available
+    # via the base url http://www.example.org/podcast to a file rss.xml
+
+    podcast --dir=/var/music/new --base=http://www.example.org/podcast 
+            --title="My New Mp3s" --out=rss.xml
+
+USAGE
+
+require 'ostruct'
+require 'optparse'
+require 'rubygems'
+require_gem 'podcast'
+
+# defaultoptions
+options = OpenStruct.new
+options.dir = ''
+options.help = false
+options.title = 'podcast'
+
+# read options
+opts = OptionParser.new
+opts.on( "-d", "--dir VAL", String )        { |val| options.dir=val }
+opts.on( "-b", "--base VAL", String )       { |val| options.base=val }
+opts.on( "-t", "--title VAL", String )      { |val| options.title=val }
+opts.on( "-o", "--out VAL", String )        { |val| options.output=val }
+opts.on( "-h", "--help" )                   { |val| options.help=val }
+opts.parse(ARGV) 
+
+# output usage 
+if options.dir == '' or options.help
+    puts usage
+    exit 
+end
+
+# create podcast object
+podcast = Podcast.new()
+podcast.base = options.base
+podcast.title = options.title
+
+# add a directory
+podcast.add_dir( options.dir )
+
+# write off the rss
+if options.output 
+    file = File.new( options.output, 'w' )
+    file.write( podcast.get_rss() )
+    file.close
+else 
+    puts podcast.get_rss()
+end
+

data/lib/mp3file.rb

@@ -0,0 +1,28 @@
+require 'mp3info'
+
+# class for representing mp3 files
+class Mp3File
+
+    attr_accessor :artist, :album, :title, :file, :path, :length, :type, :mtime
+
+    def initialize(f)
+        file = File.new(f)
+        info = Mp3Info.open(f)
+        tag = info.tag()
+        @file = f
+        @artist = tag['artist']
+        @album = tag['album']
+        @title = tag['title']
+        @path = file.path()
+        @length = file.stat.size()
+        @mtime = file.stat.mtime()
+        @type = 'audio/mpeg'
+    end
+
+    def to_s
+        "#{@artist} -- #{@album} -- #{@title}"
+    end
+
+end
+
+

data/lib/podcast.rb

@@ -0,0 +1,102 @@
+require 'find'
+require 'rss/0.9'
+require 'Mp3File'
+
+
+#  Podcast is a class that makes it easy to create MP3 RSS enclosures
+#  from the filesystem.
+#
+#  require 'podcast'
+#  p = Podcast.new
+#  p.title = 'test podcast'
+#  p.description = 'test podcast coming at ya'
+#  p.link = 'http://www.example.org'
+#  p.base = 'http://www.example.org/torrents'
+#  p.add_dir( '/home/john/music' ) 
+#  xml = p.get_rss()
+class Podcast
+
+    attr_reader :title, :link, :description, :image, :base, :language
+    attr_writer :title, :link, :description, :image, :base, :language
+
+    include Enumerable
+
+    def initialize
+        @mp3s = []
+        @language = "English"
+        @base = ''
+    end
+
+    # add an mp3 file to the podcast
+    def add_mp3( file )
+        mp3 = Mp3File.new( file )
+        @mp3s.push( mp3 )
+    end
+
+    # add a directory location to the podcast
+    # the directory will be recursively search
+    # for mp3 files.
+    def add_dir( dir )
+        # we chdir into the directory so that file paths will be relative
+        pwd = Dir.pwd
+        Dir.chdir( dir )
+        Find.find( '.' ) do |f|
+            if ( f =~ /\.mp3$/ )
+                f.sub!( %r{^./}, '' ) # remove leading './'
+                add_mp3(f)
+            end
+        end
+        # go back to original directory
+        Dir.chdir( pwd )
+    end
+
+    # the total amount of files in the podcast
+    def size
+        @mp3s.size
+    end
+
+    # write the podcast file 
+    def get_rss()
+        rss = RSS::Rss.new( "0.9" )
+        channel = RSS::Rss::Channel.new
+        channel.title = @title
+        channel.description = @description 
+        channel.link = @link 
+        channel.language = @language
+        rss.channel = channel
+
+        if ( @image )
+            image = RSS::Rss::Channel::Image.new
+            image.url = @image
+            image.title = @title
+            image.link = @link
+            channel.image = image
+        end
+
+        for mp3 in @mp3s 
+            next if ! mp3.artist
+            item = RSS::Rss::Channel::Item.new
+            item.title = mp3
+            ## add a base url 
+            if base != ''
+                link = base + '/' + mp3.path
+            else 
+                link = mp3.path
+            end
+            item.link = link
+            item.enclosure = RSS::Rss::Channel::Item::Enclosure.new( 
+                link, mp3.length, mp3.type )
+            channel.items << item
+        end
+
+        return rss.to_s
+    end
+
+    def each
+        @songs.each do |s|
+            yield s
+        end
+    end
+
+end
+

data/test/test_podcast.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+$:.push( '../lib' )
+require 'test/unit'
+require 'podcast'
+
+class PodcastTest < Test::Unit::TestCase
+
+    def test_constructor
+        p = Podcast.new
+        assert( p.class == Podcast )
+    end
+
+    def test_add_mp3
+        p = Podcast.new
+        p.add_mp3( 'test.mp3' )
+        p.add_mp3( 'test.mp3' )
+        p.add_mp3( 'test.mp3' )
+        assert_equal( p.size(), 3 )
+    end
+
+    def test_add_dir
+        p = Podcast.new
+        p.add_dir( '.' )
+        assert_equal( p.size(), 1 )
+    end
+
+    def test_get_rss
+        p = Podcast.new
+        p.title = 'test podcast'
+        p.description = 'test podcast coming at ya'
+        p.link = 'http://www.example.org'
+        p.image = 'http://www.example.org/icon.png'
+        p.base = 'http://www.example.org/torrents'
+        ## add using directory so we can confirm it is stripped
+        p.add_dir( '../test' ) 
+        xml = p.get_rss()
+
+        # parse the rss
+        parser = RSS::Parser.new( '0.9' )
+        rss = RSS::Parser.parse( xml )
+        items = rss.items()
+        assert( items.size == 1 )
+        assert_equal( items[0].link, 'http://www.example.org/torrents/test.mp3')
+    end
+
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.1
+specification_version: 1
+name: podcast
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+date: 2004-11-28
+summary: Create podcasts from MP3 files
+require_paths: 
+  - lib
+author: Ed Summers
+email: ehs@pobox.com
+homepage: http://www.inkdroid.org
+rubyforge_project: 
+description: 
+autorequire: podcast
+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: 
+platform: ruby
+files: 
+  - bin/podcast
+  - lib/mp3file.rb
+  - lib/podcast.rb
+  - test/test.mp3
+  - test/test_podcast.rb
+  - README
+test_files: 
+  - test/test_podcast.rb
+rdoc_options: []
+extra_rdoc_files: 
+  - README
+executables: 
+  - podcast
+extensions: []
+requirements: []
+dependencies: []