gst-kitchen 0.2.0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# my playground
+sandbox.rb
+media
+episodes
+episodes*rss
+podcast.yml

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+ruby "1.9.3"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sebastian Cohnen
+
+MIT License
+
+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.md

@@ -0,0 +1,87 @@
+# Geekstammtisch's Podcast Kitchen (gst-kitchen)
+
+    Publishing podcats like a nerd!
+
+This gem helps you to publish podcasts using Auphonic. It can fetch a list of Auphonic productions using
+their API. You can add episodes and generate seperated feeds per audio format.
+
+The Geekstammtisch website and this gem is inspired by [fanboys-IGOR] [igor].
+
+**Note** that there might be some Geekstammtisch specific behavior left in this gem. If you find something,
+drop me a note!
+
+
+## Installation
+
+Add this line to your application's Gem file:
+
+    gem 'gst-kitchen'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gst-kitchen
+
+
+## Conventions
+
+gst-kitchen assumes various conventions about (file) naming and URLs.
+
+* feeds: feeds must be located at: `<website_url>/episodes.<format_file_ext>.rss`, e.g. `http://geekstammtisch.de/episodes.m4a.rss`
+* episode media files must be located at: `<media_url>/<downcased handle><padded episode_nr>.<format_file_ext>`, e.g. `http://media.geekstammtisch.de/episodes/gst000.m4a`
+
+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.
+
+
+## Usage
+
+First you need to place your Auphonic credentials as JSON into `~/.auphonic`:
+
+    echo '{"user": "joe@example.com", "pass": "secret"}' > ~/.auphonic
+
+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`.
+* 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
+
+
+### CLI Usage
+
+Get a list of all Auphonic productions
+
+    $ gst-kitchen list
+
+Add a production to the podcast
+
+    $ gst-kitchen process --uuid=<PRODUCTION-UUID>
+
+Render all configured feeds based on all episodes in `episodes/`
+
+    $ gst-kitchen feeds
+    
+
+### API Usage
+
+**TBD**
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+[igor]: https://github.com/m4p/fanboys-IGOR "IGOR"

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gst-kitchen

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require "trollop"
+require "gst-kitchen"
+require "gst-kitchen/version"
+
+require "fileutils"
+
+SUB_COMMANDS = %w(feed process list version)
+global_opts = Trollop::options do
+  banner "magic file deleting and copying utility"
+  opt :podcast, "path of podcast YAML specification", :default => "podcast.yml"
+  stop_on SUB_COMMANDS
+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|
+    puts "#{production.meta["uuid"]} => #{production.meta["metadata"]["title"]}"
+  end
+
+when "process"
+  subcmd_opts = Trollop::options do
+    opt :uuid, "Auphonic's production UUID", :type => :string
+  end
+  production = Auphonic::Account.init_from_system.production(subcmd_opts[:uuid])
+
+  podcast = Podcast.from_yaml("podcast.yml")
+  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)
+else
+  Trollop::die "unknown subcommand #{subcmd.inspect}"
+end

data/gst-kitchen.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gst-kitchen/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gst-kitchen"
+  gem.version       = GstKitchen::VERSION
+  gem.authors       = ["Sebastian Cohnen"]
+  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.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "yajl-ruby"
+  gem.add_dependency "trollop"
+  gem.add_dependency "rake"
+end

data/lib/gst-kitchen.rb

@@ -0,0 +1,18 @@
+require "erb"
+require "time"
+require "uri"
+
+require "yajl"
+require "yaml"
+
+require "gst-kitchen/version"
+require "gst-kitchen/podcast"
+require "gst-kitchen/episode"
+require "gst-kitchen/media"
+
+require "gst-kitchen/auphonic"
+require "gst-kitchen/auphonic/production"
+require "gst-kitchen/auphonic/account"
+
+module GstKitchen
+end

data/lib/gst-kitchen/auphonic.rb

@@ -0,0 +1,2 @@
+module Auphonic
+end

data/lib/gst-kitchen/auphonic/account.rb

@@ -0,0 +1,33 @@
+class Auphonic::Account
+  attr_reader :username, :password
+
+  def self.init_from_system
+    auphonic_credentials = Yajl::Parser.parse(File.read(File.expand_path("~/.auphonic")))
+    self.new(auphonic_credentials)
+  end
+
+  def initialize(options={})
+    @username = options["user"]
+    @password = options["pass"]
+  end
+
+  def production(uuid)
+    Auphonic::Production.new(self, uuid)
+  end
+
+  def productions
+    request("https://auphonic.com/api/productions.json")["data"].map do |meta|
+      production = Auphonic::Production.new(self)
+      production.meta = meta
+      production
+    end
+  end
+
+
+  private
+
+  def request(url)
+    json = open(url, http_basic_authentication: [username, password])
+    Yajl::Parser.parse(json.read)
+  end
+end

data/lib/gst-kitchen/auphonic/production.rb

@@ -0,0 +1,22 @@
+require "open-uri"
+
+class Auphonic::Production
+  attr_accessor :meta
+
+  def initialize(account, uuid=nil)
+    @account = account
+    fetch uuid if uuid
+  end
+
+
+  private
+
+  def fetch(uuid)
+    @meta = request("https://auphonic.com/api/production/#{uuid}.json")
+  end
+
+  def request(url)
+    json = open(url, http_basic_authentication: [@account.username, @account.password])
+    Yajl::Parser.parse(json.read)
+  end
+end

data/lib/gst-kitchen/episode.rb

@@ -0,0 +1,74 @@
+class Episode < Struct.new(:number, :name, :length, :media, :auphonic_uuid, :published_at, :summary, :description)
+  include Comparable
+
+  def self.from_auphonic(production)
+    data = production.meta
+    /GST(?<number>\d{3})/ =~ data["data"]["metadata"]["title"]
+
+    metadata = {
+      auphonic_uuid: data["data"]["uuid"],
+      number: number.to_i,
+      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|
+      obj[item["format"]] = {
+        "size" => item["size"],
+        "file_ext" => item["ending"]
+      }
+    end
+
+    episode = self.new
+
+    episode.number = metadata[:number]
+    episode.name   = metadata[:name]
+    episode.length = metadata[:length].round
+    episode.auphonic_uuid = metadata[:auphonic_uuid]
+    episode.published_at = Time.now
+    episode.summary = metadata[:summary]
+    episode.description = metadata[:description]
+    episode.media = media
+
+    episode
+  end
+
+  def self.from_yaml(yaml_file)
+    YAML.load_file(yaml_file)
+  end
+
+  def initialize(*args)
+    super
+  end
+
+  def <=>(other)
+    self.number <=> other.number
+  end
+
+  def title
+    "#{handle} - #{name}"
+  end
+
+  def handle
+    "GST#{"%03i" % self.number}"
+  end
+
+  def rfc_2822_date
+    self.published_at.rfc2822
+  end
+
+  def duration
+    hours = length / (60 * 60)
+    minutes = (length - hours * 60 * 60) / 60
+    seconds = length % 60
+
+    "#{"%02i" % hours}:#{"%02i" % minutes}:#{"%02i" % seconds}"
+  end
+
+  def to_s
+    "#{title} (#{duration}) https://auphonic.com/engine/status/#{auphonic_uuid}"
+  end
+end
+

data/lib/gst-kitchen/media.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+
+class Media
+  class Format < Struct.new(:format, :file_ext, :mime_type)
+    Mp3 = self.new("mp3", "mp3", "audio/mpeg")
+    M4a = self.new("aac", "m4a", "audio/x-m4a")
+  end
+
+  def self.format(format)
+    case format
+    when :m4a_aac then Media::Format::M4a
+    when :mp3_mp3 then Media::Format::Mp3
+    end
+  end
+
+  def initialize(file)
+    @file = file
+    @md5_digest = Digest::MD5.file(@file).hexdigest.force_encoding("UTF-8")
+  end
+
+  def length
+    media_info["length"].to_i
+  end
+
+  def title
+    media_info["title"]
+  end
+
+  def file_size
+    @file_size ||= File.size(@file)
+  end
+
+  def duration
+    return @duration if @duration
+
+    hours = length / (60 * 60)
+    minutes = (length - hours * 60 * 60) / 60
+    seconds = length % 60
+
+    @duration = "#{"%02i" % hours}:#{"%02i" % minutes}:#{"%02i" % seconds}"
+  end
+
+  def aquire_meta_data!
+    [:duration, :file_size].each { |m| send(m) }
+  end
+
+  private
+
+  def media_info
+    return @media_info if @media_info
+
+    @media_info = TagLib::FileRef.open(@file) do |ref|
+      {
+        "title" => ref.tag.title,
+        "length" => ref.audio_properties.length
+      }
+    end
+  end
+end
+

data/lib/gst-kitchen/podcast.rb

@@ -0,0 +1,112 @@
+class Podcast
+  attr_accessor :title,
+                :subtitle,
+                :author,
+                :email,
+                :language,
+                :summary,
+                :handle,
+                :website,
+                :cover,
+                :media_url,
+                :episodes,
+                :explicit,
+                :rss_output_path,
+                :episodes_path
+
+  attr_accessor :formats
+
+  def self.from_yaml(yaml_file="podcast.yml")
+    hash = YAML.load_file(yaml_file)
+
+    podcast = self.new
+    podcast.title = hash["title"]
+    podcast.subtitle = hash["subtitle"]
+    podcast.author = hash["author"]
+    podcast.email = hash["email"]
+    podcast.language = hash["language"]
+    podcast.summary = hash["summary"]
+    podcast.handle = hash["handle"]
+    podcast.website = hash["website"]
+    podcast.cover = hash["cover"]
+    podcast.media_url = hash["media_url"]
+    podcast.explicit = hash["explicit"] || false
+    podcast.formats = hash["formats"].map { |format| Media.format(format) }
+    podcast.episodes_path = hash["episodes_path"] || "episodes/"
+    podcast.rss_output_path = hash["rss_output_path"] || "."
+
+    podcast.load_episodes
+
+    podcast
+  end
+
+  def load_episodes
+    self.episodes = Dir[File.join(self.episodes_path, "#{handle.downcase}*.yml")].map do |yml|
+      Episode.from_yaml(yml)
+    end
+  end
+
+  def create_episode_from_auphonic(production)
+    Episode.from_auphonic production
+  end
+
+  def feed_url(format)
+    url = URI(self.website)
+    url.path = "/#{rss_file(format)}"
+    url.to_s
+  end
+
+  def episode_media_url(episode, format)
+    url = URI(self.media_url)
+    url.path += "/#{episode.handle.downcase}.#{format.file_ext}"
+    url.to_s
+  end
+
+  def cover_url
+    url = URI(self.website)
+    url.path = self.cover
+    url.to_s
+  end
+
+  def deep_link_url(episode)
+    url = URI(self.website)
+    url.fragment = "#{episode.number}:"
+    url.to_s
+  end
+
+  def 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"))
+    File.open(File.join(rss_output_path, rss_file(format)), "w") do |rss|
+      rss.write template.result(binding)
+    end
+  end
+
+  def export_episode(episode)
+    destination = File.join(episodes_path, "#{episode.handle.downcase}.yml")
+    File.open(destination, "w") { |file| file.write episode.to_yaml}
+  end
+
+  def render_all_feeds
+    self.formats.each do |format|
+      render_feed(format)
+    end
+  end
+
+  def other_formats(format)
+    self.formats - [format]
+  end
+
+  private
+  def rss_file(format)
+    "episodes.#{format.file_ext}.rss"
+  end
+end

data/lib/gst-kitchen/version.rb

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

data/templates/episodes.rss.erb

@@ -0,0 +1,50 @@
+<?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"/>
+        <% end %>
+        <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>
+        <itunes:owner>
+            <itunes:name><%= podcast.author %></itunes:name>
+            <itunes:email><%= podcast.email %></itunes:email>
+        </itunes:owner>
+
+        <itunes:image href="<%= podcast.cover_url %>"/>
+
+        <itunes:category text="Technology"/>
+        <itunes:category text="Technology">
+            <itunes:category text="Gadgets"/>
+        </itunes:category>
+        <itunes:category text="Technology">
+            <itunes:category text="Tech News"/>
+        </itunes:category>
+
+        <% 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: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 %>"/>
+          <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) %>" />
+        </item>
+        <% end %>
+    </channel>
+</rss>

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: gst-kitchen
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Sebastian Cohnen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  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'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+executables:
+- gst-kitchen
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gst-kitchen
+- gst-kitchen.gemspec
+- lib/gst-kitchen.rb
+- lib/gst-kitchen/auphonic.rb
+- lib/gst-kitchen/auphonic/account.rb
+- lib/gst-kitchen/auphonic/production.rb
+- lib/gst-kitchen/episode.rb
+- lib/gst-kitchen/media.rb
+- lib/gst-kitchen/podcast.rb
+- lib/gst-kitchen/version.rb
+- templates/episodes.rss.erb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -203743376280899826
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -203743376280899826
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: gst-kitchen is a gem to publish podcasts like a nerd with auphonic!
+test_files: []