ruby-mpd-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ca78849c735d15541f0f0e04e83ac1af66d71c3c3202739a0718f7cfc7860e4
-  data.tar.gz: db532da5093220f87880cd0d47137866b089be98ba8d03a7aa89334869b6da9d
+  metadata.gz: 8418f0f9f6feb888fefb0c1bba3dc1d8992ac221b6e9381278d27091b945a1e6
+  data.tar.gz: 65b8aa6e6f008f339de0766f4f06def5b0f6255db86c60997b0ace019557d240
 SHA512:
-  metadata.gz: 0d23063c2519c020bcf16009a1f6f1874b2d4f53ad41879fc023b5b460e9a531f13a5a665574399cef5836bd9fadbfd4213d2a64f8cef966fa2b8c2dd79194e4
-  data.tar.gz: 0423b775979eb61f9eff55fcfd05d29e6375a17df5e1caf2bb6b9828d7b2d3c32e84e10c792ade9ab004f0462a91292d225e0851f9164a417c6f55c1b698504d
+  metadata.gz: a954040ae3a4828b5b456d4d006ba02d2017b798a03249426db0661ff5e3c16fd439f581f59f03a543ef3db0eed0871183012352d155189b0b337f931163dc8a
+  data.tar.gz: ada812509e41842636a482d76821e2d75f2d72424410ff8572c29d399f9efc8b8cfdc4bdf9d7d1a36240f73472d1aa4fb86c9d0f3dc25d9b7d0aa813294ef490

data/.travis.yml

@@ -8,3 +8,4 @@ deploy:
     secure: CCtmgUnWoiG4tKRalp9kfEcaeDUfipES0mcWPV4K0D/K651nxZ0kHe+VV+3rpvV1KDs4i5W+TosVvpH5lDL7+oALLFTsYgo3iam+kzMLfoskkZUuizUDxYjXrWI0T+SM0gL3Ax1J9oJ0cd7j1sUGi5TZ/IHXrKknm1yqFIx83mgKCFxYKJUAwQuwpo924ukqyQ0IsJtYX7AJ31hQwFBZSscJbriaxsz3dN+ptmvYVt9/+oIowHrvZCFnlgejel/eZ9iKCMR8buxx1RF3Q3y7LZkpMb20UBfjMwUkz/XBXGFCFVUaCLEcdFnAuoRePJ8a+q3Qkd0wZp+5g2offguVycTWsPTGgSjSAXcPUK0fOnE6bsBZ9XnkAiwkPtxO3MeG7iBcGBX2XY/Tzl+8EW2FgGeIICBh5sg+UqmrGAuqzmtgrJJwOaBeyLEbAKemAdPRfN7M0Hq1DgbOHchttmiCAY1Ja/RBiYwbEkZsPn9VI2tH3CUvdqc0B4jPV05OKU1sv06hHKJTWoCjsmvd52Tr0Kbr5ofBvLMj+uHnyCx78SwfReVCPEb2PzK5GUBG6+Ufu8UOTFdlS8gDmSO09R/qd/kSILvxCLntNVQAn/aUlnZ0aBJURxhoTQkKRSBGcGrOUXhMKnj3jnwZw1othJ5xxiSXy6fM/8JrsxyPH7TalT8=
   on:
     branch: master
+    tags: true

data/README.md

@@ -1,10 +1,15 @@
 # Ruby MPD client
 
+master: [![Build Status](https://travis-ci.org/Nondv/ruby-mpd-client.svg?branch=master)](https://travis-ci.org/Nondv/ruby-mpd-client)
+develop: [![Build Status](https://travis-ci.org/Nondv/ruby-mpd-client.svg?branch=develop)](https://travis-ci.org/Nondv/ruby-mpd-client)
+
 Yet another ruby mpd client.
 
 This gem is for my own usage (practicing my programming skills). But
 I would be glad to know if you found it useful.
 
+See on [rubydoc](http://www.rubydoc.info/gems/ruby-mpd-client)
+
 ## Installation
 
 ```ruby
@@ -27,6 +32,7 @@ MPD::Commands::Next.new.execute
 #
 conn = MPD::Connection.new(host: 'localhost', port: 6600)
 conn.connect
+conn.gets # first MPD response is always "OK <version>\n"
 MPD::Commands::Next.new(connection: conn).execute
 MPD::Commands::Pause.new(connection: conn).execute
 ```

data/lib/mpd/commands.rb

@@ -44,18 +44,36 @@ module MPD
       const_set(class_name, klass)
     end
 
-    define_trivial_command(:Pause, 'pause 1')
-    define_trivial_command(:Stop, 'stop')
-    define_trivial_command(:Previous, 'previous')
-    define_trivial_command(:Next, 'next')
-    define_trivial_command(:CurrentPlaylistClear, 'clear')
-
-    define_text_argument_command :PlaylistDelete, :rm
-    define_text_argument_command :PlaylistSave, :save
-    define_text_argument_command :PlaylistLoad, :load
-
-    %w[Consume Crossfade Random Repeat Single].each do |class_name|
-      define_option_command(class_name, class_name.downcase)
-    end
+    # @!macro [attach] define_trivial_command
+    #   @!parse
+    #     # Sends "$2" to MPD.
+    #     class Commands::$1; end
+    define_trivial_command('Pause', 'pause 1')
+    define_trivial_command('Stop', 'stop')
+    define_trivial_command('Previous', 'previous')
+    define_trivial_command('Next', 'next')
+    define_trivial_command('CurrentPlaylistClear', 'clear')
+
+    # @!macro [attach] define_text_argument_command
+    #   @!parse
+    #     # Sends '$2 "<ARGUMENT>"' to MPD
+    #     class Commands::$1; end
+    define_text_argument_command 'PlaylistDelete', :rm
+    define_text_argument_command 'PlaylistSave', :save
+    define_text_argument_command 'PlaylistLoad', :load
+    define_text_argument_command 'PlaylistClear', :playlistclear
+
+    # @!macro [attach] define_option_command
+    #   @!parse
+    #     # Sends '$2 <1/0>' to MPD
+    #     class Commands::$1
+    #       # @param state [Boolean]
+    #       def execute(state); end
+    #     end
+    define_option_command 'Consume', 'consume'
+    define_option_command 'Crossfade', 'crossfade'
+    define_option_command 'Random', 'random'
+    define_option_command 'Repeat', 'repeat'
+    define_option_command 'Single', 'single'
   end
 end

data/lib/mpd/commands/playlist_add.rb

@@ -0,0 +1,20 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Adds song(s) to specific playlist
+    # `songs` is an array of URIs.
+    #
+    class PlaylistAdd < Abstract
+      #
+      # `name` is playlist name.
+      # `songs` is position (as int) or range.
+      #
+      def execute(name, songs)
+        return exec_command("playlistadd \"#{name}\" \"#{songs}\"") unless songs.is_a?(Array)
+        exec_command_list(songs.map { |s| "playlistadd \"#{name}\" \"#{s}\"" })
+      end
+    end
+  end
+end

data/lib/mpd/commands/playlist_info.rb

@@ -0,0 +1,19 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Info about songs in specific playlist.
+    # MPD command: "listplaylistinfo <NAME>"
+    #
+    class PlaylistInfo < Abstract
+      # `songs` can be range
+      # or integer (to show info about one song)
+      # or completely ommited (to show info about all songs)
+      def execute(name)
+        response = super("listplaylistinfo \"#{name}\"")
+        Playlist.from_response(response)
+      end
+    end
+  end
+end

data/lib/mpd/commands/playlist_list.rb

@@ -0,0 +1,17 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # List of saved playlists.
+    #
+    class PlaylistList < Abstract
+      def execute
+        exec_command('listplaylists')
+          .key_value_pairs
+          .select { |k, v| k == 'playlist' }
+          .map(&:last)
+      end
+    end
+  end
+end

data/lib/mpd/server_response.rb

@@ -3,6 +3,7 @@ module MPD
   # Just a frozen string with some useful methods
   #
   class ServerResponse < String
+    # Reads data from `MPD::Connection` instance to next OK/ACK
     def self.from_connection(conn)
       line = ''
       buffer = ''
@@ -24,6 +25,16 @@ module MPD
       key_value_pairs.to_h
     end
 
+    #
+    # MPD often sends data as:
+    #
+    #     id: 1
+    #     title: some title
+    #     id: 2
+    #     title: another title
+    #
+    # So this method comes useful.
+    #
     def key_value_pairs
       content.split("\n").map do |line|
         index = line.index(':')
@@ -39,6 +50,7 @@ module MPD
       lines[0..-2].join
     end
 
+    # last line of response
     def status
       lines.last.chomp
     end

data/lib/mpd/version.rb

@@ -1,3 +1,3 @@
 module MPD
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mpd-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dmitriy Non
@@ -77,6 +77,9 @@ files:
 - lib/mpd/commands/current_song.rb
 - lib/mpd/commands/ping.rb
 - lib/mpd/commands/play.rb
+- lib/mpd/commands/playlist_add.rb
+- lib/mpd/commands/playlist_info.rb
+- lib/mpd/commands/playlist_list.rb
 - lib/mpd/commands/set_volume.rb
 - lib/mpd/commands/status.rb
 - lib/mpd/connection.rb