rubypodder 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Lex Miller
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,69 @@
+= rubypodder - A podcast aggregator without an interface
+
+This package contains rubypodder, a simple podcast receiver
+inspired by bashpodder (http://linc.homeunix.org:8080/scripts/bashpodder/).
+
+== Download
+
+The latest version of rubypodder can be found at
+
+   http://rubyforge.org/projects/rubypodder/
+
+== Installation
+
+Place the rubypodder gem in your local repository and install with
+the following:
+
+   gem install rubypodder
+
+== Quick Start
+
+Type
+
+   rubypodder
+
+When it finishes, you should see a ~/.rubypodder directory.
+This should contain an example rp.conf configuration file with a feed in
+it to get you started. If there were any podcasts to download in the feed
+they will be in a directory named after the date (e.g. 2007-01-20).
+You can see what happened by looking in rp.log.
+
+== Running the rubypodder Test Suite
+
+If you wish to run the unit tests that come with rubypodder:
+
+   gem check rubypodder --test
+
+A message will be given if any of the tests fail.
+
+=== Uninstallation
+
+To uninstall the rubypodder gem use:
+
+   gem uninstall rubypodder
+
+== Configuration
+
+Create a file +~/.rubypodder/rp.conf+ containing podcast feeds, one per line.
+
+== Usage
+
+Type
+
+   rubypodder
+
+and if there are any podcast episodes from your feeds that have not yet
+been downloaded, they will be downloaded into a "date" directory such as
++~/.rubypodder/2007-01-18/+
+
+A good idea is to use +crontab -e+ and add a line like
++0 5 * * * rubypodder+
+which will set up a cron job which will do
+this regularly.
+
+== License
+
+rubypodder is available under an MIT-style license.
+
+:include: MIT-LICENSE
+

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+Gem::manage_gems
+require 'rake/gempackagetask'
+spec = Gem::Specification.new do |s|
+    s.platform  =   Gem::Platform::RUBY
+    s.name      =   "rubypodder"
+    s.version   =   "0.1.0"
+    s.author    =   "Lex Miller"
+    s.email     =   "lex.miller @nospam@ gmail.com"
+    s.summary   =   "A podcast aggregator without an interface"
+    s.files     =   FileList['lib/*.rb', 'tests/*', 'Rakefile'].to_a
+    s.require_path       = "lib"
+    s.bindir             = "bin"
+    s.executables        = ["rubypodder"]
+    s.default_executable = "rubypodder"
+    s.autorequire        = "rubypodder"
+    s.add_dependency("rio")
+    s.test_files         = Dir.glob('tests/*.rb')
+    s.has_rdoc           = true
+    s.extra_rdoc_files   = ["README", "MIT-LICENSE"]
+end
+Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar = true
+end
+task :default => "pkg/#{spec.name}-#{spec.version}.gem" do
+    puts "generated latest version"
+end

data/bin/rubypodder

@@ -0,0 +1,2 @@
+require 'rubypodder'
+RubyPodder.new.run

data/lib/rubypodder.rb

@@ -0,0 +1,113 @@
+require 'rss/1.0'
+require 'rss/2.0'
+require 'net/http'
+require 'uri'
+require 'rubygems'
+require 'rio'
+require 'logger'
+require 'ftools'
+
+class File
+
+  def self.touch(fn)
+    File.open(fn, "w").close unless File.exist?(fn)
+  end
+
+end
+
+class RubyPodder
+
+  attr_reader :conf_file, :log_file, :done_file, :date_dir
+
+  def initialize(file_base="~/.rubypodder/rp")
+    @file_base = File.expand_path(file_base)
+    @rp_dir = File.dirname(@file_base)
+    @conf_file = @file_base + ".conf"
+    @log_file = @file_base + ".log"
+    @done_file = @file_base + ".done"
+    create_default_config_file
+    @log = Logger.new(@log_file)
+    File.touch @done_file
+    @date_dir = create_date_dir
+  end
+
+  def create_default_config_file
+    expanded_path = File.expand_path(@conf_file)
+    return if File.exists?(expanded_path)
+    make_dirname(expanded_path)
+    rio(expanded_path) < "http://downloads.bbc.co.uk/rmhttp/downloadtrial/radio4/thenowshow/rss.xml"
+  end
+
+  def make_dirname(full_filename)
+    dirname = File.dirname(full_filename)
+    File.makedirs dirname
+  end
+
+  def date_string(time)
+    time.strftime("%Y-%m-%d")
+  end
+
+  def create_date_dir
+    date_dir = @rp_dir + "/" + date_string(Time.now)
+    File.makedirs date_dir
+    date_dir
+  end
+
+  def read_feeds
+    IO.readlines(@conf_file).each {|l| l.chomp!}
+  end
+
+  def parse_rss(rss_source)
+    RSS::Parser.parse(rss_source, false)
+  end
+
+  def dest_file_name(url)
+    @date_dir + "/" + File.basename(URI.parse(url).path)
+  end
+
+  def record_download(url)
+    rio(@done_file) << "#{url}\n"
+  end
+
+  def already_downloaded(url)
+    url_regexp = Regexp.new(url)
+    File.open(@done_file).grep(url_regexp).length > 0
+  end
+
+  def download(url)
+    return if already_downloaded(url)
+    @log.info("  Downloading: #{url}")
+    file_name = dest_file_name(url)
+    rio(file_name) < rio(url)
+    record_download(url)
+  end
+
+  def remove_dir_if_empty(dirname)
+    begin
+      Dir.rmdir(dirname)
+    rescue SystemCallError
+      @log.info("#{dirname} has contents, not removed")
+    else
+      @log.info("#{dirname} was empty, removed")
+    end
+  end
+
+  def run
+    @log.info("Starting")
+    read_feeds.each do |url|
+      http_body = rio(url).contents
+      rss = parse_rss(http_body)
+      @log.info("Channel: #{rss.channel.title}")
+      rss.items.each do |item|
+        download(item.enclosure.url)
+      end
+    end
+    remove_dir_if_empty(@date_dir)
+    @log.info("Finished")
+  end
+
+end
+
+if $0 == __FILE__
+  RubyPodder.new.run
+end

data/tests/tc_rubypodder.rb

@@ -0,0 +1,199 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'test/unit'
+require 'rubypodder'
+
+class TC_RubyPodder < Test::Unit::TestCase
+
+  def setup
+    system("rm -rf " + "/tmp/test_rp.conf")
+    system("rm -rf " + "/tmp/test_rp.done")
+    File.open("/tmp/test_rp.conf", "w") do |file|
+      file.write("http://downloads.bbc.co.uk/rmhttp/downloadtrial/radio4/thenowshow/rss.xml\n")
+      file.write("http://www.guardian.co.uk/podcasts/comedy/rickygervais/mp3.xml")
+    end
+    @subdir = "/tmp/subdir"
+    system("rm -rf " + @subdir)
+    @rp = RubyPodder.new("/tmp/test_rp")
+  end
+
+  def teardown
+    system("rm -rf " + "/tmp/test_rp.conf")
+    system("rm -rf " + "/tmp/test_rp.done")
+    system("rm -rf " + "/tmp/test_rp.log")
+    system("rm -rf " + "/tmp/#{@rp.date_string(Time.now)}")
+    system("rm -rf " + @subdir)
+
+  end
+
+  def test_initialize_with_test_config_file
+    assert_kind_of(RubyPodder, @rp)
+    assert_equal("/tmp/test_rp.conf", @rp.conf_file)
+    assert_equal("/tmp/test_rp.log", @rp.log_file)
+    assert_equal("/tmp/test_rp.done", @rp.done_file)
+  end
+
+  def test_initialize_with_default_config_file
+    ENV['HOME'] = "/tmp"
+    @rp = RubyPodder.new()
+    assert_kind_of(RubyPodder, @rp)
+    assert_equal(ENV['HOME'] + "/.rubypodder/rp.conf", @rp.conf_file)
+    assert_equal(ENV['HOME'] + "/.rubypodder/rp.log", @rp.log_file)
+    assert_equal(ENV['HOME'] + "/.rubypodder/rp.done", @rp.done_file)
+    system("rm -rf " + "/tmp/.rubypodder")
+  end
+
+  def test_initialize_with_absent_config_file
+    file_base = "/tmp/test_rp"
+    file_conf = file_base + ".conf"
+    system("rm -rf " + file_conf)
+    @rp = RubyPodder.new(file_base)
+    assert(File.exists?(file_conf))
+    system("rm -rf " + file_conf)
+  end
+
+  def test_make_dirname_one_subdir
+    filename = @subdir + "/file"
+    @rp.make_dirname(filename)
+    assert(File.exists?(@subdir))
+  end
+
+  def test_make_dirname_many_subdir
+    subsubdirs = "/subsubdir/subsubsubdir"
+    filename = @subdir + subsubdirs + "/file"
+    @rp.make_dirname(filename)
+    assert(File.exists?(@subdir + subsubdirs))
+  end
+
+  def test_date_string
+    t = Time.gm(2006,"dec",18,21,0,0)
+    date_string = @rp.date_string(t)
+    assert_equal(date_string, "2006-12-18")
+  end
+
+  def test_initialize_with_absent_config_file_dir
+    file_base = @subdir + "/test_rp"
+    file_conf = file_base + ".conf"
+    @rp = RubyPodder.new(file_base)
+    assert(File.exists?(file_conf))
+  end
+
+  def test_initialize_creates_date_dir
+    file_base = @subdir + "/test_rp"
+    @rp = RubyPodder.new(file_base)
+    date_dir = @subdir + "/" + @rp.date_string(Time.now)
+    assert_equal(date_dir, @rp.date_dir)
+    assert(File.exists?(date_dir), "Subdirectory #{date_dir} not created")
+  end
+
+  def test_read_feeds
+    feed_list = @rp.read_feeds
+    assert_kind_of(Array, feed_list)
+    assert_equal(2, feed_list.length)
+    assert_equal("http://downloads.bbc.co.uk/rmhttp/downloadtrial/radio4/thenowshow/rss.xml", feed_list[0])
+  end
+
+  def test_parse_rss
+    #rss_source = IO.read("test_feed.xml")
+    rss_source = <<-END_OF_STRING
+    <?xml version="1.0" encoding="utf-8"?>
+    <rss xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" version="2.0">
+        <channel>
+            <lastBuildDate>Fri, 27 Oct 2006 16:50:15 +0100</lastBuildDate>
+            <title>The Ricky Gervais Show</title>
+            <itunes:author>Guardian Unlimited</itunes:author>
+            <link>http://www.guardian.co.uk/rickygervais</link>
+            <generator>Podcast Maker v1.2.4 - http://www.potionfactory.com/podcastmaker</generator>
+            <description>Ricky Gervais, Steve Merchant and Karl Pilkington are back yada yada</description>
+            <itunes:subtitle />
+            <itunes:summary>Ricky Gervais, Steve Merchant and Karl Pilkington are back yada yada</itunes:summary>
+            <language>en</language>
+            <copyright>Ricky Gervais, Steve Merchant, Karl Pilkington</copyright>
+            <itunes:owner>
+            <itunes:name>Glyn Hughes</itunes:name>
+            <itunes:email>glyn@rickygervais.com</itunes:email>
+            </itunes:owner>
+            <image>
+                <url>http://podcast.rickygervais.com/gu_p123_300_144.jpg</url>
+                <title>The Ricky Gervais Show</title>
+                <link>http://www.guardian.co.uk/rickygervais</link>
+                <width>144</width>
+                <height>144</height>
+            </image>
+            <itunes:image href="http://podcast.rickygervais.com/gu_p123_300.jpg" />
+            <category>Comedy</category>
+            <itunes:category text="Comedy" />
+            <itunes:keywords>Ricky, Gervais, Steve, Merchant, Karl, Pilkington</itunes:keywords>
+            <itunes:explicit>yes</itunes:explicit>
+            <item>
+                <title>The Podfather Part I - Halloween</title>
+                <itunes:author>Guardian Unlimited</itunes:author>
+                <description>The first of three specials from Ricky, Steve and Karl yada yada</description>
+                <itunes:subtitle>The first of three specials from Ricky, Steve and Karl yada yada</itunes:subtitle>
+                <itunes:summary />
+                <enclosure type="audio/mpeg" url="http://podcast.rickygervais.com/guspecials_halloween.mp3" length="15723925" />
+                <guid>http://podcast.rickygervais.com/guspecials_halloween.mp3</guid>
+                <pubDate>Tue, 31 Oct 2006 00:00:01 +0000</pubDate>
+                <category>Comedy</category>
+                <itunes:explicit>yes</itunes:explicit>
+                <itunes:duration>00:37:22</itunes:duration>
+                <itunes:keywords>Ricky, Gervais, Steve, Merchant, Karl, Pilkington</itunes:keywords>
+            </item>
+        </channel>
+    </rss>
+    END_OF_STRING
+    rss = @rp.parse_rss(rss_source)
+    assert_equal(1, rss.items.length)
+    assert_equal("http://podcast.rickygervais.com/guspecials_halloween.mp3", rss.items[0].enclosure.url)
+  end
+
+  def test_dest_file_name(url)
+    correct_dest_file_name = @rp.date_dir + "/" + "podcast.mp3"
+    dest_file_name = @rp.dest_file_name("http://www.podcast.com/podcast.mp3")
+    assert_equal(correct_dest_file_name, dest_file_name)
+    dest_file_name = @rp.dest_file_name("http://www.podcast.com/subdir/podcast.mp3")
+    assert_equal(correct_dest_file_name, dest_file_name)
+  end
+
+  def test_download
+    @rp.download("http://www.google.com/index.html")
+    dest_file = @rp.date_dir + "/" + "index.html"
+    assert(File.exists?(dest_file))
+    assert(File.open(dest_file).grep(/google/))
+  end
+
+  def test_download_recorded
+    @rp.download("http://www.google.com/index.html")
+    assert(File.exists?(@rp.done_file))
+    assert(File.open(@rp.done_file).grep(/^http:\/\/www.google.com\/index.html$/))
+  end
+
+  def test_already_downloaded
+    url1 = "http://www.google.com/index.html"
+    assert(!@rp.already_downloaded(url1), "url1 should not be already downloaded before download of url1")
+    @rp.download(url1)
+    assert(@rp.already_downloaded(url1), "url1 should be already downloaded after download of url1")
+    url2 = "http://www.google.co.nz/index.html"
+    @rp.download(url2)
+    assert(@rp.already_downloaded(url2), "url2 should be already downloaded after download of url2")
+    assert(@rp.already_downloaded(url1), "url1 should still be already downloaded after download of url2")
+  end
+
+  def test_download_omits_done_items
+    @rp.download("http://www.google.com/index.html")
+    dest_file = @rp.date_dir + "/" + "index.html"
+    system("rm -rf " + dest_file)
+    @rp.download("http://www.google.com/index.html")
+    assert(!File.exists?(dest_file))
+  end
+
+  def test_remove_dir_if_empty
+    system("mkdir -p " + @subdir)
+    @rp.remove_dir_if_empty(@subdir)
+    assert(!File.exists?(@subdir))
+    system("mkdir -p " + @subdir)
+    system("touch " + @subdir + "/fish")
+    @rp.remove_dir_if_empty(@subdir)
+    assert(File.exists?(@subdir))
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: rubypodder
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-01-20 00:00:00 +13:00
+summary: A podcast aggregator without an interface
+require_paths: 
+  - lib
+email: lex.miller @nospam@ gmail.com
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: rubypodder
+default_executable: rubypodder
+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
+signing_key: 
+cert_chain: 
+authors: 
+  - Lex Miller
+files: 
+  - lib/rubypodder.rb
+  - tests/tc_rubypodder.rb
+  - Rakefile
+  - README
+  - MIT-LICENSE
+test_files: 
+  - tests/tc_rubypodder.rb
+rdoc_options: []
+extra_rdoc_files: 
+  - README
+  - MIT-LICENSE
+executables: 
+  - rubypodder
+extensions: []
+requirements: []
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rio
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">"
+          - !ruby/object:Gem::Version 
+            version: 0.0.0
+      version: