audio-feed-manager 0.0.1

data/lib/audio_feed_manager/cli/commands_list.rb

@@ -0,0 +1,120 @@
+module AudioFeedManager
+  class CommandsList < Command
+    arguments do |s|
+      s.name 'help'
+      s.description 'Print help about available commands and arguments/options'
+
+      s.argument :command_name, required: false, description: "Command, for which to print help"
+      s.argument :subcommand_name, required: false, description: "Subcommand (such as 'add' in 'feeds add')"
+    end
+
+    takes :initialize_project,
+      :add_feed,
+      :list_feeds,
+      :add_audio_file,
+      :show_feed,
+      :get_feed_url,
+      :update_feed_rss,
+      :publish,
+      :console
+
+    def get(argv)
+      name, *options = *argv
+      command = nil
+
+      case name
+      when 'init'
+        command = initialize_project
+      when 'publish'
+        command = publish
+      when 'help'
+        command = help
+      when 'feeds'
+        subcommand, *options = *options
+        name = "#{name} #{subcommand}"
+
+        case subcommand
+        when 'add'
+          command = add_feed
+        when 'show'
+          command = show_feed
+        when 'get-url'
+          command = get_feed_url
+        when 'update-rss'
+          command = update_feed_rss
+        when 'list'
+          command = list_feeds
+        end
+      when 'audio'
+        subcommand, *options = *options
+        name = "#{name} #{subcommand}"
+
+        case subcommand
+        when 'add'
+          command = add_audio_file
+        end
+      when nil
+        command = help
+      end
+
+      raise UnknownCommand, "Unknown command: #{name}" unless command
+
+      [command, options]
+    end
+
+    def print_usage
+      console.error "Usage: afm <COMMAND> [options] [arguments...]"
+      console.error ""
+      console.error "Available commands:"
+      console.error ""
+      command_list.each do |command|
+        console.error "\t#{command.name} - #{command.description}"
+      end
+    end
+
+    def print_command_usage(command_name, subcommand_name = nil)
+      command, _ = get([command_name, subcommand_name].compact)
+
+      console.error "Usage: afm #{command.usage_line}"
+
+      if command.has_arguments?
+        console.error ""
+        console.error "Arguments:"
+
+        command.required_arguments.each do |arg|
+          console.error "\t#{arg.usage_name} - #{arg.description}"
+        end
+
+        command.optional_arguments.each do |arg|
+          console.error "\t#{arg.usage_name} (optional) - #{arg.description}"
+        end
+
+        command.varargs_arguments.each do |arg|
+          at_least_text = arg.minimum > 0 ? "(at least #{arg.minimum}) " : ""
+          console.error "\t#{arg.usage_name} #{at_least_text}- #{arg.description}"
+        end
+      end
+    end
+
+    def run(command_name: nil, subcommand_name: nil)
+      if command_name
+        print_command_usage(command_name, subcommand_name)
+      else
+        print_usage
+      end
+    end
+
+    private
+
+    def help
+      self
+    end
+
+    def command_list
+      [initialize_project, add_feed, list_feeds, show_feed, update_feed_rss, get_feed_url, add_audio_file, publish, help]
+    end
+  end
+
+  class UnknownCommand < Error
+  end
+end

data/lib/audio_feed_manager/cli/get_feed_url.rb

@@ -0,0 +1,20 @@
+module AudioFeedManager
+  class GetFeedUrl < Command
+    arguments do |s|
+      s.name 'feeds get-url'
+      s.description 'Get URL of the feed'
+
+      s.argument :feed, required: true, description: "Identifier of the feed to print the URL for."
+    end
+
+    takes :console, :feed_repository, :url_maker
+
+    def run(feed:)
+      feed = feed_repository.fetch(feed)
+      url = url_maker.feed_url(feed)
+      console.info(url)
+    rescue FeedNotFound => e
+      console.die(e)
+    end
+  end
+end

data/lib/audio_feed_manager/cli/initialize_project.rb

@@ -0,0 +1,44 @@
+require "fileutils"
+
+module AudioFeedManager
+  class InitializeProject < Command
+    takes :directory,
+      :console,
+      :config_repository,
+      :rss_files_prefix,
+      :audio_files_prefix,
+      :data_files_prefix,
+      :items_prefix,
+      :feeds_prefix
+
+    arguments do |s|
+      s.name 'init'
+      s.description 'Initialize a new project directory'
+
+      s.argument :project_dir, required: true, description: "Name of the project (will be used to create a directory)"
+    end
+
+    def run(project_dir:)
+      project_dir = directory.join(project_dir)
+      mkdir(project_dir, rss_files_prefix)
+      mkdir(project_dir, audio_files_prefix)
+      mkdir(project_dir, data_files_prefix)
+      mkdir(project_dir, items_prefix)
+      mkdir(project_dir, feeds_prefix)
+
+      config = Config.new(
+        s3_access_key: console.ask("S3 Access key"),
+        s3_secret: console.ask("S3 Secret key"),
+        s3_region: console.ask("S3 Region", default: "us-west-2"),
+        s3_bucket: console.ask("Bucket name")
+      )
+      config_repository.store(project_dir.join("config.yml"), config)
+    end
+
+    private
+
+    def mkdir(project_dir, prefix)
+      FileUtils.mkdir_p(project_dir.join(prefix))
+    end
+  end
+end

data/lib/audio_feed_manager/cli/list_feeds.rb

@@ -0,0 +1,38 @@
+module AudioFeedManager
+  class ListFeeds < Command
+    arguments do |s|
+      s.name 'feeds list'
+      s.description 'Lists the created feeds'
+    end
+
+    takes :feed_repository, :console
+
+    def run(_ = {})
+      feeds = feed_repository.list
+
+      if feeds.empty?
+        print_no_feeds_message
+      else
+        print_feeds(feeds)
+      end
+    end
+
+    private
+
+    def print_feeds(feeds)
+      console.info("Feeds:")
+      console.info("")
+
+      console.info("#\tID\tTitle")
+      feeds.each_with_index do |feed, idx|
+        console.info("#{idx+1}.\t#{feed.id}\t#{feed.title}")
+      end
+    end
+
+    def print_no_feeds_message
+      console.info("No feeds yet. Add one using: afm feeds add 'some title'")
+      console.info("")
+      console.info("\tafm feeds add 'some title'")
+    end
+  end
+end

data/lib/audio_feed_manager/cli/publish.rb

@@ -0,0 +1,21 @@
+module AudioFeedManager
+  class Publish < Command
+    arguments do |s|
+      s.name 'publish'
+      s.description 'Publish the RSS and MP3 files to S3.'
+    end
+
+    takes :feed_syncer, :feed_repository, :console
+
+    def run(_ = {})
+      feeds = feed_repository.list
+      feeds.each do |feed|
+        console.info("Syncing #{feed.id}")
+        feed_syncer.sync(feed) do |file|
+          console.info("Uploading file #{file}")
+        end
+      end
+      console.info("Done.")
+    end
+  end
+end

data/lib/audio_feed_manager/cli/show_feed.rb

@@ -0,0 +1,44 @@
+module AudioFeedManager
+  class ShowFeed < Command
+    arguments do |s|
+      s.name 'feeds show'
+      s.description 'Show detailed information about the feed'
+
+      s.argument :feed, required: true, description: "Feed to show information about, ex. feeds/hello-world"
+    end
+
+    takes :feed_repository, :feed_items_repository, :url_maker, :console
+
+    def run(feed:)
+      feed = feed_repository.fetch(feed)
+      audio_files = feed_items_repository.list(feed)
+
+      print_details(feed)
+      separator
+      print_audio_files(audio_files)
+    rescue FeedNotFound => e
+      console.die(e)
+    end
+
+    private
+
+    def print_details(feed)
+      console.info "Title: #{feed.title}"
+      console.info "ID: #{feed.id}"
+      console.info "URL: #{url_maker.feed_url(feed)}"
+    end
+
+    def separator
+      console.info ""
+    end
+
+    def print_audio_files(audio_files)
+      return console.info "No audio files. Add one with 'afm audio add <FILE>'." if audio_files.empty?
+
+      console.info("#\tID\tTitle")
+      audio_files.each_with_index do |audio_file, idx|
+        console.info "#{idx + 1}\t#{audio_file.id}\t#{audio_file.title}"
+      end
+    end
+  end
+end

data/lib/audio_feed_manager/cli/update_feed_rss.rb

@@ -0,0 +1,19 @@
+module AudioFeedManager
+  class UpdateFeedRss < Command
+    arguments do |s|
+      s.name 'feeds update-rss'
+      s.description "Regenerates the RSS .xml file for the given feed"
+
+      s.argument :feed, required: true, description: "Identifier of the feed to regenerate RSS for."
+    end
+
+    takes :feed_repository, :rss_generator, :console
+
+    def run(feed:)
+      feed = feed_repository.fetch(feed)
+      rss_generator.generate(feed)
+    rescue FeedNotFound => e
+      console.die(e)
+    end
+  end
+end

data/lib/audio_feed_manager/cli.rb

@@ -0,0 +1,19 @@
+module AudioFeedManager
+  class CLI
+    takes :commands_list, :arguments_parser, :help, :console
+
+    def run(argv)
+      command, options = commands_list.get(argv)
+      args = arguments_parser.parse(command.arguments, options)
+      command.run(args.to_hash)
+    rescue UnknownCommand => e
+      console.fail(e)
+      help.print_usage
+      raise StopApplication
+    rescue InvalidArguments => e
+      console.fail(e)
+      help.print_command_usage(command.name)
+      raise StopApplication
+    end
+  end
+end

data/lib/audio_feed_manager/config.rb

@@ -0,0 +1,5 @@
+module AudioFeedManager
+  class Config < Struct.new(:s3_region, :s3_access_key, :s3_secret, :s3_bucket)
+    include HashConstructor
+  end
+end

data/lib/audio_feed_manager/config_repository.rb

@@ -0,0 +1,14 @@
+module AudioFeedManager
+  class ConfigRepository
+    takes :storage
+
+    def load(file_name)
+      attrs = storage.read(file_name) if File.exists?(file_name)
+      Config.new(attrs || {})
+    end
+
+    def store(file_name, config)
+      storage.store(file_name, config.to_h)
+    end
+  end
+end

data/lib/audio_feed_manager/console.rb

@@ -0,0 +1,28 @@
+module AudioFeedManager
+  class Console
+    takes :stderr, :stdout, :stdin
+
+    def info(*msg)
+      stdout.puts(*msg)
+    end
+
+    def error(*msg)
+      stderr.puts(*msg)
+    end
+
+    def fail(error)
+      error(error.message)
+    end
+
+    def die(error)
+      self.fail(error)
+      raise StopApplication
+    end
+
+    def ask(label, default: "")
+      stdout.print "#{label} [#{default}]: "
+      result = stdin.gets.to_s.chomp
+      result == "" ? default : result
+    end
+  end
+end

data/lib/audio_feed_manager/directory_lister.rb

@@ -0,0 +1,9 @@
+module AudioFeedManager
+  class DirectoryLister
+    def list(directory)
+      directory = Pathname.new(directory)
+
+      Dir[directory.join("*")].map{|f| File.basename(f)}.sort
+    end
+  end
+end

data/lib/audio_feed_manager/error.rb

@@ -0,0 +1,4 @@
+module AudioFeedManager
+  class Error < StandardError
+  end
+end

data/lib/audio_feed_manager/feed.rb

@@ -0,0 +1,9 @@
+module AudioFeedManager
+  class Feed < Struct.new(:id, :title, :description, :secret_token)
+    include HashConstructor
+
+    def bare_id
+      id.gsub("feeds/", "")
+    end
+  end
+end

data/lib/audio_feed_manager/feed_items_repository.rb

@@ -0,0 +1,30 @@
+module AudioFeedManager
+  class FeedItemsRepository
+    takes :items_directory, :audio_file_repository
+
+    def add(feed, audio_file)
+      prepend_to_file(items_file(feed), audio_file.id)
+    end
+
+    def list(feed)
+      file = items_file(feed)
+      return [] unless File.exist?(file)
+      ids = File.read(file).lines.map(&:chomp)
+      ids.map{|id| audio_file_repository.fetch(id)}
+    end
+
+    private
+
+    def items_file(feed)
+      items_directory.join(feed.bare_id)
+    end
+
+    def prepend_to_file(file_name, id)
+      contents = File.exist?(file_name) ? File.read(file_name) : ""
+      File.open(file_name, "w") do |f|
+        f.puts id
+        f.print contents
+      end
+    end
+  end
+end

data/lib/audio_feed_manager/feed_repository.rb

@@ -0,0 +1,32 @@
+module AudioFeedManager
+  class FeedRepository
+    takes :feeds_directory,
+      :feeds_prefix,
+      :storage,
+      :directory_lister,
+      :new_model_creator
+
+    def add(feed)
+      new_model_creator.create(feed, directory: feeds_directory, prefix: feeds_prefix)
+    end
+
+    def list
+      names = directory_lister.list(feeds_directory)
+      ids = names.map{|name| "#{feeds_prefix}/#{name}"}
+      ids.map {|id| fetch(id)}
+    end
+
+    def fetch(id)
+      attrs = storage.read(id)
+      Feed.new(attrs)
+    rescue FileNotFound
+      raise FeedNotFound.for_id(id)
+    end
+  end
+
+  class FeedNotFound < Error
+    def self.for_id(id)
+      new("Feed by ID #{id} not found!")
+    end
+  end
+end

data/lib/audio_feed_manager/feed_syncer.rb

@@ -0,0 +1,20 @@
+module AudioFeedManager
+  class FeedSyncer
+    takes :s3_gateway, :feed_items_repository,
+      :rss_files_prefix,
+      :rss_files_directory,
+      :data_files_prefix,
+      :data_files_directory
+
+    def sync(feed, &block)
+      rss_file = rss_files_directory.join(feed.secret_token + ".xml")
+      s3_gateway.sync("#{rss_files_prefix}/#{feed.secret_token}.xml", rss_file, &block)
+
+      audio_files = feed_items_repository.list(feed)
+      audio_files.each do |audio_file|
+        data_file = data_files_directory.join(audio_file.secret_token + audio_file.extension)
+        s3_gateway.sync("#{data_files_prefix}/#{audio_file.secret_token}#{audio_file.extension}", data_file, &block)
+      end
+    end
+  end
+end

data/lib/audio_feed_manager/file_storage.rb

@@ -0,0 +1,20 @@
+require 'yaml'
+
+module AudioFeedManager
+  class FileStorage
+    takes :directory
+
+    def store(file_name, data = {})
+      File.write(directory.join(file_name), data.to_yaml)
+    end
+
+    def read(file_name)
+      YAML.load_file(directory.join(file_name))
+    rescue SystemCallError => e
+      raise FileNotFound, e.message
+    end
+  end
+
+  class FileNotFound < Error
+  end
+end

data/lib/audio_feed_manager/id3_tags.rb

@@ -0,0 +1,14 @@
+require 'id3tag'
+
+module AudioFeedManager
+  class Id3Tags
+    def read(file_name)
+      return Tags.blank unless File.exist?(file_name)
+
+      File.open(file_name, "rb") do |f|
+        tags = ID3Tag.read(f)
+        return Tags.new(title: tags.title, artist: tags.artist)
+      end
+    end
+  end
+end

data/lib/audio_feed_manager/new_model_creator.rb

@@ -0,0 +1,15 @@
+module AudioFeedManager
+  class NewModelCreator
+    takes :unique_id_generator,
+      :storage,
+      :secret_token_generator
+
+    def create(object, directory:, prefix:)
+      id = unique_id_generator.generate(object.title, directory)
+      object.id = prefix + "/" + id
+      object.secret_token = secret_token_generator.generate
+      storage.store(object.id, object.to_h)
+      object
+    end
+  end
+end

data/lib/audio_feed_manager/rss_generator.rb

@@ -0,0 +1,10 @@
+module AudioFeedManager
+  class RssGenerator
+    takes :rss_repository, :feed_items_repository
+
+    def generate(feed)
+      audio_files = feed_items_repository.list(feed)
+      rss_repository.store(feed, audio_files)
+    end
+  end
+end

data/lib/audio_feed_manager/rss_repository.rb

@@ -0,0 +1,36 @@
+require 'rss'
+
+module AudioFeedManager
+  class RSSRepository
+    takes :rss_files_directory, :url_maker
+
+    def store(feed, audio_files = [])
+      xml = render(feed, audio_files)
+      File.write(rss_files_directory.join("#{feed.secret_token}.xml"), xml)
+    end
+
+    private
+
+    def render(feed, audio_files)
+      RSS::Maker.make("2.0") do |m|
+        m.channel.title = feed.title
+        m.channel.description = feed.description
+        m.channel.link = url_maker.feed_url(feed)
+
+        audio_files.each_with_index do |file, idx|
+          m.items.new_item do |item|
+            link = url_maker.audio_file_url(file)
+            item.link = link
+            item.title = file.title
+            item.author = file.author
+            item.itunes_author = file.author
+            item.updated = (Date.today - idx).to_s
+            item.enclosure.url = link
+            item.enclosure.type = file.content_type
+            item.enclosure.length = file.size
+          end
+        end
+      end
+    end
+  end
+end

data/lib/audio_feed_manager/s3_gateway.rb

@@ -0,0 +1,39 @@
+require 'aws-sdk'
+require 'digest'
+
+module AudioFeedManager
+  class S3Gateway
+    takes :config
+
+    def url(path)
+      bucket.object(path).public_url
+    end
+
+    def sync(key, file_name, &block)
+      return unless needs_syncing?(key, file_name)
+      yield key if block_given?
+
+      object = bucket.object(key)
+      object.upload_file(file_name)
+      object.acl.put(acl: "public-read")
+    end
+
+    private
+
+    def needs_syncing?(key, file_name)
+      object = bucket.object(key)
+      return true unless object.exists?
+      object.etag.gsub('"', '') != Digest::MD5.file(file_name).to_s
+    end
+
+    def s3
+      @s3 ||= Aws::S3::Resource.new(access_key_id: config.s3_access_key,
+                                    secret_access_key: config.s3_secret,
+                                    region: config.s3_region)
+    end
+
+    def bucket
+      @bucket ||= s3.bucket(config.s3_bucket)
+    end
+  end
+end

data/lib/audio_feed_manager/secret_token_generator.rb

@@ -0,0 +1,9 @@
+require 'securerandom'
+
+module AudioFeedManager
+  class SecretTokenGenerator
+    def generate
+      SecureRandom.hex(8)
+    end
+  end
+end

data/lib/audio_feed_manager/stop_application.rb

@@ -0,0 +1,4 @@
+module AudioFeedManager
+  class StopApplication < Error
+  end
+end

data/lib/audio_feed_manager/support/getter_setter_method.rb

@@ -0,0 +1,18 @@
+module AudioFeedManager
+  module GetterSetterMethod
+    def get_set(name, &default)
+      define_method name do |value = :no_value_given|
+        default ||= ->(){}
+        inst_variable_name = "@#{name}"
+
+        instance_variable_set(inst_variable_name, value) if value != :no_value_given
+
+        if !instance_variable_defined?(inst_variable_name) && value == :no_value_given
+          instance_variable_set(inst_variable_name, instance_exec(&default))
+        end
+
+        instance_variable_get(inst_variable_name)
+      end
+    end
+  end
+end

data/lib/audio_feed_manager/support/hash_constructor.rb

@@ -0,0 +1,9 @@
+module AudioFeedManager
+  module HashConstructor
+    def initialize(args = {})
+      args.each do |name, value|
+        self.send("#{name}=", value)
+      end
+    end
+  end
+end