phonocast 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26f52ab35c4f9e89e7defccaa2f36245df45f03b
+  data.tar.gz: 56555baf255b8d7529b3edfe342a00f791800740
+SHA512:
+  metadata.gz: 3e410449e26d29500072088e4ee0ca200aa5abd75282826a4f0ea9204724118280a1de68d0aa5d528f63d4ebd66df25caade21b45ed2a1d2696990eb39d9c348
+  data.tar.gz: 6429f9701033727a1ec35c9aab6cd4b4e82bfb8b3c7c76b63186c8b9fdf5057ce7553370bc703357f62ba1b7a37885e38862aa5d2d04161b2be23baac042847e

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alex Blom
+
+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,86 @@
+# Phonocast
+
+Phonocast is a gem to convert local audio files to a podcast feed, which
+can then be deployed on your own server or even Dropbox.
+
+*Motivation:*
+[http://dancarlin.com/product/hardcore-history-compilation-episodes-1-39](http://dancarlin.com/product/hardcore-history-compilation-episodes-1-39) with [https://overcast.fm](https://overcast.fm)'s 2x speed.
+
+## Installation
+
+gem install #TODO
+
+## Usage
+
+### Generating an RSS Feed:
+
+``
+phonocast create_feed
+``
+
+### Setup Yaml Config
+
+Instead of passing the same arguments to the CLI each time, you can
+store them ina  YAML file. The YAML file also provides configuration
+options not available by the CLI.
+
+To generate the YAML file:
+``
+phonocast setup
+``
+
+## Feed Config Options.
+
+Options can be set by YAML or CLI arguments. The order of
+precedence is:
+
+DEFAULTS -> YAML -> CLI Arguments.
+
+So if you have YAML.title = "Title 1" and CLI.title = "Title 2", the
+title used will be "Title 2". Generally speaking, store your config in YAML and use CLI arguments for
+one off overrides.
+
+All itunes\_ tags correspond to iTunes RSS spec.
+
+| Name            | CLI | YAML |  Desc            |
+| -------------   | --- | ---- | ---------------- |
+| base_url        | Y   | Y    | Url where audio files are hosted, e.g. myserver.com/podcasts or mypublicdropbox.com. Defaults to link. |
+| rss_path        | Y   | Y    | Location and name of generated rss file. Default: ./phonocast.rss |
+| file_path       | Y   | Y    | Where are local audio files? Default: ./ |
+| image_path      | N   | Y    | Podcast log. base_url/image_path. Channel level. |
+| title           | Y   | Y    | Title of Podcast |
+| link            | Y   | Y    | Channel level link (e.g. mypodcast.com) |
+| yaml_path       | Y   | Y    | Location of YAML file for config. Default: ./phonocast.yaml |
+| copyright       | N   | Y    | Channel level |
+| language        | N   | Y    | Channel level |
+| description     | N   | Y    | Channel level |
+| author          | N   | Y    | Channel level |
+| itunes_block    | N   | Y    | Channel level |
+| itunes_explicit | N   | Y    | Channel level |
+| itunes_keywords | N   | Y    | Channel level |
+| itunes_subtitle | N   | Y    | Defaults to description. |
+| itunes_summary  | N   | Y    | Defaults to description. |
+
+## Deployment
+
+### Private Server:
+``
+scp -r . server:/path
+``
+
+### Dropbox:
+Drag and drop to Dropbox Public folder and set base_url appropriately.
+
+## Contributing
+
+Contributions welcome. Please open pull requests and include tests.
+
+Need contribution ideas?
+
+``
+grep -rni todo lib/
+``
+
+## Copyright
+
+Copyright (c) 2015 Alex Blom. See LICENSE for further details.

data/bin/phonocast

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'phonocast'
+
+class PhonocastCLI < Thor
+
+  desc "setup", "Init phonocast.yaml file"
+  long_desc <<-LONGDESC
+    Description:
+      Creates ./phonocast.yaml file, which can store values if you re-generate your feed.
+  LONGDESC
+  def setup_yaml
+    client = Phonocast::Client.new
+    client.setup_yaml
+  end
+
+  desc "create_feed", "Generate RSS Feed"
+  long_desc <<-LONGDESC
+      Create phonocast.rss file for podcast.
+
+      Config will load from DEFAULTS -> yaml_path -> CLI
+
+      Not all YAML keys are configurable by the CLI
+  LONGDESC
+  option :base_url, :required => false,
+    :description => 'where are files hosted? (e.g. myserver.com/data)'
+
+  option :target, :required => false,
+                  :description => "set rss file target"
+
+  option :file_path, :required => false,
+                     :description => "where are local files"
+
+  option :title, :required => false,
+                 :description => "Title of Podcast Channel"
+
+  option :link, :required => false,
+                :description => "Channel level link"
+
+  option :yaml_path, :required => false,
+                     :description => "Location of phonocast.yaml. Use if you don't want to repeat CLI commands"
+  def create_feed
+    client = Phonocast::Client.new(options.to_h)
+    client.create_feed
+  end
+end
+
+PhonocastCLI.start

data/lib/phonocast.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+
+module Phonocast
+  require 'phonocast/client'
+  require 'phonocast/channel'
+  require 'phonocast/item'
+  require 'phonocast/configuration'
+
+  VERSION = "0.1.1"
+end

data/lib/phonocast/channel.rb

@@ -0,0 +1,112 @@
+require 'rss/2.0'
+require 'rss/itunes'
+
+class Phonocast::Channel
+
+  #A Channel represents a Podcast Channel
+  #  (e.g. Hardcore History)
+  #
+  #A channel has many items (shows)
+
+  attr_accessor :title,
+                :file_path,
+                :rss_path,
+                :description,
+                :link,
+                :image_url,
+                :base_url,
+                :copyright,
+                :items,
+                :language,
+                :author,
+                :itunes_block,
+                :itunes_explicit,
+                :itunes_keywords,
+                :itunes_subtitle,
+                :itunes_summary
+
+  ALLOWED_EXTENSIONS = ['*.m4a',
+                        '*.mp3' ,
+                        '*.mov',
+                        '*.mp4',
+                        '*.m4v',
+                        '*.pdf',
+                        '*.epub']
+
+  def initialize(config)
+    validate_config(config)
+
+    @title = config.title
+    @file_path = config.file_path
+    @rss_path = config.rss_path
+    @description = config.description
+    @link = config.link
+    @base_url = config.base_url || @link
+    @copyright = config.copyright
+    @author = config.author
+    @itunes_subtitle = config.itunes_subtitle
+    @itunes_summary = config.itunes_summary
+    @language = config.language
+    @itunes_block = config.itunes_block
+
+    @image_url = "#{@base_url}/#{config.image_path}" if config.image_path
+
+    @items = []
+    init_items
+  end
+
+  #title, link & description req for rss output
+  def rss
+    rss = RSS::Rss.new("2.0")
+    channel = RSS::Rss::Channel.new
+
+    channel.title = @title
+    channel.link = @link
+    channel.description = @description
+    channel.generator = "Phonocast #{Phonocast::VERSION}"
+    #channel.author = @author
+    channel.itunes_image = RSS::ITunesChannelModel::ITunesImage.new(@image_url)
+    channel.itunes_subtitle = @itunes_subtitle
+    channel.itunes_summary = @itunes_summary
+
+    @items.each do |item|
+      channel.items << item.rss
+    end
+
+    rss.channel = channel
+
+    return rss.to_s
+  end
+
+  private
+    def validate_config(config)
+      if !config.base_url
+        warn "Warning: No base_url. Download links probably won't work"
+      end
+
+      [config.description,
+       config.title,
+       config.link].each do |key|
+         if !key || key.length < 1
+           raise ArgumentError.new("#{key} must be >1 char")
+         end
+       end
+    end
+
+    def init_items
+      podcast_files = collect_podcast_files(@file_path)
+      podcast_files.each do |file_name|
+        path = File.join(@file_path, file_name)
+        @items.push(Phonocast::Item.new(path, @base_url))
+      end
+    end
+
+    def collect_podcast_files(file_path)
+      podcast_files = []
+      Dir.chdir(file_path) do
+        podcast_files = Dir.glob(ALLOWED_EXTENSIONS)
+      end
+
+      return podcast_files
+    end
+end

data/lib/phonocast/client.rb

@@ -0,0 +1,40 @@
+class Phonocast::Client
+
+  #A Client is how you interact with Phonocast
+  #  (via CLI in 99% of cases)
+  #
+  #Pass a Client configuration opts
+  #  Phonocast::Client.new(configuration)
+
+  attr_accessor :configuration, :channel
+
+  def initialize(opts={})
+    configuration(opts)
+  end
+
+  def configuration(opts={})
+    @configuration ||= Phonocast::Configuration.new(opts)
+  end
+
+  def configuration=(opts={})
+    @configuration = Phonocast::Configuration.new(opts)
+  end
+
+  def channel
+    @channel ||= Phonocast::Channel.new(configuration)
+    @channel
+  end
+
+  def setup_yaml
+    File.open('phonocast.yaml', 'w') do |f|
+      f.write(Phonocast::Configuration::DEFAULTS.to_yaml)
+    end
+  end
+
+  def create_feed
+    File.open(channel.rss_path, "w") do |f|
+      f.write(channel.rss.to_s)
+    end
+  end
+
+end

data/lib/phonocast/configuration.rb

@@ -0,0 +1,66 @@
+require 'yaml'
+
+class Phonocast::Configuration
+
+  CONFIGURABLE_KEYS = %i( base_url
+                          file_path
+                          rss_path
+                          image_path
+                          title
+                          link
+                          copyright
+                          language
+                          description
+                          author
+                          itunes_block
+                          itunes_explicit
+                          itunes_keywords
+                          itunes_subtitle
+                          itunes_summary )
+
+   DEFAULTS = {
+    title:       'Phonocast Powered Podcast',
+    link:        'https://github.com/alexblom/phonocast',
+    file_path:   './',
+    description: " ",
+    rss_path:    "./phonocast.rss"
+   }
+
+  def initialize(opts={})
+    #attr_accessor for each CONFIGURABLE_KEY
+    setup_attr_accessors
+
+    #Start with a default config
+    config = DEFAULTS.clone
+
+    #YAML takes precedence to DEFAULTS
+    yaml_path = opts.delete(:yaml_path) || 'phonocast.yaml'
+    if File.exists?(yaml_path)
+
+      yaml = YAML.load_file(yaml_path)
+      yaml.keys.each do |key|
+        yaml[(key.to_sym rescue key) || key] = yaml.delete(key)
+      end
+
+      config.merge!(yaml)
+    end
+
+    #opts take precedence to YAML
+    config.merge!(opts)
+
+    set_instance_variables(config)
+  end
+
+  private
+    def setup_attr_accessors
+      CONFIGURABLE_KEYS.each do |key|
+        self.class.__send__(:attr_accessor, key)
+      end
+    end
+
+    def set_instance_variables(config)
+      CONFIGURABLE_KEYS.each do |key|
+        instance_variable_set("@#{key.to_s}", config[key])
+      end
+    end
+end

data/lib/phonocast/item.rb

@@ -0,0 +1,47 @@
+require 'mp3info'
+
+require 'rss/2.0'
+require 'rss/itunes'
+
+class Phonocast::Item
+
+  attr_accessor :title,
+                :published,
+                :link,
+                :author,
+                :file_size,
+                :itunes_duration
+
+  def initialize(path, base_url, author_override=nil)
+    mp3 = Mp3Info.open(path)
+    file = File.open(path)
+    file_name = File.basename path
+
+    @itunes_duration = mp3.length
+    @file_size = file.size
+    @link = "#{base_url}/#{file_name}"
+
+    mp3.tag.title ? @title = mp3.tag.title : @title = file_name
+    author_override ? @author = author_override : @author = mp3.tag.artist
+    mp3.tag2["TDR"] ? @published = mp3.tag2["TDR"] : @published = file.mtime
+  end
+
+  def rss
+    item = RSS::Rss::Channel::Item.new
+
+    item.title = @title
+    item.author = @author
+    item.pubDate = @published
+
+    item.guid = RSS::Rss::Channel::Item::Guid.new
+    item.guid.content = @link
+    item.guid.isPermaLink = true
+
+    item.enclosure = RSS::Rss::Channel::Item::Enclosure.new
+    item.enclosure.url = @link
+    item.enclosure.type = "audio/mp3"
+    item.enclosure.length = @file_size
+
+    return item
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: phonocast
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alex Blom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-mp3info
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create a Podcast feed from mp3 files
+email: alex@alexblom.com
+executables:
+- phonocast
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/phonocast
+- lib/phonocast.rb
+- lib/phonocast/channel.rb
+- lib/phonocast/client.rb
+- lib/phonocast/configuration.rb
+- lib/phonocast/item.rb
+homepage: https://github.com/AlexBlom/phonocast
+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: Create a Podcast Feed from mp3 files
+test_files: []
+has_rdoc: