ruby-mpd-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a5f269daaee86e7aae52ba8aaf7563405297cdd
+  data.tar.gz: c67bfa95cb8bbd8d0098ca1a60138f27916f993a
+SHA512:
+  metadata.gz: ca6a6b9608feec8ff4d23724589f3b03942b4ed0274a3e2ec2eb61e30761923c76547060891fa5e6501fd756134482506bc27559f29af830a128a08d5ab203a4
+  data.tar.gz: 63f2c58e74605215f01940d367ecde94ee93c1909cd3111b10a3d72cc3773668ef9da3bdc85b80b89c7fd1a68e2b7da7bd2d16f308a404e334d07c1d6ea07222

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-mpd-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitriy Non
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# 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.
+
+## Installation
+
+```ruby
+gem 'ruby-mpd-client'
+```
+
+## Usage
+
+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
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Nondv/ruby-mpd-client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'ruby-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/lib/mpd/client.rb

@@ -0,0 +1,34 @@
+require 'mpd/client/connection'
+require 'mpd/client/server_response'
+require 'mpd/client/commands'
+
+module MPD
+  class Client
+    attr_reader :connection
+
+    def initialize(host: 'localhost', port: 6600)
+      @connection = Connection.new(host: host, port: port)
+    end
+
+    def status
+      response = execute('status')
+      response.to_h
+    end
+
+    def execute(command)
+      ensure_connection_established
+      connection.puts(command)
+      response = ServerResponse.from_connection(connection)
+      raise(MpdError, response.status) if response.error?
+      response
+    end
+
+    private
+
+    def ensure_connection_established
+      return if connection.connected?
+      connection.connect
+      connection.gets
+    end
+  end
+end

data/lib/mpd/client/commands.rb

@@ -0,0 +1,10 @@
+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/playback_control.rb

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,39 @@
+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
+        @socket = TCPSocket.open(host, port)
+      end
+
+      def puts(text)
+        raise ConnectionError unless connected?
+        socket.puts(text)
+      end
+
+      def gets
+        raise ConnectionError unless connected?
+        socket.gets
+      end
+
+      def connected?
+        socket && !socket.closed?
+      rescue
+        false
+      end
+
+      private
+
+      attr_reader :socket, :host, :port
+    end
+  end
+end

data/lib/mpd/client/server_response.rb

@@ -0,0 +1,46 @@
+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.join)
+      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 { |line| line.split.map(&:strip) }
+      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

data/lib/mpd/errors.rb

@@ -0,0 +1,4 @@
+module MPD
+  class ConnectionError < StandardError; end
+  class MpdError < StandardError; end
+end

data/lib/mpd/version.rb

@@ -0,0 +1,3 @@
+module MPD
+  VERSION = '0.0.1'.freeze
+end

data/lib/ruby-mpd-client.rb

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

data/ruby-mpd-client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mpd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-mpd-client"
+  spec.version       = MPD::VERSION
+  spec.authors       = ["Dmitriy Non"]
+  spec.email         = ["non.dmitriy@gmail.com"]
+
+  spec.summary       = 'yet another MPD client on Ruby'
+  spec.homepage      = 'https://github.com/Nondv/ruby-mpd-client'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: ruby-mpd-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitriy Non
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- non.dmitriy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mpd/client.rb
+- lib/mpd/client/commands.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/errors.rb
+- lib/mpd/version.rb
+- lib/ruby-mpd-client.rb
+- ruby-mpd-client.gemspec
+homepage: https://github.com/Nondv/ruby-mpd-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: yet another MPD client on Ruby
+test_files: []