A Ruby interface to the libgpod library.
Add this line to your application's Gemfile:
gem 'rbpod'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rbpod
Functional for most read-only purposes. To get started, add require 'rbpod' to your script.
To load a database from the filesystem:
database = RbPod::Database.new('/mnt/ipod/') # => #<RbPod::Database:0xdeadbeef>
database.version # => 42
database.mountpoint # => "/mnt/ipod/"
database.filename # => "/mnt/ipod/iPod_Control/iTunes/iTunesDB"
database.synchronized? # => trueLoading a database is common, so you can also use a shortcut:
database = RbPod('/mnt/ipod/')If you'd like to create a new, blank database you can do that too:
database = RbPod::Database.create!('/tmp/ipod-blank') # => #<RbPod::Database:0xdeadbeef>The device (if any) that backs the database can be interrogated:
device = database.device # => #<RbPod::Device:0xdeadbeef>
# Model name, number, and capacity.
device.capacity # => 4.0
device.generation # => "Nano Video (3rd Gen.)"
device.model_name # => "Nano (Silver)"
device.model_number # => "A978"
# Feature support.
device.supports_photos? # => true
device.supports_videos? # => true
device.supports_artwork? # => true
device.supports_podcasts? # => true
device.supports_chapter_images? # => true
# Reading/writing SysInfo. Set a key to nil to erase it.
device['ModelNumStr'] # => "xA978"
device['PotsdamConf45'] = "Kilroy Was Here"
device.save!You can get direct access to the playlists on the device:
database.playlists # => #<RbPod::PlaylistCollection:0xdeadbeef>
# For a list of all the names of playlists on the iPod:
database.playlists.map(&:name) # => ["iPod", "Podcasts", "Recently Added"]
# For direct access to the master playlist:
database.playlists.master # => #<RbPod::Playlist:0xdeadbeef>
# For direct access to the podcast playlist:
database.playlists.podcast # => #<RbPod::Playlist:0xdeadbeef>All playlists support a variety of methods:
playlist = database.playlists.master
playlist.name # => "iPod"
playlist.length # => 400
playlist.created_on # => 2008-04-05 08:47:46 -0700
playlist.master? # => true
playlist.smart? # => false
playlist.podcast? # => false
playlist.tracks # => #<RbPod::TrackCollection:0xdeadbeef>All playlists contain a tracks method which returns an RbPod::TrackCollection:
tracks = database.playlists.master.tracks
tracks.playlist # => #<RbPod::Playlist:0xdeadbeef>
tracks.length # => 400
tracks.first # => #<RbPod::Track:0xdeadbeef>
tracks[0] # => #<RbPod::Track:0xdeadbeef>track = database.playlists.master.tracks.first
track.artist # => "Steppenwolf"
track.title # => "Born To Be Wild"
track.album # => "All Time Greatest Hits Remastered"
track.file_type # => "MPEG audio file"
track.transferred? # => trueIf anything goes belly up at run time, an RbPod::Error exception should be thrown with a detailed message.
- The RSpec tests need a lot of work and significantly more coverage, especially for integration.
- The documentation could be spiced up a bit. It's dry and doesn't provide too much useful information.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request