woody 0.3.0 → 0.3.1

data/lib/woody/compiler.rb

@@ -9,8 +9,10 @@ module Woody
       meta = YAML.load_file("content/metadata.yml")
 		
   		# instantiate the metadata hash so shit doesn't explode in our faces
-			meta = Hash.new if meta.empty?
-
+  		# WEIRD SHIT: used .empty? here before but fails if used on hash seemingly
+		if meta == false
+			meta = Hash.new 
+		end
 
       episodes     = Array.new
       filesfound   = Array.new
@@ -83,12 +85,12 @@ module Woody
         puts "Warning: content/iTunes.png missing!"
       end
 
-      # Update iTunes RSS
+      # Update (iTunes) RSS
       $config['itunes']['explicit'] = "no" if $config['itunes']['explicit'].nil?
-      itunes = File.read "#{$source_root}/itunes.xml" # Use itunes.xml template in gem, not in site's template folder.
-      itunes = Erubis::Eruby.new(itunes)
-      itunes_compiled = itunes.result(config: $config, episodes: episodes)
-      write_output_file("itunes.xml") {|f| f.write(itunes_compiled) }
+      feedxml = File.read File.join($source_root, "feed.xml") # Use feed.xml template in gem, not in site's template folder.
+      feed = Erubis::Eruby.new(feedxml)
+      feed_compiled = feed.result(config: $config, episodes: episodes)
+      write_output_file("feed.xml") {|f| f.write(feed_compiled) }
 
 
 

data/lib/woody/version.rb

@@ -1,4 +1,4 @@
 module Woody
   # Specifies Woody gem version
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/templates/{itunes.xml → feed.xml}

@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<rss xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" version="2.0">
+<rss xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
 <channel>
     <title><%= config['title'] %></title>
     <link><%= config['urlbase'] %></link>
-    <language>en</language>
+    <language><%= config['lang'] %></language>
+    
     <copyright>℗ &amp; © <%= config['author'] %></copyright>
     <itunes:subtitle><%= config['subtitle'] %></itunes:subtitle>
     <itunes:author><%= config['author'] %></itunes:author>
@@ -18,19 +19,23 @@
    
     <itunes:image href="<%= $config['urlbase'] + "/assets/iTunes.png" %>"/>
     <itunes:category text="<%= $config['itunes']['category'] %>"/>
-    
-    
-    <%- episodes.each do |episode| %>
+
+    <atom:link href="<%= $config['urlbase'] %>/feed.xml" rel="self" type="application/rss+xml" />
+
+
+  <%- episodes.each do |episode| %>
     <item>
       <title><%= episode.title %></title>
       <itunes:subtitle><%= episode.subtitle %></itunes:subtitle>
       <itunes:summary><%= episode.synopsis %></itunes:summary>
-      <enclosure url="<%= episode.file_url %>" length="<%= episode.size %>" type="audio/mpeg"/>
       <pubDate><%= episode.date.rfc2822 %></pubDate>
       <itunes:duration><%= episode.duration %></itunes:duration>
       <itunes:keywords><%= episode.keywords %></itunes:keywords>
       <itunes:explicit><%= episode.explicit_string %></itunes:explicit>
+      <description><%= episode.synopsis %></description>
+  		<enclosure url="<%= episode.file_url %>" length="<%= episode.size %>" type="audio/mpeg"/>
       <guid><%= episode.url %></guid>
+      <category>Podcasts</category>
     </item>
     <% end %>
 

data/templates/index.html

@@ -1,4 +1,5 @@
 <h2>Episodes:</h2>
+<%= link_to "RSS Feed", "#{$config['urlbase']}/feed.xml" %>
 <% episodes.each do |episode| %>
   <div class="episode">
   <%= yield episode %>

data/templates/woody-config.yml

@@ -1,29 +1,93 @@
-title: Title
-subtitle: Subtitle
-author: Author
+#############################################################
+#                                                           #
+#                                         dP      ALPHA     #
+#                                         88                #
+#      dP  dP  dP .d8888b. .d8888b. .d888b88 dP    dP       #
+#      88  88  88 88'  `88 88'  `88 88'  `88 88    88       #
+#      88.88b.88' 88.  .88 88.  .88 88.  .88 88.  .88       #
+#      8888P Y8P  `88888P' `88888P' `88888P8 `8888P88       #
+#                                                 .88       #
+#                                              d8888P       #
+#                                                           #
+#############################################################
+#                                                           #
+#  Welcome to Woody, the best way to generate iTunes-ready  #
+#  podcast feeds and websites!                              #
+#                                                           #
+#  To get started, please fill out this wee config file,    #
+#  drop some mp3s in the content folder and run:            #
+#                                                           #
+#  $ woody compile                                          #
+#                                                           #
+#  To build and compile your site! For more help see the    #
+#  readme included. Have fun!                               #
+#                                                           #
+#  Visit us on github - github.com/davidjrobertson/woody    #
+#                                                           #
+#############################################################
 
-# Include http://, domain name, but *NO trailing slash*
-urlbase: http://example.com
+################
+#  BASIC INFO  #
+################
+
+#  Title and subtitle of your podcast 
+title: David's World of Spoons
+subtitle: From Teaspoons to Ladels
+
+#  A short description of your podcast. (Also used for iTunes)
+summary: Hey there. I'm David, and this is my amazing world of spoons and other crockery!
+
+#  The name of the podcast's author
+author: David "Spoonmad" Hewitson
+
+#  Primary language of the podcast - please see http://www.w3.org/WAI/ER/IG/ert/iso639.htm
+lang: en 
+
+#  Base URL of the podcast - used to generate links
+urlbase: http://example.com 
+
+#######################
+#  ID3 CONFIGURATION  #
+#######################
 
 mp3:
-  # NOT YET IMPLEMENTED! Do you want to have ID3v2 tags for artist/title automatically set? N.B., may be truncated.
+  #  NYI! Do you want to have ID3v2 tags for artist/title automatically set? N.B., may be truncated.
   setartist: true
   settitle:  true
 
+##########################
+#  ITUNES-SPECIFIC INFO  #
+##########################
+
 itunes:
-  summary: iTunes Summary
+  #  Full name and email address of podcast owner 
   owner: 
     name: Owner
     email: owner@example.com
-  # Category MUST be one of the ones listed here http://www.apple.com/itunes/podcasts/specs.html#categories
+    
+  # One of the categories listed here: http://www.apple.com/itunes/podcasts/specs.html#categories
   category: Comedy
-  explicit: "no" # yes/no/clean
   
+  #  Is the podcast explicit? (yes/no/clean) You can type 'clean' to have your
+  #  podcast show up with a 'clean' icon in iTunes search results
+  explicit: "no"
+
+###############################
+#  DISTRIBUTION CONFIGURATION #
+###############################
+
+# NOTE: currently only Amazon S3 (AWS) is available - more soon!
+
+distributiontype: s3
+
 s3:
-  # Set the relevant s3 endpoint here. For eu-west-1 (Ireland), use this default.
+  #  Set the relevant s3 endpoint here. For eu-west-1 (Ireland), use this default.
   hostname: s3-eu-west-1.amazonaws.com
   #prefix: podcast # Uncomment this to upload in a 'subdirectory' of the S3 bucket?
   accesskey:
+    #  Your AWS access key and secret
     id: your-aws-access-key-id
     secret: your-aws-access-key-secret
+    
+  #  The bucket the podcast site should be uploaded to
   bucket: example.com

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: woody
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -112,9 +112,9 @@ files:
 - lib/woody/generator.rb
 - lib/woody/version.rb
 - templates/episode.html
+- templates/feed.xml
 - templates/iTunes.png
 - templates/index.html
-- templates/itunes.xml
 - templates/layout.html
 - templates/metadata.yml
 - templates/stylesheet.css