podcastinator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21da3fceb4c3af6e6e5ef5f14f140e794542b492
+  data.tar.gz: 1f81cf0e6eb0ffaf13631f919101abe1594d25da
+SHA512:
+  metadata.gz: 8cfd8c97c41820482c3ab8176517a873b2ab1a0071997f3fa0796818c7c92ae84d5950c0c4f73bcdb208d8972773a258c5f32c7813d531435ae0429d4fb89e08
+  data.tar.gz: 6580d5ad9c0a6ab5f932d77efc0307a4e5dfa5dade9ef45fcbc6e15edde0356f7ee9a0e2debefbead1a6441546773541fbc88ef253f4e43f33e34a5390fcf069

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in podcastinator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex McHale
+
+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,29 @@
+# Podcastinator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'podcastinator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install podcastinator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/podcastinator/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/podcastinator

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "podcastinator"
+Podcastinator.start

data/lib/podcastinator.rb

@@ -0,0 +1,60 @@
+require "optparse"
+require "erb"
+require "digest/md5"
+require "time"
+require "date"
+require "pp"
+require "yaml"
+require "uri"
+
+require "nokogiri"
+require "taglib"
+require "mime-types"
+
+require "podcastinator/version"
+require "podcastinator/extensions"
+require "podcastinator/feed"
+require "podcastinator/generator"
+
+module Podcastinator
+
+  def self.start(options = self.parse_cli_options)
+    feed = Podcastinator::Feed.new(options)
+    puts Podcastinator::Generator.new(feed).to_xml
+  end
+
+  def self.parse_cli_options
+    options = {
+      :path => Dir.pwd,
+    }
+
+    OptionParser.new do |opts|
+      opts.banner = "Usage: podcastinator [options] [audio files ...]"
+
+      opts.on("-o", "--output [FILENAME]", "Write the XML to the specified file") do |filename|
+        options[:output] = filename
+      end
+
+      opts.on("-r", "--root [PATH]", "The root path in the URL to access the audio files") do |path|
+        options[:path] = path
+      end
+    end.parse!
+
+    add_channel_yml(options)
+
+    options
+  end
+
+  def self.add_channel_yml(options)
+    yml_filename = File.join(options[:path], "channel.yml")
+    return unless File.file? yml_filename
+
+    yml_content = File.read(yml_filename)
+    yml_hash    = YAML.load(yml_content)
+
+    yml_hash.each do |key, value|
+      options[key.to_sym] ||= value
+    end
+  end
+
+end

data/lib/podcastinator/extensions.rb

@@ -0,0 +1,15 @@
+class Object
+
+  def present?
+    !blank?
+  end
+
+  def blank?
+    return true if self == nil
+    return true if kind_of?(String) && self =~ /\A\s*\z/
+    return true if respond_to?(:length) && length == 0
+    return true if to_s.length == 0
+    return false
+  end
+
+end

data/lib/podcastinator/feed.rb

@@ -0,0 +1,149 @@
+module Podcastinator
+
+  class Feed
+
+    attr_reader *%i(
+      title
+      url
+      description
+      language
+      copyright
+      subtitle
+      author
+      image_url
+      keywords
+      owner
+      items
+      local_path
+    )
+
+    def initialize(options = {})
+      @title       = options[:title]
+      @url         = options[:url]
+      @local_path  = options[:path]
+      @description = options[:description]
+      @language    = options[:language]
+      @copyright   = options[:copyright]
+      @subtitle    = options[:subtitle]
+      @author      = options[:author]
+      @image_url   = options[:image_url]
+      @keywords    = options[:keywords]
+      @owner       = Owner.build(options[:owner_name], options[:owner_email])
+
+      @items =
+        Dir.chdir(local_path) do
+          Dir[*Item.globs].uniq.map do |filename|
+            Item.new(self, filename)
+          end
+        end
+    end
+
+    class Owner < Struct.new(:name, :email)
+
+      def self.build(name, email)
+        new(name, email) if name.present? || email.present?
+      end
+
+    end
+
+    class Item
+
+      attr_reader *%i(
+        author
+        filename
+        image_url
+        local_filename
+        subtitle
+        time
+        title
+        url
+        file_size
+        mime_type
+        duration
+      )
+
+      def initialize(feed, filename)
+        @feed           = feed
+        @filename       = filename
+        @local_filename = File.join(feed.local_path, filename)
+        @url            = "#{ feed.url }/#{ URI.escape @filename.to_s }".gsub("//", "/")
+
+        @image_url =
+          if File.file? File.join(feed.local_path, "#{ filename }.jpg")
+            "#{ @url }.jpg"
+          else
+            feed.image_url
+          end
+
+        TagLib::FileRef.open(local_filename) do |fileref|
+          tag      = fileref.tag
+
+          @title    = tag.title
+          @author   = tag.artist
+          @album    = tag.album
+          @track    = if tag.track.present? && tag.track != 0 then tag.to_s.track[/^\d+/] end
+          @subtitle = if author.present? && @track.present? then %[#{ album } ##{ track }] end
+          @duration = fileref.audio_properties.length
+        end
+      end
+
+      def mime_type
+        case File.extname(filename).downcase
+        when ".mp3" then "audio/mpeg"
+        else raise UnknownMimeType, "podcastinator can't handle #{ filename }"
+        end
+      end
+
+      def guid
+        md5 = Digest::MD5.new
+
+        File.open(local_filename, 'rb') do |io|
+          while (buf = io.read(4096)) && (buf.length > 0)
+            md5.update(buf)
+          end
+        end
+
+        md5.to_s
+      end
+
+      def time
+        @time || File.mtime(local_filename)
+      end
+
+      def keywords
+        []
+      end
+
+      def self.mime_types
+        {
+          "mp3" => "audio/mpeg",
+        }
+      end
+
+      def self.globs
+        mime_types.keys.map { |ext| "**/*.#{ ext }" }
+      end
+
+      def self.build(feed, files)
+        files.map do |filename|
+          title, subtitle, author, time, image_url = nil
+
+          TagLib::FileRef.open(local_filename) do |fileref|
+            tag      = fileref.tag
+
+            title    = tag.title
+            author   = tag.artist
+            album    = tag.album
+            track    = if tag.track.present? && tag.track != 0 then tag.to_s.track[/^\d+/] end
+            subtitle = if album.present? && track.present? then %[#{ album } ##{ track }] end
+          end
+
+          new(feed, filename, title, subtitle, author, time, image_url)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/podcastinator/generator.rb

@@ -0,0 +1,68 @@
+module Podcastinator
+
+  class Generator
+
+    attr_accessor :feed
+
+    def initialize(feed)
+      @feed = feed
+    end
+
+    def xml_builder
+      Nokogiri::XML::Builder.new do |xml|
+        xml.rss("xmlns:itunes" => "http://www.itunes.com/dtds/podcast-1.0.dtd", "version" => "2.0") do
+          xml.channel do
+            # Required channel attributes
+            xml.title feed.title
+            xml.link feed.url
+            xml.description feed.description
+            xml["itunes"].summary feed.description
+            xml["itunes"].image(href: feed.image_url)
+            xml.generator "Podcastinator #{ Podcastinator::VERSION }"
+
+            # Optional channel attributes
+            xml.language feed.language if feed.language.present?
+            xml.copyright feed.copyright if feed.copyright.present?
+            xml.subtitle feed.subtitle if feed.subtitle.present?
+            xml.author feed.author if feed.author.present?
+            xml["itunes"].keywords feed.keywords.join(",") if feed.keywords.present?
+
+            # Owner details
+            if feed.owner
+              xml["itunes"].owner do
+                xml["itunes"].name feed.owner.name
+                xml["itunes"].email feed.owner.email
+              end
+            end
+
+            # Category details
+
+            # Explicit flag
+
+            # Channel items
+            feed.items.each do |item|
+              xml.item do
+                xml.title item.title
+                xml["itunes"].author item.author
+                xml["itunes"].subtitle item.subtitle if item.subtitle.present?
+                xml["itunes"].summary item.subtitle if item.subtitle.present?
+                xml["itunes"].image(href: if item.image_url.present? then item.image_url else feed.image_url end)
+                xml.enclosure(url: item.url, length: item.file_size, type: item.mime_type)
+                xml.guid(item.guid, isPermaLink: "false")
+                xml.pubDate item.time.iso8601
+                xml["itunes"].duration item.duration.to_i
+                xml["itunes"].keywords item.keywords.join(",") if item.keywords.present?
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def to_xml
+      xml_builder.to_xml
+    end
+
+  end
+
+end

data/lib/podcastinator/version.rb

@@ -0,0 +1,3 @@
+module Podcastinator
+  VERSION = "0.0.1"
+end

data/podcastinator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'podcastinator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "podcastinator"
+  spec.version       = Podcastinator::VERSION
+  spec.authors       = ["Alex McHale"]
+  spec.email         = ["alex@anticlever.com"]
+  spec.summary       = %q{A ruby library for generating podcast feeds.}
+  spec.description   = %q{A ruby library for generating podcast feeds from a source or via an API.}
+  spec.homepage      = "http://github.com/alexmchale/podcastinator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "taglib", "~> 0.6"
+  spec.add_dependency "mime-types", "~> 2.3"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: podcastinator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex McHale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: taglib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: A ruby library for generating podcast feeds from a source or via an API.
+email:
+- alex@anticlever.com
+executables:
+- podcastinator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/podcastinator
+- lib/podcastinator.rb
+- lib/podcastinator/extensions.rb
+- lib/podcastinator/feed.rb
+- lib/podcastinator/generator.rb
+- lib/podcastinator/version.rb
+- podcastinator.gemspec
+homepage: http://github.com/alexmchale/podcastinator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby library for generating podcast feeds.
+test_files: []
+has_rdoc: