dropcaster 0.0.4 → 0.0.5.rc1

data/Rakefile

@@ -1,47 +1,11 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "dropcaster"
-  gem.homepage = "http://nerab.github.com/dropcaster"
-  gem.license = "MIT"
-  gem.summary = %Q{Simple Podcast Publishing with Dropbox}
-  gem.description = %Q{Dropcaster is a podcast feed generator for the command line. It is most simple to use with Dropbox, but works equally well with any other hoster.}
-  gem.email = "nerab@gmx.at"
-  gem.authors = ["nerab"]
-  gem.executables << 'dropcaster'
-  gem.executables << 'lstags'
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "dropcaster #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end
+
+task :default => :test

data/TODO

@@ -1,12 +1,13 @@
-* Handle channel URLs not ending with a slash (may be required for hosts not discovering an index.html, like Dropbox)
-* Support subtitle and keywords in channel and items
-* If the option for the item template is present (e.g. --item-template templates/item.html.erb), generate individual html pages for each item from it and link to it from the index.html. Leave it off by default.
-* Print warnings when one of the specs from http://www.apple.com/itunes/podcasts/specs.html is violated
-* Allow muting of the iTunes warnings (see above) using a commandline switch
-* Implement sidecar files
-* Support other file types than mp3 (e.g. ogg or pdf)
-* Treat lyrics as plain text for the episode page, and with an optional command line switch we could also support markdown etc.
-* Potential optimization for large numbers of mp3 files: If there is an existing index.rss file, do not re-read the information from those files that are still there and still have the same hash value.
-* It feels pretty awkward to refer to the ID3v2 frame names all the time. After all, this is an implementation detail. Maybe we can wrap the frames with a nicer name, but still allow access to the underlying mp3info library? Maybe all we need is some aliasing and / or delegation?
-* Potentially replace the ERB template with Builder::XmlMarkup, see http://builder.rubyforge.org/ (the same that Rails uses)
-* Expose strip_itunes_private as commandline parameter
+* If the option for the item template is present (e.g. --item-template templates/item.html.erb), generate individual html pages for each item from it and link to it from the index.html. Leave it off by default.
+* Derive nice-looking HTML templates from Wordpress' Twenty Eleven theme
+* Print warnings when one of the specs from http://www.apple.com/itunes/podcasts/specs.html is violated
+* Allow muting of the iTunes warnings (see above) using a commandline switch
+* Implement sidecar files
+* Write up some documentation on how the mapping between ID3 tags, iTunes and channel / item attributes works
+* Support other file types than mp3 (e.g. ogg or pdf)
+* Treat lyrics as plain text for the episode page, and with an optional command line switch we could also support markdown etc.
+* Potential optimization for large numbers of mp3 files: If there is an existing index.rss file, do not re-read the information from those files that are still there and still have the same hash value.
+* It feels pretty awkward to refer to the ID3v2 frame names all the time. After all, this is an implementation detail. Maybe we can wrap the frames with a nicer name, but still allow access to the underlying mp3info library? Maybe all we need is some aliasing and / or delegation?
+* Potentially replace the ERB template with Builder::XmlMarkup, see http://builder.rubyforge.org/ (the same that Rails uses)
+* Improve handling of iTunes' normalization data. ```id3info test/fixtures/iTunes.mp3``` shows that comments do have a key, and we want to skip iTunNORM.
+* Write up a man page so that [gem man](http://defunkt.io/gem-man/) can pick it up

data/bin/dropcaster

@@ -1,117 +1,129 @@
-#!/usr/bin/env ruby
-
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require 'rubygems'
-require 'yaml'
-
-help = <<HELP
-Dropcaster is a podcast feed generator for the command line.
-
-Author: Nicolas E. Rabenau nerab@gmx.at
-Homepage: http://nerab.github.com/dropcaster/
-
-Basic Usage:
-
-  dropcaster            Prints a podcast feed document for the mp3 files in the current directory.
-  dropcaster [FILE]...  Prints a podcast feed document for FILES
-  dropcaster [DIR]...   Prints a podcast feed document for the mp3 files in DIR
-
-Options:
-HELP
-
-def usage
-  "Run '#{File.basename(__FILE__)} --help' for further help."
-end
-
-require 'optparse'
-require 'dropcaster'
-
-options = Hash.new
-options[:auto_detect_channel_file] = true
-
-opts = OptionParser.new do |opts|
-  opts.banner = help
-
-  opts.on("--verbose", "Verbose mode - displays additional diagnostic information") do |file|
-    Dropcaster.logger = Logger.new(STDERR)
-    Dropcaster.logger.formatter = Dropcaster::LogFormatter.new
-    Dropcaster.logger.level = Logger::INFO
-  end
-
-  opts.on("--channel FILE", "Read the channel definition from FILE instead of channel.yml in the current directory.") do |file|
-    begin
-      Dropcaster.logger.info "Reading channel definition from #{file}"
-      options = YAML.load_file(file).merge(options)
-      options[:auto_detect_channel_file] = false
-    rescue
-      Dropcaster.logger.error "Could not load channel definition. #{$!.message}"
-      Dropcaster.logger.info $!.backtrace
-      exit(1)
-    end
-  end
-
-  opts.on("--title STRING", "Use STRING as the channel's title. Overrides settings read from channel definition file.") do |title|
-    Dropcaster.logger.info "Setting channel title to '#{title}' via command line"
-    options[:title] = title
-  end
-
-  opts.on("--url URL", "Use URL as the channel's url. Overrides settings read from channel definition file.") do |url|
-    Dropcaster.logger.info "Setting channel URL to '#{url}' via command line"
-    options[:url] = url
-  end
-
-  opts.on("--description STRING", "Use STRING as the channel's description. Overrides settings read from channel definition file.") do |description|
-    Dropcaster.logger.info "Setting channel description to '#{description}' via command line"
-    options[:description] = description
-  end
-
-  opts.on("--enclosures URL", "Use URL as the base URL for the channel's enclosures. Overrides settings read from channel definition file.") do |enclosures_url|
-    Dropcaster.logger.info "Setting enclosures base URL to '#{enclosures_url}' via command line"
-    options[:enclosures_url] = enclosures_url
-  end
-
-  opts.on("--image URL", "Use URL as the channel's image URL. Overrides settings read from channel definition file.") do |image_url|
-    Dropcaster.logger.info "Setting image URL to '#{image_url}' via command line"
-    options[:image_url] = image_url
-  end
-
-  opts.on("--channel-template FILE", "Use FILE as template for generating the channel feed. Overrides the default that comes with Dropcaster.") do |file|
-    Dropcaster.logger.info "Using'#{file}' as channel template file"
-    options[:channel_template] = file
-  end
-
-  opts.on("--version", "Display current version") do
-    puts "#{File.basename(__FILE__)} " + Dropcaster::VERSION
-    exit 0
-  end
-end
-
-opts.parse!
-sources = ARGV.blank? ? '.' : ARGV
-
-if options[:auto_detect_channel_file]
-  # There was no channel file specified, so we try to load channel.yml from sources dir
-  channel_file = Dropcaster::ChannelFileLocator.locate(sources)
-
-  if File.exists?(channel_file)
-    Dropcaster.logger.info "Auto-detected channel file at #{channel_file}"
-    options_from_yaml = YAML.load_file(channel_file)
-    options = options_from_yaml.merge(options)
-  else
-    Dropcaster.logger.error "No channel file found at #{channel_file})"
-    Dropcaster.logger.info usage
-    exit(1) # No way to continue without a channel definition
-  end
-end
-
-Dropcaster.logger.info "Generating the channel with these options: #{options.inspect}"
-
-begin
-  puts Dropcaster::Channel.new(sources, options).to_rss
-rescue
-  Dropcaster.logger.error $!.message
-  Dropcaster.logger.debug $!.backtrace
-  Dropcaster.logger.info usage
-  exit(1)
-end
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'yaml'
+
+help = <<HELP
+Dropcaster is a podcast feed generator for the command line.
+
+Author: Nicolas E. Rabenau nerab@gmx.at
+Homepage: http://rubydoc.info/gems/dropcaster/file/README.md
+
+Basic Usage:
+
+  dropcaster            Prints a podcast feed document for the mp3 files in the current directory.
+  dropcaster [FILE]...  Prints a podcast feed document for FILES
+  dropcaster [DIR]...   Prints a podcast feed document for the mp3 files in DIR
+
+Options:
+HELP
+
+def usage
+  "Run '#{File.basename(__FILE__)} --help' for further help."
+end
+
+require 'optparse'
+require 'dropcaster'
+
+options = Hash.new
+options[:auto_detect_channel_file] = true
+
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on("--verbose", "Verbose mode - displays additional diagnostic information") do |file|
+    Dropcaster.logger = Logger.new(STDERR)
+    Dropcaster.logger.formatter = Dropcaster::LogFormatter.new
+    Dropcaster.logger.level = Logger::INFO
+  end
+
+  opts.on("--trace", "Verbose mode - displays additional diagnostic information") do |file|
+    Dropcaster.logger = Logger.new(STDERR)
+    Dropcaster.logger.formatter = Dropcaster::LogFormatter.new
+    Dropcaster.logger.level = Logger::DEBUG
+  end
+
+  opts.on("--channel FILE", "Read the channel definition from FILE instead of channel.yml in the current directory.") do |file|
+    begin
+      Dropcaster.logger.info "Reading channel definition from #{file}"
+      options = YAML.load_file(file).merge(options)
+      options[:auto_detect_channel_file] = false
+    rescue
+      Dropcaster.logger.error "Could not load channel definition. #{$!.message}"
+      Dropcaster.logger.info $!.backtrace
+      exit(1)
+    end
+  end
+
+  opts.on("--title STRING", "Use STRING as the channel's title. Overrides settings read from channel definition file.") do |title|
+    Dropcaster.logger.info "Setting channel title to '#{title}' via command line"
+    options[:title] = title
+  end
+
+  opts.on("--subtitle STRING", "Use STRING as the channel's subtitle. Overrides settings read from channel definition file.") do |subtitle|
+    Dropcaster.logger.info "Setting channel subtitle to '#{subtitle}' via command line"
+    options[:subtitle] = subtitle
+  end
+
+  opts.on("--url URL", "Use URL as the channel's url. Overrides settings read from channel definition file.") do |url|
+    Dropcaster.logger.info "Setting channel URL to '#{url}' via command line"
+    options[:url] = url
+  end
+
+  opts.on("--description STRING", "Use STRING as the channel's description. Overrides settings read from channel definition file.") do |description|
+    Dropcaster.logger.info "Setting channel description to '#{description}' via command line"
+    options[:description] = description
+  end
+
+  opts.on("--enclosures URL", "Use URL as the base URL for the channel's enclosures. Overrides settings read from channel definition file.") do |enclosures_url|
+    Dropcaster.logger.info "Setting enclosures base URL to '#{enclosures_url}' via command line"
+    options[:enclosures_url] = enclosures_url
+  end
+
+  opts.on("--image URL", "Use URL as the channel's image URL. Overrides settings read from channel definition file.") do |image_url|
+    Dropcaster.logger.info "Setting image URL to '#{image_url}' via command line"
+    options[:image_url] = image_url
+  end
+
+  opts.on("--channel-template FILE", "Use FILE as template for generating the channel feed. Overrides the default that comes with Dropcaster.") do |file|
+    Dropcaster.logger.info "Using'#{file}' as channel template file"
+    options[:channel_template] = file
+  end
+
+  opts.on("--version", "Display current version") do
+    puts "#{File.basename(__FILE__)} " + Dropcaster::VERSION
+    exit 0
+  end
+end
+
+opts.parse!
+sources = ARGV.blank? ? '.' : ARGV
+
+if options[:auto_detect_channel_file]
+  # There was no channel file specified, so we try to load channel.yml from sources dir
+  channel_file = Dropcaster::ChannelFileLocator.locate(sources)
+
+  if File.exists?(channel_file)
+    Dropcaster.logger.info "Auto-detected channel file at #{channel_file}"
+    options_from_yaml = YAML.load_file(channel_file)
+    options = options_from_yaml.merge(options)
+  else
+    Dropcaster.logger.error "No channel file found at #{channel_file})"
+    Dropcaster.logger.info usage
+    exit(1) # No way to continue without a channel definition
+  end
+end
+
+Dropcaster.logger.info "Generating the channel with these options: #{options.inspect}"
+
+begin
+  puts Dropcaster::Channel.new(sources, options).to_rss
+rescue
+  Dropcaster.logger.error $!.message
+  $!.backtrace.each do |line|
+    Dropcaster.logger.debug(line)
+  end
+  Dropcaster.logger.info usage
+  exit(1)
+end

data/bin/lstags

@@ -1,45 +1,51 @@
-#!/usr/bin/env ruby
-
-unless ARGV.size == 1
-  STDERR.puts "#{File.basename(__FILE__)}: Missing required parameter for the mp3 file to process"
-  exit(1)
-end
-
-require 'rubygems'
-require 'mp3info'
-
-begin
-  Mp3Info.open(ARGV.first) do |mp3info|
-    puts 'ID3v1 tags:'
-    mp3info.tag.keys.each{|key|
-      puts "  #{key} => #{mp3info.tag.send(key)}"
-    }
-    puts
-    puts 'ID3v2 tags:'
-    mp3info.tag2.keys.each{|key|
-      case key
-        when 'PIC'
-        when 'APIC'
-          # picture - do not print binary data
-        when 'ULT'
-          print "  ULT => "
-          block_counter = 0
-          mp3info.tag2.ULT.bytes{|b| 
-            print "0x%02x " % b.to_i
-            print b > 31 ? " '#{b.chr}' " : " " * 5
-            if (block_counter += 1) > 7 # display in blocks of 8 bytes
-              puts
-              print " " * 9
-              block_counter = 0
-            end
-          }
-          puts
-        else
-          puts "  #{key} => #{mp3info.tag2.send(key)}"
-      end
-    }
-  end
-rescue
-  puts "Error: #{$!.message}"
-  exit(1)
-end
+#!/usr/bin/env ruby
+
+unless ARGV.size == 1
+  STDERR.puts "#{File.basename(__FILE__)}: Missing required parameter for the mp3 file to process"
+  exit(1)
+end
+
+require 'rubygems'
+require 'mp3info'
+
+begin
+  file_name = ARGV.first
+
+  puts "Listing tags for file: #{file_name}"
+
+  Mp3Info.open(file_name) do |mp3info|
+    puts 'ID3v1 tags:'
+    mp3info.tag.keys.each{|key|
+      puts "  #{key} => #{mp3info.tag.send(key)}"
+    }
+    puts
+    puts 'ID3v2 tags:'
+    mp3info.tag2.keys.each{|key|
+      case key
+        when 'PIC'
+        when 'APIC'
+          # picture - do not print binary data
+        when 'ULT'
+          print "  ULT => "
+          block_counter = 0
+          mp3info.tag2.ULT.bytes{|b|
+            print "0x%02x " % b.to_i
+            print b > 31 ? " '#{b.chr}' " : " " * 5
+            if (block_counter += 1) > 7 # display in blocks of 8 bytes
+              puts
+              print " " * 9
+              block_counter = 0
+            end
+          }
+          puts
+        else
+          puts "  #{key} => #{mp3info.tag2.send(key)}"
+      end
+    }
+  end
+  puts "Modification date: #{File.new(file_name).mtime}"
+
+rescue
+  puts "Error: #{$!.message}"
+  exit(1)
+end

data/doc/sample-channel.yml

@@ -1,81 +1,88 @@
-#
-# A sample RSS channel definition
-#
-# This file is read by Dropcaster
-# http://github.com/nerab/dropcaster
-#
-# It defines the properties of your podcast channel.
-#
-
-#
-# Title (name) of the podcast
-#
-:title: 'All About Everything'
-
-#
-# Short description of the podcast (a few words)
-#
-:subtitle: 'A show about everything'
-
-#
-# URL to the podcast.
-#
-:url: 'http://www.example.com/podcasts/everything/'
-
-#
-# Optional base URL for enclosure links
-#
-:enclosures_url: 'http://www.example.com/podcasts/everything/episodes'
-
-#
-# Language of the podcast - ISO 639-1 Alpha-2 list (two-letter language codes, some with possible modifiers, such as "en-us").
-#
-:language: 'en-us'
-
-#
-# Not visible in iTunes, but useful as a statement in the feed
-#
-:copyright: '© 2011 John Doe & Family'
-
-#
-# Author / creator of the podcast. In iTunes, it is displayed in the artist column.
-#
-:author: 'John Doe'
-
-#
-# Longer description of the podcast
-#
-:description: 'All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our Podcast in the iTunes Store!'
-
-#
-# Contact information of the owner of the podcast. Not be publicly displayed in iTunes.
-#
-:owner:
-  :name: 'John Doe'
-  :email: 'john.doe@example.com'
-
-#
-# iTunes prefers square .jpg images that are at least 600 x 600 pixels
-#
-# If the URL does not start with http: or https:, it will be prefixed with the channel url.
-#
-:image_url: 'AllAboutEverything.jpg'
-
-#
-# Category / categories of the podcast
-#
-# For iTunes, see http://www.apple.com/itunes/podcasts/specs.html#categories for applicable values
-#
-# Examples:
-#   :categories: 'Technology'
-#   :categories: ['Technology', 'Gadgets']
-#   :categories: ['TV & Film', ['Technology', 'Gadgets']]
-#
-# Don't HTML-escape the categories, this will be taken care of by Dropcaster
-#
-:categories: ['Technology', 'Gadgets']
-
-#
-# Yes, No or Clean, see http://www.apple.com/itunes/podcasts/specs.html#explicit
-#
-:explicit: No
+#
+# A sample RSS channel definition
+#
+# This file is read by Dropcaster
+# http://github.com/nerab/dropcaster
+#
+# It defines the properties of your podcast channel.
+#
+
+#
+# Title (name) of the podcast
+#
+:title: 'All About Everything'
+
+#
+# Short description of the podcast (a few words)
+#
+:subtitle: 'A show about everything'
+
+#
+# URL to the podcast.
+#
+:url: 'http://www.example.com/podcasts/everything/'
+
+#
+# Optional base URL for enclosure links
+#
+:enclosures_url: 'http://www.example.com/podcasts/everything/episodes'
+
+#
+# Language of the podcast - ISO 639-1 Alpha-2 list (two-letter language codes, some with possible modifiers, such as "en-us").
+#
+:language: 'en-us'
+
+#
+# Not visible in iTunes, but useful as a statement in the feed
+#
+:copyright: '© 2011 John Doe & Family'
+
+#
+# Author / creator of the podcast. In iTunes, it is displayed in the artist column.
+#
+:author: 'John Doe'
+
+#
+# Longer description of the podcast
+#
+:description: 'All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our Podcast in the iTunes Store!'
+
+#
+# Contact information of the owner of the podcast. Not be publicly displayed in iTunes.
+#
+:owner:
+  :name: 'John Doe'
+  :email: 'john.doe@example.com'
+
+#
+# iTunes prefers square .jpg images that are at least 600 x 600 pixels
+#
+# If the URL does not start with http: or https:, it will be prefixed with the channel url.
+#
+:image_url: 'AllAboutEverything.jpg'
+
+#
+# Category / categories of the podcast
+#
+# For iTunes, see http://www.apple.com/itunes/podcasts/specs.html#categories for applicable values
+#
+# Examples:
+#   :categories: 'Technology'
+#   :categories: ['Technology', 'Gadgets']
+#   :categories: ['TV & Film', ['Technology', 'Gadgets']]
+#
+# Don't HTML-escape the categories, this will be taken care of by Dropcaster
+#
+:categories: ['Technology', 'Gadgets']
+
+#
+# Yes, No or Clean, see http://www.apple.com/itunes/podcasts/specs.html#explicit
+#
+:explicit: No
+
+#
+# Keywords
+#
+# Apple recommends to use not more than 12 keywords
+#
+:keywords: [salt, pepper, shaker, exciting]

data/doc/sample-sidecar.yml

@@ -1,19 +1,19 @@
-#
-# Sample sidecar file
-#
-# If this file is present side-by-side with an mp3 file, and if it has the same name as the mp3 (but with
-# an extension of yml or yaml), then any setting made in this file will be used instead of the value from the mp3.
-#
-:title: 'Title of the episode'
-:author: 'Author of the episode'
-:subtitle: 'Subtitle of the episode'
-:description: 'Desciption and summary of the episode'
-:image_url: 'URL to an image specific for this episode'
-:enclosure:
-  :url: 'URL where this episode can be downloaded'
-  :length: 42 # length of the episode in milliseconds
-  :type: 'usually audio/mp3'
-:guid: 'Globally unique id of the episode'
-:pubDate: 'Date as per RFC 2822; e.g. Wed, 15 Jun 2005 19:00:00 GMT'
-:duration: 'Either HH:MM:SS, H:MM:SS, MM:SS, M:SS, or SS'
-:keywords: ['ruby', 'rails', 'podcast'] # up to 12 text keywords
+#
+# Sample sidecar file
+#
+# If this file is present side-by-side with an mp3 file, and if it has the same name as the mp3 (but with
+# an extension of yml or yaml), then any setting made in this file will be used instead of the value from the mp3.
+#
+:title: 'Title of the episode'
+:author: 'Author of the episode'
+:subtitle: 'Subtitle of the episode'
+:description: 'Desciption and summary of the episode'
+:image_url: 'URL to an image specific for this episode'
+:enclosure:
+  :url: 'URL where this episode can be downloaded'
+  :length: 42 # length of the episode in milliseconds
+  :type: 'usually audio/mp3'
+:guid: 'Globally unique id of the episode'
+:pubDate: 'Date as per RFC 2822; e.g. Wed, 15 Jun 2005 19:00:00 GMT'
+:duration: 'Either HH:MM:SS, H:MM:SS, MM:SS, M:SS, or SS'
+:keywords: ['ruby', 'rails', 'podcast'] # up to 12 text keywords