tisba / gst-kitchen

geekstammtisch's kitchen to brew podcasts with auphonic!

Hi there 👋

gst-kitchen's Issues

undefined local variable or method `number' for Episode

I just tried to import my first auphonic file, but I got this exception:

/usr/local/opt/rbenv/versions/1.9.3-p392/lib/ruby/gems/1.9.1/gems/gst-kitchen-0.6.1/lib/gst-kitchen/episode.rb:12:in `from_auphonic': undefined local variable or method `number' for Episode:Class (NameError)
from /usr/local/opt/rbenv/versions/1.9.3-p392/lib/ruby/gems/1.9.1/gems/gst-kitchen-0.6.1/lib/gst-kitchen/podcast.rb:50:in `create_episode_from_auphonic'
from /usr/local/opt/rbenv/versions/1.9.3-p392/lib/ruby/gems/1.9.1/gems/gst-kitchen-0.6.1/bin/gst-kitchen:40:in `<top (required)>'
from /usr/local/opt/rbenv/versions/1.9.3-p392/bin/gst-kitchen:23:in `load'
from /usr/local/opt/rbenv/versions/1.9.3-p392/bin/gst-kitchen:23:in `<main>'

Episode Yaml contains too much data

Every episode.yml contains the whole serialized podcast with every episode

Access episode subtitle from auphonic data

Currently it is not possible to access the episode subtitle. We use that field as a short description for each episode

Do not hardcode gst in stats command

The stats command assumes that the files are named gstXXX.ext instead it should use podcast.handle.downcase

More GST-workflow specific stuff?

episode.rb:8 looks like this:

/#{podcast.handle}(?<number>\d{3})/ =~ data["data"]["metadata"]["title"]

I don't quite understand what ?<number> means, I have never seen that kind of regex magic before. It seems that this should save the number-string to the number variable, however on my system this does not seem to work. I get an error on line 14 telling me that number is not defined. Could you please clarify?

Also, episode.rb:27 reads:

episode = self.new

But I think it should be

episode = self.new(podcast)

because I'm getting an error on line 66, saying podcast is nil.

stats subcommand does not support opus format

Despite the opus audio format being defined in the Media class, it is not being accounted for in the stats subcommand, which only supports mp3 and m4a.

Use auphonic result urls instead of creating urls manually

Our files are named differently and therefore your manual url creation does not work for us. It would be better to use the urls that auphonic is sending in the production json

Shownotes in a separate file

Store two versions of the shownotes (long -> Page, short -> RSS Feed) in separate markdown files and use those to render page and rss feed (example: gst001.mp4, gst001-shownotes.md, gst002-shortnotes.md)

GST-specific behaviour

We would like to use your gem to publish our podcast, but I just found some GST-specific stuff:

episode.rb:6

/GST(?<number>\d{3})/ =~ data["data"]["metadata"]["title"]

episode.rb:53

"GST#{"%03i" % self.number}"

Also, are you going to include pushing stuff to Auphonic into the gem? If not, we might be interested in trying to do this. It would mean to write parts of the episode YAML-file beforehand, to give Auphonic the necessary metadata.

Let the user create a feed template

The template should not be hardcoded in the gst-kitchen tool (especially with hardcoded categories)

Add flattr to rss feed

Instacast and other podcasting clients show a Flattr button inside of the player if a Flatter link is provided in the rss feed.

The definition for this can be found here : http://developers.flattr.net/feed/

It would be great if this link could be configured in the podcast.yaml file

gst-kitchen init command

A lot of the steps described in the README could be moved to an gst-kitchen init command It could either generate example files or ask for the information in an interactive mode.

What do you think?

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can image, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post aobut this project for more information.