/vagalume

Read song's lyrics without leaving your beloved terminal

Primary LanguageRubyMIT LicenseMIT

vagalume-logo

A simple ruby interface to the Vagalume API. Also a command line utility to search song lyrics.

Install

If you are using bundler, add it to your Gemfile:

gem 'vagalume'

or you can just install it with

gem install vagalume

Usage

The usage is pretty simple:

require "vagalume"

result = Vagalume.find(art: "Metallica", mus: "The Unforgiven")

result.status # => Can be "exact", "aprox", "song_notfound" or "notfound"

song = result.song
song.id
song.name
song.language
song.url
song.lyric

artist = result.artist
artist.id
artist.name
artist.url

result.translations.with_language(Vagalume::Language::PORTUGUESE) # return a Song object

Also supports the "nolyrics" and the "ytid" (youtube id) as an extra param:

require "vagalume"

result = Vagalume.find(art: "Metallica", mus: "The Unforgiven", nolyrics: true, ytid: true)

result.status # => Can be "exact", "aprox", "song_notfound" or "notfound"

song = result.song
song.id
song.lyric (nil)
song.youtube_id

You can also use it from the command line:

vagalume Metallica - The Unforgiven

or passing the [-t] flag, to show the portuguese translation:

vagalume -t Metallica - The Unforgiven

It's also pretty good at finding approximations, so you can try something like that:

vagalume metalica - unforgiven

And everything should work fine.

Requirements

Ruby >= 1.8.7

License

Copyright (c) 2012 Brian Thomas Storti

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.

Bitdeli Badge