audio-feed-manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ed5834bc31327d2e1dfe53b430279a4fda081dd
+  data.tar.gz: 4e40fb4b0950e64972a3f5f87f28520ca0372e26
+SHA512:
+  metadata.gz: 1a86780dfbdd3f331623546d7d6c496a3d62056922ed6945693cd98b7e0bffa3c810c0d1a9b99afec86a5ddb947138288d23815cb48f842187cfa9e8cdf97b27
+  data.tar.gz: c35007e7d9f6ce772f543a706799fbb474aa4c59e47b4106fcdd46ea22a1e2801872230b65d7172d5c784b0e92983ab42d1f49e36b67e8dbbed9c37f2ab414d4

data/.gitignore

@@ -0,0 +1,27 @@
+*.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
+.ruby-version
+.ruby-gemset
+tags
+gems.tags
+spec/s3_credentials.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,17 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard 'ctags-bundler', :binary => 'ctags-exuberant', :src_path => ["lib", "spec"] do
+  watch(/^(app|lib|spec)\/.*\.rb$/)
+  watch('Gemfile.lock')
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Adam Pohorecki
+
+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,86 @@
+# AudioFeedManager
+
+A tool for managing RSS podcast feeds.
+
+## Installation
+
+Install the gem from rubygems:
+
+    $ gem install audio-feed-manager
+
+## Usage
+
+In order to use the app, you will need to perform a couple of steps.
+
+First, you will need to initialize a project (a directory containing the feeds and audio files).
+Then, you will need to add some feeds and some audio files to the feeds.
+Once you're ready, you can deploy the feeds to S3.
+
+### Initial set up
+
+In order to create a directory for the feeds and audio files, you will need to call:
+
+    $ afm init my-project
+
+Where `my-project` is a name of the directory you will want to store the files in.
+
+The command will ask you for some additional information, like the S3 credentials to use.
+
+
+### Adding feeds
+
+In order to add a feed execute the following command (while in a project directory):
+
+    $ afm feeds add "My Feed Title"
+
+This will create a file `feeds/my-feed-title`. This file name is also an identifier of the feed for later use.
+
+You can see the list of created feeds by issuing the following command:
+
+    $ afm feeds list
+
+### Adding audio files
+
+Once you have created your first feed, you can start adding audio files to it:
+
+    $ afm audio add feeds/my-feed-title /path/to/file.mp3
+
+This command will read the title and author from ID3 tags of the MP3 file. If those are not present, it will ask you to provide that information.
+
+### Publishing the feeds
+
+You can publish all of the feeds to S3 using the following command:
+
+    $ afm publish
+
+This will upload all of the MP3 and .xml files to S3.
+
+### Getting an URL for a feed
+
+In order to share a URL to a feed with other people, you can use:
+
+    $ afm feeds get-url feeds/my-feed-title
+
+You can see the URL and other feed details by issuing the following command:
+
+    $ afm feeds show feeds/my-feed-title
+
+### Re-generating RSS file
+
+All of the information about feeds and audio files is stored in plain-text files, so you can use your favorite text editor to change the initially entered details.
+
+For example, to change the order of items in a feed, you can simply edit the items file:
+
+    vim items/my-feed-title
+
+Once you are done with the editing, you will need to re-generate the RSS file for the feed you changed:
+
+    $ afm feeds update-rss feeds/my-feed-title
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/audio-feed-manager/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/audio-feed-manager.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'audio_feed_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "audio-feed-manager"
+  spec.version       = AudioFeedManager::VERSION
+  spec.authors       = ["Adam Pohorecki"]
+  spec.email         = ["adam@gunpowderlabs.com"]
+  spec.summary       = %q{A CLI tool for managing audio RSS feeds}
+  spec.description   = %q{A CLI tool for managing audio RSS feeds}
+  spec.homepage      = "https://github.com/gunpowderlabs/audio-feed-manager"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bogus"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-ctags-bundler"
+
+  spec.add_dependency "dependor"
+  spec.add_dependency "id3tag"
+  spec.add_dependency "aws-sdk", "~> 2"
+end

data/bin/afm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'audio-feed-manager'
+
+AudioFeedManager.run

data/lib/audio-feed-manager.rb

@@ -0,0 +1 @@
+require "audio_feed_manager"

data/lib/audio_feed_manager/application.rb

@@ -0,0 +1,39 @@
+module AudioFeedManager
+  class Application
+    include Dependor::AutoInject
+    look_in_modules AudioFeedManager
+
+    attr_reader :directory, :stdin, :stderr, :stdout
+
+    def initialize(directory:, stdin:, stderr:, stdout:)
+      @directory = Pathname.new(File.expand_path(directory))
+      @stdin = stdin
+      @stderr = stderr
+      @stdout = stdout
+    end
+
+    def self.let(name, &block)
+      define_method(name) do
+        @object_cache ||= {}
+        @object_cache[name] ||= instance_exec(&block)
+      end
+    end
+
+    let(:cli) { inject(CLI) }
+    let(:help) { commands_list }
+    let(:feeds_prefix) { "feeds" }
+    let(:feeds_directory) { directory.join(feeds_prefix) }
+    let(:audio_files_prefix) { "audio_files" }
+    let(:audio_files_directory) { directory.join(audio_files_prefix) }
+    let(:rss_files_prefix) { "rss" }
+    let(:rss_files_directory) { directory.join(rss_files_prefix) }
+    let(:data_files_prefix) { "data" }
+    let(:data_files_directory) { directory.join(data_files_prefix) }
+    let(:items_prefix) { "items" }
+    let(:items_directory) { directory.join(items_prefix) }
+    let(:storage) { file_storage }
+    let(:rss_repository) { inject(RSSRepository) }
+    let(:config_file) { directory.join("config.yml") }
+    let(:config) { config_repository.load(config_file) }
+  end
+end

data/lib/audio_feed_manager/audio_file.rb

@@ -0,0 +1,9 @@
+module AudioFeedManager
+  class AudioFile < Struct.new(:id, :title, :author, :secret_token, :extension, :size, :content_type)
+    include HashConstructor
+
+    def file_name
+      "#{secret_token}#{extension}"
+    end
+  end
+end

data/lib/audio_feed_manager/audio_file_adder.rb

@@ -0,0 +1,14 @@
+module AudioFeedManager
+  class AudioFileAdder
+    takes :id3_tags, :audio_file_repository, :feed_items_repository
+
+    def call(feed, file_name, title: ->(){}, author: ->(){})
+      tags = id3_tags.read(file_name)
+      audio_file = AudioFile.new(title: tags.title || title.call,
+                                 author: tags.artist || author.call)
+      audio_file = audio_file_repository.add(audio_file, file_name)
+      feed_items_repository.add(feed, audio_file)
+      audio_file
+    end
+  end
+end

data/lib/audio_feed_manager/audio_file_repository.rb

@@ -0,0 +1,42 @@
+require 'fileutils'
+
+module AudioFeedManager
+  class AudioFileRepository
+    takes :new_model_creator, :audio_files_directory, :audio_files_prefix, :data_files_directory, :storage
+
+    def add(audio_file, file_name)
+      add_file_information(audio_file, file_name)
+      audio_file = new_model_creator.create(audio_file,
+                                            directory: audio_files_directory,
+                                            prefix: audio_files_prefix)
+      copy_file(file_name, audio_file.file_name)
+
+      audio_file
+    end
+
+    def fetch(id)
+      attrs = storage.read(id)
+      AudioFile.new(attrs)
+    rescue FileNotFound
+      raise AudioFileNotFound.for_id(id)
+    end
+
+    private
+
+    def add_file_information(audio_file, file_name)
+      audio_file.extension = File.extname(file_name)
+      audio_file.size = File.size(file_name)
+      audio_file.content_type = `file --mime-type --brief #{file_name}`.chomp
+    end
+
+    def copy_file(file, new_name)
+      FileUtils.cp(file, data_files_directory.join(new_name))
+    end
+  end
+
+  class AudioFileNotFound < Error
+    def self.for_id(id)
+      new("AudioFile by id: #{id} was not found!")
+    end
+  end
+end

data/lib/audio_feed_manager/cli/add_audio_file.rb

@@ -0,0 +1,39 @@
+module AudioFeedManager
+  class AddAudioFile < Command
+    arguments do |s|
+      s.name "audio add"
+      s.description "Add a mp3 file to the specified feed"
+
+      s.argument :feed, required: true, description: "ID of the feed to add the file to, ex. feeds/hello-world"
+      s.varargs :files, minimum: 1, description: "Files to add"
+    end
+
+    takes :feed_repository, :audio_file_adder, :rss_generator, :console, :directory
+
+    def run(feed:, files:)
+      feed = feed_repository.fetch(feed)
+
+      files.each do |file|
+        add_file(feed, file)
+      end
+
+      rss_generator.generate(feed)
+    rescue FeedNotFound => e
+      console.die(e)
+    rescue SystemCallError => e
+      console.die(e)
+    end
+
+    private
+
+    def add_file(feed, file)
+      file_name = Pathname.new(directory.join(file))
+
+      console.info("Adding #{file_name} to #{feed.id}")
+
+      audio_file_adder.call feed, file_name,
+        title: ->() { console.ask("No title tag found. Please provide title", default: File.basename(file_name)) },
+        author: ->() { console.ask("No artist tag found. Please provide author") }
+    end
+  end
+end

data/lib/audio_feed_manager/cli/add_feed.rb

@@ -0,0 +1,20 @@
+module AudioFeedManager
+  class AddFeed < Command
+    arguments do |s|
+      s.name 'feeds add'
+      s.description 'Creates a new feed with a given title'
+
+      s.argument :title, required: true, description: "Title of the feed"
+    end
+
+    takes :feed_repository, :rss_generator, :console
+
+    def run(title:)
+      description = console.ask("Description", default: title)
+      feed = Feed.new(title: title, description: description)
+      feed = feed_repository.add(feed)
+      rss_generator.generate(feed)
+      console.info("Feed added. You may now refer to it as #{feed.id}.")
+    end
+  end
+end

data/lib/audio_feed_manager/cli/arguments.rb

@@ -0,0 +1,27 @@
+module AudioFeedManager
+  class Arguments
+    def self.blank
+      new
+    end
+
+    def self.from_hash(hash)
+      new(hash)
+    end
+
+    def initialize(arguments = {})
+      @arguments = arguments
+    end
+
+    def add_argument(name, value)
+      arguments[name] = value
+    end
+
+    def to_hash
+      arguments
+    end
+
+    private
+
+    attr_reader :arguments
+  end
+end

data/lib/audio_feed_manager/cli/arguments_parser.rb

@@ -0,0 +1,67 @@
+module AudioFeedManager
+  class ArgumentsParser
+    def parse(specification, arguments)
+      result = Arguments.new
+
+      result, arguments = parse_required_arguments(result, arguments, specification)
+      result, arguments = parse_optional_arguments(result, arguments, specification)
+      result, arguments = parse_varargs(result, arguments, specification)
+
+      if arguments.any?
+        raise InvalidArguments, "Provided #{arguments.size} extra arguments!"
+      end
+
+      result
+    end
+
+    private
+
+    def parse_required_arguments(result, arguments, specification)
+      if arguments.size < specification.required_arguments.size
+        raise InvalidArguments,
+          "Provided #{arguments.size} arguments, but #{specification.required_arguments.size} are required."
+      end
+
+      extract_arguments(result, arguments, specification.required_arguments)
+    end
+
+    def parse_varargs(result, arguments, specification)
+      return [result, arguments] unless specification.varargs_arguments.any?
+
+      if arguments.size < specification.minimum_varags_count
+        raise InvalidArguments,
+          "Provided #{arguments.size} for variable-length arguments, but #{specification.minimum_varags_count} are required."
+      end
+
+      specs = specification.varargs_arguments
+      arguments = arguments.dup
+
+      specs[0..-2].each do |arg|
+        value = arguments.shift(arg.minimum)
+        result.add_argument(arg.name, value)
+      end
+
+      result.add_argument(specs[-1].name, arguments)
+
+      [result, []]
+    end
+
+    def parse_optional_arguments(result, arguments, specification)
+      extract_arguments(result, arguments, specification.optional_arguments)
+    end
+
+    def extract_arguments(result, arguments, specs)
+      arguments = arguments.dup
+
+      specs.each do |arg|
+        value = arguments.shift
+        result.add_argument(arg.name, value)
+      end
+
+      [result, arguments]
+    end
+  end
+
+  class InvalidArguments < Error
+  end
+end

data/lib/audio_feed_manager/cli/arguments_specification.rb

@@ -0,0 +1,103 @@
+module AudioFeedManager
+  class ArgumentsSpecification
+    extend GetterSetterMethod
+
+    Argument = Struct.new(:name, :required, :description, :default) do
+      def usage_name
+        name.upcase
+      end
+
+      def optional
+        !required
+      end
+
+      def varargs
+        false
+      end
+    end
+
+    Varargs = Struct.new(:name, :minimum, :description) do
+      def usage_name
+        "#{name.upcase}..."
+      end
+
+      def required
+        false
+      end
+
+      def optional
+        false
+      end
+
+      def varargs
+        true
+      end
+    end
+
+    def self.no_arguments
+      new
+    end
+
+    def self.specify
+      specification = no_arguments
+      yield specification
+      specification
+    end
+
+    get_set(:name) { raise "Command name not specified" }
+    get_set(:description) { raise "Description not specified" }
+
+    def argument(name, required: false, description: "", default: nil)
+      arguments << Argument.new(name, required, description, default)
+    end
+
+    def varargs(name, minimum: 1, description: "")
+      arguments << Varargs.new(name, minimum, description)
+    end
+
+    def minimum_varags_count
+      varargs_arguments.map(&:minimum).reduce(0, :+)
+    end
+
+    def required_arguments
+      arguments.select(&:required)
+    end
+
+    def optional_arguments
+      arguments.select(&:optional)
+    end
+
+    def varargs_arguments
+      arguments.select(&:varargs)
+    end
+
+    def arguments
+      @arguments ||= []
+    end
+
+    def usage_line
+      name + required_arguments_line + optional_arguments_line + varargs_line
+    end
+
+    def has_arguments?
+      !arguments.empty?
+    end
+
+    private
+
+    def required_arguments_line
+      return "" if required_arguments.empty?
+      " " + required_arguments.map(&:usage_name).map{|s| "<#{s}>"}.join(" ")
+    end
+
+    def optional_arguments_line
+      return "" if optional_arguments.empty?
+      " " + optional_arguments.map(&:usage_name).map{|s| "[#{s}]"}.join(" ")
+    end
+
+    def varargs_line
+      return "" if varargs_arguments.empty?
+      " " + varargs_arguments.map(&:usage_name).map{|s| "[#{s}]"}.join(" ")
+    end
+  end
+end

data/lib/audio_feed_manager/cli/command.rb

@@ -0,0 +1,23 @@
+module AudioFeedManager
+  class Command
+    extend Forwardable
+
+    def self.arguments
+      yield(arguments_specification)
+    end
+
+    def self.arguments_specification
+      @arguments_specification ||= ArgumentsSpecification.no_arguments
+    end
+
+    def arguments
+      self.class.arguments_specification
+    end
+
+    def_delegators :arguments, :name, :description, :usage_line,
+      :has_arguments?, :required_arguments, :optional_arguments, :varargs_arguments
+
+    def run(arguments = {})
+    end
+  end
+end