audio_addict 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a20c9ff92ff9420328e3fad7fc6bd027a639b9cdd8603deb8586584e1b2dbb
-  data.tar.gz: b3dd3ac2feaf72ce4d90b8f870541c13df60cb22c9d8b0ba7e8575a533ccb61c
+  metadata.gz: 1344d6300842af6ee581d4ea2b5695c9f741ea0a839993dfae73d218280d0b88
+  data.tar.gz: facf7ab27a2e123012fa721e1eb4f36ed90e9fd6d0f184950b9ea6a6a2d37b39
 SHA512:
-  metadata.gz: b1bfca5b36d0a563882a7ac014b6ba5b32a7b78ace57183a286958b020ebe8bd1f056083803ddca02e3b5ab592abefa8722e553521c27dcbfa43c096f548ec3e
-  data.tar.gz: 660c35babd95d6fb25e14825d07cbbb2535dc365603352df155256fdfedc778eed8278d986df0fad5b209fd6784ff43d96b6594f3e9b70a14e9cb492d2acebff
+  metadata.gz: e95982e148ee53bba66319321918cc89ce3b17f0f1d8865677ba660a3e3bdb0dcf0ec503feea3baa4aef6434be5368b0f88293ecd43ece461ec570c082effa78
+  data.tar.gz: e9e0219a73b6e51390fd8c22a98195add6596e5d7b7bd81fd93f889aa9cc40b2c1f5b87a4ed95e081386152abfed1f9bae4d933a2da8d9097b3a4fb690b72b18

data/README.md

@@ -39,6 +39,7 @@ Features
 - View list of channels
 - View currently playing track
 - Vote on the currently playing track
+- Save a log of a all your liked tracks
 - Generate playlists
 
 
@@ -60,6 +61,8 @@ Commands:
   now       Show network, channel and playing track
   vote      Vote on the currently playing track
   playlist  Generate playlists
+  config    Manage local configuration
+
 
 ```
 

data/lib/audio_addict/cli.rb

@@ -11,6 +11,7 @@ module AudioAddict
       router.route 'now',      to: Commands::NowCmd
       router.route 'vote',     to: Commands::VoteCmd
       router.route 'playlist', to: Commands::PlaylistCmd
+      router.route 'config',   to: Commands::ConfigCmd
 
       router
     end

data/lib/audio_addict/commands/config.rb

@@ -0,0 +1,91 @@
+module AudioAddict
+  module Commands
+    class ConfigCmd < Base
+      summary "Manage local configuration"
+
+      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 keys"
+      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 "keys", "Show a list of supported config keys and their purpose."
+
+      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(args)
+        key = args['KEY'].to_sym
+        value = Config.properties[key]
+        say value ? "!txtgrn!#{value}" : "!txtred!<Unset>"
+      end
+
+      def set_command(args)
+        key = args['KEY'].to_sym
+        value = args['VALUE']
+        Config.properties[key] = value
+        Config.save
+        say "!txtgrn!#{key}=#{value}"
+      end
+
+      def del_command(args)
+        key = args['KEY'].to_sym
+        Config.delete key
+        Config.save
+        say "!txtgrn!Deleted"
+      end
+
+      def show_command(args)
+        say "!undpur!# #{Config.path}"
+        if File.exist? Config.path
+          puts File.read Config.path
+        else
+          say "!txtred!File Not Found"
+        end
+      end
+
+      def edit_command(args)
+        editor = ENV['EDITOR'] || 'vi'
+        system "#{editor} #{Config.path}"
+      end
+
+      def keys_command(args)
+        key_guide.each do |key, value|
+          say "!txtgrn!#{key}"
+          say word_wrap "  #{value}"
+          say ""
+        end
+      end
+
+    private
+
+      def key_guide
+        {
+          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.",
+        }
+      end
+      
+    end
+  end
+end

data/lib/audio_addict/commands/playlist.rb

@@ -15,45 +15,60 @@ module AudioAddict
       example "radio playlist init MyRockMusic"
       example "radio playlist generate MyRockMusic"
 
-      def run(args)
+      def init_command(args)
         needs :network, :channel, :listen_key
 
-        @args = args
-        @filename = "#{@args['NAME']}"
+        name = args['NAME']
+        outfile = "#{name}.yml"
 
-        init_command if args['init']
-        generate_command if args['generate']
+        say "!txtred!Warning!txtrst!: !txtgrn!#{outfile}!txtrst! already exists!" if File.exist? outfile
+        proceed = prompt.yes? "Create #{outfile}?"
+        if proceed
+          generate_config outfile
+          say ""
+          generate_command({ 'NAME' => name }) # we also generate the playlist
+        end
       end
 
-    private
+      def generate_command(args)
+        needs :network, :channel, :listen_key
 
-      def init_command
-        @outfile = "#{@filename}.yml"
+        name = args['NAME']
 
-        say "!txtred!Warning!txtrst!: !txtgrn!#{@outfile}!txtrst! already exists!" if File.exist? @outfile
-        proceed = prompt.yes? "Create #{@outfile}?"
-        if proceed
-          generate_config 
-          say ""
-          generate_command # we also generate the playlist
+        infile = "#{name}.yml"
+        outfile = "#{name}.pls"
+
+        if !File.exist? infile
+          say "!txtred!Cannot find #{infile}"
+        else
+          say "!txtred!Warning!txtrst!: !txtgrn!#{outfile}!txtrst! already exists!" if File.exist? outfile
+          proceed = prompt.yes? "Create #{outfile}?"
+          generate_playlist infile, outfile if proceed
         end
       end
 
-      def generate_command
-        @infile = "#{@filename}.yml"
-        @outfile = "#{@filename}.pls"
+    private
 
-        if !File.exist? @infile
-          say "!txtred!Cannot find #{@infile}"
-        else
-          say "!txtred!Warning!txtrst!: !txtgrn!#{@outfile}!txtrst! already exists!" if File.exist? @outfile
-          proceed = prompt.yes? "Create #{@outfile}?"
-          generate_playlist if proceed
+      def generate_config(outfile)
+        data = {
+          template: "http://prem2.#{radio.domain}:80/%{channel_key}?%{listen_key}"
+        }
+
+        channels = []
+        
+        radio.channels.each do |key, channel|
+          channel_data = { name: channel.name, key: key, active: true }
+          channels << channel_data
         end
+
+        data[:channels] = channels
+
+        File.write outfile, data.to_yaml
+        say "Saved !txtgrn!#{outfile}"
       end
 
-      def generate_playlist
-        data = YAML.load_file @infile
+      def generate_playlist(infile, outfile)
+        data = YAML.load_file infile
         template = data[:template]
         channels = data[:channels].select { |c| c[:active] }
 
@@ -72,32 +87,14 @@ module AudioAddict
 
         output = output.join("\n") + "\n"
 
-        File.write @outfile, output
-        say "Saved !txtgrn!#{@outfile}"
+        File.write outfile, output
+        say "Saved !txtgrn!#{outfile}"
       end
 
       def template_params(channel_key)
         { listen_key: listen_key, channel_key: channel_key }
       end
 
-      def generate_config
-        data = {
-          template: "http://prem2.#{radio.domain}:80/%{channel_key}?%{listen_key}"
-        }
-
-        channels = []
-        
-        radio.channels.each do |key, channel|
-          channel_data = { name: channel.name, key: key, active: true }
-          channels << channel_data
-        end
-
-        data[:channels] = channels
-
-        File.write @outfile, data.to_yaml
-        say "Saved !txtgrn!#{@outfile}"
-      end
-
       def listen_key
         Config.listen_key
       end

data/lib/audio_addict/commands/status.rb

@@ -8,39 +8,46 @@ module AudioAddict
 
       option "-u --unsafe", "Show the full session and listen keys"
 
-      def run(args)
-        say "!txtblu! Config Path !txtrst!: !txtgrn!#{Config.path}"
-
-        say "!txtblu! Session Key !txtrst!: "
-        if Config.session_key
-          key = Config.session_key
-          display_key = args['--unsafe'] ? key : "***#{key[-4, 4]}"
-          say "!txtgrn!#{display_key}"
-        else 
-          say "!txtred!<Unset>!txtrst! - run !txtpur!radio login!txtrst! to fix"
-        end
+      def keys
+        {
+          path: { 
+            name: "Config Path", value: Config.path },
 
-        say "!txtblu!  Listen Key !txtrst!: "
-        if Config.listen_key
-          key = Config.listen_key
-          display_key = args['--unsafe'] ? key : "***#{key[-4, 4]}"
-          say "!txtgrn!#{display_key}"
-        else 
-          say "!txtred!<Unset>!txtrst! - run !txtpur!radio login!txtrst! to fix"
-        end
+          session_key: { 
+            name: "Session Key", command: 'login', secret: true },
 
-        say "!txtblu!     Network !txtrst!: "
-        if Config.network 
-          say "!txtgrn!#{Config.network}"
-        else
-          say "!txtred!<Unset>!txtrst! - run !txtpur!radio set!txtrst! to fix"
-        end
+          listen_key: { 
+            name: "Listen Key", command: 'login', secret: true },
+
+          network: { 
+            name: "Network", command: 'set' },
 
-        say "!txtblu!     Channel !txtrst!: "
-        if Config.channel
-          say "!txtgrn!#{Config.channel}"
-        else
-          say"!txtred!<Unset>!txtrst! - run !txtpur!radio set!txtrst! to fix"
+          channel: { 
+            name: "Channel", command: 'set' },
+
+          like_log: { 
+            name: "Like Log", command: 'config like_log PATH' },
+        }
+      end
+
+      def run(args)
+        keys.each do |key, info|
+          value = info[:value] || Config.properties[key]
+
+          if value and !args['--unsafe'] and info[:secret]
+            value = "***#{value[-4, 4]}" 
+          end
+          
+          if value
+            display_value = "!txtgrn!#{value}!txtrst!"
+          else
+            display_value = "!txtred!<Unset>!txtrst!"
+            if info[:command]
+              display_value = "#{display_value} - set with !txtpur!radio #{info[:command]}"
+            end
+          end
+
+          say "!txtblu!#{info[:name].rjust 14}!txtrst! : #{display_value}"
         end
 
       end

data/lib/audio_addict/config.rb

@@ -14,27 +14,16 @@ module AudioAddict
         end
       end
 
-      def delete(key)
-        properties.delete key
+      def delete(*keys)
+        keys.each { |key| properties.delete key.to_sym }
       end
 
       def save
-        File.deep_write path, properties.to_yaml
-      end
-
-      def valid?
-        required_keys.each do |key|
-          return false unless has_key? key
-        end
-        true
-      end
-
-      def required_keys
-        [:network, :channel, :session_key]
+        File.deep_write path, sorted_properties.to_yaml
       end
 
       def has_key?(key)
-        properties.has_key? key
+        properties.has_key? key.to_sym
       end
 
       def properties
@@ -45,6 +34,10 @@ module AudioAddict
         File.exist?(path) ? YAML.load_file(path) : {}
       end
 
+      def sorted_properties
+        properties.sort.to_h
+      end
+
       def path
         @path ||= ENV.fetch('AUDIO_ADDICT_CONFIG_PATH', default_path)
       end

data/lib/audio_addict/exceptions.rb

@@ -5,12 +5,6 @@ module AudioAddict
   class ArgumentError < Error; end
   class ConfigError < Error; end
   
-  class LoginError < Error
-    def initialize(msg="This operation requires logging in")
-      super
-    end
-  end
-
   class APIError < Error
     attr_reader :response
 

data/lib/audio_addict/extensions/file.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 
 class File
   def self.contains?(file, content)
+    return false unless File.exist? file
     foreach file do |line|
       return true if line.chomp == content
     end

data/lib/audio_addict/radio.rb

@@ -68,10 +68,6 @@ module AudioAddict
       channels.keys.include? channel
     end
 
-    def favorites
-      api.member['network_favorite_channels']
-    end
-
     def api
       @api ||= API.new network
     end

data/lib/audio_addict/version.rb

@@ -1,3 +1,3 @@
 module AudioAddict
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audio_addict
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2018-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -58,20 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: requires
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +112,7 @@ files:
 - lib/audio_addict/cli.rb
 - lib/audio_addict/commands/base.rb
 - lib/audio_addict/commands/channels.rb
+- lib/audio_addict/commands/config.rb
 - lib/audio_addict/commands/login.rb
 - lib/audio_addict/commands/now.rb
 - lib/audio_addict/commands/playlist.rb