lyrics_finder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc26dd72ab5b067f0b65825a0cf201814d78c435
+  data.tar.gz: 193e8cccb5a6017c1e6a064744bd24ab52763cda
+SHA512:
+  metadata.gz: 979ecf3aa994a3091e79c9821d6fecc227f7286da1a728b6f314db0215971df116ec02bc3c63dc719989ca20f945b79c69953a181eb9b7483a9ff4aa98433071
+  data.tar.gz: 65747552f08a99b6e3935fdb7bffa1060fd1d99ff492cc7a0b8473d5a3ebba4f30e04f15c0f8ffbb9d852ad0844116a38f06307f31a9eb62fd6a5f65488d1c42

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.idea

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--format Nc
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - ruby
+  - 2.1.0
+
+notifications:
+  email:
+    recipients:
+      - dromveg@gmail.com

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lyrics_finder.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Romero
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,79 @@
+# LyricsFinder [![Build Status](https://travis-ci.org/dnlR/lyrics_finder.svg?branch=master)](https://travis-ci.org/dnlR/lyrics_finder) [![Coverage Status](https://img.shields.io/coveralls/dnlR/lyrics_finder.svg)](https://coveralls.io/r/dnlR/lyrics_finder?branch=master) [![endorse](https://api.coderwall.com/dnlr/endorsecount.png)](https://coderwall.com/dnlr)
+
+Simple library to search for song lyrics 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lyrics_finder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lyrics_finder
+
+## Hello World!
+
+Create an instance of `LyricsFinder::Fetcher`:
+
+```ruby
+  fetcher = LyricsFinder::Fetcher.new
+```
+
+You can specify which websites are you going to get the lyrics from:
+
+```ruby
+  fetcher = LyricsFinder::Fetcher.new(:song_lyrics, :azlyrics)
+```
+
+You can choose among the following:
+
+- LyricsWikia
+- SongLyrics
+- AZLyrics
+
+And search passing the author and the song title as parameters to `Fetcher#search`:
+
+```ruby
+  fetcher.search 'idina menzel', 'let it go'
+```
+Which will return and array with all the verses of the song as strings, or `nil` if it cannot found the song in any of the websites.
+
+## Example
+
+In your ruby apps:
+```ruby
+  require 'lyrics_finder'
+  
+  fetcher = LyricsFinder::Fetcher.new
+  @song = fetcher.search 'idina menzel', 'let it go'
+  puts @song
+```
+    
+## CLI
+
+LyricsFinder is also available as a command-line tool.
+
+    $ lyricsfinder search -a 'idina menzel' -t 'let it go'
+
+## Changelog
+
+v 0.0.1
+
+- Initial release
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lyrics_finder/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
+
+## Credits
+
+Inspired by [Lyricfy](https://github.com/javichito/Lyricfy).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+# Run with 'rake spec'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format documentation']
+end
+
+task :default => :spec

data/bin/lyricsfinder

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'lyrics_finder/cli'
+LyricsFinder::CLI.start

data/lib/lyrics_finder/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+require 'lyrics_finder'
+
+module LyricsFinder
+  class CLI < Thor
+    desc 'search -a Author -t Song Title', 'Search the lyrics for the specified author and title'
+    method_option 'author', :aliases => '-a', :type => :string
+    method_option 'title', :aliases => '-t', :type => :string
+    def search
+      fetcher = LyricsFinder::Fetcher.new
+      puts fetcher.search(options[:author], options[:title])
+    end
+  end
+end

data/lib/lyrics_finder/dependencies.rb

@@ -0,0 +1,13 @@
+require 'open-uri'
+require 'nokogiri'
+require 'active_support/core_ext'
+require 'i18n'
+I18n.enforce_available_locales = false
+require 'contracts'
+include Contracts
+
+require_relative 'version'
+require_relative 'providers'
+require_relative 'providers/lyrics_wikia'
+require_relative 'providers/azlyrics'
+require_relative 'providers/song_lyrics'

data/lib/lyrics_finder/providers/azlyrics.rb

@@ -0,0 +1,19 @@
+module LyricsFinder::Providers::Azlyrics
+  def format_url(author, title)
+    author = I18n.transliterate(author.strip.gsub(" ", ""))
+    title = I18n.transliterate(title.strip.gsub(" ", ""))
+    "http://www.azlyrics.com/lyrics/#{author}/#{title}.html"
+  end
+  module_function :format_url
+
+  def extract_lyric(data)
+    html = Nokogiri::HTML(data)
+    lyrics_container = html.css('div:nth-child(7)').first
+    unless lyrics_container.nil?
+      elements = lyrics_container.children.to_a
+      phrases = elements.select { |el| el.text? && el.text != "\n" && !el.blank? }
+      phrases.map! { |element| element.text.strip }
+    end
+  end
+  module_function :extract_lyric
+end

data/lib/lyrics_finder/providers/lyrics_wikia.rb

@@ -0,0 +1,23 @@
+module LyricsFinder::Providers::LyricsWikia
+  #Contract lambda { |a, s| !a.blank? && !s.blank? } => String
+  Contract String, String => String
+  def format_url(author, title)
+    author = I18n.transliterate(author.strip.gsub(" ", "_"))
+    title = I18n.transliterate(title.strip.gsub(" ", "_"))
+    "http://lyrics.wikia.com/#{author}:#{title}"
+  end
+  module_function :format_url
+
+  #Contract lambda { |x| x.is_a? Tempfile } => Module
+  Contract lambda { |x| x.is_a? Tempfile } => Array
+  def extract_lyric(data)
+    html = Nokogiri::HTML(data)
+    lyrics_container = html.css('.lyricbox').first
+    unless lyrics_container.nil?
+      elements = lyrics_container.children.to_a
+      phrases = elements.select { |el| el.text? && el.text != "\n" && !el.blank? }
+      phrases.map! { |element| element.text.strip }
+    end
+  end
+  module_function :extract_lyric
+end

data/lib/lyrics_finder/providers/song_lyrics.rb

@@ -0,0 +1,19 @@
+module LyricsFinder::Providers::SongLyrics
+  def format_url(author, title)
+    author = I18n.transliterate(author.strip.gsub(" ", "-"))
+    title = I18n.transliterate(title.strip.gsub(" ", "-"))
+    "http://www.songlyrics.com/#{author}/#{title}-lyrics/"
+  end
+  module_function :format_url
+
+  def extract_lyric(data)
+    html = Nokogiri::HTML(data)
+    lyrics_container = html.css('#songLyricsDiv').first
+    unless lyrics_container.nil?
+      elements = lyrics_container.children.to_a
+      phrases = elements.select { |el| el.text? && el.text != "\n" && !el.blank? }
+      phrases.map! { |element| element.text.strip }
+    end
+  end
+  module_function :extract_lyric
+end

data/lib/lyrics_finder/providers.rb

@@ -0,0 +1,8 @@
+module LyricsFinder::Providers
+  Contract Symbol => Module
+  def build_klass(provider)
+    klass = "LyricsFinder::Providers::" + provider.to_s.camelize
+    klass.constantize
+  end
+  module_function :build_klass
+end

data/lib/lyrics_finder/version.rb

@@ -0,0 +1,3 @@
+module LyricsFinder
+  VERSION = "0.0.1"
+end

data/lib/lyrics_finder.rb

@@ -0,0 +1,53 @@
+require_relative 'lyrics_finder/dependencies'
+
+module LyricsFinder
+  class Fetcher
+    PROVIDERS_LIST = [:lyrics_wikia, :song_lyrics, :azlyrics]
+    UsageError = Class.new(StandardError)
+    attr_reader :providers
+
+    def initialize(*args)
+      @providers = filter_providers(args)
+    end
+
+    def search(author, title)
+      validate_song_data(author, title)
+      song_lyric = catch(:song_lyric) {
+        @providers.each do |provider|
+          klass = Providers.build_klass(provider)
+          url = klass.format_url(author, title)
+
+          data = perform_request(url)
+          result = klass.extract_lyric(data) if data
+          throw :song_lyric, result unless result.nil?
+        end
+      }
+      # because if it doesn't find anything returns @providers by default
+      song_lyric != @providers ? song_lyric : nil
+    end
+    
+    private
+
+    def filter_providers(providers)
+      valid_providers = []
+      providers.each do |provider|
+        valid_providers << provider if PROVIDERS_LIST.include?(provider)
+      end
+      valid_providers.any? ? valid_providers : PROVIDERS_LIST
+    end
+
+    def validate_song_data(author, title)
+      if author.blank? || title.blank?
+        fail UsageError, "You must supply a valid author and title"
+      end
+    end
+
+    def perform_request(url)
+      begin
+        open(url)
+      rescue Exception => ex
+        # puts "ERROR: " + ex.message
+      end
+    end
+  end
+end

data/lyrics_finder.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lyrics_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lyrics_finder'
+  spec.version       = LyricsFinder::VERSION
+  spec.authors       = ['Daniel Romero']
+  spec.email         = ['dromveg@gmail.com']
+  spec.summary       = %q{Solution for finding song lyrics}
+  spec.description   = %q{Simple library for finding song lyrics}
+  spec.homepage      = 'https://github.com/dnlR/lyrics_finder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'rspec', '~> 2.14.0'
+  spec.add_development_dependency 'rspec-nc', '0.0.6'
+  spec.add_development_dependency 'vcr', '2.9.2'
+  spec.add_development_dependency 'webmock', '1.18.0'
+  spec.add_development_dependency 'coveralls', '0.7.0'
+
+  spec.add_dependency 'nokogiri', '1.6.1'
+  spec.add_dependency 'activesupport', '4.1.1'
+  spec.add_dependency 'i18n', '0.6.9'
+  spec.add_dependency 'contracts', '0.4'
+  spec.add_dependency 'thor', '0.19.1'
+end

data/spec/lyrics_finder_spec.rb

@@ -0,0 +1,142 @@
+describe LyricsFinder::Fetcher do
+  describe 'sets @providers properly on initialization' do
+    context 'without specifying providers' do
+      let(:fetcher) { LyricsFinder::Fetcher.new }
+
+      it 'sets @providers to default PROVIDERS_LIST' do
+        expect(fetcher.providers).to eq LyricsFinder::Fetcher::PROVIDERS_LIST
+      end
+    end
+
+    context 'specifying providers' do
+      context 'some providers are invalid' do
+        let(:fetcher) { LyricsFinder::Fetcher.new(:lyrics_wikia, :bad_songs) }
+        
+        it 'filters invalid providers' do
+          expect(fetcher.providers).to match_array [:lyrics_wikia]
+        end
+      end
+
+      context 'all providers are invalid' do
+        let(:fetcher) { LyricsFinder::Fetcher.new(:bad_songs, :invalid_songs) }
+        
+        it 'sets @providers to default PROVIDERS_LIST' do
+          expect(fetcher.providers).to eq LyricsFinder::Fetcher::PROVIDERS_LIST
+        end
+      end
+    end
+  end # 'initialization'
+
+  describe '#search' do
+    describe 'using LyricsWikia as the provider' do
+      context 'with a song that can be found' do
+        before :each do
+          @fetcher = LyricsFinder::Fetcher.new(:lyrics_wikia)
+          VCR.use_cassette 'LyricsWikia 200 search' do
+            @song = @fetcher.search("american authors", "best day of my life")
+          end
+        end
+
+        it 'returns an instance of Array' do
+          expect(@song.class).to eq Array
+        end
+
+        it 'returns the desired song' do
+          expect(@song).to eq LyricsWikiaSampleSongs::BEST_DAY_OF_MY_LIFE
+        end
+      end
+
+      # Searching for a song that exist but it's not yet on this website.
+      context 'with a song that cannot be found' do
+        before :each do
+          @fetcher = LyricsFinder::Fetcher.new(:lyrics_wikia)
+          VCR.use_cassette 'LyricsWikia Song does not exist search' do
+            @song = @fetcher.search("arctic monkeys", "do i wanna know")
+          end
+        end
+
+        it 'returns nil' do
+          expect(@song).to be nil
+        end
+      end
+    end
+
+    describe 'using Azlyrics as the provider' do
+      before :each do
+        @fetcher = LyricsFinder::Fetcher.new(:azlyrics)
+        VCR.use_cassette 'Azlyrics 200 search' do
+          @song = @fetcher.search("american authors", "best day of my life")
+        end
+      end
+
+      it 'returns an instance of Array' do
+        expect(@song.class).to eq Array
+      end
+
+      it 'returns the desired song' do
+        expect(@song).to eq AzlyricsSampleSongs::BEST_DAY_OF_MY_LIFE
+      end
+    end
+
+    describe 'using SongLyrics as the provider' do
+      before :each do
+        @fetcher = LyricsFinder::Fetcher.new(:song_lyrics)
+        VCR.use_cassette 'SongLyrics 200 search' do
+          @song = @fetcher.search("american authors", "best day of my life")
+        end
+      end
+
+      it 'returns an instance of Array' do
+        expect(@song.class).to eq Array
+      end
+
+      it 'returns the desired song' do
+        expect(@song).to eq SongLyricsSampleSongs::BEST_DAY_OF_MY_LIFE
+      end
+    end
+
+    # unfortunately lyrics mania doesn't return 404 if it does not find the song
+    # it just redirect to the root url www.lyricsmania.com
+    # describe 'using LyricsMania as the provider' do
+    #   before :each do
+    #     @fetcher = LyricsFinder::Fetcher.new(:lyrics_mania)
+    #     VCR.use_cassette 'LyricsMania 200 search' do
+    #       @song = @fetcher.search("american authors", "best day of my life")
+    #     end
+    #   end
+    #
+    #   it 'returns an instance of Array' do
+    #     expect(@song.class).to eq Array
+    #   end
+    #
+    #   it 'returns the desired song' do
+    #     expect(@song).to eq LyricsManiaSampleSongs::BEST_DAY_OF_MY_LIFE
+    #   end
+    # end
+
+    describe 'with a song that cannot be found' do
+      before :each do
+        @fetcher = LyricsFinder::Fetcher.new
+        VCR.use_cassette 'Nonexistent Song 404 search' do
+          @song = @fetcher.search("the foobar band", "rubynation")
+        end
+      end
+
+      it 'returns nil' do
+        expect(@song).to be nil
+      end
+    end
+
+    describe 'with invalid parameters' do
+      let(:fetcher) { LyricsFinder::Fetcher.new }
+
+      it 'fails with UsageError' do
+        expect{
+          fetcher.search("", "")
+        }.to raise_error( LyricsFinder::Fetcher::UsageError,
+                          "You must supply a valid author and title")
+      end
+    end
+  end # '#search'
+
+end