dropcaster 0.0.2 → 0.0.3

data/dropcaster.gemspec

@@ -1,87 +1,88 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{dropcaster}
-  s.version = "0.0.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{nerab}]
-  s.date = %q{2011-10-05}
-  s.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.}
-  s.email = %q{nerab@gmx.at}
-  s.executables = [%q{lstags}, %q{dropcaster}, %q{dropcaster}, %q{lstags}]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md",
-    "TODO"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "TODO",
-    "VERSION",
-    "bin/dropcaster",
-    "bin/lstags",
-    "doc/infoPane.png",
-    "doc/lyricsPane.png",
-    "doc/sample-channel.yml",
-    "doc/sample-sidecar.yml",
-    "doc/videoPane.png",
-    "dropcaster.gemspec",
-    "lib/dropcaster.rb",
-    "lib/dropcaster/channel.rb",
-    "lib/dropcaster/channel_file_locator.rb",
-    "lib/dropcaster/errors.rb",
-    "lib/dropcaster/hashkeys.rb",
-    "lib/dropcaster/item.rb",
-    "templates/channel.rss.erb",
-    "test/fixtures/channel.yml",
-    "test/fixtures/iTunes.mp3",
-    "test/helper.rb",
-    "test/unit/test_app.rb",
-    "test/unit/test_channel.rb",
-    "test/unit/test_channel_locator.rb",
-    "test/unit/test_channel_xml.rb",
-    "test/unit/test_item.rb"
-  ]
-  s.homepage = %q{http://github.com/nerab/dropcaster}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.9}
-  s.summary = %q{Simple Podcast Publishing with Dropbox}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ruby-mp3info>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<libxml-ruby>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, [">= 0"])
-    else
-      s.add_dependency(%q<ruby-mp3info>, [">= 0"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<libxml-ruby>, [">= 0"])
-      s.add_dependency(%q<rdoc>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<ruby-mp3info>, [">= 0"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<libxml-ruby>, [">= 0"])
-    s.add_dependency(%q<rdoc>, [">= 0"])
-  end
-end
-
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dropcaster}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["nerab"]
+  s.date = %q{2011-10-13}
+  s.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.}
+  s.email = %q{nerab@gmx.at}
+  s.executables = ["lstags", "dropcaster", "dropcaster", "lstags"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "TODO"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "bin/dropcaster",
+    "bin/lstags",
+    "doc/infoPane.png",
+    "doc/lyricsPane.png",
+    "doc/sample-channel.yml",
+    "doc/sample-sidecar.yml",
+    "doc/videoPane.png",
+    "dropcaster.gemspec",
+    "lib/dropcaster.rb",
+    "lib/dropcaster/channel.rb",
+    "lib/dropcaster/channel_file_locator.rb",
+    "lib/dropcaster/errors.rb",
+    "lib/dropcaster/hashkeys.rb",
+    "lib/dropcaster/item.rb",
+    "templates/iTunes.rss.erb",
+    "test/extensions/windows.rb",
+    "test/fixtures/channel.yml",
+    "test/fixtures/iTunes.mp3",
+    "test/helper.rb",
+    "test/unit/test_app.rb",
+    "test/unit/test_channel.rb",
+    "test/unit/test_channel_locator.rb",
+    "test/unit/test_channel_xml.rb",
+    "test/unit/test_item.rb"
+  ]
+  s.homepage = %q{http://nerab.github.com/dropcaster}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.1}
+  s.summary = %q{Simple Podcast Publishing with Dropbox}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby-mp3info>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<libxml-ruby>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<ruby-mp3info>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<libxml-ruby>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ruby-mp3info>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<libxml-ruby>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+  end
+end
+

data/lib/dropcaster/channel.rb

@@ -1,86 +1,96 @@
-require 'erb'
-require 'uri'
-
-module Dropcaster
-  #
-  # Represents a podcast feed in the RSS 2.0 format
-  #
-  class Channel < DelegateClass(Hash)
-    include HashKeys
-
-    # Instantiate a new Channel object. +sources+ must be present and can be a String or Array
-    # of Strings, pointing to a one or more directories or MP3 files.
-    #
-    # +options+ is a hash with all attributes for the channel. The following attributes are 
-    # mandatory when a new channel is created:
-    # 
-    # * <tt>:title</tt> - Title (name) of the podcast
-    # * <tt>:url</tt> - URL to the podcast
-    # * <tt>:description</tt> - Short description of the podcast (a few words)
-    # * <tt>:enclosure_base</tt> - Base URL for enclosure links
-    #
-    def initialize(sources, options)
-      super(Hash.new)
-
-      # Assert mandatory options
-      [:title, :url, :description, :enclosure_base].each{|attr|
-        raise MissingAttributeError.new(attr) if options[attr].blank?
-      }
-      
-      self.merge!(options)
-      self.categories = Array.new
-      @source_files = Array.new
-
-      if (sources.respond_to?(:each)) # array
-        sources.each{|src|
-          add_files(src)
-        }
-      else
-        # single file or directory
-        add_files(src)
-      end
-
-      @index_template = ERB.new(File.new(File.join(File.dirname(__FILE__), '..', '..', 'templates', 'channel.rss.erb')), 0, "%<>")
-    end
-
-    #
-    # Returns this channel as an RSS representation. The actual rendering is done with the help
-    # of an ERB template. By default, it is expected as ../../templates/channel.rss.erb (relative)
-    # to channel.rb.
-    #
-    def to_rss
-      @index_template.result(binding)
-    end
-
-    #
-    # Returns all items (episodes) of this channel, ordered by newest-first.
-    #
-    def items
-      all_items = Array.new
-      @source_files.each{|src|
-        item = Item.new(src)
-
-        # set author and image_url from channel if empty
-        item.tag.artist = self.author if item.artist.blank?
-        item.image_url = self.image_url if item.image_url.blank?
-        
-        # construct absolute URL, based on the channel's enclosure_base attribute
-        enclosure_base << '/' unless enclosure_base =~ /\/$/
-        item.url = URI.join(URI.escape(enclosure_base), URI.escape(item.file_name))
-        
-        all_items << item
-      }
-      
-      all_items.sort{|x, y| y.pub_date <=> x.pub_date}
-    end
-
-  private
-    def add_files(src)
-      if File.directory?(src)
-        @source_files.concat(Dir.glob(File.join(src, '*.mp3')))
-      else
-        @source_files << src
-      end
-    end
-  end
-end
+require 'erb'
+require 'uri'
+
+module Dropcaster
+  #
+  # Represents a podcast feed in the RSS 2.0 format
+  #
+  class Channel < DelegateClass(Hash)
+    include HashKeys
+
+    # Instantiate a new Channel object. +sources+ must be present and can be a String or Array
+    # of Strings, pointing to a one or more directories or MP3 files.
+    #
+    # +options+ is a hash with all attributes for the channel. The following attributes are
+    # mandatory when a new channel is created:
+    #
+    # * <tt>:title</tt> - Title (name) of the podcast
+    # * <tt>:url</tt> - URL to the podcast
+    # * <tt>:description</tt> - Short description of the podcast (a few words)
+    #
+    def initialize(sources, options)
+      super(Hash.new)
+
+      # Assert mandatory options
+      [:title, :url, :description].each{|attr|
+        raise MissingAttributeError.new(attr) if options[attr].blank?
+      }
+
+      self.merge!(options)
+      self.categories = Array.new
+      @source_files = Array.new
+
+      if (sources.respond_to?(:each)) # array
+        sources.each{|src|
+          add_files(src)
+        }
+      else
+        # single file or directory
+        add_files(src)
+      end
+
+      # Prepend the image URL with the channel's base to make an absolute URL
+      self.image_url = URI.join(self.url, self.image_url).to_s unless self.image_url.blank? || self.image_url =~ /^https?:/
+
+      channel_template = self.channel_template || File.join(File.dirname(__FILE__), '..', '..', 'templates', 'iTunes.rss.erb')
+
+      begin
+        @erb_template = ERB.new(File.new(channel_template), 0, "%<>")
+      rescue Errno::ENOENT => e
+        raise TemplateNotFoundError.new(e.message)
+      end
+    end
+
+    #
+    # Returns this channel as an RSS representation. The actual rendering is done with the help
+    # of an ERB template. By default, it is expected as ../../templates/channel.rss.erb (relative)
+    # to channel.rb.
+    #
+    def to_rss
+      @erb_template.result(binding)
+    end
+
+    #
+    # Returns all items (episodes) of this channel, ordered by newest-first.
+    #
+    def items
+      all_items = Array.new
+      @source_files.each{|src|
+        item = Item.new(src)
+
+        # set author and image_url from channel if empty
+        item.tag.artist = self.author if item.artist.blank?
+        item.image_url = self.image_url if item.image_url.blank?
+
+        # construct absolute URL, based on the channel's enclosures_url attribute
+        # If enclosures_url is not given, take the channel URL as a base.
+        self.enclosures_url = self.url if self.enclosures_url.blank?
+        self.enclosures_url << '/' unless self.enclosures_url =~ /\/$/
+        item.url = URI.join(URI.escape(self.enclosures_url), URI.escape(item.file_name))
+
+        all_items << item
+      }
+
+      all_items.sort{|x, y| y.pub_date <=> x.pub_date}
+    end
+
+  private
+    def add_files(src)
+      if File.directory?(src)
+        @source_files.concat(Dir.glob(File.join(src, '*.mp3')))
+      else
+        @source_files << src
+      end
+    end
+  end
+end

data/lib/dropcaster/channel_file_locator.rb

@@ -1,48 +1,48 @@
-module Dropcaster
-  #
-  # Encapsulates the strategy how to find the channel definition file
-  #
-  class ChannelFileLocator
-    class << self
-      #
-      # Locates the channel definition file based on the <tt>sources</tt> directory.
-      #
-      # * If <tt>sources</tt> is a single file name, the channel definition file is expected
-      # as channel.yml in the same directory.
-      #
-      # * If <tt>sources</tt> is a single directory name, the channel definition file is
-      # expected as channel.yml in that directory.
-      #
-      # * If <tt>sources</tt> is an array of file names, the channel definition file is
-      # expected as channel.yml in the directory common to all files. If the files are
-      # located in more than one directory, an AmbiguousSourcesError is raised. In that
-      # case, the caller should specify the channel.yml as command line parameter.
-      #
-      # * If <tt>sources</tt> is an array with more than a single directory name, an
-      # AmbiguousSourcesError is raised. In that case, the caller should specify the
-      # channel.yml as command line parameter.
-      #
-      def locate(sources)
-        channel_source_dir = nil
-
-        if sources.respond_to?(:at)
-          # More than one source given. Check that they are all in the same directory.
-          distinct_dirs = sources.collect{|source| File.dirname(source)}.uniq
-
-          if 1 == distinct_dirs.size
-            # If all are the in same directory, use that as source directory where channel.yml is expected.
-            channel_source_dir = distinct_dirs.first
-          else
-            # Since no channel_file was specified at the command line, throw and quit
-            raise AmbiguousSourcesError.new(sources)
-          end
-        else
-          # If a single file or directory is given, use that as source directory where channel.yml is expected.
-          channel_source_dir = File.dirname(sources)
-        end
-
-        File.join(channel_source_dir, CHANNEL_YML)
-      end
-    end
-  end
-end
+module Dropcaster
+  #
+  # Encapsulates the strategy how to find the channel definition file
+  #
+  class ChannelFileLocator
+    class << self
+      #
+      # Locates the channel definition file based on the <tt>sources</tt> directory.
+      #
+      # * If <tt>sources</tt> is a single file name, the channel definition file is expected
+      # as channel.yml in the same directory.
+      #
+      # * If <tt>sources</tt> is a single directory name, the channel definition file is
+      # expected as channel.yml in that directory.
+      #
+      # * If <tt>sources</tt> is an array of file names, the channel definition file is
+      # expected as channel.yml in the directory common to all files. If the files are
+      # located in more than one directory, an AmbiguousSourcesError is raised. In that
+      # case, the caller should specify the channel.yml as command line parameter.
+      #
+      # * If <tt>sources</tt> is an array with more than a single directory name, an
+      # AmbiguousSourcesError is raised. In that case, the caller should specify the
+      # channel.yml as command line parameter.
+      #
+      def locate(sources)
+        channel_source_dir = nil
+
+        if sources.respond_to?(:at)
+          # More than one source given. Check that they are all in the same directory.
+          distinct_dirs = sources.collect{|source| File.dirname(source)}.uniq
+
+          if 1 == distinct_dirs.size
+            # If all are the in same directory, use that as source directory where channel.yml is expected.
+            channel_source_dir = distinct_dirs.first
+          else
+            # Since no channel_file was specified at the command line, throw and quit
+            raise AmbiguousSourcesError.new(sources)
+          end
+        else
+          # If a single file or directory is given, use that as source directory where channel.yml is expected.
+          channel_source_dir = File.dirname(sources)
+        end
+
+        File.join(channel_source_dir, CHANNEL_YML)
+      end
+    end
+  end
+end

data/lib/dropcaster/errors.rb

@@ -1,19 +1,25 @@
-module Dropcaster
-  class ConfigurationError < StandardError
-    def initialize(msg)
-      super(msg)
-    end
-  end
-
-  class MissingAttributeError < ConfigurationError
-    def initialize(missingAttribute)
-      super("#{missingAttribute} is a mandatory attribute, but it is missing.")
-    end
-  end
-
-  class AmbiguousSourcesError < ConfigurationError
-    def initialize(ambiguousSources)
-      super("The list of sources is ambiguous. Can't derive common directory from these: #{ambiguousSources.inspect}")
-    end
-  end
-end
+module Dropcaster
+  class ConfigurationError < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
+  class MissingAttributeError < ConfigurationError
+    def initialize(missingAttribute)
+      super("#{missingAttribute} is a mandatory attribute, but it is missing.")
+    end
+  end
+
+  class AmbiguousSourcesError < ConfigurationError
+    def initialize(ambiguousSources)
+      super("The list of sources is ambiguous. Can't derive common directory from these: #{ambiguousSources.inspect}")
+    end
+  end
+
+  class TemplateNotFoundError < ConfigurationError
+    def initialize(message)
+      super("Unable to load template file: #{message}")
+    end
+  end
+end

data/lib/dropcaster/hashkeys.rb

@@ -1,12 +1,12 @@
-module Dropcaster
-  module HashKeys
-    def method_missing(meth,*args)
-      m = meth.id2name
-      if /=$/ =~ m
-        self[m.chop.to_sym] = (args.length < 2 ? args[0] : args)
-      else
-        self[m.to_sym]
-      end
-    end
-  end
-end
+module Dropcaster
+  module HashKeys
+    def method_missing(meth,*args)
+      m = meth.id2name
+      if /=$/ =~ m
+        self[m.chop.to_sym] = (args.length < 2 ? args[0] : args)
+      else
+        self[m.to_sym]
+      end
+    end
+  end
+end

data/lib/dropcaster/item.rb

@@ -1,43 +1,43 @@
-require 'mp3info'
-require 'digest/sha1'
-
-module Dropcaster
-  class Item < DelegateClass(Hash)
-    include HashKeys
-
-    def initialize(file_path, options = nil)
-      super(Hash.new)
-
-      Mp3Info.open(file_path){|mp3info|
-        self[:file_name] = Pathname.new(File.expand_path(file_path)).relative_path_from(Pathname.new(Dir.pwd)).cleanpath.to_s
-        self[:tag] = mp3info.tag
-        self[:tag2] = mp3info.tag2
-        self[:duration] = mp3info.length
-      }
-
-      self[:file_size] = File.new(self.file_name).stat.size
-      self[:uuid] = Digest::SHA1.hexdigest(File.read(self.file_name))
-      
-      if self.tag2.TDR.blank?
-        self[:pub_date] = DateTime.parse(File.new(self.file_name).mtime.to_s)
-      else
-        self[:pub_date] = DateTime.parse(self.tag2.TDR)
-      end
-      
-      # Remove iTunes normalization crap (if configured)
-      self.tag2.COM.delete_if{|comment|
-        comment =~ /^( [0-9A-F]{8}){10}$/
-      } if options && options[:strip_itunes_private]
-      
-      # Convert lyrics frame into a hash, keyed by the three-letter language code
-      if tag2.ULT
-        lyrics_parts = tag2.ULT.split(0.chr)
-
-        if lyrics_parts && 3 == lyrics_parts.size        
-          self.lyrics = Hash.new
-          self.lyrics[lyrics_parts[1]] = lyrics_parts[2]
-        end
-      end
-    end
-  end
-end
+require 'mp3info'
+require 'digest/sha1'
+
+module Dropcaster
+  class Item < DelegateClass(Hash)
+    include HashKeys
+
+    def initialize(file_path, options = nil)
+      super(Hash.new)
+
+      Mp3Info.open(file_path){|mp3info|
+        self[:file_name] = Pathname.new(File.expand_path(file_path)).relative_path_from(Pathname.new(Dir.pwd)).cleanpath.to_s
+        self[:tag] = mp3info.tag
+        self[:tag2] = mp3info.tag2
+        self[:duration] = mp3info.length
+      }
+
+      self[:file_size] = File.new(self.file_name).stat.size
+      self[:uuid] = Digest::SHA1.hexdigest(File.read(self.file_name))
+      
+      if self.tag2.TDR.blank?
+        self[:pub_date] = DateTime.parse(File.new(self.file_name).mtime.to_s)
+      else
+        self[:pub_date] = DateTime.parse(self.tag2.TDR)
+      end
+      
+      # Remove iTunes normalization crap (if configured)
+      self.tag2.COM.delete_if{|comment|
+        comment =~ /^( [0-9A-F]{8}){10}$/
+      } if options && options[:strip_itunes_private]
+      
+      # Convert lyrics frame into a hash, keyed by the three-letter language code
+      if tag2.ULT
+        lyrics_parts = tag2.ULT.split(0.chr)
+
+        if lyrics_parts && 3 == lyrics_parts.size        
+          self.lyrics = Hash.new
+          self.lyrics[lyrics_parts[1]] = lyrics_parts[2]
+        end
+      end
+    end
+  end
+end

data/lib/dropcaster.rb

@@ -1,18 +1,18 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'bundler/setup'
-require 'delegate'
-require 'yaml'
-require 'active_support/core_ext/date_time/conversions'
-require 'active_support/core_ext/object/blank'
-
-require 'dropcaster/errors'
-require 'dropcaster/hashkeys'
-require 'dropcaster/channel'
-require 'dropcaster/item'
-require 'dropcaster/channel_file_locator'
-
-module Dropcaster
-  VERSION = File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION]))
-  CHANNEL_YML = 'channel.yml'
-end
+$:.unshift File.dirname(__FILE__)
+
+require 'bundler/setup'
+require 'delegate'
+require 'yaml'
+require 'active_support/core_ext/date_time/conversions'
+require 'active_support/core_ext/object/blank'
+
+require 'dropcaster/errors'
+require 'dropcaster/hashkeys'
+require 'dropcaster/channel'
+require 'dropcaster/item'
+require 'dropcaster/channel_file_locator'
+
+module Dropcaster
+  VERSION = File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION]))
+  CHANNEL_YML = 'channel.yml'
+end