budik 1.0.0

data/config/templates/options/rpi.yml

@@ -0,0 +1,39 @@
+---
+os: rpi
+lang: en
+player:
+  omxplayer:
+    default_volume: -2100
+    path: omxplayer
+    volume_step_secs: 3
+  player: omxplayer
+  vlc:
+    default_volume: 128
+    fullscreen: true
+    path: vlc
+    rc_host: localhost
+    rc_port: 50000
+    volume_fadein_secs: 0.125
+    volume_step: 1.0
+    wait_secs_after_run: 5
+    wait_secs_if_http: 3
+rng:
+  hwrng:
+    source: /dev/random
+  method: hwrng
+  random.org:
+    apikey: ""
+sources:
+  download:
+    device: /dev/sda
+    dir: /mnt/.budik/downloads/
+    method: remove
+    mount: "udisksctl mount -b $partition"
+    partition: /dev/sda1
+    sleep: ""
+    unmount: "udisksctl unmount -b $partition"
+  path: ~/.budik/sources.yml
+tv:
+  available: true
+  use_if_no_video: true
+  wait_secs_after_on: 15

data/config/templates/options/windows.yml

@@ -0,0 +1,39 @@
+---
+os: windows
+lang: en
+player:
+  omxplayer:
+    default_volume: -2100
+    path: omxplayer
+    volume_step_secs: 3
+  player: vlc
+  vlc:
+    default_volume: 128
+    fullscreen: true
+    path: vlc
+    rc_host: localhost
+    rc_port: 50000
+    volume_fadein_secs: 0.125
+    volume_step: 1.0
+    wait_secs_after_run: 5
+    wait_secs_if_http: 3
+rng:
+  hwrng:
+    source: ""
+  method: rand
+  random.org:
+    apikey: ""
+sources:
+  download:
+    device: ""
+    dir: ~/.budik/downloads/
+    method: stream
+    mount: ""
+    partition: ""
+    sleep: ""
+    unmount: ""
+  path: ~/.budik/sources.yml
+tv:
+  available: false
+  use_if_no_video: false
+  wait_secs_after_on: 0

data/config/templates/sources/sources.yml

@@ -0,0 +1,34 @@
+---
+default:
+  - "https://www.youtube.com/watch?v=oHg5SJYRHA0"
+#
+# Syntax:
+# =======
+#
+# category1:
+#   subcategory1:
+#     - "path"
+#     -
+#       - "path1"
+#       - "path2"
+#     - name:
+#       - "path"
+#     - name:
+#       - "path1"
+#       - "path2"
+#   subcategory2:
+#     - "path"
+# category2:
+#   subcategory1:
+#     subsubcategory1:
+#       - "path1"
+#       - "path2"
+#     subsubcategory2:
+#       - "path3"
+#   subcategory2:
+#     - "path4"
+# category:
+#   - "path"
+# another_category:
+#   category:
+#     - "path2"

data/lib/budik.rb

@@ -0,0 +1,152 @@
+# = budik.rb
+# This file contains definitions of the application's command line
+# interface.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 19, 2015
+
+require 'colorize'
+require 'commander'
+require 'date'
+require 'fileutils'
+require 'json'
+require 'net/http'
+require 'open3'
+require 'r18n-core'
+require 'singleton'
+require 'socket'
+require 'sys/uname'
+require 'terminal-table'
+require 'uri'
+require 'ya2yaml'
+require 'yaml'
+require 'youtube_addy'
+require 'youtube-dl.rb'
+
+require 'budik/command'
+require 'budik/config'
+require 'budik/devices'
+require 'budik/io'
+require 'budik/player'
+require 'budik/rng'
+require 'budik/sources'
+require 'budik/storage'
+require 'budik/version'
+
+# 'Budik' is an alarm clock that randomly plays an item from your media
+# collection (local or YouTube).
+module Budik
+  # 'Budik' class describes application's command line interface.
+  class Budik
+    include Commander::Methods
+
+    # Loads strings in language specified in application's options.
+    def initialize
+      @strings = Config.instance.lang.budik
+
+      @str_config = @strings.commands.config
+      @str_run = @strings.commands.run
+      @str_sources = @strings.commands.sources
+      @str_translate = @strings.commands.translate
+    end
+
+    # Describes application's command line interface. Runs the application.
+    def run
+      program :name, 'Budik'
+      program :version, VERSION
+      program :description, @strings.description
+
+      commands
+
+      default_command :run
+
+      run!
+    end
+
+    private
+
+    # List of commands
+    def commands
+      command_config(@str_config.options)
+      command_run(@str_run.options)
+      command_sources(@str_sources.options)
+      command_translate
+    end
+
+    # Describes and runs command 'config'.
+    #
+    # - *Args*:
+    #   - +str_opts+ -> Command options' strings
+    #
+    def command_config(str_opts)
+      command :config do |c|
+        c.syntax = 'budik config [options]'
+        c.summary = @str_config.summary
+        c.description = @str_config.description
+        c.option '-r', '--reset', str_opts.reset
+        c.action { |_args, opts| Command.new(:config, opts) }
+      end
+    end
+
+    # Describes and runs command 'run'.
+    #
+    # - *Args*:
+    #   - +str_opts+ -> Command options' strings
+    #
+    def command_run(str_opts)
+      command :run do |c|
+        c.syntax = 'budik run [options]'
+        c.summary = @str_run.summary
+        c.description = @str_run.description
+        command_run_options(c, str_opts)
+        c.action { |_args, opts| Command.new(:run, opts) }
+      end
+    end
+
+    # Describes options for command 'run'.
+    #
+    # - *Args*:
+    #   - +c+ -> Ruby Commander's object
+    #   - +str_opts+ -> Command options' strings
+    #
+    def command_run_options(c, str_opts)
+      c.option '-c', '--categories [string]', String, str_opts.categories
+      c.option '-d', '--dl-method [string]', String, str_opts.dl_method
+      c.option '-n', '--number [integer]', Integer, str_opts.number
+      c.option '-p', '--player [string]', String, str_opts.player
+      c.option '-r', '--rng [string]', String, str_opts.rng
+    end
+
+    # Describes and runs command 'sources'.
+    #
+    # - *Args*:
+    #   - +str_opts+ -> Command options' strings
+    #
+    def command_sources(str_opts)
+      command :sources do |c|
+        c.syntax = 'budik sources [options]'
+        c.summary = @str_sources.summary
+        c.description = @str_sources.description
+        c.option '-c', '--categories [string]', String, str_opts.categories
+        c.option '-d', '--download', str_opts.download
+        c.option '-e', '--edit', str_opts.download
+        c.action { |_args, opts| Command.new(:sources, opts) }
+      end
+    end
+
+    # Describes and runs command 'translate'.
+    def command_translate
+      command :translate do |c|
+        c.syntax = 'budik translate [options]'
+        c.summary = @str_translate.summary
+        c.description = @str_translate.description
+        c.action { |args, _opts| Command.new(:translate, args) }
+      end
+    end
+  end
+
+  Budik.new.run if $PROGRAM_NAME == __FILE__
+end

data/lib/budik/command.rb

@@ -0,0 +1,199 @@
+# = command.rb
+# This file contains definitions of the application's commands.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 19, 2015
+
+module Budik
+  # 'Command' class holds definitions of CLI commands.
+  class Command
+    # Loads options, sources and strings.
+    # Runs command and passes specified options to it.
+    #
+    # - *Args*:
+    #   - +command+ -> Command to run (Symbol)
+    #   - +opts+ -> Command line options (Ruby Commander's object)
+    #
+    def initialize(command, opts)
+      @options = Config.instance.options
+      @sources = Config.instance.sources
+      @strings = Config.instance.lang.command
+
+      send(command, opts)
+    end
+
+    private
+
+    # Defines command 'config'.
+    # Opens configuration file for editing or resets it.
+    #
+    # - *Args*:
+    #   - +opts+ -> Command line options
+    #
+    def config(opts)
+      if opts.reset
+        Config.instance.reset
+      else
+        Config.instance.edit
+      end
+    end
+
+    # Runs alarm or falls back if an error is encountered.
+    #
+    # - *Args*:
+    #   - +opts+ -> Command line options
+    #
+    def run(opts)
+      run_alarm(opts)
+    rescue
+      run_alarm_fallback
+    end
+
+    # Defines command 'run'.
+    # Runs alarm.
+    #
+    # - *Args*:
+    #   - +opts+ -> Command line options
+    #
+    def run_alarm(opts)
+      sources = Sources.instance
+      storage = Storage.instance
+      devices = Devices.instance
+      rng = Rng.new
+      io = IO.instance
+      player = Player.instance
+
+      run_use_cli_opts(opts)
+      source = run_prepare(opts, sources, devices, rng, io)
+      run_download(source, storage.method, storage)
+      run_play(source, devices, player, storage)
+    end
+
+    # Outputs bell code 50 times in 1.2s intervals.
+    def run_alarm_fallback
+      50.times do
+        puts "\a"
+        sleep 1.2
+      end
+    end
+
+    # Applies command line options (player, rng, dl_method)
+    #
+    # - *Args*:
+    #   - +opts+ -> Command line options
+    #
+    def run_use_cli_opts(opts)
+      @options['player']['player'] = opts.player if opts.player
+      @options['rng']['method'] = opts.rng if opts.rng
+      return unless opts.dl_method
+      @options['sources']['download']['method'] = opts.dl_method
+    end
+
+    # Parses sources, applies category modifiers, mounts device if needed,
+    # generates random number and uses it to return source.
+    #
+    # - *Args*:
+    #   - +opts+ -> Command line options
+    #   - +sources+ -> Sources class instance
+    #   - +devices+ -> Devices class instance
+    #   - +rng+ -> Rng class instance
+    #   - +io+ -> IO class instance
+    # - *Returns*:
+    #   - Source (Hash)
+    #
+    def run_prepare(opts, sources, devices, rng, io)
+      sources.parse(@sources)
+      mods = opts.categories ? sources.parse_mods(opts.categories) : nil
+      sources.apply_mods(mods) if mods
+
+      devices.storage_mount
+      number = opts.number || rng.generate(sources.count)
+      source = sources.get(number)
+
+      puts io.run_info_table(source, number)
+      source
+    end
+
+    # Downloads source if needed.
+    #
+    # - *Args*:
+    #   - +source+ -> Source (Hash)
+    #   - +dl_method+ -> Download method (string: keep, remove or stream)
+    #   - +storage+ -> Storage class instance
+    #
+    def run_download(source, dl_method, storage)
+      storage.download_sources(source) unless dl_method == 'stream'
+    end
+
+    # Turns on tv if needed.
+    # Plays source or falls back if player unexpectedly exits too soon.
+    # If needed, turns off TV, removes source and unmounts storage.
+    #
+    # - *Args*:
+    #   - +sources+ -> Sources class instance
+    #   - +devices+ -> Devices class instance
+    #   - +player+ -> Player class instance
+    #   - +storage+ -> Storage class instance
+    #
+    def run_play(source, devices, player, storage)
+      devices.tv_on
+
+      start = Time.now
+      player.play(source)
+      run_alarm_fallback if Time.now - start < 5.0
+
+      devices.tv_off
+      storage.remove_sources(source)
+      devices.storage_unmount
+      sleep 5
+      devices.storage_sleep
+    end
+
+    # Defines command 'sources'
+    # Opens sources file for editing or prepares sources
+    # for viewing or downloading.
+    #
+    # - *Args*:
+    #   - +opts+ -> Command line options
+    #
+    def sources(opts)
+      if opts.edit
+        path = File.expand_path(Config.instance.options['sources']['path'])
+        Config.instance.open_file(path)
+      else
+        sources = Sources.instance
+        sources.parse(@sources)
+        sources_list_dl(sources, opts)
+      end
+    end
+
+    # Applies category modifiers and lists or download sources.
+    #
+    # - *Args*:
+    #   - +sources+ -> Sources class instance
+    #   - +opts+ -> Command line options
+    #
+    def sources_list_dl(sources, opts)
+      mods = opts.categories ? sources.parse_mods(opts.categories) : nil
+      sources.apply_mods(mods) if mods
+
+      if opts.download
+        Storage.instance.download_sources
+      else
+        IO.instance.sources_print(sources.sources)
+      end
+    end
+
+    # Creates and/or opens language file for translation.
+    #
+    # - *Args*:
+    #   - +args+ -> Command line arguments, first used as language code
+    #
+    def translate(args)
+      Config.instance.translate(args.first)
+    end
+  end
+end