budik 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8555eff6bde9e0ad78896959e1afbc21e179a4f9
+  data.tar.gz: 38f7ffb627ade715700822e5d43ca99cbfdfa878
+SHA512:
+  metadata.gz: 4ffda66f26a892ce245bc89188467b89f3ac74b92efe8b9406f94e760fffd1fcf452a773a3d2bdd05151083108b19bdfad37c3c51cf3c3f03409b3af322283a3
+  data.tar.gz: bcc8f5bbb1cd7c0ae0f6ee4cade8c2d3e6d5daeab5e14f1f9e1ea5da44c4b57529b4758beaecc6ea16f3e1ab5103cc0736d5fb504321befb65c0afc13825f03a

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/lib/budik/config/sources.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6
+addons:
+  apt:
+    packages:
+      - libav-tools

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Petr Schmied
+
+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,176 @@
+# Budík
+
+[![Build Status](https://travis-ci.org/JBlackN/budik.svg?branch=master)](https://travis-ci.org/JBlackN/budik)
+[![Dependency Status](https://gemnasium.com/JBlackN/budik.svg)](https://gemnasium.com/JBlackN/budik)
+[![Code Climate](https://codeclimate.com/github/JBlackN/budik/badges/gpa.svg)](https://codeclimate.com/github/JBlackN/budik)
+[![Coverage Status](https://coveralls.io/repos/JBlackN/budik/badge.svg?branch=master&service=github)](https://coveralls.io/github/JBlackN/budik?branch=master)
+[![Inline docs](http://inch-ci.org/github/JBlackN/budik.svg?branch=master&style=shields)](http://inch-ci.org/github/JBlackN/budik)
+
+Budík is a command line application that uses a list of your favorite songs or videos (local or YouTube) to randomly select and play one of them. When combined with cron, systemd timers or schtasks, it can be used as an alarm clock.
+
+__Warning:__ The application is intended for casual use only. Occurence of bugs is possible, no matter how much I try to avoid them.
+
+## Requirements
+
+* OS/Platform (other are untested):
+  * Windows 7+ (Powershell is needed)
+  * Linux
+  * Raspberry Pi
+* Applications:
+  * Ruby (> 1.9.2)
+  * __VLC media player__ (Windows, Linux) or __omxplayer__ (Raspberry Pi)
+  * __FFmpeg__ or __Libav__
+* If you need to (un)mount or spin down storage devices, these applications are tested:
+  * Udisks2
+  * Hdparm (read its documentation and take extra care)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'budik'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install budik
+
+## Configuration
+
+When the application is run for the first time, it automatically creates its configuration in `your_home_directory/.budik/`. Edit `options.yml` and `sources.yml` as needed.
+
+For information about correct YAML syntax, look [here](http://learnxinyminutes.com/docs/yaml/).
+
+### Options.yml - explanation
+
+```yaml
+os: "windows, linux or rpi"
+lang: "language code (default: en)"
+player:
+  omxplayer:
+    default_volume: "omxplayer's starting volume (default: -2100)"
+    path: "path to omxplayer (default: omxplayer)"
+    volume_step_secs: "pause between volume ups (default: 3, app uses 7 steps)"
+  player: "player to use (vlc or omxplayer)"
+  vlc:
+    default_volume: "vlc's starting volume (128 (default) ~ 50%, 256 ~ 100%)"
+    fullscreen: "self-explainatory (true (default) or false)"
+    path: "path to vlc (default: vlc)"
+    rc_host: "vlc's remote control interface host (default: localhost)"
+    rc_port: "vlc's remote control interface port (default: 50000)"
+    volume_fadein_secs: "pause between volume ups (default: 0.125)"
+    volume_step: "self-explainatory (default: 1.0)"
+    wait_secs_after_run: "give vlc time to start if needed (default: 5)"
+    wait_secs_if_http: "not used in current version (default: 3)"
+rng:
+  hwrng:
+    source: "/dev/urandom, /dev/random/ or /dev/hwrng"
+  method: "hwrng, random.org, rand-hwrng-seed or rand"
+  random.org:
+    apikey: "your Random.org API key"
+sources:
+  download:
+    device: "self-explainatory (example: /dev/sda)"
+    dir: "where to download sources (default (except rpi): ~/.budik/downloads/)"
+    method: "keep, remove, stream"
+    mount: "mount command, you can use $device/$partition variables (example: udisksctl mount -b $partition)"
+    partition: "self-explainatory (example: /dev/sda1)"
+    sleep: "sleep command, you can use $device/$partition variables (example: sudo hdparm -y $device)"
+    unmount: "unmount command, you can use $device/$partition variables (example: udisksctl unmount -b $partition)"
+  path: "path to sources file (default: ~/.budik/sources.yml)"
+tv:
+  available: "self-explainatory (true or false)"
+  use_if_no_video: "self-explainatory (true or false)"
+  wait_secs_after_on: "give TV time to turn on (default: 15)"
+```
+
+### Sources.yml - explanation
+
+* Category can't contain both items and subcategories.
+* Every item must have a category (file has to contain at least one category)
+* __Don't__ use backslashes in paths.
+
+```yaml
+category1:
+  subcategory1:
+    - "path"    # Unnamed single item
+    -           # Unnamed multiple items
+      - "path1"
+      - "path2"
+    - name:     # Named single item
+      - "path"
+    - name:     # Named multiple items
+      - "path1"
+      - "path2"
+  subcategory2:
+    - "path"
+category2:
+  subcategory1:
+    subsubcategory1:
+      - "path1"
+      - "path2"
+    subsubcategory2:
+      - "path3"
+  subcategory2:
+    - "path4"
+category:
+  - "path"
+another_category:
+  category:
+    - "path2"
+```
+
+## Usage
+
+Linux:
+
+    $ budik --help
+
+Windows:
+
+    $ budik.bat --help
+
+### Scheduling
+
+#### Cron
+
+  * [Scheduling Tasks with Cron Jobs](http://code.tutsplus.com/tutorials/scheduling-tasks-with-cron-jobs--net-8800)
+
+#### Systemd timers
+
+  * [How to Use Systemd Timers](http://jason.the-graham.com/2013/03/06/how-to-use-systemd-timers/)
+  * [systemd.timer — Timer unit configuration](http://www.freedesktop.org/software/systemd/man/systemd.timer.html)
+  * [systemd.time — Time and date specifications](http://www.freedesktop.org/software/systemd/man/systemd.time.html)
+
+#### Schtasks
+
+  * [Schtasks.exe](https://msdn.microsoft.com/en-us/library/windows/desktop/bb736357(v=vs.85).aspx)
+  * [Two Minute Drill: The Schtasks command](http://blogs.technet.com/b/askperf/archive/2010/05/14/two-minute-drill-the-schtasks-command.aspx)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Todo (Ideas)
+
+* [ ] Better sources management (add, remove, etc.)
+* [ ] Scheduling without need to interact with external tools
+* [ ] Download timeout
+* [ ] Automatic download after sources change
+* [ ] Better config management
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JBlackN/budik. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'coveralls/rake/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = 'features --format pretty'
+end
+RSpec::Core::RakeTask.new(:spec)
+Coveralls::RakeTask.new
+RuboCop::RakeTask.new
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib/*.rb', 'lib/budik/*.rb')
+  rdoc.rdoc_dir = 'doc'
+end
+
+task default: [:features, :spec, 'coveralls:push', :rubocop]

data/bin/budik

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'budik'
+Budik::Budik.new.run

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'budik'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here
+cat lib/budik.rb | sed "s/require 'budik/require '\.\/lib\/budik/g" >lib/budik2.rb
+rm -f lib/budik.rb
+mv lib/budik2.rb lib/budik.rb

data/budik.gemspec

@@ -0,0 +1,55 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'budik/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'budik'
+  spec.version       = Budik::VERSION
+  spec.authors       = ['Petr Schmied']
+  spec.email         = ['jblack@paworld.eu']
+
+  spec.summary       = 'Alarm clock.'
+  spec.description   = 'Alarm clock that randomly plays a song or'\
+    ' a video from YouTube or your local collection.'
+  spec.homepage      = 'http://jblack.paworld.eu/apps/budik'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    fail 'RubyGems 2.0 or newer is required to protect'\
+      ' against public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'bin'
+  # spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables << 'budik'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'commander'
+  spec.add_dependency 'r18n-core'
+  spec.add_dependency 'sys-uname'
+  spec.add_dependency 'terminal-table'
+  spec.add_dependency 'ya2yaml'
+  spec.add_dependency 'youtube_addy'
+  spec.add_dependency 'youtube-dl.rb'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rdoc'
+
+  spec.post_install_message = 'Please make sure VLC/omxplayer and FFmpeg'\
+    "/Libav are installed.\nRun 'budik(.bat) config' to edit app's options"\
+    " as needed.\nRun 'budik(.bat) sources -e' to edit your media sources."
+end

data/config/templates/lang/en.yml

@@ -0,0 +1,37 @@
+lang: "en" # Do not remove this line.
+budik:
+  description: "Alarm clock that randomly plays a song or a video from YouTube or your local collection."
+  commands:
+    config:
+      summary: "Edit program configuration."
+      description: "Open options file in your default editor."
+      options:
+        reset: "Resets configuration file to default values."
+    invalid: "Invalid command."
+    run:
+      summary: "Runs alarm (default command)."
+      description: "Runs alarm with specified options. CLI options > options.yml."
+      options:
+        categories: "Limit selection by categories. Example usage: \"cat1.subcat1 cat2.subcat1.subsubcat1 .excludethis.subcat etc.\""
+        dl_method: "Override download method set in your active options."
+        number: "Override selection using random number generator by specifying fixed number."
+        player: "Override which player to use."
+        rng: "Override random number generation method specified in your options.yml file. Possible values: \"hwrng\", \"random.org\", \"rand-hwrng-seed\", \"rand\". Default value: \"hwrng\"."
+    sources:
+      summary: "Manage source(s)."
+      description: "List or download source(s) or edit your sources file in your default editor (default: edit)."
+      options:
+        list: "List sources. Can be restricted by categories. DEFAULT option. Usage: list \"all|category.subcategory .exclude.this\". Default: list \"all\""
+        download: "Downloads source(s). Usage: download \"all|number\". Default: download \"all\"."
+    translate:
+      summary: "Translate app."
+      description: "Opens your language file in your default editor."
+output:
+  alarm: "Alarm"
+  category: "Category"
+  date: "DateTime"
+  downloading: "Downloading: "
+  number: "Number"
+sources:
+  invalid_format: "Invalid sources format."
+  invalid_item: "Item %1 is invalid."

data/config/templates/options/linux.yml

@@ -0,0 +1,39 @@
+---
+os: linux
+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: /dev/urandom
+  method: hwrng
+  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