audio_addict 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b9ee1765ac530791d434e0ae9166dcbbd6c78af0331e6744b798b042a4855cc
-  data.tar.gz: 36572839fec8085f9cdd3e55c0bf092319dac42f707c404097123454fd3f8a59
+  metadata.gz: 1bfa79e76c8667fc213082f955d753693b2f81f1857e82ac610d6b8db960ffb4
+  data.tar.gz: eb1b970c1eee32668eea5deee9c9b9d9658801451399fb55734870d0a995a5ed
 SHA512:
-  metadata.gz: 44e14f1f07236555a67735e407c6aa9ae2849fb7db87b67168f9c1ddb233ee8007cfcd0e77c7462fe26df2a92c2cc4e780513e7a2ab4f522e9aa28f9d3886370
-  data.tar.gz: c5ae90ef4ae1304a684f92679e62f66e8adaf75e65a94410b4259cbefec4aba7983e829dde112f2192564c9ce5fd242eeb0ee1fccb0185dd634e4f14e8a2398d
+  metadata.gz: 3fa5acfa2d77638568b0fa54ccd2e69a88e535fe30d2b8a35ba090b40a1aaae4ee68a1e3bf82eef38cbf751b4e2000dfec0b782a89634eb310bd65653354c003
+  data.tar.gz: 5547a8ab8c783357bb801bcc222b7f65dfadad970b4ded6bf623723651ad5e7c6b18379e624ace46af55d71f9460e8b74f6d973a5f57b811674f01d1a92e73ef

data/bin/radio

@@ -7,28 +7,24 @@ router = AudioAddict::CLI.router
 
 begin
   exit router.run ARGV
-
 rescue Interrupt, AudioAddict::Interrupt, TTY::Reader::InputInterrupt
   say "\nGoodbye"
-  exit 1  
-
+  exit 1
 rescue AudioAddict::ConfigError => e
-  say "!undred!ERROR: Missing Configuration Values"
+  say '!undred!ERROR: Missing Configuration Values'
   say "#{e.message}:"
   e.missing_keys.each do |key|
     say "- !txtblu!#{key}"
   end
-  say ""
-  say "Run !txtpur!radio config guide!txtrst! for more information"
-  exit 1  
-
+  say ''
+  say 'Run !txtpur!radio config guide!txtrst! for more information'
+  exit 1
 rescue => e
   if ENV['DEBUG']
-    puts e.backtrace.reverse 
-    say ""
+    puts e.backtrace.reverse
+    say ''
   end
   say "!undred!ERROR: #{e.class}"
   say e.message
   exit 1
-
-end
+end

data/lib/audio_addict/api.rb

@@ -1,11 +1,11 @@
-require "httparty"
+require 'httparty'
 
 module AudioAddict
   class API
     include HTTParty
     include Cache
 
-    base_uri "https://api.audioaddict.com/v1"
+    base_uri 'https://api.audioaddict.com/v1'
     debug_output $stderr if ENV['AUDIO_ADDICT_DEBUG']
 
     attr_accessor :network
@@ -16,10 +16,10 @@ module AudioAddict
 
     def login(username, password)
       session = session(username, password)
-      Config.session_key = session["key"]
-      Config.listen_key = session["member"]["listen_key"]
-      Config.email = session["member"]["email"]
-      Config.premium = session["member"]["user_type"] == "premium"
+      Config.session_key = session['key']
+      Config.listen_key = session['member']['listen_key']
+      Config.email = session['member']['email']
+      Config.premium = session['member']['user_type'] == 'premium'
       Config.save
     end
 
@@ -40,13 +40,13 @@ module AudioAddict
     end
 
     def basic_auth
-      http.basic_auth "streams", "diradio"
+      http.basic_auth 'streams', 'diradio'
     end
 
     def session(username, password)
       params = { member_session: { username: username, password: password } }
       basic_auth
-      response http.post "/#{network || "di"}/member_sessions", body: params
+      response http.post "/#{network || 'di'}/member_sessions", body: params
     end
 
     def session_key
@@ -57,10 +57,11 @@ module AudioAddict
       Config.listen_key
     end
 
-    private
+  private
 
     def response(httparty_response)
-      raise APIError.new httparty_response unless httparty_response.success?
+      raise APIError, httparty_response unless httparty_response.success?
+
       JSON.parse httparty_response.body
     end
 
@@ -69,7 +70,7 @@ module AudioAddict
     end
 
     def headers
-      { "X-Session-Key" => session_key }
+      { 'X-Session-Key' => session_key }
     end
   end
 end

data/lib/audio_addict/cache.rb

@@ -1,4 +1,4 @@
-require "lightly"
+require 'lightly'
 
 module AudioAddict
   module Cache
@@ -11,7 +11,7 @@ module AudioAddict
     end
 
     def cache_life!
-      Config.cache_life || "6h"
+      Config.cache_life || '6h'
     end
 
     def cache_dir

data/lib/audio_addict/channel.rb

@@ -7,19 +7,21 @@ module AudioAddict
     attr_reader :radio
 
     def initialize(radio, properties)
-      @radio, @properties = radio, properties
+      @radio = radio
+      @properties = properties
     end
 
     def inspectable
-      [:key, :name, :id]
+      %i[key name id]
     end
 
     def active?
       # Seems like each network has a different way of marking inactive channels.
       # This is where we normalize it
-      return false if !properties["asset_id"]
-      return false if name[0] == "X" and key[0] != "x"
-      return true
+      return false unless properties['asset_id']
+      return false if (name[0] == 'X') && (key[0] != 'x')
+
+      true
     end
 
     def track_history
@@ -36,9 +38,10 @@ module AudioAddict
     end
 
     def similar_channels
-      similar = properties["similar_channels"]
+      similar = properties['similar_channels']
       return [] unless similar
-      ids = similar.map { |s| s["similar_channel_id"] }
+
+      ids = similar.map { |s| s['similar_channel_id'] }
       radio.search_by_id ids
     end
 
@@ -52,10 +55,10 @@ module AudioAddict
         radio.api.post "#{endpoint}/#{direction}"
       end
 
-      log_like track if direction == :up and Config.like_log
+      log_like track if (direction == :up) && Config.like_log
     end
 
-    private
+  private
 
     def log_like(track = nil)
       track ||= current_track

data/lib/audio_addict/cli.rb

@@ -2,19 +2,19 @@ module AudioAddict
   class CLI
     def self.router
       router = MisterBin::Runner.new version: VERSION,
-        header: "AudioAddict Radio Utilities"
+        header: 'AudioAddict Radio Utilities'
 
-      router.route "login", to: Commands::LoginCmd
-      router.route "set", to: Commands::SetCmd
-      router.route "channels", to: Commands::ChannelsCmd
-      router.route "now", to: Commands::NowCmd
-      router.route "history", to: Commands::HistoryCmd
-      router.route "vote", to: Commands::VoteCmd
-      router.route "playlist", to: Commands::PlaylistCmd
-      router.route "config", to: Commands::ConfigCmd
-      router.route "log", to: Commands::LogCmd
-      router.route "download", to: Commands::DownloadCmd
-      router.route "api", to: Commands::APICmd
+      router.route 'login', to: Commands::LoginCmd
+      router.route 'set', to: Commands::SetCmd
+      router.route 'channels', to: Commands::ChannelsCmd
+      router.route 'now', to: Commands::NowCmd
+      router.route 'history', to: Commands::HistoryCmd
+      router.route 'vote', to: Commands::VoteCmd
+      router.route 'playlist', to: Commands::PlaylistCmd
+      router.route 'config', to: Commands::ConfigCmd
+      router.route 'log', to: Commands::LogCmd
+      router.route 'download', to: Commands::DownloadCmd
+      router.route 'api', to: Commands::APICmd
 
       router
     end

data/lib/audio_addict/commands/api.rb

@@ -1,18 +1,18 @@
 module AudioAddict
   module Commands
     class APICmd < Base
-      summary "Make direct calls to the AudioAddict API"
+      summary 'Make direct calls to the AudioAddict API'
 
-      help "This command sends a request to the provided API endpoint. The currently configured network is automatically prepended to the endpoint path, and the output is converted to YAML format."
+      help 'This command sends a request to the provided API endpoint. The currently configured network is automatically prepended to the endpoint path, and the output is converted to YAML format.'
 
-      usage "radio api [get|post|delete] ENDPOINT"
-      usage "radio api --help"
+      usage 'radio api [get|post|delete] ENDPOINT'
+      usage 'radio api --help'
 
-      param "ENDPOINT", "API endpoint path"
+      param 'ENDPOINT', 'API endpoint path'
 
-      example "radio api channels"
-      example "radio api get track_history/channel/1"
-      example "radio api post tracks/1/vote/2/up"
+      example 'radio api channels'
+      example 'radio api get track_history/channel/1'
+      example 'radio api post tracks/1/vote/2/up'
 
       def run
         needs :network
@@ -20,16 +20,17 @@ module AudioAddict
         puts response.to_yaml
       end
 
-      private
+    private
 
       def api_method
-        return :post if args["post"]
-        return :delete if args["delete"]
-        return :get
+        return :post if args['post']
+        return :delete if args['delete']
+
+        :get
       end
 
       def endpoint
-        args["ENDPOINT"]
+        args['ENDPOINT']
       end
 
       def api

data/lib/audio_addict/commands/base.rb

@@ -1,6 +1,6 @@
-require "mister_bin"
-require "colsole"
-require "tty/prompt"
+require 'mister_bin'
+require 'colsole'
+require 'tty/prompt'
 
 module AudioAddict
   module Commands

data/lib/audio_addict/commands/channels.rb

@@ -1,58 +1,58 @@
 module AudioAddict
   module Commands
     class ChannelsCmd < Base
-      summary "Show list of channels"
+      summary 'Show list of channels'
 
-      help "This command lets you list and search for channels in the currently active radio network."
+      help 'This command lets you list and search for channels in the currently active radio network.'
 
-      usage "radio channels [SEARCH --info]"
-      usage "radio channels --help"
+      usage 'radio channels [SEARCH --info]'
+      usage 'radio channels --help'
 
-      option "-i --info", "Show results with additional info, such as channel description and related channels"
+      option '-i --info', 'Show results with additional info, such as channel description and related channels'
 
-      param "SEARCH", "Channel name or a partial name to search for"
+      param 'SEARCH', 'Channel name or a partial name to search for'
 
-      example "radio channels"
-      example "radio channels --info"
-      example "radio channels metal"
-      example "radio channels metal -i"
+      example 'radio channels'
+      example 'radio channels --info'
+      example 'radio channels metal'
+      example 'radio channels metal -i'
 
       def run
         needs :network
 
         say "!undgrn!#{radio.name}\n"
 
-        search = args["SEARCH"]
+        search = args['SEARCH']
 
         channels = search ? radio.search(search) : radio.channels
 
         channels = channels.values
-        if args["--info"]
+        if args['--info']
           show_verbose channels
         else
           show_compact channels
         end
       end
 
-      private
+    private
 
       def show_verbose(channels)
         channels.each do |channel|
-          say ""
+          say ''
           say "!txtgrn!#{channel.name.ljust 22} !txtrst!# #{channel.key}"
-          say ""
-          say word_wrap "#{channel.description}"
-          say ""
+          say ''
+          say word_wrap channel.description.to_s
+          say ''
 
           similar = channel.similar_channels
 
-          if similar.any?
-            say "Similar Channels:"
-            similar.each do |key, similar|
-              say "- !txtblu!#{similar.name.ljust 20}!txtrst! # #{key}"
-            end
-            say ""
+          next unless similar.any?
+
+          say 'Similar Channels:'
+          similar.each do |key, similar_channel|
+            say "- !txtblu!#{similar_channel.name.ljust 20}!txtrst! # #{key}"
           end
+          say ''
         end
       end
 

data/lib/audio_addict/commands/config.rb

@@ -1,57 +1,57 @@
 module AudioAddict
   module Commands
     class ConfigCmd < Base
-      summary "Manage local configuration"
-
-      help "This command provides low level access to your local configuration file."
-
-      usage "radio config set KEY VALUE"
-      usage "radio config get KEY"
-      usage "radio config del KEY"
-      usage "radio config show"
-      usage "radio config edit"
-      usage "radio config check"
-      usage "radio config guide"
-      usage "radio config --help"
-
-      param "KEY", "Config key"
-      param "VALUE", "Config value"
-
-      option "-s --show", "Show the contents of the config file"
-      option "-e --edit", "Open the config file for editing"
-
-      command "get", "Show the value of this config key"
-      command "set", "Set the value of this config key"
-      command "del", "Delete the value of this config key"
-      command "show", "Show the entire config file contents"
-      command "edit", "Open the config file for editing"
-      command "guide", "Show a list of supported config keys and their purpose"
-      command "check", "Verify and report problems with the config file"
-
-      example "radio config edit"
-      example "radio config set like_log ~/like.log"
-      example "radio config del session_key"
-      example "radio config get listen_key"
+      summary 'Manage local configuration'
+
+      help 'This command provides low level access to your local configuration file.'
+
+      usage 'radio config set KEY VALUE'
+      usage 'radio config get KEY'
+      usage 'radio config del KEY'
+      usage 'radio config show'
+      usage 'radio config edit'
+      usage 'radio config check'
+      usage 'radio config guide'
+      usage 'radio config --help'
+
+      param 'KEY', 'Config key'
+      param 'VALUE', 'Config value'
+
+      option '-s --show', 'Show the contents of the config file'
+      option '-e --edit', 'Open the config file for editing'
+
+      command 'get', 'Show the value of this config key'
+      command 'set', 'Set the value of this config key'
+      command 'del', 'Delete the value of this config key'
+      command 'show', 'Show the entire config file contents'
+      command 'edit', 'Open the config file for editing'
+      command 'guide', 'Show a list of supported config keys and their purpose'
+      command 'check', 'Verify and report problems with the config file'
+
+      example 'radio config edit'
+      example 'radio config set like_log ~/like.log'
+      example 'radio config del session_key'
+      example 'radio config get listen_key'
 
       def get_command
-        key = args["KEY"].to_sym
+        key = args['KEY'].to_sym
         value = Config.properties[key]
-        say value ? "!txtgrn!#{value}" : "!txtred!<Unset>"
+        say value ? "!txtgrn!#{value}" : '!txtred!<Unset>'
       end
 
       def set_command
-        key = args["KEY"].to_sym
-        value = args["VALUE"]
+        key = args['KEY'].to_sym
+        value = args['VALUE']
         Config.properties[key] = value
         Config.save
         say "!txtgrn!#{key}=#{value}"
       end
 
       def del_command
-        key = args["KEY"].to_sym
+        key = args['KEY'].to_sym
         Config.delete key
         Config.save
-        say "!txtgrn!Deleted"
+        say '!txtgrn!Deleted'
       end
 
       def show_command
@@ -59,12 +59,12 @@ module AudioAddict
         if File.exist? Config.path
           puts File.read Config.path
         else
-          say "!txtred!File Not Found"
+          say '!txtred!File Not Found'
         end
       end
 
       def edit_command
-        editor = ENV["EDITOR"] || "vi"
+        editor = ENV['EDITOR'] || 'vi'
         system "#{editor} #{Config.path}"
       end
 
@@ -72,7 +72,7 @@ module AudioAddict
         key_guide.each do |key, value|
           say "!txtgrn!#{key}"
           say word_wrap "  #{value}"
-          say ""
+          say ''
         end
       end
 
@@ -81,17 +81,17 @@ module AudioAddict
         warnings = verify_and_show_keys optional_keys
 
         say "Done. #{errors} errors, #{warnings} warnings."
-        errors > 0 ? 1 : 0
+        errors.positive? ? 1 : 0
       end
 
-      private
+    private
 
       def verify_and_show_keys(keys, critical: false)
         problems = 0
-        prefix = critical ? "!txtred!Error  !txtrst!" : "!txtylw!Warning!txtrst!"
+        prefix = critical ? '!txtred!Error  !txtrst!' : '!txtylw!Warning!txtrst!'
 
         keys.each do |key, command|
-          if !Config.has_key? key
+          unless Config.has_key? key
             problems += 1
             say "#{prefix} : Key !txtgrn!#{key}!txtrst! is not set. Fix with !txtpur!radio #{command}!txtrst!."
           end
@@ -102,30 +102,30 @@ module AudioAddict
 
       def key_guide
         {
-          email: "Last email used for logging in.\nUsually set with !txtpur!radio login!txtrst!.",
+          email:       "Last email used for logging in.\nUsually set with !txtpur!radio login!txtrst!.",
           session_key: "Used for authentication.\nUsually set with !txtpur!radio login!txtrst!.",
-          listen_key: "Used for generating playlists.\nUsually set with !txtpur!radio login!txtrst!.",
-          network: "Specify the AudioAddict network you are currently listening to.\nUsually set with !txtpur!radio set!txtrst!.",
-          channel: "Specify the AudioAddict channel you are currently listening to.\nUsually set with !txtpur!radio set!txtrst!.",
-          like_log: "Specify the path to store all your positive votes.\nIf this is not set, votes will only be sent to AudioAddict and not logged locally.",
-          cache_dir: "Specify the path to store API response cache.\nDefault: ~/.audio_addict/cache",
-          cache_life: "Specify the cache life period.\nDefault: 6h.",
+          listen_key:  "Used for generating playlists.\nUsually set with !txtpur!radio login!txtrst!.",
+          network:     "Specify the AudioAddict network you are currently listening to.\nUsually set with !txtpur!radio set!txtrst!.",
+          channel:     "Specify the AudioAddict channel you are currently listening to.\nUsually set with !txtpur!radio set!txtrst!.",
+          like_log:    "Specify the path to store all your positive votes.\nIf this is not set, votes will only be sent to AudioAddict and not logged locally.",
+          cache_dir:   "Specify the path to store API response cache.\nDefault: ~/.audio_addict/cache",
+          cache_life:  "Specify the cache life period.\nDefault: 6h.",
         }
       end
 
       def required_keys
         {
-          email: "login",
-          session_key: "login",
-          listen_key: "login",
-          network: "set",
-          channel: "set",
+          email:       'login',
+          session_key: 'login',
+          listen_key:  'login',
+          network:     'set',
+          channel:     'set',
         }
       end
 
       def optional_keys
         {
-          like_log: "config set like_log PATH",
+          like_log: 'config set like_log PATH',
         }
       end
     end

data/lib/audio_addict/commands/download.rb

@@ -1,35 +1,36 @@
 module AudioAddict
   module Commands
     class DownloadCmd < Base
-      summary "Download songs from YouTube"
+      summary 'Download songs from YouTube'
 
-      help "This command uses youtube-dl to download the currently playing song, or songs from your like-log."
+      help 'This command uses youtube-dl to download the currently playing song, or songs from your like-log.'
 
-      usage "radio download current [--count N]"
-      usage "radio download log [--lines N --count N]"
-      usage "radio download search QUERY [--count N]"
-      usage "radio download --help"
+      usage 'radio download current [--count N]'
+      usage 'radio download log [--lines N --count N]'
+      usage 'radio download search QUERY [--count N]'
+      usage 'radio download --help'
 
-      option "-l --lines N", "Number of log lines to download [default: 1]"
-      option "-c --count N", "Number of YouTube search results to download\nDefaults to the value of the AUDIO_ADDICT_DOWNLOAD_COUNT environment variable, or 1"
+      option '-l --lines N', 'Number of log lines to download [default: 1]'
+      option '-c --count N',
+        "Number of YouTube search results to download\nDefaults to the value of the AUDIO_ADDICT_DOWNLOAD_COUNT environment variable, or 1"
 
-      param "QUERY", "YouTube search query"
+      param 'QUERY', 'YouTube search query'
 
-      command "current", "Download the currently playing song"
-      command "log", "Download the last N songs from the like-log"
-      command "search", "Download any song matching the Youtube search query"
+      command 'current', 'Download the currently playing song'
+      command 'log', 'Download the last N songs from the like-log'
+      command 'search', 'Download any song matching the Youtube search query'
 
-      environment "AUDIO_ADDICT_DOWNLOAD_COUNT", "Set the default download count (--count)"
+      environment 'AUDIO_ADDICT_DOWNLOAD_COUNT', 'Set the default download count (--count)'
 
-      example "radio download current"
-      example "radio download current --count 3"
-      example "radio download log --lines 2 --count 3"
+      example 'radio download current'
+      example 'radio download current --count 3'
+      example 'radio download log --lines 2 --count 3'
       example "radio download search 'Brimstone, Bright Shadow' -c2"
 
       def current_command
         needs :network, :channel
 
-        say "!txtblu!Downloading !txtrst!: ... "
+        say '!txtblu!Downloading !txtrst!: ... '
 
         track = current_channel.current_track
         query = track.search_string
@@ -43,9 +44,9 @@ module AudioAddict
         needs :like_log
         lines = args['--lines']&.to_i
 
-        data = log.data[-lines..-1]
+        data = log.data[-lines..]
         data.each do |line|
-          network, channel, artist, song = line.split(" :: ")
+          _network, _channel, artist, song = line.split(' :: ')
           query = "#{artist}, #{song}"
           say "\n!txtblu!Downloading !txtgrn!: #{query}"
           Youtube.new(query).get count

data/lib/audio_addict/commands/history.rb

@@ -1,23 +1,23 @@
 module AudioAddict
   module Commands
     class HistoryCmd < Base
-      summary "Show track history for the current channel"
+      summary 'Show track history for the current channel'
 
-      help "This command shows the last few tracks that were playing on the currently active channel in reverse order (top track is the most recent)."
+      help 'This command shows the last few tracks that were playing on the currently active channel in reverse order (top track is the most recent).'
 
-      usage "radio history"
-      usage "radio history --help"
+      usage 'radio history'
+      usage 'radio history --help'
 
       def run
         needs :network, :channel
         say "!undgrn!#{radio.name} > #{current_channel.name}"
-        say ""
+        say ''
         tracks.each do |track|
           say "!txtgrn! #{track.artist.rjust max_artist_len}!txtrst! : !txtblu!#{track.title}"
         end
       end
 
-      private
+    private
 
       def tracks
         @tracks ||= current_channel.track_history