Project

LyricFind

0.0
No commit activity in last 3 years
No release in over 3 years
This gem will allow your application to access LyricFind's API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.9
~> 2.0
~> 10.0
~> 3.0
~> 2.9
~> 1.21

Runtime

~> 1.6
 Project Readme

LyricFind

Gem Version | Code Climate | License | Issues | Releases | Dependencies

This gem allows your application to access LyricFind's API services to search and retrieve song information, snippets and lyrics.

Installation

Add this line to your application's Gemfile:

gem 'LyricFind'

And then execute:

$ bundle

Or install it yourself as:

$ gem install LyricFind

Running tests

Create a file called lyricfind.yml (see the example) and put in your keys there.

The run the tests using

rake

Usage

For usage examples from tests, please see here

Example for getting a song object back with info:

lf = LyricFind::API.new 'search-key', 'display-key'
song = lf.get_song_info 'u2', 'one'
# => song.lyrics
# => song.artist
# => song.song_name
# => song.album
# => song.duration
# => song.snippet
# => song.instrumental

Example for getting just the lyrics:

require 'LyricFind'

lf = LyricFind::API.new 'search-key', 'display-key'
puts lf.get_lyrics_by_song_name 'u2', 'one'

Running from the command line

Contributing

  1. Fork it (https://github.com/ihassin/lyricfind/fork)
  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 a new Pull Request

License

MIT.

Other efforts

Look here if you're looking for an impementation in Go

RubyGems

Check out the gem here