o-mpd_client 0.2.0.1

data/README.md

@@ -0,0 +1,148 @@
+# MPD::Client
+
+[![Build Status](https://badgen.net/travis/mamantoha/mpd_client)](https://travis-ci.org/mamantoha/mpd_client)
+[![Gem Version](https://badge.fury.io/rb/mpd_client.svg)](https://badge.fury.io/rb/mpd_client)
+
+Yet another Music Player Daemon (MPD) client library written entirely in Ruby.
+`mpd_client` is a Ruby port of the [python-mpd](https://github.com/Mic92/python-mpd2) library.
+
+## Installation
+
+Add this line to your application `Gemfile`:
+
+```ruby
+gem 'mpd_client'
+```
+
+And then execute:
+
+```console
+bundle
+```
+
+Or install it yourself as:
+
+```console
+gem install mpd_client
+```
+
+## Usage
+
+All functionality is contained in the `MPD::Client` class. Creating an instance of this class is as simple as:
+
+```ruby
+require 'mpd_client'
+
+client = MPD::Client.new
+```
+
+Once you have an instance of the `MPD::Client` class, start by connecting to the server:
+
+```ruby
+client.connect('localhost', 6600)
+```
+
+or Unix domain socket
+
+```ruby
+client.connect('/var/run/mpd/socket')
+```
+
+The client library can be used as follows:
+
+```ruby
+puts client.mpd_version             # print the mpd version
+puts client.search('title', 'ruby') # print the result of the command 'search title ruby'
+client.close                        # send the close command
+client.disconect                    # disconnect from the server
+```
+
+Command lists are also supported using `command_list_ok_begin` and `command_list_end`:
+
+```ruby
+client.command_list_ok_begin # start a command list
+client.update                # insert the update command into the list
+client.status                # insert the status command into the list
+client.command_list_end      # result will be a Array with the results
+```
+
+### Binary responses
+
+Some commands can return binary data.
+
+```ruby
+require 'mpd_client'
+
+client = MPD::Client.new
+client.connect('localhost', 6600)
+
+if (current_song = client.currentsong)
+  data, io = client.readpicture(current_song['file'])
+  io # StringIO
+  data # => {"size"=>"322860", "type"=>"image/jpeg", "binary"=>"3372"}
+  File.write('cover.jpg', io.string)
+end
+```
+
+The above will locate album art for the current song and save image to `cover.jpg` file.
+
+### Ranges
+
+Some commands(e.g. `move`, `delete`, `load`, `shuffle`, `playlistinfo`) support integer ranges(`[START:END]`) as argument. This is done in `mpd_client` by using two element array:
+
+```ruby
+# move the first three songs after the fifth number in the playlist
+client.move([0, 3], 5)
+```
+
+Second element can be omitted. MPD will assumes the biggest possible number then:
+
+```ruby
+# delete all songs from the current playlist, except for the firts ten
+client.delete([10,])
+```
+
+### Logging
+
+Default logger for all MPD::Client instances:
+
+```ruby
+require 'logger'
+require 'mpd_client'
+
+MPD::Client.log = Logger.new($stderr)
+
+client = MPD::Client.new
+```
+
+Sets the logger used by this instance of MPD::Client:
+
+```ruby
+require 'logger'
+require 'mpd_client'
+
+client = MPD::Client.new
+client.log = Logger.new($stderr)
+```
+
+For more information about logging configuration, see [Logger](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License and Author
+
+Copyright (c) 2012-2022 by Anton Maminov
+
+This library is distributed under the MIT license.  Please see the LICENSE file.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mpd_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'mpd_client', path: '../'

data/examples/albumart.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'logger'
+require 'mpd_client'
+
+# MPD::Client.log = Logger.new($stderr)
+
+client = MPD::Client.new
+client.connect('localhost', 6600)
+
+if (current_song = client.currentsong)
+  data, io = client.readpicture(current_song['file'])
+  puts data
+  File.write('cover.jpg', io.string)
+end

data/examples/client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'logger'
+require 'mpd_client'
+
+MPD::Client.log = Logger.new($stderr)
+
+client = MPD::Client.new
+client.connect('localhost', 6600)
+
+puts client.stats
+puts client.status
+puts client.currentsong
+puts client.playlistinfo

data/examples/idle.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'logger'
+require 'mpd_client'
+
+client = MPD::Client.new
+
+client = MPD::Client.new
+client.log = Logger.new($stderr)
+
+client.connect('localhost', 6600)
+
+# Lists all changed systems:
+# database, update, stored_playlist, playlist, player, mixer, output, options, sticker, subscription, message
+#
+subsystems = %w[player playlist]
+
+loop do
+  resp = client.idle(*subsystems)
+  puts resp
+end
+
+client.close
+client.disconnect

data/examples/range.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'pp'
+require 'logger'
+require 'mpd_client'
+
+MPD::Client.log = Logger.new($stderr)
+
+client = MPD::Client.new
+client.connect('localhost', 6600)
+
+# delete all songs from the current playlist, except for the firts ten
+client.delete([10])
+
+# move the first three songs after the fifth number in the playlist
+client.move([0, 3], 5)
+
+# print songs form 5 to 10
+client.playlistinfo([5, 10]).each { |s| puts "#{s['artist']} - #{s['title']}" }

data/examples/rangeid.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'pp'
+require 'logger'
+require 'mpd_client'
+
+MPD::Client.log = Logger.new($stderr)
+
+client = MPD::Client.new
+client.connect('localhost', 6600)
+
+# Get id of the first song in the playllist
+song = client.playlistinfo(1).first
+pp "#{song['artist']} - #{song['title']}"
+song_id = song['id']
+
+# Specifies the portion of the song that shall be played
+client.rangeid(song_id, [60, 70])
+
+# Play the playlist at song 1
+client.play(1)
+
+pp client.status

data/examples/search_and_replace_playlist.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'logger'
+require 'mpd_client'
+
+# MPD::Client.log = Logger.new($stderr)
+
+client = MPD::Client.new
+
+type = ARGV[0]
+what = ARGV[1]
+
+client = MPD::Client.new
+client.log = Logger.new($stderr)
+
+# Connecting to the server
+client.connect('localhost', 6600)
+
+puts "MPD version: #{client.mpd_version}"
+puts "mpd_client version: #{MPD::Client::VERSION}"
+
+client.stop
+client.clear # clear the current playlist
+
+# Finds songs in the db that are exactly `what`.
+# `type` can be any tag supported by MPD
+# or one of the two special parameters:
+# * 'file' - to search by full path (relative to database root),
+# * 'any' - to match against all available tags.
+songs = client.search(type, what)
+
+client.command_list_ok_begin # start a command list to speed up operations
+songs.each do |song|
+  client.add(song['file']) if song.key?('file')
+end
+client.command_list_end
+
+client.play
+
+client.close
+client.disconnect # disconnect from the server

data/examples/stickers.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'logger'
+require 'mpd_client'
+
+MPD::Client.log = Logger.new($stderr)
+
+# Stickers
+# https://mpd.readthedocs.io/en/latest/protocol.html#stickers
+
+client = MPD::Client.new
+
+# Connecting to the server
+client.connect('/run/mpd/socket')
+
+puts "MPD version: #{client.mpd_version}"
+puts "mpd_client version: #{MPD::Client::VERSION}"
+
+uri = 'world/j/Jane Air/2012.Иллюзия полёта/12. Любить любовь.ogg'
+
+# sticker set {TYPE} {URI} {NAME} {VALUE}
+#   Adds a sticker value to the specified object.
+#   If a sticker item with that name already exists, it is replaced.
+#
+client.sticker_set('song', uri, 'rating', '1')
+
+# sticker get {TYPE} {URI} {NAME}
+#   Reads a sticker value for the specified object.
+#
+puts client.sticker_get('song', uri, 'rating')
+
+# sticker list {TYPE} {URI}
+#   Lists the stickers for the specified object.
+#
+puts client.sticker_list('song', uri)
+
+# sticker find {TYPE} {URI} {NAME}
+#   Searches the sticker database for stickers with the specified name, below the specified directory (URI).
+#   For each matching song, it prints the URI and that one sticker's value.
+#
+puts client.sticker_find('song', '/', 'rating')
+
+# sticker delete {TYPE} {URI} [NAME]
+#   Deletes a sticker value from the specified object.
+#   If you do not specify a sticker name, all sticker values are deleted.
+#
+client.sticker_delete('song', uri, 'rating')
+
+client.close
+client.disconnect

data/lib/mpd_client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module MPD
+  class Client
+    VERSION = '0.2.0.1'
+  end
+end