gst-kitchen 0.2.0 → 0.4.0

data/README.md

@@ -35,7 +35,7 @@ gst-kitchen assumes various conventions about (file) naming and URLs.
 
 Meta data from each episodes is read from your Auphonic production. The episode number is read from the `title`,
 which must start with `<handle><number>`. The episode name is read from `subtitle`, summary and description is
-set to Auphonic's `summary` field. Filesizes, playtime etc. is also read from the production.
+set to Auphonic's `summary` field. File sizes, playtime etc. are also read from the production.
 
 
 ## Usage
@@ -48,8 +48,8 @@ Then you need to create a `podcast.yml` containing your podcast metadata.
 You can take a look at https://github.com/tisba/gst-website/blob/master/podcast.yml as an example.
 Important fields are
 
-* basic meta data like, `title`, `subtutle`, `author`, `email` and `language`
-* `handle` is a short *handle* for your podcast. It can be an abbreviation or acronym, or anything you like. For geekstammtisch it's `GST`.
+* basic meta data like, `title`, `subtitle`, `author`, `email` and `language`
+* `handle` is a short *handle* for your podcast. It can be an abbreviation, acronym, or anything you like. For geekstammtisch it's `GST`.
 * base URLs for the website and media location
 * list of available audio formats: fileext_encoding, e.g. `m4a_aac` or `mp3_mp3`
 * `rss_output_path` specifies where the generated feeds will be located
@@ -84,4 +84,4 @@ Render all configured feeds based on all episodes in `episodes/`
 5. Create new Pull Request
 
 
-[igor]: https://github.com/m4p/fanboys-IGOR "IGOR"
+[igor]: https://github.com/m4p/fanboys-IGOR "IGOR"

data/bin/gst-kitchen

@@ -9,7 +9,7 @@ require "fileutils"
 
 SUB_COMMANDS = %w(feed process list version)
 global_opts = Trollop::options do
-  banner "magic file deleting and copying utility"
+  banner "Geekstammtischs Kitchen to publish podcats..."
   opt :podcast, "path of podcast YAML specification", :default => "podcast.yml"
   stop_on SUB_COMMANDS
 end
@@ -17,10 +17,12 @@ end
 case ARGV.shift
 when "version"
   puts GstKitchen::VERSION
+
 when "feed"
   subcmd_opts = Trollop::options do
   end
   Podcast.from_yaml(global_opts[:podcast]).render_all_feeds
+
 when "list"
   productions = Auphonic::Account.init_from_system.productions
   productions.each do |production|
@@ -33,13 +35,58 @@ when "process"
   end
   production = Auphonic::Account.init_from_system.production(subcmd_opts[:uuid])
 
-  podcast = Podcast.from_yaml("podcast.yml")
+  podcast = Podcast.from_yaml(global_opts[:podcast])
   FileUtils.mkdir_p podcast.episodes_path
   episode = podcast.create_episode_from_auphonic production
 
   puts "Episode: #{episode}"
   puts "Writing episode YAML to #{File.join(podcast.episodes_path, episode.handle.downcase)}.yml"
   podcast.export_episode(episode)
+
+when "stats"
+  podcast = Podcast.from_yaml(global_opts[:podcast])
+  if STDIN.tty?
+    STDERR.puts "You need to pipe logs to gst-kitchen stats, e.g. cat logs/* | gst-kitchen stats"
+    exit
+  end
+  downloads = {}
+  while (logline = STDIN.gets)
+    # 93.194.154.91 - - [13/Dec/2012:16:22:38 +0100] "GET /episodes/gst000.m4a HTTP/1.1" 200 18676513 "-" "iTunes/11.0 (Macintosh; OS X 10.8.2) AppleWebKit/536.26.14"
+
+    / - - \[(?<date>.*?)\].*?(?<filename>gst\d{3}\....).*?2\d\d (?<size>\d+) / =~ logline
+
+    next unless filename
+
+    handle, format = filename.split(".")
+
+    next unless episode = podcast.episode_by_handle(handle)
+    next unless ["mp3", "m4a"].include? format
+
+    downloads[handle] ||= {}
+    downloads[handle][format] ||= {}
+
+    media_format = format == "mp3" ? "mp3" : "aac"
+
+    downloads[handle][format][:size] ||= episode.media[media_format]["size"]
+    downloads[handle][format][:downloaded] ||= 0
+    downloads[handle][format][:downloaded] += size.to_i
+  end
+
+  total_downloads = {}
+  downloads.each do |handle, episode|
+    episode.each do |format, stats|
+      downloads[handle][format][:count] = stats[:downloaded].to_f / stats[:size]
+      total_downloads[handle] ||= {}
+      total_downloads[handle]["total_downloads"] ||= 0
+      total_downloads[handle]["total_downloads"] += downloads[handle][format][:count]
+    end
+  end
+
+  downloads.keys.each do |handle|
+    downloads[handle].merge!(total_downloads[handle])
+  end
+
+  puts downloads.to_yaml
 else
   Trollop::die "unknown subcommand #{subcmd.inspect}"
 end

data/gst-kitchen.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["sebastian.cohnen@gmx.net"]
   gem.description   = %q{gst-kitchen is a gem to publish podcasts like a nerd with auphonic!}
   gem.summary       = %q{gst-kitchen is a gem to publish podcasts like a nerd with auphonic!}
-  gem.homepage      = ""
+  gem.homepage      = "http://github.com/tisba/gst-kitchen"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -20,4 +20,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency "yajl-ruby"
   gem.add_dependency "trollop"
   gem.add_dependency "rake"
+  gem.add_dependency "redcarpet"
 end

data/lib/gst-kitchen.rb

@@ -7,6 +7,7 @@ require "yaml"
 
 require "gst-kitchen/version"
 require "gst-kitchen/podcast"
+require "gst-kitchen/feed"
 require "gst-kitchen/episode"
 require "gst-kitchen/media"
 

data/lib/gst-kitchen/episode.rb

@@ -1,4 +1,4 @@
-class Episode < Struct.new(:number, :name, :length, :media, :auphonic_uuid, :published_at, :summary, :description)
+class Episode < Struct.new(:number, :name, :length, :media, :auphonic_uuid, :published_at, :summary)
   include Comparable
 
   def self.from_auphonic(production)
@@ -11,7 +11,6 @@ class Episode < Struct.new(:number, :name, :length, :media, :auphonic_uuid, :pub
       length: data["data"]["length"],
       name: data["data"]["metadata"]["subtitle"].strip,
       summary: data["data"]["metadata"]["summary"].strip,
-      description: data["data"]["metadata"]["summary"].strip
     }
 
     media = data["data"]["output_files"].each_with_object({}) do |item, obj|
@@ -29,7 +28,6 @@ class Episode < Struct.new(:number, :name, :length, :media, :auphonic_uuid, :pub
     episode.auphonic_uuid = metadata[:auphonic_uuid]
     episode.published_at = Time.now
     episode.summary = metadata[:summary]
-    episode.description = metadata[:description]
     episode.media = media
 
     episode

data/lib/gst-kitchen/feed.rb

@@ -0,0 +1,71 @@
+require 'redcarpet'
+require 'ruby-debug'
+
+class GstKitchen::Feed
+
+  class ShownotesRenderer < Redcarpet::Render::HTML
+
+    TWITTER_HANDLE_PATTER = /(\W)@(\w+)\b/
+
+    def preprocess(full_document)
+      return full_document if full_document.nil?
+
+      # Duplicate the string so we don't alter the original, then call to_str
+      # to cast it back to a String instead of a SafeBuffer. This is required
+      # for gsub calls to work as we need them to.
+      full_document = full_document.dup.to_str
+
+      # Extract pre blocks so they are not altered
+      # from http://github.github.com/github-flavored-markdown/
+      extractions = {}
+      full_document.gsub!(%r{<pre>.*?</pre>|<code>.*?</code>}m) do |match|
+        md5 = Digest::MD5.hexdigest(match)
+        extractions[md5] = match
+        "{gfm-extraction-#{md5}}"
+      end
+
+      full_document = parse(full_document)
+
+      # Insert pre block extractions
+      full_document.gsub!(/\{gfm-extraction-(\h{32})\}/) do
+        extractions[$1]
+      end
+
+      return full_document
+    end
+
+    private
+
+    def parse(document)
+      parse_twitter_handle(document)
+
+      return document
+    end
+
+    def parse_twitter_handle(document)
+      document.gsub!(TWITTER_HANDLE_PATTER, '\1[@\2](https://twitter.com/\2)')
+    end
+
+  end
+
+  TEMPLATE_PATH = File.join(File.dirname(__FILE__), "..", "..", "templates")
+
+  attr_reader :format, :template
+
+  def initialize(options = {})
+    @format   = options[:format]
+    @template = ERB.new(File.read(File.join(TEMPLATE_PATH, "#{options[:template]}.rss.erb")))
+  end
+
+  def render_as_markdown(text)
+    markdown = Redcarpet::Markdown.new(ShownotesRenderer, autolink: true)
+    markdown.render text
+  end
+
+  def to_xml(variables = {})
+    variables.each { |var, value| instance_variable_set("@#{var}", value) }
+
+    @template.result(binding)
+  end
+
+end

data/lib/gst-kitchen/podcast.rb

@@ -50,6 +50,12 @@ class Podcast
     Episode.from_auphonic production
   end
 
+  def episode_by_handle(handle)
+    self.episodes.find do |episode|
+      episode.handle.downcase == handle.downcase
+    end
+  end
+
   def feed_url(format)
     url = URI(self.website)
     url.path = "/#{rss_file(format)}"
@@ -78,15 +84,10 @@ class Podcast
     self
   end
 
-  def current_format
-    @current_format
-  end
-
   def render_feed(format)
-    @current_format = format
-    template = ERB.new File.read(File.join(File.dirname(__FILE__), "../..", "templates/episodes.rss.erb"))
+    feed = GstKitchen::Feed.new format: format, template: "episodes"
     File.open(File.join(rss_output_path, rss_file(format)), "w") do |rss|
-      rss.write template.result(binding)
+      rss.write feed.to_xml(podcast: podcast)
     end
   end
 
@@ -106,6 +107,7 @@ class Podcast
   end
 
   private
+
   def rss_file(format)
     "episodes.#{format.file_ext}.rss"
   end

data/lib/gst-kitchen/version.rb

@@ -1,3 +1,3 @@
 module GstKitchen
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/templates/episodes.rss.erb

@@ -1,27 +1,27 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <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><%= podcast.title %></title>
-        <link><%= podcast.website %></link>
-        <atom:link rel="self" href="<%= podcast.feed_url(podcast.current_format) %>" type="application/rss+xml" title="<%= podcast.current_format.file_ext.upcase %> Audio"/>
-        <% podcast.other_formats(current_format).each do |format| %>
-        <atom:link rel="alternate" href="<%= podcast.feed_url(format) %>" type="application/rss+xml" title="<%= format.file_ext.upcase %> Audio"/>
+        <title><%= @podcast.title %></title>
+        <link><%= @podcast.website %></link>
+        <atom:link rel="self" href="<%= @podcast.feed_url(@format) %>" type="application/rss+xml" title="<%= @format.file_ext.upcase %> Audio"/>
+        <% @podcast.other_formats(@format).each do |format| %>
+        <atom:link rel="alternate" href="<%= @podcast.feed_url(format) %>" type="application/rss+xml" title="<%= format.file_ext.upcase %> Audio"/>
         <% end %>
-        <language><%= podcast.language %></language>
+        <language><%= @podcast.language %></language>
         <generator>gst-kitchen</generator>
-        <copyright><%= podcast.author %>, cc-by-nc-sa</copyright>
-        <itunes:subtitle><%= podcast.subtitle %></itunes:subtitle>
-        <itunes:author><%= podcast.author %></itunes:author>
-        <managingEditor><%= podcast.email %> (<%= podcast.author %>)</managingEditor>
-        <itunes:summary><%= podcast.summary %></itunes:summary>
-        <itunes:explicit><%= podcast.explicit ? "yes" : "no" %></itunes:explicit>
-        <description><%= podcast.summary %></description>
+        <copyright><%= @podcast.author %>, cc-by-nc-sa</copyright>
+        <itunes:subtitle><%= @podcast.subtitle %></itunes:subtitle>
+        <itunes:author><%= @podcast.author %></itunes:author>
+        <managingEditor><%= @podcast.email %> (<%= @podcast.author %>)</managingEditor>
+        <itunes:summary><%= @podcast.summary %></itunes:summary>
+        <itunes:explicit><%= @podcast.explicit ? "yes" : "no" %></itunes:explicit>
+        <description><%= @podcast.summary %></description>
         <itunes:owner>
-            <itunes:name><%= podcast.author %></itunes:name>
-            <itunes:email><%= podcast.email %></itunes:email>
+            <itunes:name><%= @podcast.author %></itunes:name>
+            <itunes:email><%= @podcast.email %></itunes:email>
         </itunes:owner>
 
-        <itunes:image href="<%= podcast.cover_url %>"/>
+        <itunes:image href="<%= @podcast.cover_url %>"/>
 
         <itunes:category text="Technology"/>
         <itunes:category text="Technology">
@@ -31,19 +31,19 @@
             <itunes:category text="Tech News"/>
         </itunes:category>
 
-        <% podcast.episodes.each do |episode| %>
+        <% @podcast.episodes.each do |episode| %>
         <item>
           <title><%= episode.title %></title>
-          <itunes:explicit><%= podcast.explicit ? "yes" : "no" %></itunes:explicit>
-          <itunes:author><%= podcast.author %></itunes:author>
+          <itunes:explicit><%= @podcast.explicit ? "yes" : "no" %></itunes:explicit>
+          <itunes:author><%= @podcast.author %></itunes:author>
           <itunes:subtitle><%= episode.title %></itunes:subtitle>
-          <enclosure url="<%= podcast.episode_media_url(episode, current_format) %>" length="<%= episode.media[current_format.format]["size"] %>" type="<%= current_format.mime_type %>"/>
+          <enclosure url="<%= @podcast.episode_media_url(episode, @format) %>" length="<%= episode.media[@format.format]["size"] %>" type="<%= @format.mime_type %>"/>
           <guid isPermaLink="false"><%= episode.handle %></guid>
           <pubDate><%= episode.rfc_2822_date %></pubDate>
           <itunes:duration><%= episode.duration %></itunes:duration>
           <itunes:summary><![CDATA[<%= episode.summary %>]]></itunes:summary>
-          <description><![CDATA[<%= episode.description %>]]></description>
-          <atom:link rel="http://podlove.org/deep-link" href="<%= podcast.deep_link_url(episode) %>" />
+          <description><![CDATA[<%= render_as_markdown episode.summary %>]]></description>
+          <atom:link rel="http://podlove.org/deep-link" href="<%= @podcast.deep_link_url(episode) %>" />
         </item>
         <% end %>
     </channel>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gst-kitchen
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: gst-kitchen is a gem to publish podcasts like a nerd with auphonic!
 email:
 - sebastian.cohnen@gmx.net
@@ -79,11 +95,12 @@ files:
 - lib/gst-kitchen/auphonic/account.rb
 - lib/gst-kitchen/auphonic/production.rb
 - lib/gst-kitchen/episode.rb
+- lib/gst-kitchen/feed.rb
 - lib/gst-kitchen/media.rb
 - lib/gst-kitchen/podcast.rb
 - lib/gst-kitchen/version.rb
 - templates/episodes.rss.erb
-homepage: ''
+homepage: http://github.com/tisba/gst-kitchen
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -97,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -203743376280899826
+      hash: 1700055491858221400
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -203743376280899826
+      hash: 1700055491858221400
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24