Song Lyrics for your Ruby apps.
Ruby
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
lyricfy.gemspec

README.md

Lyricfy

Song Lyrics for your Ruby apps.

Build Status Code Climate Gem Version

Installation

Add this line to your application's Gemfile:

gem 'lyricfy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lyricfy

Usage

You need to create an instance of the Lyricfy::Fetcher class and send the #search message with the artist name and song title respectively. The following example shows the most basic usage.

fetcher = Lyricfy::Fetcher.new
song = fetcher.search 'Coldplay', 'Viva la vida'
puts song.body # prints lyrics separated by '\n'

You can also pass a custom separator to the #body method. For example:

lyrics.body("<br>") # returns a String with the song lyrics separated by a <br> tag

The Lyricfy::Fetcher#search method returns a Lyricfy::Song object with the following methods:

  • title
  • author
  • lines
  • body

Where title is the song title, author is the song artist, lines is an Array of the lyric paragraphs and body returns a String with the song lyrics separated with \n by default.

How does it work?

Under the hood, this library fetch the song lyrics by scraping some websites called "Providers". The currently supported providers are:

By default this gem will recursively search for the lyric on each of the providers, if the lyric is not found it will return nil. You can also tell Lyricfy to only use the provider(s) that you want.

fetcher = Lyricfy::Fetcher.new(:metro_lyrics)
song = fetcher.search 'Coldplay', 'Viva la vida'
puts song.body

In this case Lyricfy will look for the lyric only on MetroLyrics.

Changelog

v0.1.0

  • Cleaner API
  • Added a Song class
  • Added custom separators for the lyrics
  • Added memoization. Thanks to @marksim

v0.0.2

  • Fixed a small bug inside Lyricfy::Fetcher#search
  • Added some small refactorings

v0.0.1

  • Initial release

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request