ruby-mpd 0.1.4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+Gemfile.lock
+
+config.yml

data/AUTHORS

@@ -0,0 +1 @@
+Andrew Rader (bitwise_mcgee AT yahoo.com / http://nymb.us)

data/COPYING

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/DOC.rdoc

@@ -0,0 +1,78 @@
+#
+#== librmpd.rb
+#
+# librmpd.rb is another Ruby MPD Library with a goal of greater
+# ease of use, more functionality, and thread safety
+#
+# Author:: Andrew Rader (bitwise_mcgee AT yahoo.com | http://nymb.us)
+# Copyright:: Copyright (c) 2006 Andrew Rader
+# License:: Distributed under the GNU GPL v2 (See COPYING file)
+#
+# This was written with MPD version 0.11.5 (http://www.musicpd.org)
+#
+# The main class is the MPD class. This provides the functionality for
+# talking to the server as well as setting up callbacks for when events
+# occur (such as song changes, state changes, etc). The use of callbacks
+# is optional, if they are used a seperate thread will continuously poll
+# the server on its status, when something is changed, your program will
+# be notified via any callbacks you have set. Most methods are the same
+# as specified in the MPD Server Protocol, however some have been modified
+# or renamed. Most notable is the list* and lsinfo functions have been
+# replace with more sane methods (such as `files` for all files)
+#
+#== Usage
+#
+# First create an MPD object
+#
+#  require 'librmpd'
+#
+#  mpd = MPD.new 'localhost', 6600
+#
+# and connect it to the server
+#
+#  mpd.connect
+#
+# You can now issue any of the commands. Each command is documented below.
+#
+#=== Callbacks
+#
+# Callbacks are a way to easily setup your client as event based, rather
+# than polling based. This means rather than having to check for changes
+# in the server, you setup a few methods that will be called when those
+# changes occur. For example, you could have a 'state_changed' method
+# that will be called whenever the server changes state. You could then
+# have this method change a label to reflect to the new state.
+#
+# To use callbacks in your program, first setup your callback methods. For
+# example, say you have the class MyClient. Simply define whatever
+# callbacks you want inside your class. See the documentation on the
+# callback type constants in the MPD class for details on how each callback
+# is called
+#
+# Once you have your callback methods defined, use the register_callback
+# methods to inform librmpd about them. You can have multiple callbacks
+# for each type of callback without problems. Simply use object.method('method_name')
+# to get a reference to a Method object. Pass this object to the
+# register_callback (along with the proper type value), and you're set.
+#       
+# An Example:
+#
+#   class MyClient
+#    ...
+#    def state_callback(newstate)
+#     puts "MPD Changed State: #{newstate}"
+#    end
+#    ...
+#   end
+#
+#   client = MyClient.new
+#   mpd = MPD.new
+#   mpd.register_callback(client.method('state_callback'), MPD::STATE_CALLBACK)
+#       
+#   # Connect and Enable Callbacks
+#   mpd.connect(true)
+#
+# In order for the callback to be used, you must enable callbacks when you
+# connect by passing true to the connect method. Now, whenever the state changes
+# on the server, myclientobj's state_callback method will be called (and passed
+# the new state as an argument)

data/README.rdoc

@@ -0,0 +1,174 @@
+= ruby-mpd
+
+ruby-mpd is a powerful object-oriented Music Player Daemon library, forked from librmpd.
+librmpd is as of writing outdated by 6(*!*) years. This library tries to act as a successor,
+originally using librmpd as a base, however almost all of the codebase was rewritten.
+ruby-mpd supports all "modern" MPD features.
+
+== MPD Protocol
+
+The Music Player Daemon protocol is implemented inside the library. The implementation
+brings the entire set of features to ruby, with support of the newest protocol commands.
+However some commands were remapped, some were converted to objects, as I felt they fit
+this way much more into ruby and are more intuitive.
+
+== Installation
+
+  gem install ruby-mpd
+
+== Usage
+
+Require the library.
+
+  require 'ruby-mpd'
+
+Then, make a new object:
+
+  mpd = MPD.new 'localhost', 6600
+
+You can also omit the host and/or port, and it will use the defaults.
+
+  mpd = MPD.new 'localhost'
+  mpd = MPD.new
+
+
+Once you have an instance of the MPD class, connect to the server:
+
+  mpd.connect
+
+When you are done, disconnect by calling disconnect.
+
+  mpd.disconnect
+
+*Note*: The server may disconnect you at any time due to inactivity. This can
+be fixed by enabling callbacks (see the Callbacks section) or by issuing a
+`ping` command at certain intervals
+
+Once connected, you can issue commands to talk to the server
+
+    mpd.connect
+    if mpd.stopped?
+      mpd.play
+    end
+    song = mpd.current_song
+    puts "Current Song: #{song.artist} - #{song.title}"
+
+You can find documentation for each command [here](TODO)
+
+== Playlists
+
+Playlists are one of the objects that map the MPD commands onto a simple to use
+object. Instead of going trough all those function calls, passing data along to
+get your results, you simply use the object in an object-oriented way:
+
+  mpd.playlists # 0> [MPD::Playlist, MPD::Playlist...]
+
+  playlist = mpd.playlists.first
+
+  p playlist.name # => "My playlist"
+
+  playlist.songs # => [MPD::Song, MPD::Song...]
+
+  playlist.rename('Awesomelist')
+  p playlist.name # => "Awesomelist"
+
+  playlist.add('awesome_track.mp3')
+
+To create a new playlist, simply create a new object. The playlist will be created
+in the daemon's library automatically as soon as you use +#add+ or +#findadd+. There
+is also no save method, as playlists get 'saved' by the daemon any time you do an
+action on them (add, delete, rename).
+
+  MPD::Playlist.new(mpd, 'name')
+
+Currently, one also has to pass in the MPD connection, as playlists are tied to
+a certain connection.
+
+== Callbacks
+
+Callbacks are a simple way to make your client respond to events, rather that
+have to continuously ask the server for updates. This allows you to focus on
+displaying the data, rather that working overly hard to get it. This is done
+by having a background thread continuously check the server for changes. Because
+of this thead, enabling callbacks also means your client will stay connected to
+the server without having to worry about timeouts.
+
+To make use of callbacks, we need to:
+
+(1) Setup a callback to be called when something happens.
+(2) Connect to the server with callbacks set as enabled.
+
+
+Firstly, we need to create a callback block and subscribe it, so that will get
+triggered whenever a specific event happens. When the callback is triggered,
+it will also recieve the new values of the event that happened.
+
+So how do we do this? We use the MPD#on method, which sets it all up for us. The
+argument takes a symbol with the name of the event. The function also requires a block,
+which is our actual callback that will get called.
+
+  mpd.on :volume do |volume|
+    puts "Volume was set to #{volume}"!
+  end
+
+One can also use separate methods or Procs and whatnot, just pass them in as a parameter.
+  
+  # Proc
+  proc = Proc.new {|volume| puts "Volume was set to #{volume}"! }
+  mpd.on :volume, &proc
+
+  # Method
+  def volume_change(value)
+    puts "Volume changed to #{value}!"
+  end
+
+  method = self.method(:volume_change)
+  mpd.on :volume, &method
+
+ruby-mpd supports callbacks for any of the keys returned by MPD#status, as well as +:connection+.
+which will notify us when we connect or disconnect to the daemon. Here's the full list of events,
+along with the variables it will return:
+
+  * *volume*: The volume level as an Integer between 0-100.
+  * *repeat*: true or false
+  * *random*: true or false
+  * *single*: true or false
+  * *consume*: true or false
+  * *playlist*: 31-bit unsigned Integer, the playlist version number.
+  * *playlistlength*: Integer, the length of the playlist
+  * *state*: :play, :stop, or :pause, state of the playback.
+  * *song*: An MPD::Song object, representing the current song.
+  * *songid*: playlist songid of the current song stopped on or playing.
+  * *nextsong*: playlist song number of the next song to be played.
+  * *nextsongid*: playlist songid of the next song to be played.
+  * *time*: Returns two variables, *+total+* and *+elapsed+*, Integers representing seconds.
+  * *elapsed*: Float, representing total time elapsed within the current song, but with higher accuracy.
+  * *bitrate*: instantaneous bitrate in kbps.
+  * *xfade*: crossfade in seconds
+  * *mixrampdb*: mixramp threshold in dB (Float)
+  * *mixrampdelay*: mixrampdelay in seconds
+  * *audio*: Returns three variables: sampleRate, bits and channels.
+  * *updating_db*: job id
+  * *error*: if there is an error, returns message here
+
+Note that if the callback returns more than one value, the callback needs more arguments
+in order to recieve those values:
+
+  mpd.on :audio do |sampleRate, bits, channels|
+    puts bits
+  end
+
+  mpd.on :audio do |*args|
+    puts args.join(',')
+  end
+
+Finally, the easiest step. In order for callbacks to work, connect to the server
+with callbacks enabled:
+
+    mpd.connect true
+
+Easy as pie. The above will connect to the server like normal, but this time it will
+create a new thread that loops until you issue a `disconnect`. This loop checks the
+server, then sleeps for two tenths of a second, then loops. Because it's continuously
+polling the server, there's the added benefit of your client not being disconnected
+due to inactivity.