ruby-mpd-client 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d038318cf899183f6ed52cc1f3c13294b87d899
-  data.tar.gz: 1c19d632d7c424d08ba14a5df9be67ca64217213
+SHA256:
+  metadata.gz: 8ca78849c735d15541f0f0e04e83ac1af66d71c3c3202739a0718f7cfc7860e4
+  data.tar.gz: db532da5093220f87880cd0d47137866b089be98ba8d03a7aa89334869b6da9d
 SHA512:
-  metadata.gz: 8ebe86c126933033f19be9e25b1c1e1a7e1c2b76856f1e65b60e16e0b685781d6c9f554688e3799a34221072b10b88495a3be94eb296d51f14d97b1092ba2e6b
-  data.tar.gz: 93ae6e1f0904011acf8976c26bfc8616d64d7a3336bb382fd076b6e80747e464fbadab11af69a608a0822f84108ca0ba6922645298aacdf51890d820ddd5e95d
+  metadata.gz: 0d23063c2519c020bcf16009a1f6f1874b2d4f53ad41879fc023b5b460e9a531f13a5a665574399cef5836bd9fadbfd4213d2a64f8cef966fa2b8c2dd79194e4
+  data.tar.gz: 0423b775979eb61f9eff55fcfd05d29e6375a17df5e1caf2bb6b9828d7b2d3c32e84e10c792ade9ab004f0462a91292d225e0851f9164a417c6f55c1b698504d

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+- 2.3.0
+script: rake spec
+deploy:
+  provider: rubygems
+  api_key:
+    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

data/README.md

@@ -18,13 +18,21 @@ It does not do much
 ```ruby
 require 'ruby-mpd-client'
 
-mpd = MPD::Client.new(host: 'localhost')
-mpd.volume(50)
-mpd.random(true)
-mpd.next
-# and so on
+MPD::Commands::SetVolume.new(host: 'localhost') # :host can be ommited
+                        .execute(75)
+MPD::Commands::Next.new.execute
+
+#
+# to use one connection
+#
+conn = MPD::Connection.new(host: 'localhost', port: 6600)
+conn.connect
+MPD::Commands::Next.new(connection: conn).execute
+MPD::Commands::Pause.new(connection: conn).execute
 ```
 
+For available commands see [lib/mpd/commands](lib/mpd/commands).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Nondv/ruby-mpd-client.

data/lib/mpd/commands.rb

@@ -0,0 +1,61 @@
+Dir[File.join(__dir__, 'commands', '*.rb')].each { |f| require f }
+
+module MPD
+  #
+  # Contains classes representing MPD commands
+  #
+  module Commands
+    #
+    # To decrease code amount
+    #
+    def self.define_trivial_command(class_name, command)
+      klass = Class.new(::MPD::Commands::Abstract) do
+        define_method :execute do
+          super(command)
+        end
+      end
+
+      const_set(class_name, klass)
+    end
+
+    #
+    # To define commands like 'save "whatever this is"'
+    #
+    def self.define_text_argument_command(class_name, command)
+      klass = Class.new(::MPD::Commands::Abstract) do
+        define_method :execute do |arg|
+          super("#{command} \"#{arg}\"")
+        end
+      end
+
+      const_set(class_name, klass)
+    end
+
+    #
+    # To define commands like "random <1/0>"
+    #
+    def self.define_option_command(class_name, command)
+      klass = Class.new(::MPD::Commands::Abstract) do
+        define_method :execute do |state|
+          super(command + state ? ' 1' : ' 0')
+        end
+      end
+
+      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
+  end
+end

data/lib/mpd/commands/abstract.rb

@@ -0,0 +1,61 @@
+require 'mpd/connection'
+require 'mpd/server_response'
+require 'mpd/playlist'
+
+module MPD
+  module Commands
+    #
+    # Base class for MPD commands.
+    #
+    class Abstract
+      attr_reader :connection
+
+      #
+      # You can provide you own connection. It should have same
+      #
+      def initialize(connection: nil, host: 'localhost', port: 6600)
+        @connection = connection || Connection.new(host: host, port: port).tap(&:connect).tap(&:gets)
+      end
+
+      #
+      # This method should be overriden.
+      # Example:
+      #
+      #     def execute
+      #       super('ping')
+      #     end
+      #
+      def execute(command)
+        exec_command(command)
+      end
+
+      private
+
+      def exec_command(command)
+        connection.puts(command)
+        response = ServerResponse.from_connection(connection)
+        raise(MpdError, response.status) if response.error?
+        response
+      end
+
+      def exec_command_list(commands)
+        connection.puts('command_list_begin')
+        commands.each { |c| connection.puts(c) }
+        connection.puts('command_list_end')
+
+        response = ServerResponse.from_connection(connection)
+        raise(MpdError, response.status) if response.error?
+        response
+      end
+
+      def resolve_range(arg)
+        if arg.is_a?(Range)
+          last = arg.exclude_end? ? arg.end : arg.end + 1
+          "#{arg.begin}:#{last}"
+        else
+          arg
+        end
+      end
+    end
+  end
+end

data/lib/mpd/commands/all_files.rb

@@ -0,0 +1,17 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Uses "listall" command to get
+    # all files (directories are filtered out) from db.
+    #
+    class AllFiles < Abstract
+      def execute
+        super('listall').key_value_pairs
+                        .select { |e| e[0] == 'file' }
+                        .map(&:last)
+      end
+    end
+  end
+end

data/lib/mpd/commands/change_volume.rb

@@ -0,0 +1,14 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Increases/decreases volume by some number
+    #
+    class ChangeVolume < Abstract
+      def execute(n)
+        super("volume #{n}")
+      end
+    end
+  end
+end

data/lib/mpd/commands/current_playlist_add.rb

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

data/lib/mpd/commands/current_playlist_info.rb

@@ -0,0 +1,18 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Info about songs in current playlist
+    #
+    class CurrentPlaylistInfo < Abstract
+      # `songs` can be range
+      # or integer (to show info about one song)
+      # or completely ommited (to show info about all songs)
+      def execute(songs = nil)
+        response = super("playlistinfo #{resolve_range(songs)}")
+        Playlist.from_response(response)
+      end
+    end
+  end
+end

data/lib/mpd/commands/current_playlist_remove.rb

@@ -0,0 +1,20 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Removes songs from current playlist
+    # by id or position/range
+    #
+    class CurrentPlaylistRemove < Abstract
+      #
+      # `position` is int or range
+      # `id` is int song id
+      #
+      def execute(position: nil, id: nil)
+        raise(ArgumentError) if position && id || !position && !id
+        exec_command(id ? "deleteid #{id}" : "delete #{resolve_range(position)}")
+      end
+    end
+  end
+end

data/lib/mpd/commands/current_song.rb

@@ -0,0 +1,14 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Current song info as hash
+    #
+    class CurrentSong < Abstract
+      def execute
+        super('currentsong').to_h
+      end
+    end
+  end
+end

data/lib/mpd/commands/ping.rb

@@ -0,0 +1,23 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Tries to execute "ping" command.
+    # Returns `true` if succedeed,
+    # raises error if `MpdError` occurred,
+    # `false` otherwise
+    #
+    class Ping < Abstract
+      # rubocop:disable Lint/RescueWithoutErrorClass
+      def execute
+        super('ping')
+        true
+      rescue => e
+        raise e if e.is_a?(MpdError)
+        false
+      end
+      # rubocop:enable Lint/RescueWithoutErrorClass
+    end
+  end
+end

data/lib/mpd/commands/play.rb

@@ -0,0 +1,23 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Play specific song (by id or cur. playlist position).
+    #
+    #
+    class Play < Abstract
+      def execute(position: nil, id: nil)
+        raise(ArgumentError, 'too many arguments') if position && id
+
+        if position
+          super("play #{position}")
+        elsif id
+          super("playid #{id}")
+        else
+          super('play')
+        end
+      end
+    end
+  end
+end

data/lib/mpd/commands/set_volume.rb

@@ -0,0 +1,14 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Set specific volume to specific value
+    #
+    class SetVolume < Abstract
+      def execute(n)
+        super("setvol #{n}")
+      end
+    end
+  end
+end

data/lib/mpd/commands/status.rb

@@ -0,0 +1,14 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Player status
+    #
+    class Status < Abstract
+      def execute
+        super('status').to_h
+      end
+    end
+  end
+end

data/lib/mpd/connection.rb

@@ -0,0 +1,41 @@
+require 'socket'
+
+module MPD
+  #
+  # Simple wrapper over Socket
+  #
+  class Connection
+    def initialize(host:, port:)
+      @host = host
+      @port = port
+    end
+
+    def connect
+      disconnect if socket
+      @socket = TCPSocket.open(host, port)
+    end
+
+    def disconnect
+      socket && socket.close
+      @socket = nil
+    end
+
+    def puts(text)
+      raise ConnectionError unless socket
+      socket.puts(text)
+    rescue Errno::ECONNRESET
+      raise ConnectionError
+    end
+
+    def gets
+      raise ConnectionError unless socket
+      socket.gets || raise(ConnectionError)
+    rescue Errno::ECONNRESET
+      raise ConnectionError
+    end
+
+    private
+
+    attr_reader :socket, :host, :port
+  end
+end

data/lib/mpd/server_response.rb

@@ -0,0 +1,50 @@
+module MPD
+  #
+  # Just a frozen string with some useful methods
+  #
+  class ServerResponse < String
+    def self.from_connection(conn)
+      line = ''
+      buffer = ''
+      while line != "OK\n" && !line.start_with?('ACK')
+        line = conn.gets
+        raise(ConnectionError) if line.nil?
+        buffer << line
+      end
+
+      new(buffer.force_encoding('UTF-8'))
+    end
+
+    def initialize(response_text)
+      super
+      freeze
+    end
+
+    def to_h
+      key_value_pairs.to_h
+    end
+
+    def key_value_pairs
+      content.split("\n").map do |line|
+        index = line.index(':')
+        raise "can't create key-value pair" unless index
+        key = line[0...index]
+        value = line[(index + 1)..-1].strip
+        [key, value]
+      end
+    end
+
+    # text without status
+    def content
+      lines[0..-2].join
+    end
+
+    def status
+      lines.last.chomp
+    end
+
+    def error?
+      status.start_with?('ACK')
+    end
+  end
+end

data/lib/mpd/version.rb

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

data/lib/ruby-mpd-client.rb

@@ -1,3 +1,3 @@
 require 'mpd/version'
 require 'mpd/errors'
-require 'mpd/client'
+require 'mpd/commands'

data/ruby-mpd-client.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec-its'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mpd-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dmitriy Non
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-02 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: 
 email:
 - non.dmitriy@gmail.com
@@ -46,21 +60,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- lib/mpd/client.rb
-- lib/mpd/client/commands.rb
-- lib/mpd/client/commands/current_playlist.rb
-- lib/mpd/client/commands/playback_control.rb
-- lib/mpd/client/commands/playback_options.rb
-- lib/mpd/client/connection.rb
-- lib/mpd/client/server_response.rb
+- lib/mpd/commands.rb
+- lib/mpd/commands/abstract.rb
+- lib/mpd/commands/all_files.rb
+- lib/mpd/commands/change_volume.rb
+- lib/mpd/commands/current_playlist_add.rb
+- lib/mpd/commands/current_playlist_info.rb
+- lib/mpd/commands/current_playlist_remove.rb
+- lib/mpd/commands/current_song.rb
+- lib/mpd/commands/ping.rb
+- lib/mpd/commands/play.rb
+- lib/mpd/commands/set_volume.rb
+- lib/mpd/commands/status.rb
+- lib/mpd/connection.rb
 - lib/mpd/errors.rb
 - lib/mpd/playlist.rb
+- lib/mpd/server_response.rb
 - lib/mpd/song.rb
 - lib/mpd/version.rb
 - lib/ruby-mpd-client.rb
@@ -85,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: yet another MPD client on Ruby

data/lib/mpd/client.rb

@@ -1,51 +0,0 @@
-require 'mpd/client/connection'
-require 'mpd/client/server_response'
-require 'mpd/client/commands'
-
-module MPD
-  class Client
-    def self.connect(host: 'localhost', port: 6600)
-      new(host: host, port: port).tap(&:connect)
-    end
-
-    def initialize(host: 'localhost', port: 6600)
-      @connection = Connection.new(host: host, port: port)
-    end
-
-    def current_song
-      execute('currentsong').to_h
-    end
-
-    def status
-      response = execute('status')
-      response.to_h
-    end
-
-    def execute(command)
-      connection.puts(command)
-      response = ServerResponse.from_connection(connection)
-      raise(MpdError, response.status) if response.error?
-      response
-    end
-
-    def connected?
-      execute('ping')
-    rescue => e
-      raise e if e.is_a?(MpdError)
-      false
-    end
-
-    def connect
-      connection.connect
-      raise(ConnectionError) unless connection.gets =~ /^OK/
-    end
-
-    def disconnect
-      connection.disconnect
-    end
-
-    private
-
-    attr_reader :connection
-  end
-end

data/lib/mpd/client/commands.rb

@@ -1,10 +0,0 @@
-Dir[File.join(__dir__, 'commands', '*.rb')].each { |f| require f }
-
-module MPD
-  class Client
-    # Module of modules that implement some MPD commands
-    module Commands
-      constants.each { |mod| Client.include(const_get(mod)) }
-    end
-  end
-end

data/lib/mpd/client/commands/current_playlist.rb

@@ -1,17 +0,0 @@
-require 'mpd/playlist'
-
-module MPD
-  class Client
-    module Commands
-      # https://www.musicpd.org/doc/protocol/queue.html
-      module CurrentPlaylist
-        # songs - integer or range
-        def playlist_info(songs = nil)
-          argument = songs.is_a?(Range) ? "#{songs.begin}:#{songs.end}" : songs
-          response = execute "playlistinfo #{argument}"
-          Playlist.from_response(response)
-        end
-      end
-    end
-  end
-end

data/lib/mpd/client/commands/playback_control.rb

@@ -1,36 +0,0 @@
-module MPD
-  class Client
-    module Commands
-      # https://www.musicpd.org/doc/protocol/playback_commands.html
-      module PlaybackControl
-        def play(position: nil, id: nil)
-          raise(ArgumentError, 'too many arguments') if position && id
-
-          if position
-            execute "play #{position}"
-          elsif id
-            execute "playid #{id}"
-          else
-            execute 'pause 0'
-          end
-        end
-
-        def pause
-          execute 'pause 1'
-        end
-
-        def stop
-          execute 'stop'
-        end
-
-        def previous
-          execute 'previous'
-        end
-
-        def next
-          execute 'next'
-        end
-      end
-    end
-  end
-end

data/lib/mpd/client/commands/playback_options.rb

@@ -1,36 +0,0 @@
-module MPD
-  class Client
-    module Commands
-      # https://www.musicpd.org/doc/protocol/playback_option_commands.html
-      module PlaybackOptions
-        def consume(state)
-          execute "consume #{state ? 1 : 0}"
-        end
-
-        def crossfade(state)
-          execute "crossfade #{state ? 1 : 0}"
-        end
-
-        def random(state)
-          execute "random #{state ? 1 : 0}"
-        end
-
-        def repeat(state)
-          execute "repeat #{state ? 1 : 0}"
-        end
-
-        def single(state)
-          execute "single #{state ? 1 : 0}"
-        end
-
-        def volume(val)
-          execute "setvol #{val}"
-        end
-
-        def change_volume_by(val)
-          execute("volume #{val}")
-        end
-      end
-    end
-  end
-end

data/lib/mpd/client/connection.rb

@@ -1,39 +0,0 @@
-require 'socket'
-
-module MPD
-  class Client
-    #
-    # It's `Client`'s internal class. Don't use it outside `Client`
-    #
-    class Connection
-      def initialize(host:, port:)
-        @host = host
-        @port = port
-      end
-
-      def connect
-        disconnect if socket
-        @socket = TCPSocket.open(host, port)
-      end
-
-      def disconnect
-        socket && socket.close
-        @socket = nil
-      end
-
-      def puts(text)
-        raise ConnectionError unless socket
-        socket.puts(text)
-      end
-
-      def gets
-        raise ConnectionError unless socket
-        socket.gets
-      end
-
-      private
-
-      attr_reader :socket, :host, :port
-    end
-  end
-end

data/lib/mpd/client/server_response.rb

@@ -1,52 +0,0 @@
-module MPD
-  class Client
-    #
-    # Just a frozen string with some useful methods
-    #
-    class ServerResponse < String
-      def self.from_connection(conn)
-        line = ''
-        buffer = ''
-        while line != "OK\n" && !line.start_with?('ACK')
-          line = conn.gets
-          raise(ConnectionError) if line.nil?
-          buffer << line
-        end
-
-        new(buffer.force_encoding('UTF-8'))
-      end
-
-      def initialize(response_text)
-        super
-        freeze
-      end
-
-      def to_h
-        key_value_pairs.to_h
-      end
-
-      def key_value_pairs
-        content.split("\n").map do |line|
-          index = line.index(':')
-          raise "can't create key-value pair" unless index
-          key = line[0...index]
-          value = line[(index + 1)..-1].strip
-          [key, value]
-        end
-      end
-
-      # text without status
-      def content
-        lines[0..-2].join
-      end
-
-      def status
-        lines.last.chomp
-      end
-
-      def error?
-        status.start_with?('ACK')
-      end
-    end
-  end
-end