podcast 0.0.3 → 0.0.4

data/README

@@ -6,19 +6,21 @@ 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:
+will work:
+
+    gem install ruby-mp3info
+
+Or 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.
+Once you've installed ruby-mp3info and podcast you should have a 
+command line utility you can run on a directory of mp3 files:
 
-    % podcast --dir=/home/john/mp3s --out=podcast.xml
+    % podcast --dir=/home/ed/mp3s --out=podcast.rss
 
 Please email the author with suggestions and questions.
 
     Ed Summers <ehs@pobox.com>
 
-Happy podcasting.
-
 =end

data/bin/podcast

@@ -1,65 +1,50 @@
 #!/usr/bin/env ruby
 
-usage = <<-USAGE
+# == Synopsis
+#
+# Generate a podcast file from a directory of mp3 files. All subdirectories
+# below indicated directory will be searched. 
+#
+# == Usage
+# 
+#   podcast --dir my/mp3/dir --out podcast.rss
+#
+# == Author
+# Ed Summers <ehs@pobox.com>
+#
+# == Copyright
+# Copyright (c) 2004 Ed Summers.
+# Licensed under the same terms as Ruby.
 
-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 'rdoc/usage'
 require 'rubygems'
 require_gem 'podcast'
 
-# defaultoptions
-options = OpenStruct.new
-options.dir = ''
-options.help = false
-options.title = 'podcast'
+# the location to look for mp3s
+dir = ''
+
+# the location to write the podcast file
+podcast_file = nil 
 
 # 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
+opts.on( "-d", "--dir VAL", String )        { |val| dir=val }
+opts.on( "-o", "--out VAL", String )        { |val| podcast_file=val }
+opts.parse(ARGV) rescue RDoc::usage( 'usage' )
+RDoc::usage( 'usage' ) if dir == ''
 
 # create podcast object
-podcast = Podcast.new()
-podcast.base = options.base
-podcast.title = options.title
+podcast = Podcast::Feed.new()
 
 # add a directory
-podcast.add_dir( options.dir )
+podcast.add_dir( dir )
 
 # write off the rss
-if options.output 
-    file = File.new( options.output, 'w' )
+if podcast_file  
+    file = File.new( podcast_file, 'w' )
     file.write( podcast.get_rss() )
     file.close
 else 
     puts podcast.get_rss()
 end
-

data/lib/podcast.rb

@@ -1,102 +1,116 @@
 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
+require 'mp3info'
 
-    # add an mp3 file to the podcast
-    def add_mp3( file )
-        mp3 = Mp3File.new( file )
-        @mp3s.push( mp3 )
-    end
+module Podcast 
+
+    class Feed
 
-    # 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)
+        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
-        # go back to original directory
-        Dir.chdir( pwd )
-    end
 
-    # the total amount of files in the podcast
-    def size
-        @mp3s.size
-    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
 
-    # 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
+
+            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
 
-        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
+        def each
+            @songs.each do |s|
+                yield s
             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
+    class Mp3File
+
+        attr_reader :artist, :album, :title, :file, :path, :length, :type, :mtime
+        attr_writer :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
 
 end
-

data/test/{test_podcast.rb → ts_podcast.rb}

@@ -1,47 +1,47 @@
 #!/usr/bin/env ruby
 
-$:.push( 'lib' )
+$LOAD_PATH.unshift('lib')
 require 'test/unit'
 require 'podcast'
 
 class PodcastTest < Test::Unit::TestCase
 
     def test_constructor
-        p = Podcast.new
-        assert( p.class == Podcast )
+        p = Podcast::Feed.new
+        assert(p.class == Podcast::Feed)
     end
 
     def test_add_mp3
-        p = Podcast.new
-        p.add_mp3( 'test/test.mp3' )
-        p.add_mp3( 'test/test.mp3' )
-        p.add_mp3( 'test/test.mp3' )
-        assert_equal( p.size(), 3 )
+        p = Podcast::Feed.new
+        p.add_mp3('test/test.mp3')
+        p.add_mp3('test/test.mp3')
+        p.add_mp3('test/test.mp3')
+        assert_equal(p.size(), 3)
     end
 
     def test_add_dir
-        p = Podcast.new
-        p.add_dir( 'test' )
-        assert_equal( p.size(), 1 )
+        p = Podcast::Feed.new
+        p.add_dir('.')
+        assert_equal(p.size(), 1)
     end
 
     def test_get_rss
-        p = Podcast.new
+        p = Podcast::Feed.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' ) 
+        p.add_dir('test') 
         xml = p.get_rss()
 
         # parse the rss
-        parser = RSS::Parser.new( '0.9' )
-        rss = RSS::Parser.parse( xml )
+        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')
+        assert(items.size == 1)
+        assert_equal(items[0].link, 'http://www.example.org/torrents/test.mp3')
     end
 
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.1
+rubygems_version: 0.8.11
 specification_version: 1
 name: podcast
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2004-12-02
+  version: 0.0.4
+date: 2005-11-21 00:00:00 -06:00
 summary: Create podcasts from MP3 files
 require_paths: 
   - lib
-author: Ed Summers
 email: ehs@pobox.com
 homepage: http://www.inkdroid.org
 rubyforge_project: 
@@ -25,15 +24,18 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - Ed Summers
 files: 
   - bin/podcast
-  - lib/mp3file.rb
   - lib/podcast.rb
   - test/test.mp3
-  - test/test_podcast.rb
+  - test/ts_podcast.rb
   - README
 test_files: 
-  - test/test_podcast.rb
+  - test/ts_podcast.rb
 rdoc_options: []
 extra_rdoc_files: 
   - README

data/lib/mp3file.rb

@@ -1,28 +0,0 @@
-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
-
-