muzak 0.0.13 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6895336a3fa06db40e63f71d227e36b11a18397
-  data.tar.gz: 32f2ad6998993b76b783d9e97d8d91db55db1be0
+  metadata.gz: efea3aab55cde7f64c4385e48873e81f89ba4b0f
+  data.tar.gz: ff90d394bdb2937280c31615f7ca84d9e1e7651f
 SHA512:
-  metadata.gz: bea81c7b13e504c158e9fb6d01beb3431d56b48c578b3f0c659dd059adad4c6cd87d1e3e975c58bf8be6fe1e412dad6508846cb5a98b603fa96a9948a3f0a4ed
-  data.tar.gz: 692b0d3ba74454f6c7669156f4cf472932c930bcb29e59399149371db188eaf01442062bd7a8be31af854bbc06f2636d2694505ab46edb1e9848c6e4ed7f78cb
+  metadata.gz: 5e4182c5276d798c51cd282ba6b6f8d5524eee2577c3f5f3574cd7f96bdfcb18b2d3b12f8362c1adf21cf0e074491ada9944c64f56d9c1d9d245b34415d43346
+  data.tar.gz: 2827f75b69ecf2da6321ec3944647b0e9c64d2812d40b48bd76697dc999eb493e12c55b5b8e55149c3ec67e34565f310024873713a7d957e6d4a1b689c555452

data/bin/muzak-cmd

@@ -1,19 +1,21 @@
 #!/usr/bin/env ruby
 
 require "muzak"
+require "socket"
 
 def fatal(msg)
   puts "Fatal: #{msg}"
   exit 1
 end
 
-fifo_path = File.join(Muzak::CONFIG_DIR, "muzak.fifo")
-
-fatal "Is muzakd running?" unless File.exist?(fifo_path)
-
-File.open(fifo_path, "w") do |io|
-  # we don't actually need to do this, but let's be verbose for the user
-  fatal "Unknown command." unless Muzak::Cmd.commands.include?(ARGV.first)
-
-  io.puts ARGV.join(" ")
+begin
+  server_host = Muzak::Config.daemon_host
+  server_port = Muzak::Config.daemon_port
+  sock = TCPSocket.new server_host, server_port
+rescue
+  fatal "Is muzakd running?"
 end
+
+sock.puts ARGV.join(" ")
+puts sock.gets
+sock.close

data/bin/muzak-dmenu

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 
 require "muzak"
+require "socket"
 
 def fatal(msg)
-  puts "Fatal: #{msg}"
+  STDERR.puts "Fatal: #{msg}"
   exit 1
 end
 
@@ -13,12 +14,17 @@ def dmenu(options)
 	`printf "#{opts}" | #{dmenu}`
 end
 
-fifo_path = File.join(Muzak::CONFIG_DIR, "muzak.fifo")
-
-fatal "Is muzakd running?" unless File.exist?(fifo_path)
+begin
+  server_host = Muzak::Config.daemon_host
+  server_port = Muzak::Config.daemon_port
+  sock = TCPSocket.new server_host, server_port
+rescue
+  fatal "Is muzakd running?"
+end
 
 command = dmenu Muzak::Cmd.commands
 
-File.open(fifo_path, "w") do |io|
-  io.puts command unless command.empty?
-end
+sock.puts command unless command.empty?
+puts sock.gets
+
+sock.close

data/bin/muzakd

@@ -2,24 +2,31 @@
 
 require "muzak"
 require "shellwords"
+require "socket"
+require "json"
+require "thread"
 
 Process.daemon unless Muzak::Config.debug || Muzak::Config.verbose
 Thread.abort_on_exception = Muzak::Config.debug
 
 muzak = Muzak::Instance.new
 
-fifo_path = File.join(Muzak::CONFIG_DIR, "muzak.fifo")
-File.delete(fifo_path) if File.exist?(fifo_path) # just in case a previous session died
-File.mkfifo(fifo_path)
+server_port = Muzak::Config.daemon_port || 2669
+server = TCPServer.new server_port
 
-File.open(fifo_path, "r+") do |fifo|
-  loop do
-    cmd_argv = Shellwords.split(fifo.readline) rescue next
+exiting = false
+
+loop do
+  begin
+    client = server.accept
+    cmd_argv = Shellwords.split(client.readline)
     next if cmd_argv.empty? || cmd_argv.any?(&:empty?)
-    cmd = cmd_argv.shift
-    muzak.command cmd, *cmd_argv
-    break if cmd == "quit"
+    client.puts(muzak.command(*cmd_argv).to_json)
+    break if cmd_argv.first == "quit"
+  rescue Exception => e
+    client.puts({ error: e.to_s }.to_json)
+    raise e
+  ensure
+    client.close
   end
 end
-
-File.delete(fifo_path) if File.exist?(fifo_path)

data/lib/muzak/cmd/config.rb

@@ -5,12 +5,10 @@ module Muzak
     # Query the {Muzak::Config} for a given key.
     # @command `config-get <key>`
     # @cmdexample `muzak> config-get player`
-    def config_get(*args)
-      fail_arity(args, 1)
-      key = args.shift
-      return if key.nil?
+    def config_get(key)
+      value = Config.send Utils.resolve_method(key)
 
-      info "#{key}: #{Config.send Utils.resolve_method(key)}"
+      build_response data: { key => value }
     end
   end
 end

data/lib/muzak/cmd/index.rb

@@ -4,29 +4,32 @@ module Muzak
     # @command `index-build`
     # @cmdexample `muzak> index-build`
     def index_build(*args)
-      warn_arity(args, 0)
-
       verbose "building a new index, this may take a while"
 
       index.build!
+
+      build_response data: {
+        artists: index.artists.size,
+        albums: index.albums.size
+      }
     end
 
     # List all artists in the index.
     # @command `list-artists`
     # @cmdexample `muzak> list-artists`
-    def list_artists(*args)
-      warn_arity(args, 0)
-
-      puts index.artists.join("\n")
+    def list_artists
+      build_response data: {
+        artists: index.artists
+      }
     end
 
     # List all albums in the index.
     # @command `list-albums`
     # @cmdexample `muzak> list-albums`
-    def list_albums(*args)
-      warn_arity(args, 0)
-
-      puts index.album_names.join("\n")
+    def list_albums
+      build_response data: {
+        albums: index.album_names
+      }
     end
 
     # List all albums by the given artist in the index.
@@ -34,9 +37,12 @@ module Muzak
     # @cmdexample `muzak> albums-by-artist Your Favorite Artist`
     def albums_by_artist(*args)
       artist = args.join(" ")
-      return if artist.nil?
 
-      puts index.albums_by(artist).map(&:title)
+      albums = index.albums_by(artist).map(&:title)
+
+      build_response data: {
+        albums: albums
+      }
     end
 
     # List all songs by the given artist in the index.
@@ -44,9 +50,12 @@ module Muzak
     # @cmdexample `muzak> songs-by-artist Your Next Favorite Artist`
     def songs_by_artist(*args)
       artist = args.join(" ")
-      return if artist.nil?
 
-      puts index.songs_by(artist).map(&:title)
+      songs = index.songs_by(artist).map(&:title)
+
+      build_response data: {
+        songs: songs
+      }
     end
   end
 end

data/lib/muzak/cmd/meta.rb

@@ -5,7 +5,10 @@ module Muzak
     # @cmdexample `muzak> help`
     def help(*args)
       commands = Muzak::Cmd.commands.join(", ")
-      info "available commands: #{commands}"
+
+      build_response data: {
+        commands: commands
+      }
     end
 
     # List all available plugins.
@@ -14,8 +17,9 @@ module Muzak
     # @note This list will differ from loaded plugins, if not all available
     #   plugins are configured.
     def list_plugins
-      plugins = Plugin.plugin_names.join(", ")
-      puts "available plugins: #{plugins}"
+      build_response data: {
+        plugins: Plugin.plugin_names
+      }
     end
 
     # Terminates the muzak instance (**not** just the client).
@@ -24,6 +28,8 @@ module Muzak
     def quit
       verbose "muzak is quitting..."
       player.deactivate!
+
+      build_response
     end
   end
 end

data/lib/muzak/cmd/player.rb

@@ -11,6 +11,8 @@ module Muzak
       end
 
       player.activate!
+
+      build_response
     end
 
     # Deactivate the configured player.
@@ -22,6 +24,8 @@ module Muzak
 
       # do cleanup even if the player isn't running, just in case
       player.deactivate!
+
+      build_response
     end
 
     # Tell the player to begin playback.
@@ -29,6 +33,8 @@ module Muzak
     # @cmdexample `muzak> play`
     def play
       player.play
+
+      build_response
     end
 
     # Tell the player to pause.
@@ -36,6 +42,8 @@ module Muzak
     # @cmdexample `muzak> pause`
     def pause
       player.pause
+
+      build_response
     end
 
     # Tell the player to toggle its playback state.
@@ -47,6 +55,8 @@ module Muzak
       else
         player.play
       end
+
+      build_response
     end
 
     # Tell the player to load the next song.
@@ -54,6 +64,8 @@ module Muzak
     # @cmdexample `muzak> next`
     def next
       player.next_song
+
+      build_response
     end
 
     # Tell the player to load the previous song.
@@ -61,6 +73,8 @@ module Muzak
     # @cmdexample `muzak> previous`
     def previous
       player.previous_song
+
+      build_response
     end
 
     # Tell the player to enqueue all songs by the given artist.
@@ -68,13 +82,15 @@ module Muzak
     # @cmdexample `muzak> enqueue-artist Your Favorite Artist`
     def enqueue_artist(*args)
       artist = args.join(" ")
-      return if artist.nil?
-
       albums = index.albums_by(artist)
-      return if albums.empty?
 
-      albums.each do |album|
-        player.enqueue_album album
+      unless albums.empty?
+        albums.each do |album|
+          player.enqueue_album album
+        end
+        build_response
+      else
+        build_response error: "no albums by: '#{artist}'"
       end
     end
 
@@ -83,30 +99,39 @@ module Muzak
     # @cmdexample `muzak> enqueue-album Your Favorite Album`
     def enqueue_album(*args)
       album_name = args.join(" ")
-      return if album_name.nil?
 
       album = index.albums[album_name]
-      return if album.nil?
 
-      player.enqueue_album album
+      if album
+        player.enqueue_album album
+        build_response
+      else
+        build_response error: "no such album: '#{album_name}'"
+      end
     end
 
     # Tell the player to load the given number of random songs.
     # @command `jukebox [count]`
     # @cmdexample `muzak> jukebox 150`
-    def jukebox(*args)
-      count = args.shift || Config.jukebox_size
-
+    def jukebox(count = Config.jukebox_size)
       songs = index.jukebox(count.to_i)
 
-      songs.each { |s| player.enqueue_song s }
+      Thread.new do
+        songs.each { |s| player.enqueue_song s }
+      end
+
+      build_response data: {
+        jukebox: songs.map(&:full_title)
+      }
     end
 
     # Tell the player to list its internal queue.
     # @command `list-queue`
     # @cmdexample `muzak> list-queue`
     def list_queue
-      puts player.list_queue.map(&:title)
+      build_response data: {
+        queue: player.list_queue.map(&:title)
+      }
     end
 
     # Tell the player to shuffle its internal queue.
@@ -114,6 +139,8 @@ module Muzak
     # @cmdexample `muzak> shuffle-queue`
     def shuffle_queue
       player.shuffle_queue
+
+      build_response
     end
 
     # Tell the player to clear its internal queue.
@@ -122,15 +149,21 @@ module Muzak
     # @note This does not (usually) stop the current song.
     def clear_queue
       player.clear_queue
+
+      build_response
     end
 
     # Retrieve the currently playing song from the player and print it.
     # @command `now-playing`
     # @cmdexample `muzak> now-playing`
     def now_playing
-      return unless player.playing?
-
-      info player.now_playing.full_title
+      if player.playing?
+        build_response data: {
+          playing: player.now_playing.full_title
+        }
+      else
+        build_response error: "no currently playing song"
+      end
     end
   end
 end

data/lib/muzak/cmd/playlist.rb

@@ -3,100 +3,97 @@ module Muzak
     # List all currently available playlists.
     # @command `list-playlists`
     # @cmdexample `muzak> list-playlists`
-    def list_playlists(*args)
-      Playlist.playlist_names.each do |playlist|
-        info playlist
-      end
+    def list_playlists
+      build_response data: {
+        playlists: Playlist.playlist_names
+      }
     end
 
     # Delete the given playlist.
     # @command `playlist-delete <playlist>`
     # @cmdexample `muzak> playlist-delete favorites`
-    def playlist_delete(*args)
-      fail_arity(args, 1)
-      pname = args.shift
-
+    def playlist_delete(pname)
       debug "deleting playist '#{pname}'"
 
       Playlist.delete!(pname)
       playlists[pname] = nil
+
+      build_response
     end
 
     # Add the given playlist to the player's queue.
     # @command `enqueue-playlist <playlist>`
     # @cmdexample `muzak> enqueue-playlist favorites`
-    def enqueue_playlist(*args)
-      fail_arity(args, 1)
-      pname = args.shift
-
+    def enqueue_playlist(pname)
       player.enqueue_playlist(playlists[pname])
       event :playlist_enqueued, playlists[pname]
+
+      build_response
     end
 
     # Add the given album to the given playlist.
     # @command `playlist-add-album <playlist> <album name>`
     # @cmdexample `muzak> playlist-add-album favorites Your Favorite Album`
-    def playlist_add_album(*args)
-      pname = args.shift
-      return if pname.nil?
-
+    def playlist_add_album(pname, *args)
       album_name = args.join(" ")
-      return if album_name.nil?
-
       album = index.albums[album_name]
-      return if album.nil?
 
-      playlists[pname].add(album.songs)
+      if album
+        playlists[pname].add(album.songs)
+        build_response
+      else
+        build_response error: "no such album: '#{album_name}'"
+      end
     end
 
     # Add the given artist to the given playlist.
     # @command `playlist-add-artist <playlist> <artist name>`
     # @cmdexample `muzak> playlist-add-artist dad-rock The Rolling Stones`
-    def playlist_add_artist(*args)
-      pname = args.shift
-      return if pname.nil?
-
+    def playlist_add_artist(pname, *args)
       artist = args.join(" ")
-      return if artist.nil?
+      songs = index.songs_by(artist)
 
-      playlists[pname].add(index.songs_by(artist))
+      unless songs.empty?
+        playlists[pname].add(songs)
+        build_response
+      else
+        build_response error: "no songs by artist: '#{artist}'"
+      end
     end
 
     # Add the currently playing song to the given playlist.
     # @see Muzak::Player::StubPlayer#now_playing
     # @command `playlist-add-current <playlist>`
     # @cmdexample `muzak> playlist-add-current favorites`
-    def playlist_add_current(*args)
-      return unless player.running?
-
-      pname = args.shift
-      return if pname.nil?
-
-      playlists[pname].add player.now_playing
+    def playlist_add_current(pname)
+      if player.running?
+        playlists[pname].add player.now_playing
+        build_response
+      else
+        build_response error: "the player is not running"
+      end
     end
 
     # Deletes the currently playing song from the given playlist.
     # @see Muzak::Player::StubPlayer#now_playing
     # @command `playlist-del-current <playlist>`
     # @cmdexample `muzak> playlist-del-current favorites`
-    def playlist_del_current(*args)
-      return unless player.running?
-
-      pname = args.shift
-      return if pname.nil?
-
-      playlists[pname].delete player.now_playing
+    def playlist_del_current(pname)
+      if player.running?
+        playlists[pname].delete player.now_playing
+        build_response
+      else
+        build_response error: "the player is not running"
+      end
     end
 
     # Shuffle the given playlist.
     # @see Muzak::Playlist#shuffle!
     # @command `playlist-shuffle <playlist>`
     # @cmdexample `muzak> playlist-shuffle dad-rock`
-    def playlist_shuffle(*args)
-      pname = args.shift
-      return if pname.nil?
-
+    def playlist_shuffle(pname)
       playlists[pname].shuffle!
+      build_response
     end
   end
 end

data/lib/muzak/const.rb

@@ -1,6 +1,6 @@
 module Muzak
   # Muzak's current version
-  VERSION = "0.0.13".freeze
+  VERSION = "0.1.0".freeze
 
   # The root directory for all user configuration, data, etc
   CONFIG_DIR = File.expand_path("~/.config/muzak").freeze

data/lib/muzak/index.rb

@@ -18,10 +18,11 @@ module Muzak
 
     # @param tree [String] the root to begin indexing from
     # @param deep [Boolean] whether to build a "deep" index
+    # @param sync [Boolean] whether or not to save to {Muzak::INDEX_FILE}
     # @note if the index ({Muzak::INDEX_FILE}) already exists and is not
     #   outdated, no building is performed.
     # @see #build!
-    def initialize(tree, deep: false)
+    def initialize(tree, deep: false, sync: true)
       @tree = tree
       @deep = deep
 
@@ -31,17 +32,23 @@ module Muzak
         return unless outdated?
       end
 
-      build!
+      build!(sync)
+    end
+
+    # Synchronize the in-memory index hash with {Muzak::INDEX_FILE}.
+    def sync!
+      File.open(INDEX_FILE, "w") { |io| io.write Marshal::dump @hash }
     end
 
     # (Re)builds and saves the index ({Muzak::INDEX_FILE}) to disk.
+    # @param sync [Boolean] whether or not to save to {Muzak::INDEX_FILE}
     # @note This method can be expensive.
-    def build!
+    def build!(sync: true)
       @hash = build_index_hash!
 
       debug "indexed #{albums.length} albums by #{artists.length} artists"
 
-      File.open(INDEX_FILE, "w") { |io| io.write Marshal::dump @hash }
+      sync! if sync
     end
 
     # @return [Boolean] whether or not the current index is deep

data/lib/muzak/instance.rb

@@ -11,12 +11,17 @@ module Muzak
     #   instance.command "enqueue-playlist", "favorites"
     #   instance.command "pause"
     def command(cmd, *args)
-      send Utils.resolve_command(cmd), *args
-    end
-
-    def method_missing(meth, *args)
-      warn "unknown command: #{Utils.resolve_method(meth)}"
-      help
+      if Cmd.commands.include?(cmd)
+        meth = method(Utils.resolve_command(cmd))
+        if meth.arity == args.size || meth.arity <= -1
+          meth.call *args
+        else
+          build_response error: "got #{args.size} args, needed #{meth.arity}"
+        end
+      else
+        warn "unknown command: '#{cmd}'"
+        build_response error: "unknown command '#{cmd}'"
+      end
     end
 
     # @return [Index] the instance's music index

data/lib/muzak/utils.rb

@@ -115,22 +115,16 @@ module Muzak
       output pretty(:blue, "verbose"), args
     end
 
-    # Outputs a boxed warning message unless the arity of the given arguments
-    #   equals the expected arity.
-    # @param args [Array<String>] the arguments
-    # @param arity [Integer] the expected arity
-    # @return [void]
-    def warn_arity(args, arity)
-      warn "expected #{arity} arguments, got #{args.length}" unless args.length == arity
-    end
-
-    # Outputs a boxed failure message unless the arity of the given arguments
-    #   equals the expected arity.
-    # @param args [Array<String>] the arguments
-    # @param arity [Integer] the expected arity
-    # @return [void]
-    def fail_arity(args, arity)
-      error "needed #{arity} arguments, got #{args.length}" unless args.length == arity
+    # Returns a response hash containing the given data and error.
+    # @param error [String] the error string, if needed
+    # @param data [String, Hash] the data, if needed
+    def build_response(error: nil, data: nil)
+      { response: {
+          error: error,
+          data: data,
+          method: caller_locations.first.label
+        }
+      }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muzak
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.1.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2016-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
@@ -27,7 +27,6 @@ dependencies:
 description: A library for controlling playlists and media players.
 email: william@tuffbizz.com
 executables:
-- muzak
 - muzakd
 - muzak-cmd
 - muzak-dmenu
@@ -37,7 +36,6 @@ files:
 - ".yardopts"
 - LICENSE
 - README.md
-- bin/muzak
 - bin/muzak-cmd
 - bin/muzak-dmenu
 - bin/muzakd

data/bin/muzak

@@ -1,46 +0,0 @@
-#!/usr/bin/env ruby
-
-require "muzak"
-require "readline"
-require "shellwords"
-
-Thread.abort_on_exception = Muzak::Config.debug
-
-muzak = Muzak::Instance.new
-
-COMMANDS = Muzak::Cmd.commands
-
-CONFIG_REGEX = /^config-(get)|(set)|(del)/
-ARTIST_REGEX = Regexp.union COMMANDS.select{ |c| c =~ /artist/ }.map { |c| /^#{c}/ }
-ALBUM_REGEX = Regexp.union COMMANDS.select{ |c| c =~ /album/ }.map { |c| /^#{c}/ }
-PLAYLIST_REGEX = /^playlist-delete/
-
-comp = proc do |s|
-  case Readline.line_buffer
-  when CONFIG_REGEX
-    muzak.config.keys.grep(Regexp.new(Regexp.escape(s)))
-  when ARTIST_REGEX
-    ss = Readline.line_buffer.split(" ")
-    muzak.index.artists.grep(Regexp.new(Regexp.escape(ss[1..-1].join(" "))))
-  when ALBUM_REGEX
-    muzak.index.album_names.grep(Regexp.new(Regexp.escape(s)))
-  when PLAYLIST_REGEX
-    Muzak::Playlist.playlist_names.grep(Regexp.new(Regexp.escape(s)))
-  else
-    COMMANDS.grep(Regexp.new(Regexp.escape(s)))
-  end
-end
-
-Readline.completion_append_character = " "
-Readline.completion_proc = comp
-
-# ignore interrupts
-trap("INT", "SIG_IGN")
-
-while line = Readline.readline("muzak> ", true)
-  cmd_argv = Shellwords.split(line) rescue next
-  next if cmd_argv.empty? || cmd_argv.any?(&:empty?)
-  cmd = cmd_argv.shift
-  muzak.command cmd, *cmd_argv
-  break if cmd == "quit"
-end