budik 1.0.0

data/lib/budik/rng.rb

@@ -0,0 +1,154 @@
+# = rng.rb
+# This file contains methods for random number generation.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 20, 2015
+
+module Budik
+  # 'Rng' class provides various methods for random number generation.
+  class Rng
+    # Loads RNG options including method.
+    def initialize
+      @options = Config.instance.options['rng']
+      @method = @options['method']
+    end
+
+    # Gets RNG options and method.
+    attr_accessor :options, :method
+
+    # Generates random number.
+    #
+    # - *Args*:
+    #   - +items+ -> Total number of items (Fixnum).
+    # - *Returns*:
+    #   - Fixnum (0...items)
+    #
+    def generate(items)
+      case @method
+      when 'hwrng'
+        hwrng(@options['hwrng'], items)
+      when 'random.org'
+        random_org(@options['random.org'], items)
+      when 'rand-hwrng-seed'
+        swrng(items, hwrng(@options['hwrng'], 2**64))
+      else
+        swrng(items)
+      end
+    end
+
+    private
+
+    # Reads random number from hwrng (/dev/hwrng, /dev/(u)random).
+    # Removes modulo bias.
+    # http://funloop.org/post/2015-02-27-removing-modulo-bias-redux.html
+    # Falls back to swrng if an exception is encountered.
+    #
+    # - *Args*:
+    #   - +options+ -> Hwrng options (Hash).
+    #   - +items+ -> Total number of items (Fixnum).
+    # - *Returns*:
+    #   - Fixnum (0...items)
+    #
+    def hwrng(options, items)
+      source = File.new(options['source'], 'r')
+      max = 2**64
+      bound = items - 1
+      threshold = (max - bound) % bound
+      number = source.read(8).unpack('Q') while number.first < threshold
+      number.first % bound
+    rescue
+      swrng(items)
+    end
+
+    # Queries Random.org API to obtain random number.
+    # https://api.random.org/json-rpc/1/
+    # Falls back to swrng if incorrect response is received.
+    #
+    # - *Args*:
+    #   - +options+ -> Random.org options (Hash).
+    #   - +items+ -> Total number of items (Fixnum).
+    # - *Returns*:
+    #   - Fixnum (0...items)
+    #
+    def random_org(options, items)
+      response = random_org_request(options, items)
+      return response if response.is_a? Fixnum
+
+      if response.code.to_i == 200
+        JSON.parse(response.body)['result']['random']['data'].first
+      else
+        swrng(items)
+      end
+    end
+
+    # Generates Random.org API request data.
+    #
+    # - *Args*:
+    #   - +apikey+ -> Random.org API key (String).
+    #   - +items+ -> Total number of items (Fixnum).
+    # - *Returns*:
+    #   - Random.org API request data (Hash).
+    #
+    def random_org_request_data(apikey, items)
+      { jsonrpc: '2.0',
+        method: 'generateIntegers',
+        params: {
+          apiKey: apikey,
+          n: 1,
+          min: 0,
+          max: items - 1
+        },
+        id: 29 }
+    end
+
+    # Builds a request and sends it to Random.org API.
+    #
+    # - *Args*:
+    #   - +options+ -> Random.org options (Hash).
+    #   - +items+ -> Total number of items (Fixnum).
+    # - *Returns*:
+    #   - Random.org API response object or Fixnum (0...items).
+    #
+    def random_org_request(options, items)
+      uri = URI.parse('http://api.random.org/json-rpc/1/invoke')
+      header = { 'Content-Type' => 'application/json-rpc' }
+      data = random_org_request_data(options['apikey'], items)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri, header)
+      request.body = data.to_json
+
+      random_org_request_send(http, request)
+    end
+
+    # Sends a request to Random.org API.
+    #
+    # - *Args*:
+    #   - +http+ -> Net::HTTP object.
+    #   - +request+ -> Net::HTTP::Post object.
+    # - *Returns*:
+    #   - HTTPResponse object or Fixnum (0...items).
+    #
+    def random_org_request_send(http, request)
+      http.request(request)
+    rescue
+      swrng(items)
+    end
+
+    # Generates random number using (s)rand.
+    #
+    # - *Args*:
+    #   - +items+ -> Total number of items (Fixnum).
+    #   - +seed+ -> Custom seed for rand.
+    # - *Returns*:
+    #   - Fixnum (0...items).
+    #
+    def swrng(items, seed = nil)
+      seed.nil? ? srand : srand(seed) # TODO: Test this
+      rand(0...items)
+    end
+  end
+end

data/lib/budik/sources.rb

@@ -0,0 +1,182 @@
+# = sources.rb
+# This file contains methods for parsing sources and category modifiers.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 20, 2015
+
+module Budik
+  # 'Sources' class loads and parses media sources file.
+  class Sources
+    include Singleton
+
+    # Initializes sources instance variable and strings in currently set
+    # language.
+    def initialize
+      @sources = []
+      @strings = Config.instance.lang.sources
+    end
+
+    # Gets sources
+    attr_accessor :sources
+
+    # Applies category modifiers.
+    #
+    # - *Args*:
+    #   - +mods+ -> Category modifiers (Hash).
+    #
+    def apply_mods(mods)
+      @sources.keep_if do |source|
+        mods[:adds].any? { |mod| apply_mods_check(source[:category], mod) }
+      end
+
+      @sources.delete_if do |source|
+        mods[:rms].any? { |mod| apply_mods_check(source[:category], mod) }
+      end
+    end
+
+    # Checks if mod applies to category.
+    #
+    # - *Args*:
+    #   - +category+ -> Category to be checked (Array).
+    #   - +mod+ -> Modifier to be checked (Array).
+    # - *Returns*:
+    #   - true or false
+    #
+    def apply_mods_check(category, mod)
+      mod_len = mod.length - 1
+      cat_len = category.length - 1
+      len = mod_len <= cat_len ? mod_len : cat_len
+
+      map = category[0..len].zip(mod[0..len]).map { |c, m| c == m }
+      !map.include? false
+    end
+
+    # Returns total count of sources
+    def count
+      @sources.length
+    end
+
+    # Returns source by number.
+    #
+    # - *Args*:
+    #   - +number+ -> Fixnum.
+    #
+    def get(number)
+      @sources[number]
+    end
+
+    # Normalizes item.
+    #
+    # - *Args*:
+    #   - +item+ -> Item to normalize (Array, Hash or String).
+    #   - +category+ -> Item's category (Array).
+    # - *Returns*:
+    #   - Normalized source (Hash).
+    # - *Raises*:
+    #   - +RuntimeError+ -> If item is not Array, Hash or String.
+    #
+    def normalize(source, category)
+      case source
+      when Array
+        normalize_multiple_items(source, category)
+      when Hash
+        normalize_named_source(source, category)
+      when String
+        normalize_unnamed_source(source, category)
+      else
+        fail @strings.invalid_format
+      end
+    end
+
+    # Normalizes unnamed source with multiple items.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to normalize (Array).
+    #   - +category+ -> Source's category (Array).
+    # - *Returns*:
+    #   - Normalized source (Hash).
+    #
+    def normalize_multiple_items(source, category)
+      { name: source.join(' + '), category: category, path: source }
+    end
+
+    # Normalizes named source.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to normalize (Hash).
+    #   - +category+ -> Source's category (Array).
+    # - *Returns*:
+    #   - Normalized source (Hash).
+    #
+    def normalize_named_source(source, category)
+      { name: source.keys[0], category: category, path: source.values[0] }
+    end
+
+    # Normalizes unnamed source with single item.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to normalize (String).
+    #   - +category+ -> Source's category (Array).
+    # - *Returns*:
+    #   - Normalized source (Hash).
+    #
+    def normalize_unnamed_source(source, category)
+      { name: source, category: category, path: [] << source }
+    end
+
+    # Parses sources' categories.
+    #
+    # - *Args*:
+    #   - +sources+ -> Sources loaded from YAML (Hash).
+    #   - +current_category+ -> Source's category (Array).
+    # - *Raises*:
+    #   - +RuntimeError+ -> If category's contents is not Array nor Hash.
+    #
+    def parse(sources, current_category = [])
+      sources.each do |category, contents|
+        case contents
+        when Hash
+          parse(contents, current_category + ([] << category))
+        when Array
+          parse_category(contents, current_category + ([] << category))
+        else
+          fail @strings.invalid_format
+        end
+      end
+    end
+
+    # Parses category contents.
+    #
+    # - *Args*:
+    #   - +contents+ -> Category's contents (Array).
+    #   - +category+ -> Source's category (Array).
+    #
+    def parse_category(contents, category)
+      contents.each { |source| @sources << normalize(source, category) }
+    end
+
+    # Parses string of category modifiers into two arrays (adds, rms).
+    #
+    # - *Args*:
+    #   - +mods+ -> Category modifiers (String).
+    # - *Returns*:
+    #   - Parsed modifiers (Hash).
+    #
+    def parse_mods(mods)
+      parsed_mods = { adds: [], rms: [] }
+
+      mods.split(' ').each do |mod|
+        if mod.split('.').first.empty?
+          parsed_mods[:rms] << mod.split('.').drop(1)
+        else
+          parsed_mods[:adds] << mod.split('.')
+        end
+      end
+
+      parsed_mods
+    end
+  end
+end

data/lib/budik/storage.rb

@@ -0,0 +1,91 @@
+# = storage.rb
+# This file contains methods for managing downloaded sources.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 20, 2015
+
+module Budik
+  # 'Storage' class downloads and manages media sources/items.
+  class Storage
+    include Singleton
+
+    # Loads sources, download directory and download method.
+    def initialize
+      @sources = Sources.instance.sources
+      dir = Config.instance.options['sources']['download']['dir']
+      @dir = File.expand_path(dir) + '/'
+      @method = Config.instance.options['sources']['download']['method']
+    end
+
+    # Gets sources, download directory and download method.
+    attr_accessor :sources, :dir, :method
+
+    # Downloads specified source or all sources.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to download (Hash).
+    #
+    def download_sources(source = nil)
+      if source
+        IO.instance.storage_download_info(source)
+        source[:path].each do |path|
+          download_youtube(YouTubeAddy.extract_video_id(path), path)
+        end
+      else
+        @sources.each { |src| download_sources(src) }
+      end
+    end
+
+    # Downloads video from YouTube by ID with specified options.
+    #
+    # - *Args*:
+    #   - +id+ -> YouTube video ID (String).
+    #   - +address+ -> YouTube video address (String).
+    #
+    def download_youtube(id, address)
+      return unless id && !File.file?(@dir + id + '.mp4')
+
+      # TODO: Update youtube-dl if fail
+      # TODO: username + password
+      options = { output: @dir + '%(id)s.%(ext)s',
+                  format: 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/mp4',
+                  playlist: false }
+      YoutubeDL.download '"' + address + '"', options
+    end
+
+    # Gets downloaded item's location.
+    #
+    # - *Args*:
+    #   - +item+ -> Item to locate (String).
+    # - *Returns*:
+    #   - Path to downloaded file.
+    #   - Unaltered path if streaming or if the item is local.
+    #
+    def locate_item(item)
+      return item if @method == 'stream'
+      is_url = (item =~ /\A#{URI.regexp(%w(http https))}\z/)
+      is_url ? @dir + YouTubeAddy.extract_video_id(item) + '.mp4' : item
+    end
+
+    # Removes specified source or all sources.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to remove (Hash).
+    #
+    def remove_sources(source = nil)
+      return unless @method == 'remove'
+
+      if source
+        source[:path].each do |path|
+          next if locate_item(path) == path
+          FileUtils.rm File.expand_path(locate_item(path)), force: true
+        end
+      else
+        @sources.each { |src| remove_sources(src) }
+      end
+    end
+  end
+end

data/lib/budik/version.rb

@@ -0,0 +1,15 @@
+# = version.rb
+# This file defines application's version.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 20, 2015
+
+# 'Budik' is an alarm clock that randomly plays an item from your media
+# collection (local or YouTube).
+module Budik
+  # Application's version
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,288 @@
+--- !ruby/object:Gem::Specification
+name: budik
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Petr Schmied
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: commander
+  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: r18n-core
+  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: sys-uname
+  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: terminal-table
+  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: ya2yaml
+  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: youtube_addy
+  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: youtube-dl.rb
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: cucumber
+  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: rubocop
+  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: coveralls
+  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: rdoc
+  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: Alarm clock that randomly plays a song or a video from YouTube or your
+  local collection.
+email:
+- jblack@paworld.eu
+executables:
+- budik
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/budik
+- bin/console
+- bin/setup
+- budik.gemspec
+- config/templates/lang/en.yml
+- config/templates/options/linux.yml
+- config/templates/options/rpi.yml
+- config/templates/options/windows.yml
+- config/templates/sources/sources.yml
+- lib/budik.rb
+- lib/budik/command.rb
+- lib/budik/config.rb
+- lib/budik/devices.rb
+- lib/budik/io.rb
+- lib/budik/player.rb
+- lib/budik/rng.rb
+- lib/budik/sources.rb
+- lib/budik/storage.rb
+- lib/budik/version.rb
+homepage: http://jblack.paworld.eu/apps/budik
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: |-
+  Please make sure VLC/omxplayer and FFmpeg/Libav are installed.
+  Run 'budik(.bat) config' to edit app's options as needed.
+  Run 'budik(.bat) sources -e' to edit your media sources.
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Alarm clock.
+test_files: []